mcabber/doc/mcabber.1.txt
author Mikael Berthe <mikael@lilotux.net>
Sat, 27 Feb 2016 13:40:34 +0100
changeset 2254 54a12919cdee
parent 2244 4ddff7f8ad90
child 2257 3f04914d8643
permissions -rw-r--r--
Ready for release 1.0.2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
     1
MCABBER(1)
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
     2
===========
222
882029ebd052 [/trunk] Changeset 234 by mikael
mikael
parents: 210
diff changeset
     3
Mikael BERTHE <mcabber@lilotux.net>
2254
54a12919cdee Ready for release 1.0.2
Mikael Berthe <mikael@lilotux.net>
parents: 2244
diff changeset
     4
v1.0.2, February 2016
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
     5
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
     6
NAME
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
     7
----
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
     8
mcabber - a simple Jabber (XMPP) console client
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
     9
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
    10
SYNOPSIS
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
    11
--------
1259
c5c09f8f60b0 Change command line option -v to -V
Mikael Berthe <mikael@lilotux.net>
parents: 1257
diff changeset
    12
'mcabber' [ -h | -V | -f configfile ]
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
    13
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
    14
DESCRIPTION
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
    15
-----------
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    16
`mcabber(1)` is a small Jabber (XMPP) console client. +
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    17
For now it needs a configuration file to start, so please copy the sample
208
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
    18
mcabberrc file and adapt your connection settings.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    19
360
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 349
diff changeset
    20
You also need to have an existing Jabber account to use this software, as
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 349
diff changeset
    21
it cannot (un)register accounts yet.
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 349
diff changeset
    22
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    23
Here are some of the features of `mcabber`:
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    24
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    25
- 'SASL/SSL/TLS support'.
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    26
- 'MUC support' (Multi-User Chat).
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    27
- 'PGP, OTR support'
1062
9207f2efb921 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1037
diff changeset
    28
- 'Chat States' support (typing notifications)
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    29
- 'History logging:'  If enabled (see the CONFIGURATION FILE section),
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    30
  `mcabber` can save discussions to text history log files.
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    31
- 'Commands completion:'  If possible, `mcabber` will try to complete your
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    32
  command line if you hit the Tab key.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    33
- 'Input line history:'  Any message or command entered is in the input line
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    34
  history and can be reused easily.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    35
- 'External actions:'  Some events (like receiving a message) can trigger an
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    36
  external action such as a shell script if you enable it in your
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    37
  configuration file.  A sample events script ("eventcmd") is provided with
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    38
  `mcabber` source code, in the contrib directory.
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    39
- 'Modules:'  `mcabber` can load modules (a.k.a. plugins) at runtime that
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    40
  extend its features.
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    41
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    42
OPTIONS
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    43
-------
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    44
-h::
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    45
        Quick help usage message
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    46
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    47
-V::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    48
        Displays `mcabber` version and compile-time definitions.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    49
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    50
-f configfile::
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    51
        Use configuration file 'configfile'
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    52
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    53
WINDOWS/PANES
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    54
-------------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
    55
The `mcabber(1)` screen is divided into 4 regions.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    56
The 'roster', alias 'buddylist', is on the left.  The 'chat window', or chat
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    57
buffer, is on the right.  The 'input line' lies at the bottom of the screen,
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    58
under a small 'log window'.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    59
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
    60
Two status lines surround the log window.  The bottom status line is the
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
    61
"main status line" and reflects mcabber general status.  The other line
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
    62
is the "chat status line" and shows the status of the currently selected
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
    63
buddy.
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
    64
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
    65
To display buddies chat buffers, you will have to enter 'chat mode'.
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
    66
You can enter chat mode by pressing enter, and leave chat mode with the ESC
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
    67
key.  Simply sending a message will also enable chat mode.
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
    68
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    69
There are several advantages to the two-mode implementation: first, it allows
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    70
accurate "unread" message functionality, as described in the next section;
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    71
without this, merely scrolling to a specific buddy will "read" the new
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    72
messages of all buddies in-between.  Second, it allows quickly hiding the
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    73
conversation with a single keystroke.  Third, it allows jumping between
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    74
the few buddies with whom you are conversing with the '/roster alternate'
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    75
command described in another section, without having to manually scroll
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
    76
back and forth.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    77
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    78
KEYS
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    79
----
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
    80
Text typing occurs in the 'input line'; basic operations are supported
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
    81
(left arrow, right arrow, home/end keys, insert, delete, backspace...).
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    82
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    83
PageUp and PageDown keys are used to move in the roster.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    84
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
    85
