comparison mcabber/doc/mcabber.1 @ 227:365818971234

[/trunk] Changeset 239 by mikael * Update compiled manpage...
author mikael
date Tue, 07 Jun 2005 16:20:14 +0000
parents bebefc0aa5a9
children bfc14cfb068e
comparison
equal deleted inserted replaced
226:bebefc0aa5a9 227:365818971234
26 mcabber [ \-f configfile ] [ --help | \-h ] 26 mcabber [ \-f configfile ] [ --help | \-h ]
27 27
28 .SH "DESCRIPTION" 28 .SH "DESCRIPTION"
29 29
30 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\&. 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\&.
32 32
33 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\&. 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 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\&. 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\&.
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
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 input line; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&. 69 Text typing happens 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
78 Here is a quick description of the key bindings: 78 Here is a quick description of the key bindings:
79 79
80 80
81 Ctrl\-a 81 Ctrl\-a
82 82
83
84
85 Go to the beginning of the input line 83 Go to the beginning of the input line
86 84
87
88
89 Ctrl\-e 85 Ctrl\-e
90 86
91
92
93 Go to the end of the input line 87 Go to the end of the input line
94 88
95
96
97 Ctrl\-l 89 Ctrl\-l
98 90
99
100
101 Force a resize 91 Force a resize
102 92
103
104
105 PgUp/PgDown 93 PgUp/PgDown
106 94
107
108
109 Move inside the roster (buddylist) 95 Move inside the roster (buddylist)
110 96
111
112
113 Tab 97 Tab
114 98
115
116
117 Complete current word, in the input line 99 Complete current word, in the input line
118 100
119
120
121 Ctrl\-g 101 Ctrl\-g
122 102
123
124
125 Cancel completion / ctrl\-g 103 Cancel completion / ctrl\-g
126 104
127
128
129 Ctrl\-p/Ctrl\-n 105 Ctrl\-p/Ctrl\-n
130 106
131
132
133 Scroll up/down half a screen in the buffer window (chat mode) 107 Scroll up/down half a screen in the buffer window (chat mode)
134 108
135
136
137 Ctrl\-u 109 Ctrl\-u
138 110
139
140
141 Delete from beginning of the line to the cursor 111 Delete from beginning of the line to the cursor
142 112
143
144
145 Ctrl\-k 113 Ctrl\-k
146 114
147
148
149 Delete from the cursor to the end of line 115 Delete from the cursor to the end of line
150 116
151
152
153 Ctrl\-w 117 Ctrl\-w
154 118
155
156
157 Backward kill word 119 Backward kill word
158 120
159
160
161 Ctrl\-t 121 Ctrl\-t
162 122
163
164
165 Transpose chars 123 Transpose chars
166 124
167
168
169 Ctrl\-q 125 Ctrl\-q
170 126
171
172
173 Jump to the next unread message (Not yet implemented) 127 Jump to the next unread message (Not yet implemented)
174 128
175 129
176 .SH "COMMANDS" 130 .SH "COMMANDS"
177 131
178 .TP 132 .TP
179 /add jid 133 /add jid
180 Add the jid Jabber user to our roster, and send a notification request to this buddy 134 Add the jid Jabber user to our roster, and send a notification request to this buddy\&.
181 135
182 .TP 136 .TP
183 /buffer clear|top|bottom 137 /buffer clear|top|bottom
184 The buffer command manipulates the current buddy's buffer (chat window)\&. 138 The buffer command manipulates the current buddy's buffer (chat window)\&.
185 clear 139 \fIclear\fR
186 140
187 clear the current buddy chat window 141 clear the current buddy chat window
188 142
189 top 143 \fItop\fR
190 144
191 jump to the top of the current buddy chat buffer 145 jump to the top of the current buddy chat buffer
192 146
193 bottom 147 \fIbottom\fR
194 148
195 jump to the bottom of the current buddy chat buffer 149 jump to the bottom of the current buddy chat buffer
196 150
197 151
198 .TP 152 .TP
199 /clear 153 /clear
200 The clear command is an alias for "/buffer clear"\&. 154 The clear command is actually an alias for "/buffer clear"\&.
155
156 .TP
157 /del
158 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.
201 159
202 .TP 160 .TP
203 /group expand|shrink|toggle 161 /group expand|shrink|toggle
204 The group command changes the group display settings\&. 162 The group command changes the group display settings\&.
205 expand 163 \fIexpand\fR
206 164
207 expand the current group tree in the roster (syn: unfold) 165 expand the current group tree in the roster (syn: \fIunfold\fR)
208 166
209 shrink 167 \fIshrink\fR
210 168
211 shrink the current group tree in the roster (syn: fold) 169 shrink the current group tree in the roster (syn: \fIfold\fR)
212 170
213 toggle 171 \fItoggle\fR
214 172
215 toggle the fold/unfold state of the current tree 173 toggle the fold/unfold state of the current tree
216 174
217 175
218 .TP 176 .TP
219 /info 177 /info
220 Display info on the selected entry (user, agent, group...) 178 Display info on the selected entry (user, agent, group...)\&.
179
180 .TP
181 /move [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\&.
221 183
222 .TP 184 .TP
223 /quit 185 /quit
224 Disconnect and leave mcabber(1) 186 Disconnect and leave mcabber(1)\&.
187
188 .TP
189 /rename 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)\&.
225 191
226 .TP 192 .TP
227 /roster hide_offline|show_offline|top|bottom 193 /roster hide_offline|show_offline|top|bottom
228 The roster command manipulates the roster/buddylist\&. 194 The roster command manipulates the roster/buddylist\&.
229 hide_offline 195 \fIhide_offline\fR
230 196
231 hide offline buddies 197 hide offline buddies
232 198
233 show_offline 199 \fIshow_offline\fR
234 200
235 show offline buddies 201 show offline buddies
236 202
237 top 203 \fItop\fR
238 204
239 jump to the top of the roster 205 jump to the top of the roster
240 206
241 bottom 207 \fIbottom\fR
242 208
243 jump to the bottom of the roster 209 jump to the bottom of the roster
244 210
245 211
246 .TP 212 .TP