Mercurial > ~mikael > mcabber > hg
comparison mcabber/doc/mcabber.1 @ 226:bebefc0aa5a9
[/trunk] Changeset 238 by mikael
* Add manpage because generation isn't easy
author | mikael |
---|---|
date | Tue, 07 Jun 2005 15:45:52 +0000 |
parents | |
children | 365818971234 |
comparison
equal
deleted
inserted
replaced
225:d5ae42cbe1fa | 226:bebefc0aa5a9 |
---|---|
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 | |
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 update your connection options\&. | |
32 | |
33 | |
34 The mcabber(1) screen is divided into 4 regions\&. The roster, alias buddylist, is on the left\&. The chat window, or chat buffer, is on the right\&. The input line lies at the bottom of the screen, under a small log window\&. | |
35 | |
36 | |
37 To display buddies chat buffers, you will have to enter chat mode\&. You can enter chat mode by pressing enter, and leave chat mode with the ESC key\&. Sending a message also enables chat mode implicitly\&. | |
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 | |
50 Commands completion: If possible, mcabber(1) will try to complete your commands line if you hit the Tab key\&. | |
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 | |
69 Text typing happens in the input line; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. | |
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 | |
78 Here is a quick description of the key bindings: | |
79 | |
80 | |
81 Ctrl\-a | |
82 | |
83 | |
84 | |
85 Go to the beginning of the input line | |
86 | |
87 | |
88 | |
89 Ctrl\-e | |
90 | |
91 | |
92 | |
93 Go to the end of the input line | |
94 | |
95 | |
96 | |
97 Ctrl\-l | |
98 | |
99 | |
100 | |
101 Force a resize | |
102 | |
103 | |
104 | |
105 PgUp/PgDown | |
106 | |
107 | |
108 | |
109 Move inside the roster (buddylist) | |
110 | |
111 | |
112 | |
113 Tab | |
114 | |
115 | |
116 | |
117 Complete current word, in the input line | |
118 | |
119 | |
120 | |
121 Ctrl\-g | |
122 | |
123 | |
124 | |
125 Cancel completion / ctrl\-g | |
126 | |
127 | |
128 | |
129 Ctrl\-p/Ctrl\-n | |
130 | |
131 | |
132 | |
133 Scroll up/down half a screen in the buffer window (chat mode) | |
134 | |
135 | |
136 | |
137 Ctrl\-u | |
138 | |
139 | |
140 | |
141 Delete from beginning of the line to the cursor | |
142 | |
143 | |
144 | |
145 Ctrl\-k | |
146 | |
147 | |
148 | |
149 Delete from the cursor to the end of line | |
150 | |
151 | |
152 | |
153 Ctrl\-w | |
154 | |
155 | |
156 | |
157 Backward kill word | |
158 | |
159 | |
160 | |
161 Ctrl\-t | |
162 | |
163 | |
164 | |
165 Transpose chars | |
166 | |
167 | |
168 | |
169 Ctrl\-q | |
170 | |
171 | |
172 | |
173 Jump to the next unread message (Not yet implemented) | |
174 | |
175 | |
176 .SH "COMMANDS" | |
177 | |
178 .TP | |
179 /add jid | |
180 Add the jid Jabber user to our roster, and send a notification request to this buddy | |
181 | |
182 .TP | |
183 /buffer clear|top|bottom | |
184 The buffer command manipulates the current buddy's buffer (chat window)\&. | |
185 clear | |
186 | |
187 clear the current buddy chat window | |
188 | |
189 top | |
190 | |
191 jump to the top of the current buddy chat buffer | |
192 | |
193 bottom | |
194 | |
195 jump to the bottom of the current buddy chat buffer | |
196 | |
197 | |
198 .TP | |
199 /clear | |
200 The clear command is an alias for "/buffer clear"\&. | |
201 | |
202 .TP | |
203 /group expand|shrink|toggle | |
204 The group command changes the group display settings\&. | |
205 expand | |
206 | |
207 expand the current group tree in the roster (syn: unfold) | |
208 | |
209 shrink | |
210 | |
211 shrink the current group tree in the roster (syn: fold) | |
212 | |
213 toggle | |
214 | |
215 toggle the fold/unfold state of the current tree | |
216 | |
217 | |
218 .TP | |
219 /info | |
220 Display info on the selected entry (user, agent, group...) | |
221 | |
222 .TP | |
223 /quit | |
224 Disconnect and leave mcabber(1) | |
225 | |
226 .TP | |
227 /roster hide_offline|show_offline|top|bottom | |
228 The roster command manipulates the roster/buddylist\&. | |
229 hide_offline | |
230 | |
231 hide offline buddies | |
232 | |
233 show_offline | |
234 | |
235 show offline buddies | |
236 | |
237 top | |
238 | |
239 jump to the top of the roster | |
240 | |
241 bottom | |
242 | |
243 jump to the bottom of the roster | |
244 | |
245 | |
246 .TP | |
247 /say text | |
248 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\&. | |
249 | |
250 .TP | |
251 /status [online|avail|invisible|free|dnd|busy|notavail|away] | |
252 Set the current status\&. If no status is specified, display the current status\&. | |
253 | |
254 .SH "CONFIGURATION FILE" | |
255 | |
256 | |
257 See the provided sample configuration file, which should be self\-documented\&. | |
258 | |
259 .SH "FILES" | |
260 | |
261 | |
262 The following files can be used by mcabber(1): | |
263 | |
264 .nf | |
265 | |
266 $HOME/\&.mcabber/mcabberrc Default configuration file | |
267 $HOME/\&.mcabberrc Configuration file used if no other has been found | |
268 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled | |
269 | |
270 .fi | |
271 | |
272 .SH "BUGS" | |
273 | |
274 | |
275 Certainly a lot\&. Please tell me if you find one! :\-) | |
276 | |
277 .SH "AUTHOR" | |
278 | |
279 | |
280 Written by Mikael BERTHE: \fImailto:mcabber@lilotux.net\fR\&. Originally based on Cabber: \fIhttp://cabber.sourceforge.net\fR, please consult the AUTHORS file for details\&. | |
281 | |
282 .SH "RESOURCES" | |
283 | |
284 | |
285 Main web site: \fIhttp://www.lilotux.net/~mikael/mcabber/\fR | |
286 | |
287 .SH "COPYING" | |
288 | |
289 | |
290 Copyright (C) 2005 Mikael Berthe\&. Some portions are Copyright (C) 2002\-2004 cabber@ajmacias\&.com: \fImailto:cabber@ajmacias.com\fR\&. | |
291 | |
292 | |
293 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. | |
294 |