Up and Down arrow keys can be used to move in the input line history; they
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
    86
jump to the previous/next line from the history beginning with the same string
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
    87
(from first column to the cursor column).
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
    88
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    89
To send a message, move to the chosen buddy in the buddylist, type your
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    90
message and hit enter.  If the line begins with a slash, this will be
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    91
interpreted as a command (see the COMMAND section below).  Hit escape to
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    92
leave the chat mode.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    93
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
    94
Here is a quick description of the default key bindings:
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    95
1062
9207f2efb921 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1037
diff changeset
    96
Esc::           Disable chat mode
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    97
Ctrl-a::        Go to the beginning of the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
    98
Ctrl-e::        Go to the end of the input line
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
    99
Ctrl-l::        Force a refresh
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
   100
Up/Down::       Move in the input line history
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   101
PgUp/PgDown::   Move inside the roster (buddylist)
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   102
Tab::           Complete current word, in the input line
1083
07941d7feee9 Ctrl-d sends a multi-line message
Mikael Berthe <mikael@lilotux.net>
parents: 1062
diff changeset
   103
Ctrl-g::        Cancel completion
07941d7feee9 Ctrl-d sends a multi-line message
Mikael Berthe <mikael@lilotux.net>
parents: 1062
diff changeset
   104
Ctrl-c::        Abort multi-line messages and completions
07941d7feee9 Ctrl-d sends a multi-line message
Mikael Berthe <mikael@lilotux.net>
parents: 1062
diff changeset
   105
Ctrl-d::        Send/terminate a multi-line message
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   106
Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode)
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
   107
Ctrl-Left::     Move the cursor back to the start of the current or previous word
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
   108
Ctrl-Right::    Move the cursor forward to the end of the current or next word
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   109
Ctrl-u::        Delete from beginning of the line to the cursor
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   110
Ctrl-k::        Delete from the cursor to the end of line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   111
Ctrl-w::        Backward kill word
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   112
Ctrl-t::        Transpose chars
263
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
   113
Ctrl-o::        Accept line and put the next history line in the input line (accept-line-and-down-history)
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   114
1096
3d92e648a8db Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1086
diff changeset
   115
Additional key bindings may be specified using the '/bind' command described
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   116
in the COMMANDS section.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   117
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   118
MCABBER'S ROSTER
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   119
----------------
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   120
The first listed item on the roster is '[status]', which keeps a log of
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   121
everything that appears in the short log window below the main chat area.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   122
While the log window was designed for showing the latest few elements, the
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   123
dedicated '[status]' buffer allows more comfortable viewing of the log, as
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   124
well as scrolling it in a standard manner.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   125
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   126
Group names are displayed above the items that are within them, and are
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   127
indicated by '---' to the left of the name.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   128
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   129
For every real Jabber contact, the roster displays four pieces of information:
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   130
the buddy's name or alias, its online status, its authorization status, and
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   131
whether there are unread messages from the buddy waiting for you.
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   132
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   133
The online status is one of the following:
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   134
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   135
        'o';;  online
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   136
        'f';;  free for chat
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   137
        'a';;  away
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   138
        'n';;  not available (labeled 'extended away' in some clients)
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   139
        'd';;  do not disturb
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   140
        '_';;  offline (or invisible to you)
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   141
        '?';;  unknown, usually meaning you are not authorized to see this buddy's status
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   142
        'x';;  a conference room in which you are not participating
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   143
        'C';;  a conference room in which you are participating
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   144
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   145
The authorization status indicates whether a buddy is authorized to receive
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   146
your online status updates, and is displayed by the brackets surrounding the
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   147
buddy's online status.  Square brackets, like '[o]', indicate that this
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   148
buddy is authorized to receive your status.  Curly braces, like '\{o\}',
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   149
indicate that they are not authorized to receive your status.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   150
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   151
When there are unread messages from a buddy which you have not looked at,
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   152
a hash mark ('#') appears in the leftmost section of the roster for that
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   153
buddy.  The hash mark disappears once you view that buddy's message
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   154
buffer.
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   155
When the user attention is requested (or when you receive a message containing
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   156
your nickname in a MUC room), the hash mark is replaced with the 'attention
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   157
sign', an exclamation mark ('!').
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   158
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   159
Examples:
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   160
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   161
        ' --- Buds';;     This is a group named 'Buds'
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   162
        '#[o] John';;     John is online, can see your status, and sent you a message that you did not read yet
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   163
        ' \{?\} Sally';;  Neither you nor Sally have authorized each other to see your online status
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   164
        ' \{a\} Jane';;   Jane is away, but she cannot see your online status
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   165
        '#[C] \x@y.c';;   You are participating in \x@y.c conference room, and there are unread messages
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   166
1242
b335d30881bd Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1233
diff changeset
   167
