Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1.txt @ 854:bfaab692a683

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manpage (pmw) This is Philip M. White's manpage update patch, slightly modified.
author Mikael Berthe <mikael@lilotux.net>
date Sat, 13 May 2006 22:26:15 +0200
parents f8c0447beec2
children 4b77a2ab18e5
comparison
equal deleted inserted replaced
853:bdd526ec62bc 854:bfaab692a683
17 For now it needs a configuration file to start, so please copy the sample 17 For now it needs a configuration file to start, so please copy the sample
18 mcabberrc file and adapt your connection settings. 18 mcabberrc file and adapt your connection settings.
19 19
20 You also need to have an existing Jabber account to use this software, as 20 You also need to have an existing Jabber account to use this software, as
21 it cannot (un)register accounts yet. 21 it cannot (un)register accounts yet.
22
23 The `mcabber(1)` screen is divided into 4 regions.
24 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat
25 buffer, is on the right. The 'input line' lies at the bottom of the screen,
26 under a small 'log window'.
27
28 Two status lines surround the log window. The bottom status line is the
29 "main status line" and reflects mcabber general status. The other line
30 is the "chat status line" and shows the status of the currently selected
31 buddy.
32
33 To display buddies chat buffers, you will have to enter 'chat mode'.
34 You can enter chat mode by pressing enter, and leave chat mode with the ESC
35 key. Simply sending a message will also enable chat mode.
36 22
37 Here are some of the features of `mcabber`: 23 Here are some of the features of `mcabber`:
38 24
39 - 'SSL support'. 25 - 'SSL support'.
40 - 'MUC support' (Multi-User Chat). 26 - 'MUC support' (Multi-User Chat).
43 - 'Commands completion:' If possible, `mcabber` will try to complete your 29 - 'Commands completion:' If possible, `mcabber` will try to complete your
44 command line if you hit the Tab key. 30 command line if you hit the Tab key.
45 - 'Input line history:' Any message or command entered is in the input line 31 - 'Input line history:' Any message or command entered is in the input line
46 history and can be reused easily. 32 history and can be reused easily.
47 - 'External actions:' Some events (like receiving a message) can trigger an 33 - 'External actions:' Some events (like receiving a message) can trigger an
48 external action, for example a shell script (you need to enable it in your 34 external action such as a shell script if you enable it in your
49 configuration file). A sample events script ("eventcmd") is provided with 35 configuration file. A sample events script ("eventcmd") is provided with
50 `mcabber` source code, in the contrib directory. 36 `mcabber` source code, in the contrib directory.
51 37
52 OPTIONS 38 OPTIONS
53 ------- 39 -------
54 --help, -h:: 40 --help, -h::
55 Quick help usage message 41 Quick help usage message
56 42
57 -f configfile:: 43 -f configfile::
58 Use configuration file 'configfile' 44 Use configuration file 'configfile'
59 45
46 WINDOWS/PANES
47 -------------
48 The `mcabber(1)` screen is divided into 4 regions.
49 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat
50 buffer, is on the right. The 'input line' lies at the bottom of the screen,
51 under a small 'log window'.
52
53 Two status lines surround the log window. The bottom status line is the
54 "main status line" and reflects mcabber general status. The other line
55 is the "chat status line" and shows the status of the currently selected
56 buddy.
57
58 To display buddies chat buffers, you will have to enter 'chat mode'.
59 You can enter chat mode by pressing enter, and leave chat mode with the ESC
60 key. Simply sending a message will also enable chat mode.
61
62 There are several advantages to the two-mode implementation: first, it allows
63 accurate "unread" message functionality, as described in the next section;
64 without this, merely scrolling to a specific buddy will "read" the new
65 messages of all buddies in-between. Second, it allows quickly hiding the
66 conversation with a single keystroke. Third, it allows jumping between
67 the few buddies with whom you are conversing with the '/roster alternate'
68 command described in another section, without having to manually scroll
69 back and forth.
70
60 KEYS 71 KEYS
61 ---- 72 ----
62
63 Text typing occurs in the 'input line'; basic operations are supported 73 Text typing occurs in the 'input line'; basic operations are supported
64 (left arrow, right arrow, home/end keys, insert, delete, backspace...). 74 (left arrow, right arrow, home/end keys, insert, delete, backspace...).
65 75
66 PageUp and PageDown keys are used to move in the roster. 76 PageUp and PageDown keys are used to move in the roster.
67 77
91 Ctrl-w:: Backward kill word 101 Ctrl-w:: Backward kill word
92 Ctrl-t:: Transpose chars 102 Ctrl-t:: Transpose chars
93 Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history) 103 Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history)
94 Ctrl-q:: Jump to the next unread message 104 Ctrl-q:: Jump to the next unread message
95 105
96 COMMANDS 106 Additional key bindings may be specified using the /bind command described
97 -------- 107 in the COMMANDS section.
98 108
99 /add [jid [nickname]]:: 109 MCABBER'S ROSTER
100 Add the "jid" Jabber user to our roster (default group), and send a 110 ----------------
101 notification request to this buddy. If no nickname is specified, the 111 The first listed resource on the roster is '[status]', which keeps a log of
102 jid is used. If no jid (or an empty string "") is provided or if jid 112 everything that appears in the short log window below the main chat area.
103 is ".", the current buddy is used. 113 While the log window was designed for showing the latest few elements, the
104 114 dedicated '[status]' buffer allows more comfortable viewing of the log, as
115 well as scrolling it in a standard manner.
116
117 Group names are displayed above the resources that are within them, and are
118 indicated by '---' to the left of the name.
119
120 For every real Jabber resource, the roster displays four pieces of information:
121 the resource's name or alias, its online status, its authorization status, and
122 whether there are unread messages from the resource waiting for you.
123
124 The online status is one of the following:
125
126 'o';; online
127 'f';; free for chat
128 'a';; away
129 'n';; not available (labeled 'extended away' in some clients)
130 'd';; do not disturb
131 'i';; invisible (displayed only for your resource)
132 '_';; offline (or invisible to you)
133 '?';; unknown, usually meaning you are not authorized to see this resource's status
134 'x';; a conference room in which you are not participating
135 'C';; a conference room in which you are participating
136
137 The authorization status indicates whether a resource is authorized to receive
138 your online status updates, and is displayed by the brackets surrounding the
139 resource's online status. Square brackets, like '[o]', indicate that this
140 resource is authorized to receive your status. Curly braces, like '\{o\}',
141 indicate that they are not authorized to receive your status.
142
143 When there are unread messages from the resource which you have not looked at,
144 a hash mark ('#') appears in the leftmost section of the roster for that
145 resource. The hash mark disappears once you view that resource's message log.
146
147 Examples:
148
149 ' --- Buds';; This is a group named 'Buds'
150 '#[o] John';; John is online, can see your status, and sent you a message that you did not read yet
151 ' \{?\} Sally';; Neither you nor Sally have authorized each other to see your online status
152 ' \{a\} Jane';; Jane is away, but she cannot see your online status
153 '#[C] x@y.c';; You are participating in x@y.c conference room, and there are unread messages
154
155 COMMANDS RELATED TO MCABBER
156 ---------------------------
105 /alias name = command line:: 157 /alias name = command line::
106 Add "name" as an alias for "command line". + 158 Add "name" as an alias for "command line". +
107 Aliases are expanded only once, thus they can not be chained. + 159 Aliases are expanded only once, thus they can not be chained. +
108 "/alias name" displays the value associated with the "name" alias; 160 "/alias name" displays the value associated with the "name" alias;
109 "/alias name =" unsets the "name" alias. + 161 "/alias name =" unsets the "name" alias. +
110 Example: "/alias away = status away". 162 Example: "/alias away = status away".
111
112 /authorization allow|cancel|request|request_unsubscribe [jid]::
113 Manage the presence subscriptions. +
114 If no jid is provided, the current buddy is used.
115
116 'allow';; allow the buddy to receive your presence updates
117 'cancel';; cancel the buddy' subscription to your presence updates
118 'request';; request a subscription to the buddy's presence updates
119 'request_unsubscribe';; request unsubscription from the buddy's presence updates
120 163
121 /bind keycode = command line:: 164 /bind keycode = command line::
122 Bind a command line to the key with the "keycode" code number. + 165 Bind a command line to the key with the "keycode" code number. +
123 Keycodes of unused keys are displayed by `mcabber` in the log window 166 Keycodes of unused keys are displayed by `mcabber` in the log window
124 when pressing the key, for example "Unknown key=265". + 167 when pressing the key, for example "Unknown key=265". +
143 'search_forward' text;; search for "text" in the current buddy chat buffer 186 'search_forward' text;; search for "text" in the current buddy chat buffer
144 187
145 /clear:: 188 /clear::
146 The 'clear' command is actually an alias for "/buffer clear". 189 The 'clear' command is actually an alias for "/buffer clear".
147 190
191 /quit::
192 Disconnect and leave `mcabber(1)`.
193
194 /version::
195 Display mcabber version
196
197 COMMANDS RELATED TO THE SERVER AND CONNECTION
198 ---------------------------------------------
148 /connect:: 199 /connect::
149 Establish connection to the Jabber server. 200 Establish connection to the Jabber server.
150
151 /del::
152 Delete the current buddy from our roster, unsubscribe from its presence
153 notification and unsubscribe it from ours.
154 201
155 /disconnect:: 202 /disconnect::
156 Terminate connection to the Jabber server. Note: the roster is only 203 Terminate connection to the Jabber server. Note: the roster is only
157 available when the connection to the server is active, so the 204 available when the connection to the server is active, so the
158 buddylist is empty when disconnected. 205 buddylist is empty when disconnected.
165 212
166 'accept';; accept the event #n 213 'accept';; accept the event #n
167 'ignore';; remove the event #n from the list 214 'ignore';; remove the event #n from the list
168 'reject';; reject the event #n 215 'reject';; reject the event #n
169 'list';; list all pending events 216 'list';; list all pending events
217
218 /rawxml send::
219 '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.
220
221 COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES
222 ---------------------------------------------------
223 /add [jid [nickname]]::
224 Add the "jid" Jabber user to our roster (default group), and send a
225 notification request to this buddy. If no nickname is specified, the
226 jid is used. If no jid (or an empty string "") is provided or if jid
227 is ".", the current buddy is used.
228
229 /authorization allow|cancel|request|request_unsubscribe [jid]::
230 Manage the presence subscriptions. +
231 If no jid is provided, the current buddy is used.
232
233 'allow';; allow the buddy to receive your presence updates
234 'cancel';; cancel the buddy' subscription to your presence updates
235 'request';; request a subscription to the buddy's presence updates
236 'request_unsubscribe';; request unsubscription from the buddy's presence updates
237
238 /del::
239 Delete the current buddy from our roster, unsubscribe from its presence
240 notification and unsubscribe it from ours.
170 241
171 /group fold|unfold|toggle:: 242 /group fold|unfold|toggle::
172 The 'group' command changes the current group display. 243 The 'group' command changes the current group display.
173 244
174 'fold';; fold (shrink) the current group tree in the roster 245 'fold';; fold (shrink) the current group tree in the roster
209 'send_to' jid;; send the current multi-line message to "jid" 280 'send_to' jid;; send the current multi-line message to "jid"
210 'toggle';; switch to/from multi-line mode (begin/send) 281 'toggle';; switch to/from multi-line mode (begin/send)
211 'toggle_verbatim';; same with verbatim multi-line mode 282 'toggle_verbatim';; same with verbatim multi-line mode
212 'abort';; leave multi-line mode without sending the message 283 'abort';; leave multi-line mode without sending the message
213 284
214 /quit::
215 Disconnect and leave `mcabber(1)`.
216
217 /rawxml send::
218 '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.
219
220 /rename nickname:: 285 /rename nickname::
221 Rename current buddy to the given nickname. 286 Rename current buddy to the given nickname.
222 This command does not work for groups, at the moment (but you can move 287 This command does not work for groups, at the moment (but you can move
223 the buddies to another group with the "/move" command). 288 the buddies to another group with the "/move" command).
224 289
293 Note: this status will be overridden by subsequent "/status" commands. 358 Note: this status will be overridden by subsequent "/status" commands.
294 If you are using the auto-away feature, the status will overridden 359 If you are using the auto-away feature, the status will overridden
295 too. + 360 too. +
296 Note: The jid can include a resource (i.e. user@server/resource). 361 Note: The jid can include a resource (i.e. user@server/resource).
297 362
298 /version::
299 Display mcabber version
300
301 CONFIGURATION FILE 363 CONFIGURATION FILE
302 ------------------ 364 ------------------
303 See the provided sample configuration file, which should be self-documented. 365 See the provided sample configuration file, which should be self-documenting.
304 366
305 FILES 367 FILES
306 ----- 368 -----
307 The following files can be used by `mcabber(1)`: 369 The following files can be used by `mcabber(1)`:
308 370