mcabber: mcabber/doc/mcabber.1.html comparison

comparison mcabber/doc/mcabber.1.html @ 260:33e1a05864a6

Add "verbatim multi-line" mode, with commands disabled "/msay verbatim" enters multi-line mode with all commands disabled but "/msay", so that lines beginning with a slash '/' can be sent. Note: <Tab> still do commands completion.

author	mikael@frmp8452
date	Fri, 01 Jul 2005 23:47:03 +0100
parents	719b87a693a9
children	1bcc3eec08f0

comparison

equal deleted inserted replaced

-:594e73bc9610
+:33e1a05864a6
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<meta name="generator" content="AsciiDoc 6.0.3" />
+<meta name="generator" content="AsciiDoc 7.0.0" />
 <meta name="author" content="Mikael BERTHE" />
 <meta name="author-email" content="mcabber@lilotux.net" />
 <link rel="stylesheet" href="./manpage.css" type="text/css" />
 <title>mcabber</title>
 </head>
 <p>mcabber -
 a simple Jabber console client
 </p>
 <div id="synopsis">
 <h2>SYNOPSIS</h2>
-<p>
+<p><b>mcabber</b> [ -f configfile ] [ --help | -h ]</p>
-<b>mcabber</b> [ -f configfile ] [ &#8212;help | -h ]
-</p>
 </div>
 <h2>DESCRIPTION</h2>
-<p>
+<p><tt>mcabber(1)</tt> is a small Jabber console client.<br />
-<tt>mcabber(1)</tt> is a small Jabber console client.<br />
 For now it needs a configuration file to start, so please copy the sample
-mcabberrc file and adapt your connection settings.
+mcabberrc file and adapt your connection settings.</p>
-</p>
+<p>The <tt>mcabber(1)</tt> screen is divided into 4 regions.
-<p>
-The <tt>mcabber(1)</tt> screen is divided into 4 regions.
 The <b>roster</b>, alias <b>buddylist</b>, is on the left.  The <b>chat window</b>, or chat
 buffer, is on the right.  The <b>input line</b> lies at the bottom of the screen,
-under a small <b>log window</b>.
+under a small <b>log window</b>.</p>
-</p>
+<p>To display buddies chat buffers, you will have to enter <b>chat mode</b>.
-<p>
-To display buddies chat buffers, you will have to enter <b>chat mode</b>.
 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.
+key.  Simply sending a message will also enable chat mode.</p>
-</p>
+<p>Here are some of the features of <tt>mcabber</tt>:</p>
-<p>
-Here are some of the features of <tt>mcabber</tt>:
-</p>
 <ul>
 <li>
 <p>
 <b>SSL support</b>.
 </p>
 </li>
 </ul>
 <h2>OPTIONS</h2>
 <dl>
 <dt><b>
-&#8212;help, -h
+--help, -h
 </b></dt>
 <dd>
 Quick help usage message
 </dd>
 <dt><b>
 -f configfile
 </b></dt>
 <dd>
 Use configuration file <b>configfile</b>
 </dd>
 </dl>
 <h2>KEYS</h2>
-<p>
+<p>Text typing occurs in the <b>input line</b>; basic operations are supported
-Text typing occurs in the <b>input line</b>; basic operations are supported
+(left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).</p>
-(left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).
+<p>PageUp and PageDown keys are used to move in the roster.</p>
-</p>
+<p>To send a message, move to the choosen buddy in the buddylist, type your
-<p>
-PageUp and PageDown keys are used to move in the roster.
-</p>
-<p>
-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.
+leave the chat mode.</p>
-</p>
+<p>Here is a quick description of the key bindings:</p>
-<p>
-Here is a quick description of the key bindings:
-</p>
 <table class="hlist">
 <tr valign="top">
 <td>
 Ctrl-a
 </td>
 <td>
 Go to the beginning of the input line
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-e
 </td>
 <td>
 Go to the end of the input line
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-l
 </td>
 <td>
 Force a resize
 </td>
 </tr>
 <tr valign="top">
 <td>
 PgUp/PgDown
 </td>
 <td>
 Move inside the roster (buddylist)
 </td>
 </tr>
 <tr valign="top">
 <td>
 Tab
 </td>
 <td>
 Complete current word, in the input line
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-g
 </td>
 <td>
 Cancel completion / ctrl-g
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-p/Ctrl-n
 </td>
 <td>
 Scroll up/down half a screen in the buffer window (chat mode)
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-u
 </td>
 <td>
 Delete from beginning of the line to the cursor
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-k
 </td>
 <td>
 Delete from the cursor to the end of line
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-w
 </td>
 <td>
 Backward kill word
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-t
 </td>
 <td>
 Transpose chars
 </td>
 </tr>
 <tr valign="top">
 <td>
 Ctrl-q
 </td>
 <td>
 Jump to the next unread message
 </td>
 </tr>
 </table>
 <h2>COMMANDS</h2>
 <dl>
 <dt><b>
 /add jid [nickname]
 </b></dt>
 <dd>
 Add the <b>jid</b> Jabber user to our roster (default group), and send a
 notification request to this buddy.  If no nickname is specified, the
 jid is used.
 </dd>
 <dt><b>
 /buffer clear|top|bottom
 </b></dt>
 <dd>
 The <b>buffer</b> command manipulates the current buddy's buffer
 (chat window).
 <table class="hlist">
 <tr valign="top">
 <td>
 <b>clear</b>
 </td>
 <td>
 clear the current buddy chat window
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>top</b>
 </td>
 <td>
 jump to the top of the current buddy chat buffer
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>bottom</b>
 </td>
 <td>
 jump to the bottom of the current buddy chat buffer
 </td>
 </tr>
 </table>
 </dd>
 <dt><b>
 /clear
 </b></dt>
 <dd>
 The <b>clear</b> command is actually an alias for "/buffer clear".
 </dd>
 <dt><b>
 /del
 </b></dt>
 <dd>
 Delete the current buddy from our roster, unsubscribe from its presence
 notification and unsubscribe it from ours.
 </dd>
 <dt><b>
 /group fold|unfold|toggle
 </b></dt>
 <dd>
 The <b>group</b> command changes the current group display.
 <table class="hlist">
 <tr valign="top">
 <td>
 <b>fold</b>
 </td>
 <td>
 fold (shrink) the current group tree in the roster
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>unfold</b>
 </td>
 <td>
 unfold (expand) the current group tree in the roster
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>toggle</b>
 </td>
 <td>
 toggle the state (fold/unfold) of the current tree
 </td>
 </tr>
 </table>
 </dd>
 <dt><b>
 /info
 </b></dt>
 <dd>
 Display info on the selected entry (user, agent, group&#8230;).
 </dd>
 <dt><b>
 /move [groupname]
 </b></dt>
 <dd>
 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.
+</dd>
-</dd>
+<dt><b>
-<dt><b>
+/msay begin|verbatim|send|abort
-/msay begin|send|abort
+</b></dt>
-</b></dt>
+<dd>
-<dd>
 Send a multi-line message.  To write a single message with several
 lines, the <b>multi-line mode</b> should be used.  In multi-line mode,
 each line (except command lines) typed in the input line will
 be added to the multi-line message.  Once the message is finished, it
 can be sent to the current selected buddy with the "msay /send"
-command.
+command.  The <b>verbatim</b> multi-line mode disables commands, so that it
+is possible to enter lines starting with a slash.  Only the "/msay"
+command (with send or abort parameters) can be used to exit verbatim mode.
 <table class="hlist">
 <tr valign="top">
 <td>
 <b>begin</b>
 </td>
 <td>
 enter multi-line mode
+</td>
+</tr>
+<tr valign="top">
+<td>
+<b>verbatim</b>
+</td>
+<td>
+enter verbatim multi-line mode
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>send</b>
 </td>
 <td>
 send the current multi-line message to the currently selected buddy
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>abort</b>
 </td>
 <td>
 leave multi-line mode without sending the message
 </td>
 </tr>
 </table>
 </dd>
 <dt><b>
 /quit
 </b></dt>
 <dd>
 Disconnect and leave <tt>mcabber(1)</tt>.
 </dd>
 <dt><b>
 /rename nickname
 </b></dt>
 <dd>
 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).
 </dd>
 <dt><b>
 /roster hide_offline|show_offline|top|bottom
 </b></dt>
 <dd>
 The <b>roster</b> command manipulates the roster/buddylist.
 <table class="hlist">
 <tr valign="top">
 <td>
 <b>hide_offline</b>
 </td>
 <td>
 hide offline buddies
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>show_offline</b>
 </td>
 <td>
 show offline buddies
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>top</b>
 </td>
 <td>
 jump to the top of the roster
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>bottom</b>
 </td>
 <td>
 jump to the bottom of the roster
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>unread_first</b>
 </td>
 <td>
 jump to the first unread message
 </td>
 </tr>
 <tr valign="top">
 <td>
 <b>unread_next</b>
 </td>
 <td>
 jump to the next unread message
 </td>
 </tr>
 </table>
 </dd>
 <dt><b>
 /say text
 </b></dt>
 <dd>
 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.
 </dd>
 <dt><b>
 /status [online|avail|invisible|free|dnd|busy|notavail|away]
 </b></dt>
 <dd>
 Set the current status.  If no status is specified, display the
 current status.
 </dd>
 </dl>
 <h2>CONFIGURATION FILE</h2>
-<p>
+<p>See the provided sample configuration file, which should be self-documented.</p>
-See the provided sample configuration file, which should be self-documented.
-</p>
 <h2>FILES</h2>
-<p>
+<p>The following files can be used by <tt>mcabber(1)</tt>:</p>
-The following files can be used by <tt>mcabber(1)</tt>:
+<div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc    Default configuration file
-</p>
-<div class="literalparagraph"><pre>
-$HOME/.mcabber/mcabberrc    Default configuration file
 $HOME/.mcabberrc            Configuration file used if no other has been found
-$HOME/.mcabber/histo/       Default directory for storing chat history files, if enabled
+$HOME/.mcabber/histo/       Default directory for storing chat history files, if enabled</pre></div>
-</pre></div>
 <h2>BUGS</h2>
-<p>
+<p>Certainly a lot.  Please tell me if you find one!  :-)</p>
-Certainly a lot.  Please tell me if you find one!  :-)
-</p>
 <h2>AUTHOR</h2>
-<p>
+<p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br />
-Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br />
 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please
-consult the AUTHORS file for details.
+consult the AUTHORS file for details.</p>
-</p>
 <h2>RESOURCES</h2>
-<p>
+<p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p>
-<a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a>
-</p>
 <h2>COPYING</h2>
-<p>
+<p>Copyright &#169; 2005 Mikael Berthe.<br />
-Copyright &#169; 2005 Mikael Berthe.<br />
+Some portions are Copyright &#169; 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p>
-Some portions are Copyright &#169; 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.
+<p>Free use of this software is granted under the terms of the GNU General Public
-</p>
+License (GPL).</p>
-<p>
-Free use of this software is granted under the terms of the GNU General Public
-License (GPL).
-</p>
 <div id="footer">
 <p>
 Version 0.6.2<br />
-Last updated 14-Jun-2005 23:30:26 CEST
+Last updated 02-Jul-2005 00:36:19 CEST
 </p>
 </div>
 </div>
 </body>
 </html>

Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1.html @ 260:33e1a05864a6