COMMANDS
b335d30881bd Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1233
diff changeset
   168
--------
b335d30881bd Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1233
diff changeset
   169
Please refer to the online help (command /help), it is probably more up-to-date than this manpage.  Furthermore, help files have been translated into several languages. +
b335d30881bd Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1233
diff changeset
   170
You will find an overview of the `mcabber` commands in this manual.
b335d30881bd Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1233
diff changeset
   171
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   172
COMMANDS RELATED TO MCABBER
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   173
---------------------------
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   174
/add [jid [nickname]]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   175
        Add the "jid" Jabber user to our roster (default group), and send a notification request to this buddy.  If no nickname is specified, the jid is used.  If no jid (or an empty string "") is provided or if jid is ".", the current buddy is used.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   176
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   177
        ['jid' [nickname]];;  Add to our roster "jid" as "nickname"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   178
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   179
        Example: "/add somebody@jabber.server.com Somebody"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   180
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
   181
/alias [name [= command line]]::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   182
        This command let you to add aliases which can simplify sophisticated commands. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   183
        You can manage your aliases by:
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   184
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   185
        (without arguments);;  Print list of currently defined aliases
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   186
        'name';;  Print the value of alias called "name"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   187
        'name'=;;  Unset alias called "name"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   188
        'name' = command line;;  Set alias called "name" with value "command line"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   189
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   190
        Example: "/alias away = status away"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   191
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   192
/authorization allow|cancel|request|request_unsubscribe [jid]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   193
        This command manages presence subscriptions: it allows you to request presence subscriptions from others on your roster, and allows you to control who receives your presence notifications. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   194
        If no JID is provided, the currently-selected buddy is used.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   195
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   196
        'allow';;  Allow the buddy to receive your presence updates
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   197
        'cancel';;  Cancel the buddy's subscription to your presence updates
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   198
        'request';;  Request a subscription to the buddy's presence updates
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   199
        'request_unsubscribe';;  Request unsubscription from the buddy's presence updates
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
   200
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
   201
/bind [keycode [= command line]]::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   202
        Bind the command to the key given as "keycode".  To examine which keys are currently not used look at `mcabber` log window and press examined key.  For example: "Unknown key=265" means that you can bind some command to key #265.
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
   203
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   204
        (without arguments);;  Display list of current bindings
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   205
        'keycode';;  Display the command line bound to this key
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   206
        'keycode'=;;  Unbind key with code "keycode"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   207
        'keycode' = command line;;  Bind "command line" to the key with code "keycode"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   208
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   209
        Example: "/bind 265 = status away" (265 is F1). +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   210
        Note: keycodes can be different depending on your ncurses configuration. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   211
        Tip: aliases also can be used instead of commands.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   212
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   213
/buffer clear|close|close_all|purge|list::
1139
104676e3389b Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1131
diff changeset
   214
/buffer top|bottom|date|%|search_backward|search_forward::
876
e583d617838a Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 870
diff changeset
   215
/buffer scroll_lock|scroll_unlock|scroll_toggle::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   216
/buffer save filename::
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   217
        Buddy's buffer manipulation command.  E.g. you can search through buffer for "text", clear chat window etc.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   218
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   219
        'clear';;  Clear the current buddy chat window
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   220
        'close' [jid];;  Empty all contents of the buffer and close the current buddy chat window
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   221
        'close_all';;  Empty all contents of the chat buffers and close the chat windows
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   222
        'purge' [jid];;  Clear the current buddy chat window and empty all contents of the chat buffer
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   223
        'list';;  Display the list of existing buffers, with their length (lines/blocks)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   224
        'top';;  Jump to the top of the current buddy chat buffer
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   225
        'bottom';;  Jump to the bottom of the current buddy chat buffer
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   226
        'up' [n];;  Scroll the buffer up [n] lines (default: half a screen)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   227
        'down' [n];;  Scroll the buffer down [n] lines (default: half a screen)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   228
        'date' [date];;  Jump to the first line after the specified [date] in the chat buffer (date format: "YYYY-mm-dd")
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   229
        % n;;  Jump to position %n of the buddy chat buffer
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   230
        'search_backward' text;;  Search for [text] in the current buddy chat buffer
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   231
        'search_forward' text;;  Search for [text] in the current buddy chat buffer
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   232
        'scroll_lock';;  Lock buffer scrolling
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   233
        'scroll_unlock';;  Unlock buffer scrolling
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   234
        'scroll_toggle';;  Toggle buffer scrolling (lock/unlock)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   235
        'save' filename;;  Save the contents of the current buffer to the file "filename"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   236
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   237
/chat_disable [--show-roster]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   238
        Disable chat mode. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   239
        With --show-roster, the fullscreen mode will be disabled.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   240
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   241
/clear::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   242
        This command is actually an alias for "/buffer clear".  It clears the current buddy chat window.
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   243
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   244
/color roster (status wildcard (color|-)|clear)::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   245
/color mucnick nick (color|-)::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   246
/color muc (jid|.|*) [on|preset|off|-]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   247
        The 'color' command allows setting dynamic color properties of the screen.
