Mercurial > hg
annotate mcabber/doc/mcabber.1.txt @ 1338:43eb4833db0c
Post-0.9.4 changes
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sat, 27 Oct 2007 16:31:12 +0200 |
parents | f8cfa22cedc2 |
children | 305f7a609545 |
rev | line source |
---|---|
198 | 1 MCABBER(1) |
2 =========== | |
222 | 3 Mikael BERTHE <mcabber@lilotux.net> |
1338 | 4 v0.9.5-dev, October 2007 |
198 | 5 |
6 NAME | |
7 ---- | |
200 | 8 mcabber - a simple Jabber console client |
198 | 9 |
10 SYNOPSIS | |
11 -------- | |
1259
c5c09f8f60b0
Change command line option -v to -V
Mikael Berthe <mikael@lilotux.net>
parents:
1257
diff
changeset
|
12 'mcabber' [ -h | -V | -f configfile ] |
198 | 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) |
198 | 109 |
1096 | 110 Additional key bindings may be specified using the '/bind' command described |
854 | 111 in the COMMANDS section. |
112 | |
113 MCABBER'S ROSTER | |
114 ---------------- | |
115 The first listed resource on the roster is '[status]', which keeps a log of | |
116 everything that appears in the short log window below the main chat area. | |
117 While the log window was designed for showing the latest few elements, the | |
118 dedicated '[status]' buffer allows more comfortable viewing of the log, as | |
119 well as scrolling it in a standard manner. | |
120 | |
121 Group names are displayed above the resources that are within them, and are | |
122 indicated by '---' to the left of the name. | |
123 | |
124 For every real Jabber resource, the roster displays four pieces of information: | |
125 the resource's name or alias, its online status, its authorization status, and | |
126 whether there are unread messages from the resource waiting for you. | |
127 | |
128 The online status is one of the following: | |
199 | 129 |
854 | 130 'o';; online |
131 'f';; free for chat | |
132 'a';; away | |
133 'n';; not available (labeled 'extended away' in some clients) | |
134 'd';; do not disturb | |
135 'i';; invisible (displayed only for your resource) | |
136 '_';; offline (or invisible to you) | |
137 '?';; unknown, usually meaning you are not authorized to see this resource's status | |
138 'x';; a conference room in which you are not participating | |
139 'C';; a conference room in which you are participating | |
199 | 140 |
854 | 141 The authorization status indicates whether a resource is authorized to receive |
142 your online status updates, and is displayed by the brackets surrounding the | |
143 resource's online status. Square brackets, like '[o]', indicate that this | |
144 resource is authorized to receive your status. Curly braces, like '\{o\}', | |
145 indicate that they are not authorized to receive your status. | |
146 | |
147 When there are unread messages from the resource which you have not looked at, | |
148 a hash mark ('#') appears in the leftmost section of the roster for that | |
149 resource. The hash mark disappears once you view that resource's message log. | |
150 | |
151 Examples: | |
152 | |
153 ' --- Buds';; This is a group named 'Buds' | |
154 '#[o] John';; John is online, can see your status, and sent you a message that you did not read yet | |
155 ' \{?\} Sally';; Neither you nor Sally have authorized each other to see your online status | |
156 ' \{a\} Jane';; Jane is away, but she cannot see your online status | |
157 '#[C] x@y.c';; You are participating in x@y.c conference room, and there are unread messages | |
158 | |
1242 | 159 COMMANDS |
160 -------- | |
161 Please refer to the online help (command /help), it is probably more up-to-date than this manpage. Furthermore, help files have been translated into several languages. + | |
162 You will find an overview of the `mcabber` commands in this manual. | |
163 | |
854 | 164 COMMANDS RELATED TO MCABBER |
165 --------------------------- | |
870 | 166 /alias [name [= command line]]:: |
289 | 167 Add "name" as an alias for "command line". + |
168 Aliases are expanded only once, thus they can not be chained. + | |
870 | 169 "/alias name" displays the value associated with the "name" alias; + |
289 | 170 "/alias name =" unsets the "name" alias. + |
870 | 171 "/alias" displays a list of the existing aliases. + |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
172 Example: "/alias away = status away". |
289 | 173 |
870 | 174 /bind [keycode [= command line]]:: |
289 | 175 Bind a command line to the key with the "keycode" code number. + |
432 | 176 Keycodes of unused keys are displayed by `mcabber` in the log window |
289 | 177 when pressing the key, for example "Unknown key=265". + |
870 | 178 "/bind keycode" displays the command line bound to the given keycode; + |
179 "/bind keycode =" unbinds the given keycode. + | |
180 "/bind" displays a list of the bound keycodes. + | |
289 | 181 Note: aliases can be used in key bindings. + |
450 | 182 Example: "/bind 265 = status online" (265 is F1 for me, but it may |
289 | 183 depend on your ncurses installation). |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
184 |
1139 | 185 /buffer clear|close|close_all|purge:: |
186 /buffer top|bottom|date|%|search_backward|search_forward:: | |
876 | 187 /buffer scroll_lock|scroll_unlock|scroll_toggle:: |
202 | 188 The 'buffer' command manipulates the current buddy's buffer |
189 (chat window). | |
199 | 190 |
465
52171a3dc199
Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents:
450
diff
changeset
|
191 'clear';; clear the current buddy chat window |
1139 | 192 'close';; empty all contents of the buffer and close the current buddy chat window |
193 'close_all';; empty all contents of the chat buffers and close the chat windows | |
876 | 194 'purge';; clear the current buddy chat window and empty all contents of the chat buffer |
1139 | 195 'top';; jump to the top of the current buddy chat buffer |
511 | 196 'bottom';; jump to the bottom of the current buddy chat buffer |
197 'up' [n];; scroll the buffer up n lines (default: half a screen) | |
198 'down' [n];; scroll the buffer down n lines (default: half a screen) | |
618 | 199 '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) |
200 '%' n;; jump to position %n of the buddy chat buffer | |
491 | 201 'search_backward' text;; search for "text" in the current buddy chat buffer |
202 'search_forward' text;; search for "text" in the current buddy chat buffer | |
876 | 203 'scroll_lock';; lock buffer scrolling |
204 'scroll_unlock';; unlock buffer scrolling | |
205 'scroll_toggle';; toggle buffer scrolling (lock/unlock) | |
199 | 206 |
207 /clear:: | |
206 | 208 The 'clear' command is actually an alias for "/buffer clear". |
199 | 209 |
870 | 210 /help [command]:: |
211 Display generic help or help about a specific mcabber command. | |
212 | |
854 | 213 /quit:: |
214 Disconnect and leave `mcabber(1)`. | |
215 | |
1242 | 216 /set option[=value]:: |
217 Display or set an option value. | |
218 | |
219 /source [file]:: | |
220 Read a configuration file. | |
221 | |
854 | 222 /version:: |
223 Display mcabber version | |
224 | |
225 COMMANDS RELATED TO THE SERVER AND CONNECTION | |
226 --------------------------------------------- | |
298
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
227 /connect:: |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
228 Establish connection to the Jabber server. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
229 |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
230 /disconnect:: |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
231 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
|
232 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
|
233 buddylist is empty when disconnected. |
35cda94e570d
Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents:
290
diff
changeset
|
234 |
829 | 235 /event #n|* accept|ignore|reject:: |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
236 /event list:: |
829 | 237 Tell mcabber what to do about a pending event. + |
238 If the first parameter is "*", the command will apply to all | |
239 queued events. | |
775
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
240 |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
241 'accept';; accept the event #n |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
242 'ignore';; remove the event #n from the list |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
243 'reject';; reject the event #n |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
244 'list';; list all pending events |
b4befb3052e5
Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents:
710
diff
changeset
|
245 |
901 | 246 /rawxml send string:: |
854 | 247 '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. |
248 | |
249 COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES | |
250 --------------------------------------------------- | |
251 /add [jid [nickname]]:: | |
252 Add the "jid" Jabber user to our roster (default group), and send a | |
253 notification request to this buddy. If no nickname is specified, the | |
254 jid is used. If no jid (or an empty string "") is provided or if jid | |
255 is ".", the current buddy is used. | |
256 | |
257 /authorization allow|cancel|request|request_unsubscribe [jid]:: | |
258 Manage the presence subscriptions. + | |
259 If no jid is provided, the current buddy is used. | |
260 | |
261 'allow';; allow the buddy to receive your presence updates | |
262 'cancel';; cancel the buddy' subscription to your presence updates | |
263 'request';; request a subscription to the buddy's presence updates | |
264 'request_unsubscribe';; request unsubscription from the buddy's presence updates | |
265 | |
266 /del:: | |
267 Delete the current buddy from our roster, unsubscribe from its presence | |
268 notification and unsubscribe it from ours. | |
269 | |
240 | 270 /group fold|unfold|toggle:: |
271 The 'group' command changes the current group display. | |
199 | 272 |
637 | 273 'fold';; fold (shrink) the current group tree in the roster |
240 | 274 'unfold';; unfold (expand) the current group tree in the roster |
275 'toggle';; toggle the state (fold/unfold) of the current tree | |
199 | 276 |
277 /info:: | |
440
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
278 Display info on the selected entry (user, agent, group...). + |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
279 For users, resources are displayed with the status, priority and |
264f40222872
Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents:
436
diff
changeset
|
280 status message (if available) of each resource. |
199 | 281 |
210 | 282 /move [groupname]:: |
283 Move the current buddy to the requested group. If no group is | |
975 | 284 specified, then the buddy is moved to the default group. |
285 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
|
286 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
|
287 to jump to the moved buddy. |
210 | 288 |
839 | 289 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort:: |
238 | 290 Send a multi-line message. To write a single message with several |
289 | 291 lines, the 'multi-line mode' should be used. + |
292 In multi-line mode, each line (except command lines) typed in the input | |
293 line will be added to the multi-line message. Once the message is | |
450 | 294 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
|
295 send" command (or Ctrl-d). + |
810 | 296 The 'begin' subcommand enables multi-line mode. Note that it allows |
297 a message subject to be specified. + | |
289 | 298 The 'verbatim' multi-line mode disables commands, so that it is |
299 possible to enter lines starting with a slash. Only the "/msay" | |
300 command (with send or abort parameters) can be used to exit verbatim | |
799 | 301 mode. + |
839 | 302 The 'toggle' and 'toggle_verbatim' subcommands can be bound to a key to |
303 use the multi-line mode quickly (for example, "bind M109 = msay toggle" | |
304 to switch using the Meta-m combination). | |
238 | 305 |
810 | 306 'begin' [subject];; enter multi-line mode |
307 'verbatim';; enter verbatim multi-line mode | |
308 'send';; send the current multi-line message to the currently selected buddy | |
309 'send_to' jid;; send the current multi-line message to "jid" | |
310 'toggle';; switch to/from multi-line mode (begin/send) | |
839 | 311 'toggle_verbatim';; same with verbatim multi-line mode |
810 | 312 'abort';; leave multi-line mode without sending the message |
238 | 313 |
1242 | 314 /pgp disable|enable|force|info [jid]:: |
1096 | 315 /pgp setkey [jid [key]]:: |
316 Manipulate PGP settings for the specified jid (by default the currently selected contact). Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command. | |
317 | |
318 'disable' [jid];; disable PGP encryption for jid (or the currently selected contact) | |
319 'enable' [jid];; enable PGP encryption for jid (or the currently selected contact) | |
1242 | 320 [-]'force' [jid];; enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support |
1096 | 321 'info' [jid];; show current PGP settings for the contact |
322 'setkey' [jid [key]];; set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut-jid "." for the currently selected contact. | |
323 | |
886 | 324 /rename name:: |
325 Rename current buddy or group to the given name. | |
326 Please note that a group name change is only done when the server's | |
327 acknowledgment is received, so a slight delay can be noticed. | |
450 | 328 |
1062 | 329 /request last|time|vcard|version [jid]:: |
700 | 330 Send a "IQ" query to the current buddy, or to the specified Jabber |
331 user. If the resource is not provided with the jid, mcabber will | |
332 send the query to all known resources for this user. | |
333 | |
601 | 334 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy:: |
593 | 335 /room invite|kick|ban|role|affil:: |
1062 | 336 /room bookmark [add|del] [-autojoin|+autojoin]:: |
450 | 337 The 'room' command handles Multi-User Chat room actions. |
338 | |
901 | 339 '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 | 340 'leave' [message];; leave the current room |
1162
39b20ea22ce9
/room names: add options --short, --quiet
Mikael Berthe <mikael@lilotux.net>
parents:
1152
diff
changeset
|
341 'names' [--short|--quiet];; display the members of the current room |
487 | 342 'nick' nick;; change your nickname in the current room |
491 | 343 'privmsg' nick msg;; send private message "msg" to "nick" |
487 | 344 'remove';; remove the current room from the roster (you must have left this room before) |
345 'topic';; set topic for current room | |
346 'unlock';; unlock current room (if you are the owner) | |
601 | 347 'destroy' [reason];; destroy the current room (use with care!) |
573 | 348 'whois' nick;; display MUC information about "nick" |
593 | 349 'ban' jid [reason];; ban jid from the current room |
350 'invite' jid [reason];; invite jid to the current room | |
351 'kick' nick [reason];; kick "nick" from the current room | |
352 'role' jid role [reason];; change jid's role (role can be "none", "visitor", "participant", "moderator") | |
353 'affil' jid affil [reason];; change jid's affiliation (affil can be "none", "member", "admin", "owner") | |
1062 | 354 'bookmark' add/update/remove a room bookmark, set/unset autojoin |
199 | 355 |
1086
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
356 /roster bottom|top|up|down|group_prev|group_next:: |
330 | 357 /roster alternate|unread_first|unread_next:: |
265 | 358 /roster search bud:: |
1086
5e2e647e781b
Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents:
1083
diff
changeset
|
359 /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
|
360 /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
|
361 /roster hide|show|toggle:: |
1062 | 362 /roster note [-|text]:: |
265 | 363 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: |
199 | 364 |
265 | 365 'bottom';; jump to the bottom of the roster |
366 '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
|
367 'up';; move up in the roster |
00809e3e327e
Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents:
372
diff
changeset
|
368 '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
|
369 '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
|
370 '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
|
371 '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
|
372 '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
|
373 '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
|
374 'search' bud;; search for a buddy with a name or jid containing "bud" (only in the displayed buddylist) |
202 | 375 'hide_offline';; hide offline buddies |
376 'show_offline';; show offline buddies | |
290
f63839a4cb35
Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents:
289
diff
changeset
|
377 '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
|
378 '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
|
379 'item_unlock' jid;; undo the effects of item_lock |
710 | 380 'hide';; hide roster (full-width chat window) |
381 'show';; show roster | |
382 'toggle';; toggle roster visibility | |
1062 | 383 'note' [text];; display or set an annotation (if text is "-", the annotation is deleted). In the "status" buffer, it will display all annotations. |
199 | 384 |
385 /say text:: | |
491 | 386 Send the "text" message to the currently selected buddy. Can be useful |
199 | 387 if you want to send a message beginning with a slash, for example. |
388 | |
480 | 389 /say_to jid text:: |
491 | 390 Send the "text" message to the specified jid. |
480 | 391 Please note that this command doesn't set the default resource for |
392 a contact, so if you want to send several messages to a specific | |
916 | 393 resource you will have to use "/say_to" for each message. |
480 | 394 |
522 | 395 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]]:: |
396 Show or set the current status. + | |
397 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
|
398 If a status message is specified, it will overrride the message* |
522 | 399 variables (these variables can be set in the configuration file). |
400 If no relevant message* variable is set and no status message provided, | |
401 the current status message is kept. If StatusMessage is "-", the | |
402 current status message is cleared. | |
199 | 403 |
450 | 404 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]:: |
405 Send the requested status to the specified Jabber user. + | |
660 | 406 If the specified jid is ".", the current buddy is used. + |
450 | 407 Note: this status will be overridden by subsequent "/status" commands. |
408 If you are using the auto-away feature, the status will overridden | |
409 too. + | |
410 Note: The jid can include a resource (i.e. user@server/resource). | |
411 | |
199 | 412 CONFIGURATION FILE |
413 ------------------ | |
854 | 414 See the provided sample configuration file, which should be self-documenting. |
198 | 415 |
200 | 416 FILES |
417 ----- | |
202 | 418 The following files can be used by `mcabber(1)`: |
200 | 419 |
420 $HOME/.mcabber/mcabberrc Default configuration file | |
421 $HOME/.mcabberrc Configuration file used if no other has been found | |
422 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled | |
423 | |
198 | 424 BUGS |
425 ---- | |
349 | 426 Certainly. Please tell me if you find one! :-) |
198 | 427 |
428 AUTHOR | |
429 ------ | |
222 | 430 Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. + |
204 | 431 Originally based on http://cabber.sourceforge.net[Cabber], please |
198 | 432 consult the AUTHORS file for details. |
433 | |
434 RESOURCES | |
435 --------- | |
202 | 436 http://www.lilotux.net/~mikael/mcabber/[Main web site] |
198 | 437 |
438 COPYING | |
439 ------- | |
1242 | 440 Copyright \(C) 2005, 2006, 2007 Mikael Berthe. + |
1096 | 441 Some portions are Copyright \(C) 2002-2004 mailto:cabber@ajmacias.com[]. |
198 | 442 |
443 Free use of this software is granted under the terms of the GNU General Public | |
444 License (GPL). | |
445 |