Mercurial > hg
annotate mcabber/doc/mcabber.1.txt @ 1086:5e2e647e781b
Add command /roster group_prev|group_next and update documentation
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Wed, 06 Dec 2006 22:14:41 +0100 |
parents | 07941d7feee9 |
children | 3d92e648a8db |
rev | line source |
---|---|
198 | 1 MCABBER(1) |
2 =========== | |
222 | 3 Mikael BERTHE <mcabber@lilotux.net> |
1037 | 4 v0.8.4-dev, November 2006 |
198 | 5 |
6 NAME | |
7 ---- | |
200 | 8 mcabber - a simple Jabber console client |
198 | 9 |
10 SYNOPSIS | |
11 -------- | |
12 'mcabber' [ -f configfile ] [ --help | -h ] | |
13 | |
14 DESCRIPTION | |
15 ----------- | |
204 | 16 `mcabber(1)` is a small Jabber console client. + |
200 | 17 For now it needs a configuration file to start, so please copy the sample |
208 | 18 mcabberrc file and adapt your connection settings. |
200 | 19 |
360
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
349
diff
changeset
|
20 You also need to have an existing Jabber account to use this software, as |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
349
diff
changeset
|
21 it cannot (un)register accounts yet. |
20283b69db99
Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents:
349
diff
changeset
|
22 |
854 | 23 Here are some of the features of `mcabber`: |
24 | |
25 - 'SSL support'. | |
26 - 'MUC support' (Multi-User Chat). | |
1062 | 27 - 'PGP support' |
28 - 'Chat States' support (typing notifications) | |
854 | 29 - 'History logging:' If enabled (see the CONFIGURATION FILE section), |
30 `mcabber` can save discussions to history log files. | |
31 - 'Commands completion:' If possible, `mcabber` will try to complete your | |
32 command line if you hit the Tab key. | |
33 - 'Input line history:' Any message or command entered is in the input line | |
34 history and can be reused easily. | |
35 - 'External actions:' Some events (like receiving a message) can trigger an | |
36 external action such as a shell script if you enable it in your | |
37 configuration file. A sample events script ("eventcmd") is provided with | |
38 `mcabber` source code, in the contrib directory. | |
39 | |
40 OPTIONS | |
41 ------- | |
42 --help, -h:: | |
43 Quick help usage message | |
44 | |
45 -f configfile:: | |
46 Use configuration file 'configfile' | |
47 | |
48 WINDOWS/PANES | |
49 ------------- | |
202 | 50 The `mcabber(1)` screen is divided into 4 regions. |
200 | 51 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat |
52 buffer, is on the right. The 'input line' lies at the bottom of the screen, | |
53 under a small 'log window'. | |
54 | |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
55 Two status lines surround the log window. The bottom status line is the |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
56 "main status line" and reflects mcabber general status. The other line |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
57 is the "chat status line" and shows the status of the currently selected |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
58 buddy. |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
59 |
204 | 60 To display buddies chat buffers, you will have to enter 'chat mode'. |
61 You can enter chat mode by pressing enter, and leave chat mode with the ESC | |
229 | 62 key. Simply sending a message will also enable chat mode. |
204 | 63 |
854 | 64 There are several advantages to the two-mode implementation: first, it allows |
65 accurate "unread" message functionality, as described in the next section; | |
66 without this, merely scrolling to a specific buddy will "read" the new | |
67 messages of all buddies in-between. Second, it allows quickly hiding the | |
68 conversation with a single keystroke. Third, it allows jumping between | |
69 the few buddies with whom you are conversing with the '/roster alternate' | |
70 command described in another section, without having to manually scroll | |
71 back and forth. | |
200 | 72 |
73 KEYS | |
74 ---- | |
229 | 75 Text typing occurs in the 'input line'; basic operations are supported |
76 (left arrow, right arrow, home/end keys, insert, delete, backspace...). | |
200 | 77 |
78 PageUp and PageDown keys are used to move in the roster. | |
79 | |
618 | 80 Up and Down arrow keys can be used to move in the input line history; they |
81 jump to the previous/next line from the history beginning with the same string | |
82 (from first column to the cursor column). | |
83 | |
200 | 84 To send a message, move to the choosen buddy in the buddylist, type your |
85 message and hit enter. If the line begins with a slash, this will be | |
86 interpreted as a command (see the COMMAND section below). Hit escape to | |
87 leave the chat mode. | |
88 | |
89 Here is a quick description of the key bindings: | |
90 | |
1062 | 91 Esc:: Disable chat mode |
200 | 92 Ctrl-a:: Go to the beginning of the input line |
93 Ctrl-e:: Go to the end of the input line | |
618 | 94 Ctrl-l:: Force a refresh |
95 Up/Down:: Move in the input line history | |
200 | 96 PgUp/PgDown:: Move inside the roster (buddylist) |
97 Tab:: Complete current word, in the input line | |
1083
07941d7feee9
Ctrl-d sends a multi-line message
Mikael Berthe <mikael@lilotux.net>
parents:
1062
diff
changeset
|
98 Ctrl-g:: Cancel completion |
07941d7feee9
Ctrl-d sends a multi-line message
Mikael Berthe <mikael@lilotux.net>
parents:
1062
diff
changeset
|
99 Ctrl-c:: Abort multi-line messages and completions |
07941d7feee9
Ctrl-d sends a multi-line message
Mikael Berthe <mikael@lilotux.net>
parents:
1062
diff
changeset
|
100 Ctrl-d:: Send/terminate a multi-line message |
200 | 101 Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode) |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
102 Ctrl-Left:: Move the cursor back to the start of the current or previous word |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
103 Ctrl-Right:: Move the cursor forward to the end of the current or next word |
200 | 104 Ctrl-u:: Delete from beginning of the line to the cursor |
105 Ctrl-k:: Delete from the cursor to the end of line | |
106 Ctrl-w:: Backward kill word | |
107 Ctrl-t:: Transpose chars | |
263 | 108 Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history) |
236 | 109 Ctrl-q:: Jump to the next unread message |
198 | 110 |
854 | 111 Additional key bindings may be specified using the /bind command described |
112 in the COMMANDS section. | |
113 | |
114 MCABBER'S ROSTER | |
115 ---------------- | |
116 The first listed resource on the roster is '[status]', which keeps a log of | |
117 everything that appears in the short log window below the main chat area. | |
118 While the log window was designed for showing the latest few elements, the | |
119 dedicated '[status]' buffer allows more comfortable viewing of the log, as | |
120 well as scrolling it in a standard manner. | |
121 | |
122 Group names are displayed above the resources that are within them, and are | |
123 indicated by '---' to the left of the name. | |
124 | |
125 For every real Jabber resource, the roster displays four pieces of information: | |
126 the resource's name or alias, its online status, its authorization status, and | |
127 whether there are unread messages from the resource waiting for you. | |
128 | |
129 The online status is one of the following: | |
199 | 130 |
854 | 131 'o';; online |
132 'f';; free for chat | |
133 'a';; away | |
134 'n';; not available (labeled 'extended away' in some clients) | |
135 'd';; do not disturb | |
136 'i';; invisible (displayed only for your resource) | |
137 '_';; offline (or invisible to you) | |
138 '?';; unknown, usually meaning you are not authorized to see this resource's status | |
139 'x';; a conference room in which you are not participating | |
140 'C';; a conference room in which you are participating | |
199 | 141 |
854 | 142 The authorization status indicates whether a resource is authorized to receive |
143 your online status updates, and is displayed by the brackets surrounding the | |
144 resource's online status. Square brackets, like '[o]', indicate that this | |
145 resource is authorized to receive your status. Curly braces, like '\{o\}', | |
146 indicate that they are not authorized to receive your status. | |
147 | |
148 When there are unread messages from the resource which you have not looked at, | |
149 a hash mark ('#') appears in the leftmost section of the roster for that | |
150 resource. The hash mark disappears once you view that resource's message log. | |
151 | |
152 Examples: | |
153 | |
154 ' --- Buds';; This is a group named 'Buds' | |
155 '#[o] John';; John is online, can see your status, and sent you a message that you did not read yet | |
156 ' \{?\} Sally';; Neither you nor Sally have authorized each other to see your online status | |
157 ' \{a\} Jane';; Jane is away, but she cannot see your online status | |
158 '#[C] x@y.c';; You are participating in x@y.c conference room, and there are unread messages | |
159 | |
160 COMMANDS RELATED TO MCABBER | |
161 --------------------------- | |
870 | 162 /alias [name [= command line]]:: |
289 | 163 Add "name" as an alias for "command line". + |
164 Aliases are expanded only once, thus they can not be chained. + | |
870 | 165 "/alias name" displays the value associated with the "name" alias; + |
289 | 166 "/alias name =" unsets the "name" alias. + |
870 | 167 "/alias" displays a list of the existing aliases. + |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
168 Example: "/alias away = status away". |
289 | 169 |
870 | 170 /bind [keycode [= command line]]:: |
289 | 171 Bind a command line to the key with the "keycode" code number. + |
432 | 172 Keycodes of unused keys are displayed by `mcabber` in the log window |
289 | 173 when pressing the key, for example "Unknown key=265". + |
870 | 174 "/bind keycode" displays the command line bound to the given keycode; + |
175 "/bind keycode =" unbinds the given keycode. + | |
176 "/bind" displays a list of the bound keycodes. + | |
289 | 177 Note: aliases can be used in key bindings. + |
450 | 178 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
289 | 179 depend on your ncurses installation). |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
180 |
870 | 181 /buffer clear|purge|top|bottom|date|%|search_backward|search_forward:: |
876 | 182 /buffer scroll_lock|scroll_unlock|scroll_toggle:: |
202 | 183 The 'buffer' command manipulates the current buddy's buffer |
184 (chat window). | |
199 | 185 |
465
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
186 'clear';; clear the current buddy chat window |
876 | 187 'purge';; clear the current buddy chat window and empty all contents of the chat buffer |
511 | 188 'bottom';; jump to the bottom of the current buddy chat buffer |
465
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
189 'top';; jump to the top of the current buddy chat buffer |
511 | 190 'up' [n];; scroll the buffer up n lines (default: half a screen) |
191 'down' [n];; scroll the buffer down n lines (default: half a screen) | |
618 | 192 'date' date;; jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional) |
193 '%' n;; jump to position %n of the buddy chat buffer | |
491 | 194 'search_backward' text;; search for "text" in the current buddy chat buffer |
195 'search_forward' text;; search for "text" in the current buddy chat buffer | |
876 | 196 'scroll_lock';; lock buffer scrolling |
197 'scroll_unlock';; unlock buffer scrolling | |
198 'scroll_toggle';; toggle buffer scrolling (lock/unlock) | |
199 | 199 |
200 /clear:: | |
206 | 201 The 'clear' command is actually an alias for "/buffer clear". |
199 | 202 |
870 | 203 /help [command]:: |
204 Display generic help or help about a specific mcabber command. | |
205 | |
854 | 206 /quit:: |
207 Disconnect and leave `mcabber(1)`. | |
208 | |
209 /version:: | |
210 Display mcabber version | |
211 | |
212 COMMANDS RELATED TO THE SERVER AND CONNECTION | |
213 --------------------------------------------- | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
214 /connect:: |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
215 Establish connection to the Jabber server. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
216 |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
217 /disconnect:: |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
218 Terminate connection to the Jabber server. Note: the roster is only |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
219 available when the connection to the server is active, so the |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
220 buddylist is empty when disconnected. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
221 |
829 | 222 /event #n|* accept|ignore|reject:: |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
223 /event list:: |
829 | 224 Tell mcabber what to do about a pending event. + |
225 If the first parameter is "*", the command will apply to all | |
226 queued events. | |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
227 |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
228 'accept';; accept the event #n |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
229 'ignore';; remove the event #n from the list |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
230 'reject';; reject the event #n |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
231 'list';; list all pending events |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
232 |
901 | 233 /rawxml send string:: |
854 | 234 '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. |
235 | |
236 COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES | |
237 --------------------------------------------------- | |
238 /add [jid [nickname]]:: | |
239 Add the "jid" Jabber user to our roster (default group), and send a | |
240 notification request to this buddy. If no nickname is specified, the | |
241 jid is used. If no jid (or an empty string "") is provided or if jid | |
242 is ".", the current buddy is used. | |
243 | |
244 /authorization allow|cancel|request|request_unsubscribe [jid]:: | |
245 Manage the presence subscriptions. + | |
246 If no jid is provided, the current buddy is used. | |
247 | |
248 'allow';; allow the buddy to receive your presence updates | |
249 'cancel';; cancel the buddy' subscription to your presence updates | |
250 'request';; request a subscription to the buddy's presence updates | |
251 'request_unsubscribe';; request unsubscription from the buddy's presence updates | |
252 | |
253 /del:: | |
254 Delete the current buddy from our roster, unsubscribe from its presence | |
255 notification and unsubscribe it from ours. | |
256 | |
240 | 257 /group fold|unfold|toggle:: |
258 The 'group' command changes the current group display. | |
199 | 259 |
637 | 260 'fold';; fold (shrink) the current group tree in the roster |
240 | 261 'unfold';; unfold (expand) the current group tree in the roster |
262 'toggle';; toggle the state (fold/unfold) of the current tree | |
199 | 263 |
264 /info:: | |
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
265 Display info on the selected entry (user, agent, group...). + |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
266 For users, resources are displayed with the status, priority and |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
267 status message (if available) of each resource. |
199 | 268 |
210 | 269 /move [groupname]:: |
270 Move the current buddy to the requested group. If no group is | |
975 | 271 specified, then the buddy is moved to the default group. |
272 If the group groupname doesn't exist, it is created. + | |
506
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
497
diff
changeset
|
273 Tip: if the chatmode is enabled, you can use "/roster alternate" |
74dcd0df532e
"/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents:
497
diff
changeset
|
274 to jump to the moved buddy. |
210 | 275 |
839 | 276 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort:: |
238 | 277 Send a multi-line message. To write a single message with several |
289 | 278 lines, the 'multi-line mode' should be used. + |
279 In multi-line mode, each line (except command lines) typed in the input | |
280 line will be added to the multi-line message. Once the message is | |
450 | 281 finished, it can be sent to the current selected buddy with the "/msay |
1083
07941d7feee9
Ctrl-d sends a multi-line message
Mikael Berthe <mikael@lilotux.net>
parents:
1062
diff
changeset
|
282 send" command (or Ctrl-d). + |
810 | 283 The 'begin' subcommand enables multi-line mode. Note that it allows |
284 a message subject to be specified. + | |
289 | 285 The 'verbatim' multi-line mode disables commands, so that it is |
286 possible to enter lines starting with a slash. Only the "/msay" | |
287 command (with send or abort parameters) can be used to exit verbatim | |
799 | 288 mode. + |
839 | 289 The 'toggle' and 'toggle_verbatim' subcommands can be bound to a key to |
290 use the multi-line mode quickly (for example, "bind M109 = msay toggle" | |
291 to switch using the Meta-m combination). | |
238 | 292 |
810 | 293 'begin' [subject];; enter multi-line mode |
294 'verbatim';; enter verbatim multi-line mode | |
295 'send';; send the current multi-line message to the currently selected buddy | |
296 'send_to' jid;; send the current multi-line message to "jid" | |
297 'toggle';; switch to/from multi-line mode (begin/send) | |
839 | 298 'toggle_verbatim';; same with verbatim multi-line mode |
810 | 299 'abort';; leave multi-line mode without sending the message |
238 | 300 |
886 | 301 /rename name:: |
302 Rename current buddy or group to the given name. | |
303 Please note that a group name change is only done when the server's | |
304 acknowledgment is received, so a slight delay can be noticed. | |
450 | 305 |
1062 | 306 /request last|time|vcard|version [jid]:: |
700 | 307 Send a "IQ" query to the current buddy, or to the specified Jabber |
308 user. If the resource is not provided with the jid, mcabber will | |
309 send the query to all known resources for this user. | |
310 | |
601 | 311 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy:: |
593 | 312 /room invite|kick|ban|role|affil:: |
1062 | 313 /room bookmark [add|del] [-autojoin|+autojoin]:: |
450 | 314 The 'room' command handles Multi-User Chat room actions. |
315 | |
901 | 316 'join' [room [nick [pass]]];; join "room", using "nick" as nickname. If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file). If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id. A password can be provided to enter protected rooms. If your nickname contains space characters, use quotes. |
487 | 317 'leave' [message];; leave the current room |
318 'names';; display members of the current room | |
319 'nick' nick;; change your nickname in the current room | |
491 | 320 'privmsg' nick msg;; send private message "msg" to "nick" |
487 | 321 'remove';; remove the current room from the roster (you must have left this room before) |
322 'topic';; set topic for current room | |
323 'unlock';; unlock current room (if you are the owner) | |
601 | 324 'destroy' [reason];; destroy the current room (use with care!) |
573 | 325 'whois' nick;; display MUC information about "nick" |
593 | 326 'ban' jid [reason];; ban jid from the current room |
327 'invite' jid [reason];; invite jid to the current room | |
328 'kick' nick [reason];; kick "nick" from the current room | |
329 'role' jid role [reason];; change jid's role (role can be "none", "visitor", "participant", "moderator") | |
330 'affil' jid affil [reason];; change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
1062 | 331 'bookmark' add/update/remove a room bookmark, set/unset autojoin |
199 | 332 |
1086
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
333 /roster bottom|top|up|down|group_prev|group_next:: |
330 | 334 /roster alternate|unread_first|unread_next:: |
265 | 335 /roster search bud:: |
1086
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
336 /roster hide_offline|show_offline|toggle_offline:: |
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
337 /roster item_lock|item_unlock:: |
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
338 /roster hide|show|toggle:: |
1062 | 339 /roster note [-|text]:: |
265 | 340 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: |
199 | 341 |
265 | 342 'bottom';; jump to the bottom of the roster |
343 'top';; jump to the top of the roster | |
377
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
344 'up';; move up in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
345 'down';; move down in the roster |
1086
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
346 'group_prev';; jump to the previous group in the roster |
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
347 'group_next';; jump to the next group in the roster |
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
348 'alternate';; jump to alternate buddy. The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first") |
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
349 'unread_first';; jump to the first unread message |
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
350 'unread_next';; jump to the next unread message |
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
351 'search' bud;; search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) |
202 | 352 'hide_offline';; hide offline buddies |
353 'show_offline';; show offline buddies | |
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
354 'toggle_offline';; toggle display of offline buddies |
1086
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
355 'item_lock' jid;; lock the roster item so it remains visible regardless of its status |
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
356 'item_unlock' jid;; undo the effects of item_lock |
710 | 357 'hide';; hide roster (full-width chat window) |
358 'show';; show roster | |
359 'toggle';; toggle roster visibility | |
1062 | 360 'note' [text];; display or set an annotation (if text is "-", the annotation is deleted). In the "status" buffer, it will display all annotations. |
199 | 361 |
362 /say text:: | |
491 | 363 Send the "text" message to the currently selected buddy. Can be useful |
199 | 364 if you want to send a message beginning with a slash, for example. |
365 | |
480 | 366 /say_to jid text:: |
491 | 367 Send the "text" message to the specified jid. |
480 | 368 Please note that this command doesn't set the default resource for |
369 a contact, so if you want to send several messages to a specific | |
916 | 370 resource you will have to use "/say_to" for each message. |
480 | 371 |
522 | 372 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]]:: |
373 Show or set the current status. + | |
374 If no status is specified, display the current status. + | |
320
dce1dd4d0ca8
Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents:
310
diff
changeset
|
375 If a status message is specified, it will overrride the message* |
522 | 376 variables (these variables can be set in the configuration file). |
377 If no relevant message* variable is set and no status message provided, | |
378 the current status message is kept. If StatusMessage is "-", the | |
379 current status message is cleared. | |
199 | 380 |
450 | 381 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]:: |
382 Send the requested status to the specified Jabber user. + | |
660 | 383 If the specified jid is ".", the current buddy is used. + |
450 | 384 Note: this status will be overridden by subsequent "/status" commands. |
385 If you are using the auto-away feature, the status will overridden | |
386 too. + | |
387 Note: The jid can include a resource (i.e. user@server/resource). | |
388 | |
199 | 389 CONFIGURATION FILE |
390 ------------------ | |
854 | 391 See the provided sample configuration file, which should be self-documenting. |
198 | 392 |
200 | 393 FILES |
394 ----- | |
202 | 395 The following files can be used by `mcabber(1)`: |
200 | 396 |
397 $HOME/.mcabber/mcabberrc Default configuration file | |
398 $HOME/.mcabberrc Configuration file used if no other has been found | |
399 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled | |
400 | |
198 | 401 BUGS |
402 ---- | |
349 | 403 Certainly. Please tell me if you find one! :-) |
198 | 404 |
405 AUTHOR | |
406 ------ | |
222 | 407 Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. + |
204 | 408 Originally based on http://cabber.sourceforge.net[Cabber], please |
198 | 409 consult the AUTHORS file for details. |
410 | |
411 RESOURCES | |
412 --------- | |
202 | 413 http://www.lilotux.net/~mikael/mcabber/[Main web site] |
198 | 414 |
415 COPYING | |
416 ------- | |
700 | 417 Copyright (C) 2005, 2006 Mikael Berthe. + |
202 | 418 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[]. |
198 | 419 |
420 Free use of this software is granted under the terms of the GNU General Public | |
421 License (GPL). | |
422 |