1242
b335d30881bd Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1233
diff changeset
   248
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   249
        'roster' clear;;  Remove all color rules for the roster.  All roster items will get its default color.
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   250
        'roster' status wildcard color;;  Set a color rule (or overwrite, if it already exists).  The status is string containing all statuses the roster item can have for the rule to match, or * if any status is OK.  Wildcard is the file-matching wildcard that will be applied to JID.  Color is the wanted color. If color is -, the rule is removed. If more than one rule matches, the color from the last created (not overwritten) is used.
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   251
        'mucnick' nick (color|-);;  Marks the nick to be colored by given color.  If a MUC has colored nicks, this one will be used.  If color is -, the color is marked as chosen automatically, which means it will not be used in 'preset' coloring mode, but will stay the same in 'on' coloring mode.
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   252
        'muc' (jid|.|*) [on|preset|off|-];;  Sets a MUC nick coloring mode.  If a jid (. means currently selected jid) is provided, the mode will apply to this specific MUC.  If * is used, it will be applied to all MUCs, except the ones set by their jid. Mode 'on' colors all nicks, 'preset' only the ones manually set by /color mucnick command and 'off' colors none.  If not specified, defaults to 'on'.  Mode '-' removes the mode from given JID, which means the global one will apply.  You can not remove the global mode. Default global coloring mode is 'off'.
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   253
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
   254
/connect::
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
   255
        Establish connection to the Jabber server.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
   256
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   257
/del::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   258
        Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   259
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
   260
/disconnect::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   261
        Terminate the connection to the Jabber server. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   262
        Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected.
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
   263
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   264
/echo message::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   265
        Display "message" in the log window.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   266
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   267
/event #n|* accept|ignore|reject [event-specific arguments]::
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
   268
