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