mcabber/doc/mcabber.1.html
author Mikael Berthe <mikael@lilotux.net>
Fri, 08 Jul 2005 22:10:42 +0100
changeset 289 72fa52203651
parent 286 a3d65d7f0bc3
child 290 f63839a4cb35
permissions -rw-r--r--
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 :(
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
     1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
     2
<html>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
     3
<head>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
     4
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
     5
<meta name="generator" content="AsciiDoc 7.0.0" />
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
     6
<meta name="author" content="Mikael BERTHE" />
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
     7
<meta name="author-email" content="mcabber@lilotux.net" />
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
     8
<link rel="stylesheet" href="./manpage.css" type="text/css" />
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
     9
<title>mcabber</title>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    10
</head>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    11
<body>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    12
<div id="content">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    13
<h1>MCABBER(1) Manual Page</h1>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    14
<h2>NAME</h2>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    15
<p>mcabber -
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    16
   a simple Jabber console client
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    17
</p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    18
<div id="synopsis">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    19
<h2>SYNOPSIS</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    20
<p><b>mcabber</b> [ -f configfile ] [ --help | -h ]</p>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    21
</div>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    22
<h2>DESCRIPTION</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    23
<p><tt>mcabber(1)</tt> is a small Jabber console client.<br />
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    24
For now it needs a configuration file to start, so please copy the sample
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    25
mcabberrc file and adapt your connection settings.</p>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    26
<p>The <tt>mcabber(1)</tt> screen is divided into 4 regions.
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    27
The <b>roster</b>, alias <b>buddylist</b>, is on the left.  The <b>chat window</b>, or chat
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    28
buffer, is on the right.  The <b>input line</b> lies at the bottom of the screen,
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    29
under a small <b>log window</b>.</p>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    30
<p>To display buddies chat buffers, you will have to enter <b>chat mode</b>.
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    31
You can enter chat mode by pressing enter, and leave chat mode with the ESC
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    32
key.  Simply sending a message will also enable chat mode.</p>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    33
<p>Here are some of the features of <tt>mcabber</tt>:</p>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    34
<ul>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    35
<li>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    36
<p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    37
<b>SSL support</b>.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    38
</p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    39
</li>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    40
<li>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    41
<p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    42
<b>History logging:</b>  If enabled (see the CONFIGURATION FILE section),
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    43
  <tt>mcabber(1)</tt> can save discussions to history log files.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    44
</p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    45
</li>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    46
<li>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    47
<p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    48
<b>Commands completion:</b>  If possible, <tt>mcabber(1)</tt> will try to complete your
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    49
  command line if you hit the Tab key.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    50
</p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    51
</li>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    52
<li>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    53
<p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    54
<b>External actions:</b>  Some events (like receiving a message) can trigger an
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    55
  external action, for example a shell script (you need to enable it in your
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    56
  configuration file).
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    57
</p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    58
</li>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    59
</ul>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    60
<h2>OPTIONS</h2>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    61
<dl>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    62
<dt><b>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    63
--help, -h
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    64
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    65
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    66
        Quick help usage message
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    67
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    68
<dt><b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    69
-f configfile
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    70
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    71
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    72
        Use configuration file <b>configfile</b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    73
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    74
</dl>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    75
<h2>KEYS</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    76
<p>Text typing occurs in the <b>input line</b>; basic operations are supported
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    77
(left arrow, right arrow, home/end keys, insert, delete, backspace&#8230;).</p>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    78
<p>PageUp and PageDown keys are used to move in the roster.</p>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    79
<p>To send a message, move to the choosen buddy in the buddylist, type your
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    80
message and hit enter.  If the line begins with a slash, this will be
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    81
interpreted as a command (see the COMMAND section below).  Hit escape to
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    82
leave the chat mode.</p>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
    83
<p>Here is a quick description of the key bindings:</p>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    84
<table class="hlist">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    85
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    86
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    87
Ctrl-a
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    88
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    89
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    90
Go to the beginning of the input line
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    91
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    92
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    93
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    94
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    95
Ctrl-e
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    96
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    97
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    98
Go to the end of the input line
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
    99
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   100
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   101
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   102
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   103
Ctrl-l
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   104
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   105
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   106
Force a resize
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   107
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   108
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   109
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   110
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   111
PgUp/PgDown
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   112
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   113
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   114
Move inside the roster (buddylist)
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   115
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   116
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   117
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   118
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   119
Tab
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   120
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   121
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   122
Complete current word, in the input line
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   123
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   124
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   125
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   126
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   127
Ctrl-g
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   128
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   129
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   130
Cancel completion / ctrl-g
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   131
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   132
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   133
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   134
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   135
Ctrl-p/Ctrl-n
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   136
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   137
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   138
Scroll up/down half a screen in the buffer window (chat mode)
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   139
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   140
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   141
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   142
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   143
Ctrl-u
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   144
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   145
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   146
Delete from beginning of the line to the cursor
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   147
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   148
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   149
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   150
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   151
Ctrl-k
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   152
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   153
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   154
Delete from the cursor to the end of line
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   155
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   156
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   157
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   158
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   159
Ctrl-w
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   160
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   161
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   162
Backward kill word
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   163
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   164
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   165
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   166
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   167
Ctrl-t
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   168
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   169
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   170
Transpose chars
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   171
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   172
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   173
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   174
<td>
263
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   175
Ctrl-o
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   176
</td>
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   177
<td>
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   178
Accept line and put the next history line in the input line (accept-line-and-down-history)
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   179
</td>
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   180
</tr>
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   181
<tr valign="top">
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   182
<td>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   183
Ctrl-q
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   184
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   185
<td>
236
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   186
Jump to the next unread message
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   187
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   188
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   189
</table>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   190
<h2>COMMANDS</h2>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   191
<dl>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   192
<dt><b>
245
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
   193
/add jid [nickname]
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   194
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   195
<dd>
245
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
   196
        Add the <b>jid</b> Jabber user to our roster (default group), and send a
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
   197
        notification request to this buddy.  If no nickname is specified, the
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
   198
        jid is used.
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   199
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   200
<dt><b>
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
   201
/alias name = command line
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
   202
</b></dt>
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
   203
<dd>
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   204
        Add "name" as an alias for "command line".<br />
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   205
        Aliases are expanded only once, thus they can not be chained.<br />
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   206
        "/alias name" displays the value associated with the "name" alias;
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   207
        "/alias name =" unsets the "name" alias.<br />
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
   208
        Example: "/alias away = status away".
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   209
</dd>
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   210
<dt><b>
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   211
/bind keycode = command line
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   212
</b></dt>
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   213
<dd>
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   214
        Bind a command line to the key with the "keycode" code number.<br />
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   215
        Keycodes of unused keys are displayed by mcabber in the log window
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   216
        when pressing the key, for example "Unknown key=265".<br />
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   217
        "/bind keycode" displays the command line bound to the given keycode;
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   218
        "/bind keycode" unbinds the given keycode.<br />
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   219
        Note: aliases can be used in key bindings.<br />
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   220
        Example: "/bind 265 = status online" (265 is F1 for me, but it can
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   221
        depend on your ncurses installation).
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
   222
</dd>
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
   223
<dt><b>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   224
/buffer clear|top|bottom
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   225
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   226
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   227
        The <b>buffer</b> command manipulates the current buddy's buffer
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   228
        (chat window).
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   229
<table class="hlist">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   230
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   231
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   232
<b>clear</b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   233
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   234
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   235
clear the current buddy chat window
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   236
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   237
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   238
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   239
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   240
<b>top</b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   241
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   242
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   243
jump to the top of the current buddy chat buffer
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   244
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   245
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   246
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   247
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   248
<b>bottom</b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   249
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   250
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   251
jump to the bottom of the current buddy chat buffer
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   252
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   253
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   254
</table>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   255
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   256
<dt><b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   257
/clear
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   258
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   259
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   260
        The <b>clear</b> command is actually an alias for "/buffer clear".
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   261
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   262
<dt><b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   263
/del
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   264
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   265
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   266
        Delete the current buddy from our roster, unsubscribe from its presence
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   267
        notification and unsubscribe it from ours.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   268
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   269
<dt><b>
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
   270
/group fold|unfold|toggle
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   271
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   272
<dd>
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
   273
        The <b>group</b> command changes the current group display.
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   274
<table class="hlist">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   275
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   276
<td>
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
   277
<b>fold</b>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   278
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   279
<td>
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
   280
fold (shrink) the current group tree in the roster
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   281
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   282
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   283
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   284
<td>
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
   285
<b>unfold</b>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   286
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   287
<td>
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
   288
unfold (expand) the current group tree in the roster
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   289
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   290
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   291
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   292
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   293
<b>toggle</b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   294
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   295
<td>
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
   296
toggle the state (fold/unfold) of the current tree
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   297
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   298
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   299
</table>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   300
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   301
<dt><b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   302
/info
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   303
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   304
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   305
        Display info on the selected entry (user, agent, group&#8230;).
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   306
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   307
<dt><b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   308
/move [groupname]
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   309
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   310
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   311
        Move the current buddy to the requested group.  If no group is
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   312
        specified, then the buddy is moved to the default group.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   313
        This command only works with users (not agents), at the moment.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   314
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   315
<dt><b>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   316
/msay begin|verbatim|send|abort
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   317
</b></dt>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   318
<dd>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   319
        Send a multi-line message.  To write a single message with several
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   320
        lines, the <b>multi-line mode</b> should be used.<br />
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   321
        In multi-line mode, each line (except command lines) typed in the input
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   322
        line will be added to the multi-line message.  Once the message is
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   323
        finished, it can be sent to the current selected buddy with the "msay
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   324
        /send" command.<br />
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   325
        The <b>verbatim</b> multi-line mode disables commands, so that it is
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   326
        possible to enter lines starting with a slash.  Only the "/msay"
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   327
        command (with send or abort parameters) can be used to exit verbatim
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   328
        mode.
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   329
<table class="hlist">
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   330
<tr valign="top">
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   331
<td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   332
<b>begin</b>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   333
</td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   334
<td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   335
enter multi-line mode
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   336
</td>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   337
</tr>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   338
<tr valign="top">
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   339
<td>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   340
<b>verbatim</b>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   341
</td>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   342
<td>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   343
enter verbatim multi-line mode
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   344
</td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   345
</tr>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   346
<tr valign="top">
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   347
<td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   348
<b>send</b>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   349
</td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   350
<td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   351
send the current multi-line message to the currently selected buddy
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   352
</td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   353
</tr>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   354
<tr valign="top">
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   355
<td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   356
<b>abort</b>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   357
</td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   358
<td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   359
leave multi-line mode without sending the message
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   360
</td>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   361
</tr>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   362
</table>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   363
</dd>
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   364
<dt><b>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   365
/quit
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   366
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   367
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   368
        Disconnect and leave <tt>mcabber(1)</tt>.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   369
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   370
<dt><b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   371
/rename nickname
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   372
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   373
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   374
        Rename current buddy to the given nickname.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   375
        This command does not work for groups, at the moment (but you can move
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   376
        the buddies to another group with the /move command).
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   377
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   378
<dt><b>
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   379
/roster bottom|top|hide_offline|show_offline|unread_first|unread_next
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   380
</b></dt>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   381
<dt><b>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   382
/roster search bud
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   383
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   384
<dd>
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   385
        The <b>roster</b> command manipulates the roster/buddylist.  Here are the available parameters:
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   386
<table class="hlist">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   387
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   388
<td>
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   389
<b>bottom</b>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   390
</td>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   391
<td>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   392
jump to the bottom of the roster
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   393
</td>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   394
</tr>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   395
<tr valign="top">
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   396
<td>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   397
<b>top</b>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   398
</td>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   399
<td>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   400
jump to the top of the roster
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   401
</td>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   402
</tr>
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   403
<tr valign="top">
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   404
<td>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   405
<b>hide_offline</b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   406
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   407
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   408
hide offline buddies
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   409
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   410
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   411
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   412
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   413
<b>show_offline</b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   414
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   415
<td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   416
show offline buddies
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   417
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   418
</tr>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   419
<tr valign="top">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   420
<td>
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   421
<b>search</b> bud
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   422
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   423
<td>
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   424
search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist)
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   425
</td>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   426
</tr>
236
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   427
<tr valign="top">
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   428
<td>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   429
<b>unread_first</b>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   430
</td>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   431
<td>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   432
jump to the first unread message
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   433
</td>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   434
</tr>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   435
<tr valign="top">
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   436
<td>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   437
<b>unread_next</b>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   438
</td>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   439
<td>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   440
jump to the next unread message
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   441
</td>
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
   442
</tr>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   443
</table>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   444
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   445
<dt><b>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   446
/say text
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   447
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   448
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   449
        Send the text message to the currently selected buddy.  Can be useful
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   450
        if you want to send a message beginning with a slash, for example.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   451
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   452
<dt><b>
277
4d7040cff8ee Remove busy/occupied status, which does not really exist
Mikael Berthe <mikael@lilotux.net>
parents: 265
diff changeset
   453
/status [online|avail|invisible|free|dnd|notavail|away]
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   454
</b></dt>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   455
<dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   456
        Set the current status.  If no status is specified, display the
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   457
        current status.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   458
</dd>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   459
</dl>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   460
<h2>CONFIGURATION FILE</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   461
<p>See the provided sample configuration file, which should be self-documented.</p>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   462
<h2>FILES</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   463
<p>The following files can be used by <tt>mcabber(1)</tt>:</p>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   464
<div class="literalparagraph"><pre>$HOME/.mcabber/mcabberrc    Default configuration file
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   465
$HOME/.mcabberrc            Configuration file used if no other has been found
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   466
$HOME/.mcabber/histo/       Default directory for storing chat history files, if enabled</pre></div>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   467
<h2>BUGS</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   468
<p>Certainly a lot.  Please tell me if you find one!  :-)</p>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   469
<h2>AUTHOR</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   470
<p>Written by <a href="mailto:mcabber@lilotux.net">Mikael BERTHE</a>.<br />
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   471
Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   472
consult the AUTHORS file for details.</p>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   473
<h2>RESOURCES</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   474
<p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   475
<h2>COPYING</h2>
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   476
<p>Copyright &#169; 2005 Mikael Berthe.<br />
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   477
Some portions are Copyright &#169; 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p>
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   478
<p>Free use of this software is granted under the terms of the GNU General Public
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
   479
License (GPL).</p>
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   480
<div id="footer">
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   481
<p>
254
719b87a693a9 [/trunk] Changeset 267 by mikael
mikael
parents: 245
diff changeset
   482
Version 0.6.2<br />
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   483
Last updated 08-Jul-2005 23:04:30 CEST
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   484
</p>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   485
</div>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   486
</div>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   487
</body>
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents:
diff changeset
   488
</html>