/event list::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   269
        Tell mcabber what to do about pending events. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   270
        If the first parameter is '*', the command will apply to all queued events. +
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   271
        Event-specific arguments will be interpreted on event-to event basis.  The only built-in case, when argument is used is MUC invitation reject - argument, if present, will be interpreted as reject reason.
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   272
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   273
        #N|* accept [event-specific arguments];;  Event number #N/All events will be accepted
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   274
        #N|* ignore [event-specific arguments];;  Event number #N/All events will be ignored
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   275
        #N|* reject [event-specific arguments];;  Event number #N/All events will be rejected
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   276
        'list';;  List all pending events
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
   277
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   278
/group fold|unfold|toggle [groupname]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   279
        This command changes the current group display.
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
   280
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   281
        'fold' [groupname];;  Fold (shrink) the current/specified group tree in the roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   282
        'unfold' [groupname];;  Unfold (expand) the current/specified group tree in the roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   283
        'toggle' [groupname];;  Toggle the state (fold/unfold) of the current/specified tree
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   284
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   285
/help [command|+topic]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   286
        Display help for command "command" or topic "topic". +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   287
        Example: "/help buffer"
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   288
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   289
/iline fchar|bchar|char_fdel|char_bdel|char_swap::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   290
/iline fword|bword|word_bdel|word_fdel::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   291
/iline word_upcase|word_downcase|word_capit::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   292
/iline hist_beginning_search_bwd|hist_beginning_search_fwd::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   293
/iline hist_prev|hist_next::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   294
/iline iline_start|iline_end|iline_fdel|iline_bdel::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   295
/iline iline_accept|iline_accept_down_hist::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   296
/iline compl_do|compl_cancel::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   297
/iline send_multiline::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   298
        Input line commands
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   299
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   300
        'fchar';;  Move to the next letter
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   301
        'bchar';;  Move to the previous letter
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   302
        'char_fdel';;  Delete the letter at cursor position
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   303
        'char_bdel';;  Delete the letter before cursor position
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   304
        'char_swap';;  Transpose chars
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   305
        'fword';;  Move the cursor forward to the end of the current or next word
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   306
        'bword';;  Move the cursor back to the start of the current or previous word
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   307
        'word_bdel';;  Delete the word from cursor position to its start
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   308
        'word_fdel';;  Delete the word from cursor position to its end
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   309
        'word_upcase';;  Convert the word from cursor position to its end to upper case
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   310
        'word_downcase';;  Convert the word from cursor position to its end to down case
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   311
        'word_capit';;  Capitalize the word from cursor position to its end
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   312
        'hist_beginning_search_bwd';;  Search backward in the history for a  line  beginning  with  the current  line  up  to the cursor (this leaves the cursor in its original position)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   313
        'hist_beginning_search_fwd';;  Search forward in the history for a  line  beginning  with  the current  line  up  to the cursor (this leaves the cursor in its original position)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   314
        'hist_prev';;  Previous line of input line history
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   315
        'hist_next';;  Next line of input line history
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   316
        'iline_start';;  Go to the beginning of the input line
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   317
        'iline_end';;  Go to the end of the input line
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   318
        'iline_fdel';;  Delete from the cursor to the end of line
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   319
        'iline_bdel';;  Delete from beginning of the line to the cursor
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   320
        'iline_accept';;  Accept line
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   321
        'iline_accept_down_hist';;  Accept line and put the next history line in the input line
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   322
        'compl_do';;  Complete current word, in the input line
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   323
        'compl_cancel';;  Cancel completion
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   324
        'send_multiline';;  Send/terminate a multi-line message
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   325
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   326
/info::
440
264f40222872 Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents: 436
diff changeset
   327
        Display info on the selected entry (user, agent, group...). +
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   328
        For users, resources are displayed with the status, priority and status message (if available) of each resource.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   329
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   330
/module load|unload [-f] module::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   331
/module info module::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   332
/module [list]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   333
        Load, unload or show info on module.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   334
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   335
        'load' [-f] module;;  Loads specified module.  If -f flag is specified, most of module loading errors will be ignored.
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   336
        'unload' [-f] module;;  Unloads specified module. Note: The force flag will not remove any dependency on this module!
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   337
        'info' module;;  Shows available information about this module.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   338
        ['list'];;  Lists modules in a format: [modulename]  [reference count] ([Manually/Automatically loaded]) [any extra info, like version or dependencies]
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   339
210
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
   340
/move [groupname]::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   341
        Move the current buddy to the requested group.  If no group is specified, then the buddy is moved to the default group.  If the group "groupname" doesn't exist, it is created. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   342
        Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy.
210
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
   343
839
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
   344
/msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   345
        Send a multi-line message.  To write a single message with several lines, the 'multi-line mode' should be used. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   346
        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. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   347
        The 'begin' subcommand enables multi-line mode.  Note that it allows a message subject to be specified. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   348
        The 'verbatim' 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. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   349
        The 'toggle' subcommand can be bound to a key to use the multi-line mode quickly (for example, "bind M13 = msay toggle" to switch using the Meta-Enter combination).
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   350
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   351
        'begin' [subject];;  Enter multi-line mode
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   352
        'verbatim';;  Enter verbatim multi-line mode
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   353
        'send' [-n|-h];;  Send the current multi-line message to the currently selected buddy
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   354
        'send_to' [-n|-h] jid;;  Send the current multi-line message to "jid"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   355
        'toggle'|'toggle_verbatim';;  Switch to/from multi-line mode (begin/send)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   356
        'abort';;  Leave multi-line mode without sending the message
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   357
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   358
        The -n or -h flags turn the message to "normal" or "headline" accordingly, as opposed to default "chat" message.
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   359
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   360
/otr key::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   361
/otr start|stop|info [jid]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   362
/otr fingerprint [jid [fpr]]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   363
/otr smpq|smpr [jid] secret::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   364
/otr smpa [jid]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   365
        You can use the shortcut-jid "." for the currently selected contact.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   366
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   367
        'key';;  Print the fingerprint of your private key to the Status Buffer
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   368
        'start' [jid];;  Open an OTR channel to the specified jid (or the currently selected contact)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   369
        'stop' [jid];;  Close the OTR channel to the specified jid (or the currently selected contact)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   370
        'info' [jid];;  Show current OTR status for the specified jid (or the currently selected contact)
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   371
        'fingerprint' [jid [fpr]];;  Show the active fingerprint of an OTR channel. If the fingerprint is provided instead of "fpr", the fingerprint will become trusted.  If you replace "fpr" by some bogus string the fingerprint will loose the trusted status.
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   372
        'smpq' [jid] secret;;  Initiate the Socialist Millionaires Protocol with the secret and the buddy
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   373
        'smpr' [jid] secret;;  Respond to the Initiation of the jid with the secret
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   374
        'smpa' [jid];;  Abort the running Socialist Millionaires Protocol
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   375
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   376
/otrpolicy::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   377
/otrpolicy (default|jid) (plain|manual|opportunistic|always)::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   378
        You can use the shortcut-jid "." for the currently selected contact.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   379
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   380
        (without arguments);;  Prints all OTR policies to the status buffer
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   381
        ('default'|'jid') (plain|manual|opportunistic|always);;  Sets either the default policy or the policy for the given jid The plain policy should never be used, because you won't be able to receive or send any OTR encrypted messages. If you set the policy to manual, you or your chat partner have to start the OTR encryption by hand (e.g. with /otr start). The policy "opportunistic" does that itself by sending a special whitespace-sequence at the end of unencrypted messages.  So the other OTR-enabled chat client knows, that you want to use OTR.  Note that the first message will always be unencryted, if you use this policy. With the policy "always" no message will be sent in plain text.  If you try to sent the first message unencrypted, mcabber will try to establish an OTR channel.  Please resend your message, when you get the information that the channel was established.  If someone sends you plaintext messages while the policy is set to "always", you'll be able to read the message but it won't be saved to the history.
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
   382
1242
b335d30881bd Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1233
diff changeset
   383
/pgp disable|enable|force|info [jid]::
1096
3d92e648a8db Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1086
diff changeset
   384
/pgp setkey [jid [key]]::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   385
        This command manipulates PGP settings for the specified jid (by default the currently selected contact). +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   386
        Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command.  You can force PGP encryption with the "force" subcommand.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   387
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   388
        'disable' [jid];;  Disable PGP encryption for jid (or the currently selected contact)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   389
        'enable' [jid];;  Enable PGP encryption for jid (or the currently selected contact)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   390
        [+|-]'force' [jid];;  Enforce PGP encryption, even for offline messages, and always assume the recipient has PGP support.  If a message can't be encrypted (missing key or key id), the messages won't be sent at all.  This option is ignored when PGP is disabled.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   391
        'info' [jid];;  Show current PGP settings for the contact
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   392
        'setkey' [jid [key]];;  Set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut-jid "." for the currently selected contact.
1096
3d92e648a8db Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1086
diff changeset
   393
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   394
/quit::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   395
        This command closes all connections and quit mcabber.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   396
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   397
/rawxml send string::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   398
        Send "string" (raw XML format) to the Jabber server. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   399
        No check is done on the string provided. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   400
        BEWARE!
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   401
        Use this only if you know what you are doing, or you could terminate the connection. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   402
        Example: "/rawxml send <presence><show>away</show></presence>"
1096
3d92e648a8db Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1086
diff changeset
   403
886
e58ae191a25c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 876
diff changeset
   404
/rename name::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   405
        Rename the current buddy or group to the given "name".  If "name" is -, the name is removed from the roster (and mcabber will display the JID or username).
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   406
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   407
/request last|ping|time|vcard|version [jid]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   408
        Send a "IQ" query to the current buddy, or to the specified Jabber user.  If the resource is not provided with the jid, mcabber will send the query to all known resources for this user.
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
   409
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   410
        'last';;  Request "last" information (usually idle time)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   411
        'ping';;  Send an XMPP Ping request.  Note that you should use the full JID since a ping sent to a bare JID will be handled by the server.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   412
        'time';;  Request time from the buddy
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   413
        'vcard';;  Request VCard from the buddy
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   414
        'version';;  Request version from the buddy
