Mercurial > hg
annotate mcabber/doc/mcabber.1.txt @ 286:a3d65d7f0bc3
Add /alias documentation
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Fri, 08 Jul 2005 07:27:56 +0100 |
parents | 4d7040cff8ee |
children | 72fa52203651 |
rev | line source |
---|---|
198 | 1 MCABBER(1) |
2 =========== | |
222 | 3 Mikael BERTHE <mcabber@lilotux.net> |
254 | 4 v0.6.2, June 2005 |
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 |
202 | 20 The `mcabber(1)` screen is divided into 4 regions. |
200 | 21 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat |
22 buffer, is on the right. The 'input line' lies at the bottom of the screen, | |
23 under a small 'log window'. | |
24 | |
204 | 25 To display buddies chat buffers, you will have to enter 'chat mode'. |
26 You can enter chat mode by pressing enter, and leave chat mode with the ESC | |
229 | 27 key. Simply sending a message will also enable chat mode. |
204 | 28 |
29 Here are some of the features of `mcabber`: | |
200 | 30 |
204 | 31 - 'SSL support'. |
32 - 'History logging:' If enabled (see the CONFIGURATION FILE section), | |
33 `mcabber(1)` can save discussions to history log files. | |
34 - 'Commands completion:' If possible, `mcabber(1)` will try to complete your | |
229 | 35 command line if you hit the Tab key. |
204 | 36 - 'External actions:' Some events (like receiving a message) can trigger an |
37 external action, for example a shell script (you need to enable it in your | |
38 configuration file). | |
200 | 39 |
40 OPTIONS | |
41 ------- | |
42 --help, -h:: | |
202 | 43 Quick help usage message |
200 | 44 |
45 -f configfile:: | |
202 | 46 Use configuration file 'configfile' |
200 | 47 |
48 KEYS | |
49 ---- | |
50 | |
229 | 51 Text typing occurs in the 'input line'; basic operations are supported |
52 (left arrow, right arrow, home/end keys, insert, delete, backspace...). | |
200 | 53 |
54 PageUp and PageDown keys are used to move in the roster. | |
55 | |
56 To send a message, move to the choosen buddy in the buddylist, type your | |
57 message and hit enter. If the line begins with a slash, this will be | |
58 interpreted as a command (see the COMMAND section below). Hit escape to | |
59 leave the chat mode. | |
60 | |
61 Here is a quick description of the key bindings: | |
62 | |
63 Ctrl-a:: Go to the beginning of the input line | |
64 Ctrl-e:: Go to the end of the input line | |
65 Ctrl-l:: Force a resize | |
66 PgUp/PgDown:: Move inside the roster (buddylist) | |
67 Tab:: Complete current word, in the input line | |
68 Ctrl-g:: Cancel completion / ctrl-g | |
69 Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode) | |
70 Ctrl-u:: Delete from beginning of the line to the cursor | |
71 Ctrl-k:: Delete from the cursor to the end of line | |
72 Ctrl-w:: Backward kill word | |
73 Ctrl-t:: Transpose chars | |
263 | 74 Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history) |
236 | 75 Ctrl-q:: Jump to the next unread message |
198 | 76 |
199 | 77 COMMANDS |
78 -------- | |
79 | |
245 | 80 /add jid [nickname]:: |
81 Add the 'jid' Jabber user to our roster (default group), and send a | |
82 notification request to this buddy. If no nickname is specified, the | |
83 jid is used. | |
199 | 84 |
286
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
85 /alias name = command line:: |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
86 Add "name" as an alias for "command line". |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
87 Example: "/alias away = status away". |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
88 Aliases are expanded only once, thus they can not be chained. |
a3d65d7f0bc3
Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents:
277
diff
changeset
|
89 |
199 | 90 /buffer clear|top|bottom:: |
202 | 91 The 'buffer' command manipulates the current buddy's buffer |
92 (chat window). | |
199 | 93 |
202 | 94 'clear';; clear the current buddy chat window |
95 'top';; jump to the top of the current buddy chat buffer | |
96 'bottom';; jump to the bottom of the current buddy chat buffer | |
199 | 97 |
98 /clear:: | |
206 | 99 The 'clear' command is actually an alias for "/buffer clear". |
199 | 100 |
205 | 101 /del:: |
102 Delete the current buddy from our roster, unsubscribe from its presence | |
103 notification and unsubscribe it from ours. | |
104 | |
240 | 105 /group fold|unfold|toggle:: |
106 The 'group' command changes the current group display. | |
199 | 107 |
240 | 108 'fold';; fold (shrink) the current group tree in the roster |
109 'unfold';; unfold (expand) the current group tree in the roster | |
110 'toggle';; toggle the state (fold/unfold) of the current tree | |
199 | 111 |
112 /info:: | |
208 | 113 Display info on the selected entry (user, agent, group...). |
199 | 114 |
210 | 115 /move [groupname]:: |
116 Move the current buddy to the requested group. If no group is | |
117 specified, then the buddy is moved to the default group. | |
229 | 118 This command only works with users (not agents), at the moment. |
210 | 119 |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
120 /msay begin|verbatim|send|abort:: |
238 | 121 Send a multi-line message. To write a single message with several |
122 lines, the 'multi-line mode' should be used. In multi-line mode, | |
123 each line (except command lines) typed in the input line will | |
124 be added to the multi-line message. Once the message is finished, it | |
125 can be sent to the current selected buddy with the "msay /send" | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
126 command. The 'verbatim' multi-line mode disables commands, so that it |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
127 is possible to enter lines starting with a slash. Only the "/msay" |
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
128 command (with send or abort parameters) can be used to exit verbatim mode. |
238 | 129 |
130 'begin';; enter multi-line mode | |
260
33e1a05864a6
Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents:
254
diff
changeset
|
131 'verbatim';; enter verbatim multi-line mode |
238 | 132 'send';; send the current multi-line message to the currently selected buddy |
133 'abort';; leave multi-line mode without sending the message | |
134 | |
199 | 135 /quit:: |
208 | 136 Disconnect and leave `mcabber(1)`. |
137 | |
138 /rename nickname:: | |
139 Rename current buddy to the given nickname. | |
229 | 140 This command does not work for groups, at the moment (but you can move |
210 | 141 the buddies to another group with the /move command). |
199 | 142 |
265 | 143 /roster bottom|top|hide_offline|show_offline|unread_first|unread_next:: |
144 /roster search bud:: | |
145 The 'roster' command manipulates the roster/buddylist. Here are the available parameters: | |
199 | 146 |
265 | 147 'bottom';; jump to the bottom of the roster |
148 'top';; jump to the top of the roster | |
202 | 149 'hide_offline';; hide offline buddies |
150 'show_offline';; show offline buddies | |
265 | 151 'search' bud;; search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) |
236 | 152 'unread_first';; jump to the first unread message |
153 'unread_next';; jump to the next unread message | |
199 | 154 |
155 /say text:: | |
202 | 156 Send the text message to the currently selected buddy. Can be useful |
199 | 157 if you want to send a message beginning with a slash, for example. |
158 | |
277
4d7040cff8ee
Remove busy/occupied status, which does not really exist
Mikael Berthe <mikael@lilotux.net>
parents:
265
diff
changeset
|
159 /status [online|avail|invisible|free|dnd|notavail|away]:: |
199 | 160 Set the current status. If no status is specified, display the |
161 current status. | |
162 | |
163 CONFIGURATION FILE | |
164 ------------------ | |
165 See the provided sample configuration file, which should be self-documented. | |
198 | 166 |
200 | 167 FILES |
168 ----- | |
202 | 169 The following files can be used by `mcabber(1)`: |
200 | 170 |
171 $HOME/.mcabber/mcabberrc Default configuration file | |
172 $HOME/.mcabberrc Configuration file used if no other has been found | |
173 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled | |
174 | |
198 | 175 BUGS |
176 ---- | |
202 | 177 Certainly a lot. Please tell me if you find one! :-) |
198 | 178 |
179 AUTHOR | |
180 ------ | |
222 | 181 Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. + |
204 | 182 Originally based on http://cabber.sourceforge.net[Cabber], please |
198 | 183 consult the AUTHORS file for details. |
184 | |
185 RESOURCES | |
186 --------- | |
202 | 187 http://www.lilotux.net/~mikael/mcabber/[Main web site] |
198 | 188 |
189 COPYING | |
190 ------- | |
202 | 191 Copyright (C) 2005 Mikael Berthe. + |
192 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[]. | |
198 | 193 |
194 Free use of this software is granted under the terms of the GNU General Public | |
195 License (GPL). | |
196 |