summaryrefslogtreecommitdiff
path: root/doc/en/autogen/weechat_commands.xml
blob: 4fa9c345d1f116617d05427dbb7b2a3f55c26921 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<?xml version="1.0" encoding="UTF-8"?>
<!--
     ********* WARNING! *********

     This file is autogenerated with docgen.pl script. *** DO NOT EDIT! ***
     docgen.pl builds XML doc files to include in many languages
-->

<command>bar  [add barname type[,cond1,cond2,...] position size separator item1,item2,...] | [default] | [del barname|-all] | [set barname name|priority|condition|position|filling|size|separator|items value] | [hide|show barname] | [scroll barname category.name value] | [list] | [listitems]</command>
<programlisting>
manage bars

          add: add a new bar
      barname: name of bar (must be unique)
         type:   root: outside windows),
               window: inside windows, with optional conditions (see below)
    cond1,...: condition(s) for displaying bar (only for type "window"):
                 active: on active window
               inactive: on inactive windows
               nicklist: on windows with nicklist
               without condition, bar is always displayed
     position: bottom, top, left or right
      filling: horizontal or vertical
         size: size of bar (in chars)
    separator: 1 for using separator (line), 0 or nothing means no separator
    item1,...: items for this bar
      default: create default bars
          del: delete a bar (or all bars with -all)
          set: set a value for a bar property
         hide: hide a bar
         show: show an hidden bar
       scroll: scroll bar up/down
category.name: category and name of buffer to scroll ('*' means current buffer, you should use '*' for root bars)
        value: value for scroll: 'x' or 'y', followed by '+', '-', 'b' (beginning) or 'e' (end), value (for +/-), and optional %% (to scroll by %% of width/height, otherwise value is number of chars)
         list: list all bars
     listfull: list all bars (verbose)
    listitems: list all bar items

Examples:
  create a bar with time and completion:
    /bar add mybar root bottom 1 0 [time],completion
  hide a bar:
    /bar hide mybar
  scroll nicklist 10 lines down on current buffer:
    /bar scroll nicklist * y+10
  scroll nicklist one page up on #weechat buffer:
    /bar scroll nicklist #weechat y-100%
  scroll to end of nicklist on current buffer:
    /bar scroll nicklist * ye
</programlisting>
<command>buffer  [action [args] | number | [[server] [channel]]]</command>
<programlisting>
manage buffers

 action: action to do:
  clear: clear buffer content (-all for all buffers, number for a buffer, or nothing for current buffer)
   move: move buffer in the list (may be relative, for example -1)
  close: close buffer
   list: list buffers (no parameter implies this list)
 notify: display notify levels for all open buffers
 scroll: scroll in history (may be relative, and may end by a letter: s=sec, m=min, h=hour, d=day, M=month, y=year); if there is only letter, then scroll to beginning of this item

 number: jump to buffer by number
server,
channel: jump to buffer by server and/or channel name

Examples:
clear current buffer: /buffer clear
   clear all buffers: /buffer clear -all
         move buffer: /buffer move 5
        close buffer: /buffer close this is part msg
     scroll 1 day up: /buffer scroll 1d  ==  /buffer scroll -1d  ==  /buffer scroll -24h
 scroll to beginning
         of this day: /buffer scroll d
  scroll 15 min down: /buffer scroll +15m
   scroll 20 msgs up: /buffer scroll -20
    jump to #weechat: /buffer #weechat
</programlisting>
<command>command  plugin command</command>
<programlisting>
launch explicit WeeChat or plugin command

 plugin: plugin name ('weechat' for WeeChat internal command)
command: command to execute (a '/' is automatically added if not found at beginning of command)
</programlisting>
<command>filter  [list] | [enable|disable|toggle] | [add buffer tags regex] | [del number|-all]</command>
<programlisting>
filter messages in buffers, to hide/show them according to tags or regex

   list: list all filters
 enable: enable filters (filters are enabled by default)
