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