Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1 @ 229:bfc14cfb068e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[/trunk] Changeset 241 by mikael * Update doc (man + html).
author mikael
date Tue, 07 Jun 2005 18:35:04 +0000
parents 365818971234
children 72fd1273f2b7
comparison
equal deleted inserted replaced
228:f29a95231102 229:bfc14cfb068e
32 32
33 33
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\&. 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\&.
35 35
36 36
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\&. Sending a message also enables chat mode implicitly\&. 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\&.
38 38
39 39
40 Here are some of the features of mcabber: 40 Here are some of the features of mcabber:
41 41
42 .TP 3 42 .TP 3
45 .TP 45 .TP
46 \(bu 46 \(bu
47 History logging: If enabled (see the CONFIGURATION FILE section), mcabber(1) can save discussions to history log files\&. 47 History logging: If enabled (see the CONFIGURATION FILE section), mcabber(1) can save discussions to history log files\&.
48 .TP 48 .TP
49 \(bu 49 \(bu
50 Commands completion: If possible, mcabber(1) will try to complete your commands line if you hit the Tab key\&. 50 Commands completion: If possible, mcabber(1) will try to complete your command line if you hit the Tab key\&.
51 .TP 51 .TP
52 \(bu 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)\&. 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 54 .LP
55 55
64 Use configuration file configfile 64 Use configuration file configfile
65 65
66 .SH "KEYS" 66 .SH "KEYS"
67 67
68 68
69 Text typing happens in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. 69 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&.
70 70
71 71
72 PageUp and PageDown keys are used to move in the roster\&. 72 PageUp and PageDown keys are used to move in the roster\&.
73 73
74 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\&. 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 76
77
78 Here is a quick description of the key bindings: 77 Here is a quick description of the key bindings:
79 78
80 79 Ctrl\-a Go to the beginning of the input line
81 Ctrl\-a 80
82 81 Ctrl\-e Go to the end of the input line
83 Go to the beginning of the input line 82
84 83 Ctrl\-l Force a resize
85 Ctrl\-e 84
86 85 PgUp/PgDown Move inside the roster (buddylist)
87 Go to the end of the input line 86
88 87 Tab Complete current word, in the input line
89 Ctrl\-l 88
90 89 Ctrl\-g Cancel completion / ctrl\-g
91 Force a resize 90
92 91 Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode)
93 PgUp/PgDown 92
94 93 Ctrl\-u Delete from beginning of the line to the cursor
95 Move inside the roster (buddylist) 94
96 95 Ctrl\-k Delete from the cursor to the end of line
97 Tab 96
98 97 Ctrl\-w Backward kill word
99 Complete current word, in the input line 98
100 99 Ctrl\-t Transpose chars
101 Ctrl\-g 100
102 101 Ctrl\-q Jump to the next unread message (Not yet implemented)
103 Cancel completion / ctrl\-g
104
105 Ctrl\-p/Ctrl\-n
106
107 Scroll up/down half a screen in the buffer window (chat mode)
108
109 Ctrl\-u
110
111 Delete from beginning of the line to the cursor
112
113 Ctrl\-k
114
115 Delete from the cursor to the end of line
116
117 Ctrl\-w
118
119 Backward kill word
120
121 Ctrl\-t
122
123 Transpose chars
124
125 Ctrl\-q
126
127 Jump to the next unread message (Not yet implemented)
128 102
129 103
130 .SH "COMMANDS" 104 .SH "COMMANDS"
131 105
132 .TP 106 .TP
133 /add jid 107 \fB/add\fR jid
134 Add the jid Jabber user to our roster, and send a notification request to this buddy\&. 108 Add the jid Jabber user to our roster, and send a notification request to this buddy\&.
135 109
136 .TP 110 .TP
137 /buffer clear|top|bottom 111 \fB/buffer\fR clear|top|bottom
138 The buffer command manipulates the current buddy's buffer (chat window)\&. 112 The buffer command manipulates the current buddy's buffer (chat window)\&.
139 \fIclear\fR 113
140 114 \fBclear\fR clear the current buddy chat window
141 clear the current buddy chat window 115 \fBtop\fR jump to the top of the current buddy chat buffer
142 116 \fBbottom\fR jump to the bottom of the current buddy chat buffer
143 \fItop\fR 117
144 118 .TP
145 jump to the top of the current buddy chat buffer 119 \fB/clear\fR
146
147 \fIbottom\fR
148
149 jump to the bottom of the current buddy chat buffer
150
151
152 .TP
153 /clear
154 The clear command is actually an alias for "/buffer clear"\&. 120 The clear command is actually an alias for "/buffer clear"\&.
155 121
156 .TP 122 .TP
157 /del 123 \fB/del\fR
158 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&. 124 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.
159 125
160 .TP 126 .TP
161 /group expand|shrink|toggle 127 \fB/group\fR expand|shrink|toggle
162 The group command changes the group display settings\&. 128 The group command changes the group display settings\&.
163 \fIexpand\fR 129
164 130 \fBexpand\fR expand the current group tree in the roster (syn: unfold)
165 expand the current group tree in the roster (syn: \fIunfold\fR) 131 \fBshrink\fR shrink the current group tree in the roster (syn: fold)
166 132 \fBtoggle\fR toggle the fold/unfold state of the current tree
167 \fIshrink\fR 133
168 134 .TP
169 shrink the current group tree in the roster (syn: \fIfold\fR) 135 \fB/info\fR
170
171 \fItoggle\fR
172
173 toggle the fold/unfold state of the current tree
174
175
176 .TP
177 /info
178 Display info on the selected entry (user, agent, group...)\&. 136 Display info on the selected entry (user, agent, group...)\&.
179 137
180 .TP 138 .TP
181 /move [groupname] 139 \fB/move\fR [groupname]
182 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), right now\&. 140 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\&.
183 141
184 .TP 142 .TP
185 /quit 143 \fB/quit\fR
186 Disconnect and leave mcabber(1)\&. 144 Disconnect and leave mcabber(1)
187 145
188 .TP 146 .TP
189 /rename nickname 147 \fB/rename\fR nickname
190 Rename current buddy to the given nickname\&. This command does not work for groups, right now (but you can move the buddies to another group with the /move command)\&. 148 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)\&.
191 149
192 .TP 150 .TP
193 /roster hide_offline|show_offline|top|bottom 151 \fB/roster\fR hide_offline|show_offline|top|bottom
194 The roster command manipulates the roster/buddylist\&. 152 The roster command manipulates the roster/buddylist\&.
195 \fIhide_offline\fR 153
196 154 \fBhide_offline\fR hide offline buddies
197 hide offline buddies 155 \fBshow_offline\fR show offline buddies
198 156 \fBtop\fR jump to the top of the roster
199 \fIshow_offline\fR 157 \fBbottom\fR jump to the bottom of the roster
200 158
201 show offline buddies 159 .TP
202 160 \fB/say\fR text
203 \fItop\fR
204
205 jump to the top of the roster
206
207 \fIbottom\fR
208
209 jump to the bottom of the roster
210
211
212 .TP
213 /say text
214 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\&. 161 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\&.
215 162
216 .TP 163 .TP
217 /status [online|avail|invisible|free|dnd|busy|notavail|away] 164 \fB/status\fR [online|avail|invisible|free|dnd|busy|notavail|away]
218 Set the current status\&. If no status is specified, display the current status\&. 165 Set the current status\&. If no status is specified, display the current status\&.
219 166
220 .SH "CONFIGURATION FILE" 167 .SH "CONFIGURATION FILE"
221 168
222 169
241 Certainly a lot\&. Please tell me if you find one! :\-) 188 Certainly a lot\&. Please tell me if you find one! :\-)
242 189
243 .SH "AUTHOR" 190 .SH "AUTHOR"
244 191
245 192
246 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\&. 193 Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&.
194 Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&.
247 195
248 .SH "RESOURCES" 196 .SH "RESOURCES"
249 197
250 198
251 Main web site: \fIhttp://www.lilotux.net/~mikael/mcabber/\fR 199 Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR>
252 200
253 .SH "COPYING" 201 .SH "COPYING"
254 202
255 203
256 Copyright (C) 2005 Mikael Berthe\&. Some portions are Copyright (C) 2002\-2004 cabber@ajmacias\&.com: \fImailto:cabber@ajmacias.com\fR\&. 204 Copyright (C) 2005 Mikael Berthe\&.
205
206 Some portions are Copyright (C) 2002\-2004 <cabber@ajmacias\&.com>\&.
257 207
258 208
259 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. 209 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
260 210