700
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 674
diff changeset
   415
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   416
/room join|leave|names|nick|remove|topic|unlock|destroy::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   417
/room privmsg|invite|whois|kick|ban|unban|role|affil::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   418
/room setopt print_status|auto_whois [value]::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   419
/room bookmark [add|del] [-autojoin|+autojoin] [-|nick]::
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
   420
        The 'room' command handles Multi-User Chat room actions.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
   421
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   422
        'join' [room [nick [pass]]];;  Join "room", using "nick" as nickname.  If no nickname is provided (or if it is an empty string), the "nickname" option value is used (see sample configuration file).  If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "." can be used instead of the full room id.  A password can be provided to enter protected rooms.  If your nickname contains space characters, use quotes.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   423
        'leave' [message];;  Leave the current room
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   424
        'names' [--detail|--short|--quiet|--compact];;  Display members of the current room
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   425
        'nick' newnick;;  Change your nickname in the current room
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   426
        'privmsg' nick msg;;  Send private message "msg" to "nick"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   427
        'remove';;  Remove the current room from the roster (you must have left this room before)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   428
        'topic' -|newtopic;;  Set topic for current room
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   429
        'unlock';;  Unlock current room (if you are the owner)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   430
        'destroy' [reason];;  Destroy the current room (use with care!)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   431
        'whois' nick;;  Display MUC information about "nick"
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   432
        'ban' jid [reason];;  Ban jid from the current room
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   433
        'unban' jid;;  Unban jid from the current room
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   434
        'invite' jid [reason];;  Invite jid to the current room
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   435
        'kick' nick [reason];;  Kick "nick" from the current room
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   436
        'role' jid role [reason];;  Change jid's role (role can be "none", "visitor", "participant", "moderator")
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   437
        'affil' jid affil [reason];;  Change jid's affiliation (affil can be "none", "member", "admin", "owner")
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   438
        'setopt' print_status|auto_whois [value];;  Change settings for the current room For print_status, the possible values are "default", "none", "in_and_out", "all". For auto_whois, the possible values are "default", "off", "on". When the value is "default", the options muc_print_status / muc_auto_whois is used.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   439
        'bookmark' [add|del] [-autojoin|+autojoin] [-|nick];;  Add, remove or update a bookmark (default is add). If autojoin is set, mcabber will automatically join the MUC room when it connects to the server. To see the list of bookmarks, use /room bookmark in the status buffer.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   440
1086
5e2e647e781b Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1083
diff changeset
   441
/roster bottom|top|up|down|group_prev|group_next::
330
a9013124ede6 Add "/roster alternate"
Mikael Berthe <mikael@lilotux.net>
parents: 320
diff changeset
   442
/roster alternate|unread_first|unread_next::
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
   443
/roster search bud::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   444
/roster display|hide_offline|show_offline|toggle_offline::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   445
/roster item_lock|item_unlock|item_toggle_lock::
1086
5e2e647e781b Add command /roster group_prev|group_next and update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1083
diff changeset
   446
/roster hide|show|toggle::
1062
9207f2efb921 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1037
diff changeset
   447
/roster note [-|text]::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   448
        The 'roster' command manipulates the roster/buddylist. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   449
        Here are the available parameters:
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   450
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   451
        'bottom';;  Jump to the bottom of the roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   452
        'top';;  Jump to the top of the roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   453
        'up' [n];;  Move up [n lines] in the roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   454
        'down' [n];;  Move down [n lines] in the roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   455
        'group_prev';;  Jump to the previous group in the roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   456
        'group_next';;  Jump to the next group in the roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   457
        'alternate';;  Jump to alternate buddy.  The "alternate" buddy is the last buddy left while being in chat mode.  This command is thus especially useful after commands like "/roster unread_next" (Ctrl-q).
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   458
        'unread_first';;  Jump to the first unread message
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   459
        'unread_next';;  Jump to the next unread message
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   460
        'search' bud;;  Search for a buddy with a name or jid containing "bud" (only in the displayed buddylist)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   461
        'display' [mask];;  See or update the roster filter. The mask should contain the shortcut letters of the status you want to see ([o]nline, [f]ree_for_chat, [d]o_not_disturb, [n]ot_available, [a]way, [_]offline). For example "ofdna" to display only connected buddies.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   462
        'hide_offline';;  Hide offline buddies (same as /roster display ofdna)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   463
        'show_offline';;  Show offline buddies (same as /roster display ofdna_)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   464
        'toggle_offline';;  Toggle display of offline buddies
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   465
        'item_lock' [jid];;  Lock the roster item so it remains visible regardless of its status
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   466
        'item_unlock' [jid];;  Undo the effects of item_lock
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   467
        'item_toggle_lock' [jid];;  Invert the current lock flag
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   468
        'hide';;  Hide roster (full-width chat window)
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   469
        'show';;  Show roster
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   470
        'toggle';;  Toggle roster visibility
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   471
        'note' [-|text];;  Set/update/delete an annotation. If there is no text, the current item's annotation is displayed -- if you are in the status buffer, all notes are displayed. If text is "-", the note is erased.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   472
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   473
/say [-n|-h|--] text::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   474
        Send the "text" message to the currently selected buddy.  It can be useful if you want to send a message beginning with a slash, for example. +
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   475
        The "-n" flag turns the message to "normal" type, "-h" to "headline".  "--" can be used to send chat message beginning with -n or -h.
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   476
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   477
/say_to [-n|-h] [-q] [-f file] jid text::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   478
        Send the "text" message to the specified jid. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   479
        Please note that this command doesn't set the default resource for a contact, so if you want to send several messages to a specific resource you will have to use "/say_to" for each message. +