disable: disable filters
 toggle: toggle filters
    add: add a filter
    del: delete a filter
 number: number of filter to delete (look at list to find it)
   -all: delete all filters
 buffer: buffer where filter is active: it may be a name (category.name) or "*" for all buffers
   tags: comma separated list of tags, for example: "irc_join,irc_part,irc_quit"
  regex: regular expression to search in line (use \t to separate prefix from message)

Examples:
  filter IRC join/part/quit messages:
    /filter add * irc_join,irc_part,irc_quit *
  filter nick "toto" on channel #weechat:
    /filter add freenode.#weechat * toto\t
  filter lines containing word "spam":
    /filter add * * spam
  filter lines containing "weechat sucks" on channel #weechat:
    /filter add freenode.#weechat * weechat sucks
</programlisting>
<command>help  [command | option]</command>
<programlisting>
display help about commands and options

command: a command name
 option: an option name (use /set to see list)
</programlisting>
<command>history  [clear | value]</command>
<programlisting>
show buffer command history

clear: clear history
value: number of history entries to show
</programlisting>
<command>input  return | complete_next | complete_previous | search_next | delete_previous_char | delete_next_char | delete_previous_word | delete_next_word | delete_beginning_of_line | delete_end_of_line | delete_line | clipboard_paste | transpose_chars | move_beginning_of_line | move_end_of_line | move_previous_char | move_next_char | move_previous_word | move_next_word | history_previous | history_next | history_global_previous | history_global_next | jump_smart | jump_last_buffer | jump_previous_buffer | hotlist_clear | grab_key | scroll_unread | set_unread | set_unread_current_buffer | insert [args]</command>
<programlisting>
functions for command line

Cette commande est utilisée par les associations de touches ou les extensions.
</programlisting>
<command>key  [key [command [args]]] | [unbind key] | [reset -yes]</command>
<programlisting>
bind/unbind keys

      key: display or bind this key to a command
   unbind: unbind a key
    reset: restore bindings to the default values and delete ALL personal bindings (use carefully!)
</programlisting>
<command>plugin  [list [name]] | [listfull [name]] | [load filename] | [autoload] | [reload [name]] | [unload [name]]</command>
<programlisting>
list/load/unload plugins

    list: list loaded plugins
listfull: list loaded plugins (verbose)
    load: load a plugin
autoload: autoload plugins in system or user directory
  reload: reload one plugin (if no name given, unload all plugins, then autoload plugins)
  unload: unload one or all plugins

Without argument, /plugin command lists loaded plugins.
</programlisting>
<command>quit</command>
<programlisting>
quit WeeChat
</programlisting>
<command>reload  [file [file...]]</command>
<programlisting>
reload configuration files from disk

file: configuration file to reload

Without argument, all files (WeeChat and plugins) are reloaded.
</programlisting>
<command>save  [file [file...]]</command>
<programlisting>
save configuration files to disk

file: configuration file to save

Without argument, all files (WeeChat and plugins) are saved.
</programlisting>
<command>set  [option [ = value]]</command>
<programlisting>
set config options

option: name of an option
 value: value for option
</programlisting>
<command>unset  [option]</command>
<programlisting>
unset/reset config options

option: name of an option (may begin or end with "*" to mass-reset options, use carefully!)

According to option, it's reset (for standard options) or removed (for optional settings, like server values).
</programlisting>
<command>upgrade  [path_to_binary]</command>
<programlisting>
upgrade WeeChat without disconnecting from servers

path_to_binary: path to WeeChat binary (default is current binary)

This command run again a WeeChat binary, so it should have been compiled or installed with a package manager before running this command.
</programlisting>
<command>uptime  [-o]</command>
<programlisting>
show WeeChat uptime

-o: send uptime on current channel as an IRC message
</programlisting>
<command>window  [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]]</command>
<programlisting>
manage windows

  list: list open windows (no parameter implies this list)
    -1: jump to previous window
    +1: jump to next window
    b#: jump to next window displaying buffer number #
    up: switch to window above current one
  down: switch to window below current one
  left: switch to window on the left
 right: switch to window on the right
splith: split current window horizontally
splitv: split current window vertically
resize: resize window size, new size is &lt;pct&gt; pourcentage of parent window
 merge: merge window with another (all = keep only one window)

For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4
</programlisting>