comparison mcabber/doc/mcabber.1.txt @ 289:72fa52203651

Update documentation * Update /alias doc * Add documentation for /bind * Improve /msay help for AsciiDoc and HTML formats. Don't know how to get a better presentation with the manpage format :(
author Mikael Berthe <mikael@lilotux.net>
date Fri, 08 Jul 2005 22:10:42 +0100
parents a3d65d7f0bc3
children f63839a4cb35
comparison
equal deleted inserted replaced
288:1eea0fa0955e 289:72fa52203651
1 MCABBER(1) 1 MCABBER(1)
2 =========== 2 ===========
3 Mikael BERTHE <mcabber@lilotux.net> 3 Mikael BERTHE <mcabber@lilotux.net>
4 v0.6.2, June 2005 4 v0.6.2, July 2005
5 5
6 NAME 6 NAME
7 ---- 7 ----
8 mcabber - a simple Jabber console client 8 mcabber - a simple Jabber console client
9 9
81 Add the 'jid' Jabber user to our roster (default group), and send a 81 Add the 'jid' Jabber user to our roster (default group), and send a
82 notification request to this buddy. If no nickname is specified, the 82 notification request to this buddy. If no nickname is specified, the
83 jid is used. 83 jid is used.
84 84
85 /alias name = command line:: 85 /alias name = command line::
86 Add "name" as an alias for "command line". 86 Add "name" as an alias for "command line". +
87 Aliases are expanded only once, thus they can not be chained. +
88 "/alias name" displays the value associated with the "name" alias;
89 "/alias name =" unsets the "name" alias. +
87 Example: "/alias away = status away". 90 Example: "/alias away = status away".
88 Aliases are expanded only once, thus they can not be chained. 91
92 /bind keycode = command line::
93 Bind a command line to the key with the "keycode" code number. +
94 Keycodes of unused keys are displayed by mcabber in the log window
95 when pressing the key, for example "Unknown key=265". +
96 "/bind keycode" displays the command line bound to the given keycode;
97 "/bind keycode" unbinds the given keycode. +
98 Note: aliases can be used in key bindings. +
99 Example: "/bind 265 = status online" (265 is F1 for me, but it can
100 depend on your ncurses installation).
89 101
90 /buffer clear|top|bottom:: 102 /buffer clear|top|bottom::
91 The 'buffer' command manipulates the current buddy's buffer 103 The 'buffer' command manipulates the current buddy's buffer
92 (chat window). 104 (chat window).
93 105
117 specified, then the buddy is moved to the default group. 129 specified, then the buddy is moved to the default group.
118 This command only works with users (not agents), at the moment. 130 This command only works with users (not agents), at the moment.
119 131
120 /msay begin|verbatim|send|abort:: 132 /msay begin|verbatim|send|abort::
121 Send a multi-line message. To write a single message with several 133 Send a multi-line message. To write a single message with several
122 lines, the 'multi-line mode' should be used. In multi-line mode, 134 lines, the 'multi-line mode' should be used. +
123 each line (except command lines) typed in the input line will 135 In multi-line mode, each line (except command lines) typed in the input
124 be added to the multi-line message. Once the message is finished, it 136 line will be added to the multi-line message. Once the message is
125 can be sent to the current selected buddy with the "msay /send" 137 finished, it can be sent to the current selected buddy with the "msay
126 command. The 'verbatim' multi-line mode disables commands, so that it 138 /send" command. +
127 is possible to enter lines starting with a slash. Only the "/msay" 139 The 'verbatim' multi-line mode disables commands, so that it is
128 command (with send or abort parameters) can be used to exit verbatim mode. 140 possible to enter lines starting with a slash. Only the "/msay"
141 command (with send or abort parameters) can be used to exit verbatim
142 mode.
129 143
130 'begin';; enter multi-line mode 144 'begin';; enter multi-line mode
131 'verbatim';; enter verbatim multi-line mode 145 'verbatim';; enter verbatim multi-line mode
132 'send';; send the current multi-line message to the currently selected buddy 146 'send';; send the current multi-line message to the currently selected buddy
133 'abort';; leave multi-line mode without sending the message 147 'abort';; leave multi-line mode without sending the message