comparison mcabber/doc/mcabber.1.html @ 618:341568185492

Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Fri, 16 Dec 2005 16:20:30 +0100
parents 803973541c22
children 7d9841ea20d8
comparison
equal deleted inserted replaced
617:d3a8b43bf9e7 618:341568185492
56 command line if you hit the Tab key. 56 command line if you hit the Tab key.
57 </p> 57 </p>
58 </li> 58 </li>
59 <li> 59 <li>
60 <p> 60 <p>
61 <b>Input line history:</b> Any message or command entered is in the input line
62 history and can be reused easily.
63 </p>
64 </li>
65 <li>
66 <p>
61 <b>External actions:</b> Some events (like receiving a message) can trigger an 67 <b>External actions:</b> Some events (like receiving a message) can trigger an
62 external action, for example a shell script (you need to enable it in your 68 external action, for example a shell script (you need to enable it in your
63 configuration file). A sample events script ("eventcmd") is provided with 69 configuration file). A sample events script ("eventcmd") is provided with
64 <tt>mcabber</tt> source code, in the contrib directory. 70 <tt>mcabber</tt> source code, in the contrib directory.
65 </p> 71 </p>
82 </dl> 88 </dl>
83 <h2>KEYS</h2> 89 <h2>KEYS</h2>
84 <p>Text typing occurs in the <b>input line</b>; basic operations are supported 90 <p>Text typing occurs in the <b>input line</b>; basic operations are supported
85 (left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).</p> 91 (left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).</p>
86 <p>PageUp and PageDown keys are used to move in the roster.</p> 92 <p>PageUp and PageDown keys are used to move in the roster.</p>
93 <p>Up and Down arrow keys can be used to move in the input line history; they
94 jump to the previous/next line from the history beginning with the same string
95 (from first column to the cursor column).</p>
87 <p>To send a message, move to the choosen buddy in the buddylist, type your 96 <p>To send a message, move to the choosen buddy in the buddylist, type your
88 message and hit enter. If the line begins with a slash, this will be 97 message and hit enter. If the line begins with a slash, this will be
89 interpreted as a command (see the COMMAND section below). Hit escape to 98 interpreted as a command (see the COMMAND section below). Hit escape to
90 leave the chat mode.</p> 99 leave the chat mode.</p>
91 <p>Here is a quick description of the key bindings:</p> 100 <p>Here is a quick description of the key bindings:</p>
109 <tr valign="top"> 118 <tr valign="top">
110 <td> 119 <td>
111 Ctrl-l 120 Ctrl-l
112 </td> 121 </td>
113 <td> 122 <td>
114 Force a resize 123 Force a refresh
124 </td>
125 </tr>
126 <tr valign="top">
127 <td>
128 Up/Down
129 </td>
130 <td>
131 Move in the input line history
115 </td> 132 </td>
116 </tr> 133 </tr>
117 <tr valign="top"> 134 <tr valign="top">
118 <td> 135 <td>
119 PgUp/PgDown 136 PgUp/PgDown
212 Add "name" as an alias for "command line".<br /> 229 Add "name" as an alias for "command line".<br />
213 Aliases are expanded only once, thus they can not be chained.<br /> 230 Aliases are expanded only once, thus they can not be chained.<br />
214 "/alias name" displays the value associated with the "name" alias; 231 "/alias name" displays the value associated with the "name" alias;
215 "/alias name =" unsets the "name" alias.<br /> 232 "/alias name =" unsets the "name" alias.<br />
216 Example: "/alias away = status away". 233 Example: "/alias away = status away".
234 </dd>
235 <dt><b>
236 /authorization allow|cancel|request [jid]
237 </b></dt>
238 <dd>
239 Manage the presence subscriptions.<br />
240 If no jid is provided, the current buddy is used.
241 <table class="hlist">
242 <tr valign="top">
243 <td>
244 <b>allow</b>
245 </td>
246 <td>
247 allow the buddy to receive your presence updates
248 </td>
249 </tr>
250 <tr valign="top">
251 <td>
252 <b>cancel</b>
253 </td>
254 <td>
255 cancel the buddy' subscription to your presence updates
256 </td>
257 </tr>
258 <tr valign="top">
259 <td>
260 <b>request</b>
261 </td>
262 <td>
263 request a subscription to the buddy's presence updates
264 </td>
265 </tr>
266 </table>
217 </dd> 267 </dd>
218 <dt><b> 268 <dt><b>
219 /bind keycode = command line 269 /bind keycode = command line
220 </b></dt> 270 </b></dt>
221 <dd> 271 <dd>
227 Note: aliases can be used in key bindings.<br /> 277 Note: aliases can be used in key bindings.<br />
228 Example: "/bind 265 = status online" (265 is F1 for me, but it may 278 Example: "/bind 265 = status online" (265 is F1 for me, but it may
229 depend on your ncurses installation). 279 depend on your ncurses installation).
230 </dd> 280 </dd>
231 <dt><b> 281 <dt><b>
232 /buffer clear|top|bottom|search_backward|search_forward|date|% 282 /buffer clear|top|bottom|date|%|search_backward|search_forward
233 </b></dt> 283 </b></dt>
234 <dd> 284 <dd>
235 The <b>buffer</b> command manipulates the current buddy's buffer 285 The <b>buffer</b> command manipulates the current buddy's buffer
236 (chat window). 286 (chat window).
237 <table class="hlist"> 287 <table class="hlist">
275 scroll the buffer down n lines (default: half a screen) 325 scroll the buffer down n lines (default: half a screen)
276 </td> 326 </td>
277 </tr> 327 </tr>
278 <tr valign="top"> 328 <tr valign="top">
279 <td> 329 <td>
330 <b>date</b> date
331 </td>
332 <td>
333 jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional)
334 </td>
335 </tr>
336 <tr valign="top">
337 <td>
338 <b>%</b> n
339 </td>
340 <td>
341 jump to position %n of the buddy chat buffer
342 </td>
343 </tr>
344 <tr valign="top">
345 <td>
280 <b>search_backward</b> text 346 <b>search_backward</b> text
281 </td> 347 </td>
282 <td> 348 <td>
283 search for "text" in the current buddy chat buffer 349 search for "text" in the current buddy chat buffer
284 </td> 350 </td>
287 <td> 353 <td>
288 <b>search_forward</b> text 354 <b>search_forward</b> text
289 </td> 355 </td>
290 <td> 356 <td>
291 search for "text" in the current buddy chat buffer 357 search for "text" in the current buddy chat buffer
292 </td>
293 </tr>
294 <tr valign="top">
295 <td>
296 <b>date</b> date
297 </td>
298 <td>
299 jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional)
300 </td>
301 </tr>
302 <tr valign="top">
303 <td>
304 <b>%</b> n
305 </td>
306 <td>
307 jump to position %n of the buddy chat buffer
308 </td> 358 </td>
309 </tr> 359 </tr>
310 </table> 360 </table>
311 </dd> 361 </dd>
312 <dt><b> 362 <dt><b>
748 <p>Free use of this software is granted under the terms of the GNU General Public 798 <p>Free use of this software is granted under the terms of the GNU General Public
749 License (GPL).</p> 799 License (GPL).</p>
750 <div id="footer"> 800 <div id="footer">
751 <p> 801 <p>
752 Version 0.7.2-dev<br /> 802 Version 0.7.2-dev<br />
753 Last updated 14-Dec-2005 00:04:31 CEST 803 Last updated 16-Dec-2005 16:12:33 CEST
754 </p> 804 </p>
755 </div> 805 </div>
756 </div> 806 </div>
757 </body> 807 </body>
758 </html> 808 </html>