1924
57c352ed37f9 Update help/documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1891
diff changeset
   480
        You can send a message to a specific resource of the currently selected contact by using /say_to ./resourcename message. +
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   481
        The "-n" flag turns the message to "normal" type, "-h" to "headline".  "--" can be used to send chat messages beginning with -n or -h. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   482
        When "-q" is used, the message will be sent in the background and will not change the current active window. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   483
        A text file can be provided with the "-f" switch (in which case there's no need to pass a text argument after the jid, of course).
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   484
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   485
/screen_refresh::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   486
        Refresh the mcabber screen.
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   487
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   488
/set [option [= value]]::
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   489
        Display or set an option value. +
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   490
        Without arguments prints a list of all set options with their values
480
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
   491
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   492
/source pattern::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   493
        Read configuration files, that match glob pattern (sorted in alphabetical order).
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   494
1973
9fe1c0a54e73 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1933
diff changeset
   495
/status [online|avail|free|dnd|notavail|away [-|statusmessage]]::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   496
/status message -|statusmessage::
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
   497
        Show or set the current status. +
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
   498
        If no status is specified, display the current status. +
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   499
        If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file). +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   500
        If no relevant message* variable is set and no status message provided, the current status message is kept. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   501
        If StatusMessage is "-", the current status message is cleared. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   502
        With the "/status message" command, mcabber will update the message while preserving the status.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   503
1973
9fe1c0a54e73 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1933
diff changeset
   504
/status_to jid online|avail|free|dnd|notavail|away [statusmessage]::
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   505
/status_to jid message statusmessage::
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
   506
        Send the requested status to the specified Jabber user. +
660
ef7f0b58a159 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 639
diff changeset
   507
        If the specified jid is ".", the current buddy is used. +
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   508
        Note: this status will be overridden by subsequent "/status" commands.  If you are using the auto-away feature, the status will overridden too. +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   509
        Note: The jid can include a resource (i.e. \user@server/resource).
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   510
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   511
/version::
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   512
        Display current version of mcabber.
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
   513
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   514
CONFIGURATION FILE
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
   515
------------------
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
   516
See the provided sample configuration file, which should be self-documenting.
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   517
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   518
FILES
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   519
-----
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
   520
The following files can be used by `mcabber(1)`:
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   521
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   522
    $HOME/.mcabber/mcabberrc    Default configuration file
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   523
    $HOME/.mcabberrc            Configuration file used if no other has been found
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   524
    $HOME/.mcabber/histo/       Default directory for storing chat history files, if enabled
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   525
    /usr/share/mcabber/help/    Default directory for online help files
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   526
    /usr/lib/mcabber/           Default directory for modules
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
   527
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   528
BUGS
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   529
----
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   530
Certainly.  Please tell me if you find one!  :-) +
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   531
Please visit our website to find out about the MUC room and the bug tracker.
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   532
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   533
AUTHOR
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   534
------
1759
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   535
Written by mailto:mikael@lilotux.net[Mikael BERTHE] and others
921429804e20 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 1606
diff changeset
   536
(see AUTHORS file). +
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   537
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   538
RESOURCES
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   539
---------
1842
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   540
http://mcabber.com/[Main web site] +
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   541
http://wiki.mcabber.com/[Official wiki] +
cec7cbeb1c2e Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 1759
diff changeset
   542
xmpp:mcabber@conf.lilotux.net[MCabber MUC room]
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   543
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   544
COPYING
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   545
-------
2254
54a12919cdee Ready for release 1.0.2
Mikael Berthe <mikael@lilotux.net>
parents: 2244
diff changeset
   546
Copyright \(C) 2005-2016 Mikael Berthe and others. +
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   547
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   548
Free use of this software is granted under the terms of the GNU General Public
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
   549
License (GPL).