Mercurial > hg
comparison mcabber/doc/mcabber.1 @ 450:fa93f47a08fe
Update manual page
* Add /room and /status_to documentation
* Some other corrections
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Mon, 26 Sep 2005 00:24:22 +0200 |
parents | 264f40222872 |
children | 52171a3dc199 |
comparison
equal
deleted
inserted
replaced
449:e08b0c2d0e54 | 450:fa93f47a08fe |
---|---|
112 \fB/add\fR jid [nickname] | 112 \fB/add\fR jid [nickname] |
113 Add the jid Jabber user to our roster (default group), and send a notification request to this buddy\&. If no nickname is specified, the jid is used\&. | 113 Add the jid Jabber user to our roster (default group), and send a notification request to this buddy\&. If no nickname is specified, the jid is used\&. |
114 | 114 |
115 .TP | 115 .TP |
116 \fB/alias\fR name = command line | 116 \fB/alias\fR name = command line |
117 Add "name" as an alias for "command line"\&. Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&. Example: "/alias away = status away"\&. | 117 Add "name" as an alias for "command line"\&. |
118 | |
119 Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&. | |
120 | |
121 Example: "/alias away = status away"\&. | |
118 | 122 |
119 .TP | 123 .TP |
120 \fB/bind\fR keycode = command line | 124 \fB/bind\fR keycode = command line |
121 Bind a command line to the key with the "keycode" code number\&. Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&. Note: aliases can be used in key bindings\&. Example: "/bind 265 = status online" (265 is F1 for me, but it can depend on your ncurses installation)\&. | 125 Bind a command line to the key with the "keycode" code number\&. |
126 | |
127 Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&. | |
128 | |
129 Note: aliases can be used in key bindings\&. | |
130 | |
131 Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation)\&. | |
122 | 132 |
123 .TP | 133 .TP |
124 \fB/buffer\fR clear|top|bottom|search_backward|search_forward | 134 \fB/buffer\fR clear|top|bottom|search_backward|search_forward |
125 The buffer command manipulates the current buddy's buffer (chat window)\&. | 135 The buffer command manipulates the current buddy's buffer (chat window)\&. |
126 | 136 |
162 \fB/move\fR [groupname] | 172 \fB/move\fR [groupname] |
163 Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. This command only works with users (not agents), at the moment\&. | 173 Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. This command only works with users (not agents), at the moment\&. |
164 | 174 |
165 .TP | 175 .TP |
166 \fB/msay\fR begin|verbatim|send|abort | 176 \fB/msay\fR begin|verbatim|send|abort |
167 Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&. In multi\-line mode, each line (except command lines) typed in the input line will be added to the multi\-line message\&. Once the message is finished, it can be sent to the current selected buddy with the "msay /send" command\&. The \fIverbatim\fR multi\-line mode disables commands, so that it is possible to enter lines starting with a slash\&. Only the "/msay" command (with send or abort parameters) can be used to exit verbatim mode\&. | 177 Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&. |
178 | |
179 In multi\-line mode, each line (except command lines) typed in the input line will be added to the multi\-line message\&. Once the message is finished, it can be sent to the current selected buddy with the "/msay send" command\&. | |
180 | |
181 The \fIverbatim\fR multi\-line mode disables commands, so that it is possible to enter lines starting with a slash\&. Only the "/msay" command (with send or abort parameters) can be used to exit verbatim mode\&. | |
168 | 182 |
169 \fBbegin\fR enter multi\-line mode | 183 \fBbegin\fR enter multi\-line mode |
170 \fBverbatim\fR enter verbatim multi\-line mode | 184 \fBverbatim\fR enter verbatim multi\-line mode |
171 \fBsend\fR send the current multi\-line message to the currently selected buddy | 185 \fBsend\fR send the current multi\-line message to the currently selected buddy |
172 \fBabort\fR leave multi\-line mode without sending the message | 186 \fBabort\fR leave multi\-line mode without sending the message |
175 \fB/rawxml\fR send | 189 \fB/rawxml\fR send |
176 \fBsend\fR string: send string (raw XML format) to the Jabber server\&. No check is done on the string provided\&. BEWARE! Use this only if you know what you are doing, or you could terminate the connection\&. | 190 \fBsend\fR string: send string (raw XML format) to the Jabber server\&. No check is done on the string provided\&. BEWARE! Use this only if you know what you are doing, or you could terminate the connection\&. |
177 | 191 |
178 .TP | 192 .TP |
179 \fB/rename\fR nickname | 193 \fB/rename\fR nickname |
180 Rename current buddy to the given nickname\&. This command does not work for groups, at the moment (but you can move the buddies to another group with the /move command)\&. | 194 Rename current buddy to the given nickname\&. This command does not work for groups, at the moment (but you can move the buddies to another group with the "/move" command)\&. |
195 | |
196 | |
197 .TP | |
198 \fB/room\fR join|leave|names|remove | |
199 The room command handles Multi\-User Chat room actions\&. | |
200 | |
201 \fBjoin\fR room nick join "room", using "nick" as nickname | |
202 \fBleave\fR leave the current room | |
203 \fBnames\fR display members of the current room | |
204 \fBremove\fR remove the current room from the roster\&. You must have left this room before\&. | |
181 | 205 |
182 .TP | 206 .TP |
183 \fB/roster\fR | 207 \fB/roster\fR |
184 The roster command manipulates the roster/buddylist\&. Here are the available parameters: | 208 The roster command manipulates the roster/buddylist\&. Here are the available parameters: |
185 | 209 |
201 | 225 |
202 .TP | 226 .TP |
203 \fB/status\fR [online|avail|invisible|free|dnd|notavail|away [StatusMessage]] | 227 \fB/status\fR [online|avail|invisible|free|dnd|notavail|away [StatusMessage]] |
204 Set the current status\&. If no status is specified, display the current status\&. If a status message is specified, it will overrride the message* variables\&. | 228 Set the current status\&. If no status is specified, display the current status\&. If a status message is specified, it will overrride the message* variables\&. |
205 | 229 |
230 .TP | |
231 \fB/status_to\fR jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] | |
232 Send the requested status to the specified Jabber user\&. | |
233 | |
234 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&. | |
235 | |
236 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&. | |
237 | |
206 .SH "CONFIGURATION FILE" | 238 .SH "CONFIGURATION FILE" |
207 | 239 |
208 | 240 |
209 See the provided sample configuration file, which should be self\-documented\&. | 241 See the provided sample configuration file, which should be self\-documented\&. |
210 | 242 |