Mercurial > hg
comparison mcabber/doc/mcabber.1.txt @ 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 |
---|---|
98 Keycodes of unused keys are displayed by `mcabber` in the log window | 98 Keycodes of unused keys are displayed by `mcabber` in the log window |
99 when pressing the key, for example "Unknown key=265". + | 99 when pressing the key, for example "Unknown key=265". + |
100 "/bind keycode" displays the command line bound to the given keycode; | 100 "/bind keycode" displays the command line bound to the given keycode; |
101 "/bind keycode" unbinds the given keycode. + | 101 "/bind keycode" unbinds the given keycode. + |
102 Note: aliases can be used in key bindings. + | 102 Note: aliases can be used in key bindings. + |
103 Example: "/bind 265 = status online" (265 is F1 for me, but it can | 103 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
104 depend on your ncurses installation). | 104 depend on your ncurses installation). |
105 | 105 |
106 /buffer clear|top|bottom|search_backward|search_forward:: | 106 /buffer clear|top|bottom|search_backward|search_forward:: |
107 The 'buffer' command manipulates the current buddy's buffer | 107 The 'buffer' command manipulates the current buddy's buffer |
108 (chat window). | 108 (chat window). |
148 /msay begin|verbatim|send|abort:: | 148 /msay begin|verbatim|send|abort:: |
149 Send a multi-line message. To write a single message with several | 149 Send a multi-line message. To write a single message with several |
150 lines, the 'multi-line mode' should be used. + | 150 lines, the 'multi-line mode' should be used. + |
151 In multi-line mode, each line (except command lines) typed in the input | 151 In multi-line mode, each line (except command lines) typed in the input |
152 line will be added to the multi-line message. Once the message is | 152 line will be added to the multi-line message. Once the message is |
153 finished, it can be sent to the current selected buddy with the "msay | 153 finished, it can be sent to the current selected buddy with the "/msay |
154 /send" command. + | 154 send" command. + |
155 The 'verbatim' multi-line mode disables commands, so that it is | 155 The 'verbatim' multi-line mode disables commands, so that it is |
156 possible to enter lines starting with a slash. Only the "/msay" | 156 possible to enter lines starting with a slash. Only the "/msay" |
157 command (with send or abort parameters) can be used to exit verbatim | 157 command (with send or abort parameters) can be used to exit verbatim |
158 mode. | 158 mode. |
159 | 159 |
169 'send' 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. | 169 'send' 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. |
170 | 170 |
171 /rename nickname:: | 171 /rename nickname:: |
172 Rename current buddy to the given nickname. | 172 Rename current buddy to the given nickname. |
173 This command does not work for groups, at the moment (but you can move | 173 This command does not work for groups, at the moment (but you can move |
174 the buddies to another group with the /move command). | 174 the buddies to another group with the "/move" command). |
175 | |
176 /room join|leave|names|remove:: | |
177 The 'room' command handles Multi-User Chat room actions. | |
178 | |
179 'join' room nick;; join "room", using "nick" as nickname | |
180 'leave';; leave the current room | |
181 'names';; display members of the current room | |
182 'remove';; remove the current room from the roster. You must have left this room before. | |
175 | 183 |
176 /roster bottom|top|hide_offline|show_offline|toggle_offline:: | 184 /roster bottom|top|hide_offline|show_offline|toggle_offline:: |
177 /roster alternate|unread_first|unread_next:: | 185 /roster alternate|unread_first|unread_next:: |
178 /roster search bud:: | 186 /roster search bud:: |
179 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: | 187 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: |
198 Set the current status. If no status is specified, display the | 206 Set the current status. If no status is specified, display the |
199 current status. + | 207 current status. + |
200 If a status message is specified, it will overrride the message* | 208 If a status message is specified, it will overrride the message* |
201 variables. | 209 variables. |
202 | 210 |
211 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]:: | |
212 Send the requested status to the specified Jabber user. + | |
213 Note: this status will be overridden by subsequent "/status" commands. | |
214 If you are using the auto-away feature, the status will overridden | |
215 too. + | |
216 Note: The jid can include a resource (i.e. user@server/resource). | |
217 | |
203 CONFIGURATION FILE | 218 CONFIGURATION FILE |
204 ------------------ | 219 ------------------ |
205 See the provided sample configuration file, which should be self-documented. | 220 See the provided sample configuration file, which should be self-documented. |
206 | 221 |
207 FILES | 222 FILES |