annotate mcabber/doc/mcabber.1.txt @ 946:5c1dfc8e54d7 0.8.0

Ready for release 0.8.0
author Mikael Berthe <mikael@lilotux.net>
date Sun, 13 Aug 2006 21:01:30 +0200
parents 2647b2078cc8
children e79d82933dea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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>
946
5c1dfc8e54d7 Ready for release 0.8.0
Mikael Berthe <mikael@lilotux.net>
parents: 923
diff changeset
4 v0.8.0, August 2006
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 ----
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
8 mcabber - a simple Jabber 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 --------
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
12 'mcabber' [ -f configfile ] [ --help | -h ]
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 -----------
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
16 `mcabber(1)` is a small Jabber 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
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
25 - 'SSL support'.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
26 - 'MUC support' (Multi-User Chat).
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
27 - 'History logging:' If enabled (see the CONFIGURATION FILE section),
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
28 `mcabber` can save discussions to history log files.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
29 - 'Commands completion:' If possible, `mcabber` will try to complete your
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
30 command line if you hit the Tab key.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
31 - '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
32 history and can be reused easily.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
33 - 'External actions:' Some events (like receiving a message) can trigger an
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
34 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
35 configuration file. A sample events script ("eventcmd") is provided with
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
36 `mcabber` source code, in the contrib directory.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
37
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
38 OPTIONS
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
39 -------
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
40 --help, -h::
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
41 Quick help usage message
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
42
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
43 -f configfile::
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
44 Use configuration file 'configfile'
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
45
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
46 WINDOWS/PANES
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
47 -------------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
48 The `mcabber(1)` screen is divided into 4 regions.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
49 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
50 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
51 under a small 'log window'.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
52
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
53 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
54 "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
55 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
56 buddy.
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
57
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
58 To display buddies chat buffers, you will have to enter 'chat mode'.
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
59 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
60 key. Simply sending a message will also enable chat mode.
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
61
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
62 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
63 accurate "unread" message functionality, as described in the next section;
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
64 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
65 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
66 conversation with a single keystroke. Third, it allows jumping between
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
67 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
68 command described in another section, without having to manually scroll
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
69 back and forth.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
70
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
71 KEYS
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
72 ----
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
73 Text typing occurs in the 'input line'; basic operations are supported
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
74 (left arrow, right arrow, home/end keys, insert, delete, backspace...).
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
75
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
76 PageUp and PageDown keys are used to move in the roster.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
77
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
78 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
79 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
80 (from first column to the cursor column).
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
81
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
82 To send a message, move to the choosen buddy in the buddylist, type your
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
83 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
84 interpreted as a command (see the COMMAND section below). Hit escape to
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
85 leave the chat mode.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
86
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
87 Here is a quick description of the key bindings:
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
88
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
89 Ctrl-a:: Go to the beginning of the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
90 Ctrl-e:: Go to the end of the input line
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
91 Ctrl-l:: Force a refresh
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
92 Up/Down:: Move in the input line history
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
93 PgUp/PgDown:: Move inside the roster (buddylist)
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
94 Tab:: Complete current word, in the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
95 Ctrl-g:: Cancel completion / ctrl-g
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
96 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
97 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
98 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
99 Ctrl-u:: Delete from beginning of the line to the cursor
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
100 Ctrl-k:: Delete from the cursor to the end of line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
101 Ctrl-w:: Backward kill word
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
102 Ctrl-t:: Transpose chars
263
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
103 Ctrl-o:: Accept line and put the next history line in the input line (accept-line-and-down-history)
236
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 234
diff changeset
104 Ctrl-q:: Jump to the next unread message
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
105
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
106 Additional key bindings may be specified using the /bind command described
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
107 in the COMMANDS section.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
108
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
109 MCABBER'S ROSTER
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
110 ----------------
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
111 The first listed resource on the roster is '[status]', which keeps a log of
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
112 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
113 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
114 dedicated '[status]' buffer allows more comfortable viewing of the log, as
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
115 well as scrolling it in a standard manner.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
116
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
117 Group names are displayed above the resources that are within them, and are
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
118 indicated by '---' to the left of the name.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
119
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
120 For every real Jabber resource, the roster displays four pieces of information:
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
121 the resource's name or alias, its online status, its authorization status, and
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
122 whether there are unread messages from the resource waiting for you.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
123
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
124 The online status is one of the following:
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
125
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
126 'o';; online
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
127 'f';; free for chat
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
128 'a';; away
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
129 'n';; not available (labeled 'extended away' in some clients)
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
130 'd';; do not disturb
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
131 'i';; invisible (displayed only for your resource)
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
132 '_';; offline (or invisible to you)
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
133 '?';; unknown, usually meaning you are not authorized to see this resource's status
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
134 'x';; a conference room in which you are not participating
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
135 'C';; a conference room in which you are participating
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
136
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
137 The authorization status indicates whether a resource is authorized to receive
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
138 your online status updates, and is displayed by the brackets surrounding the
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
139 resource's online status. Square brackets, like '[o]', indicate that this
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
140 resource is authorized to receive your status. Curly braces, like '\{o\}',
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
141 indicate that they are not authorized to receive your status.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
142
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
143 When there are unread messages from the resource which you have not looked at,
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
144 a hash mark ('#') appears in the leftmost section of the roster for that
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
145 resource. The hash mark disappears once you view that resource's message log.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
146
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
147 Examples:
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
148
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
149 ' --- Buds';; This is a group named 'Buds'
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
150 '#[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
151 ' \{?\} 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
152 ' \{a\} Jane';; Jane is away, but she cannot see your online status
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
153 '#[C] x@y.c';; You are participating in x@y.c conference room, and there are unread messages
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
154
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
155 COMMANDS RELATED TO MCABBER
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
156 ---------------------------
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
157 /alias [name [= command line]]::
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
158 Add "name" as an alias for "command line". +
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
159 Aliases are expanded only once, thus they can not be chained. +
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
160 "/alias name" displays the value associated with the "name" alias; +
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
161 "/alias name =" unsets the "name" alias. +
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
162 "/alias" displays a list of the existing aliases. +
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
163 Example: "/alias away = status away".
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
164
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
165 /bind [keycode [= command line]]::
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
166 Bind a command line to the key with the "keycode" code number. +
432
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 423
diff changeset
167 Keycodes of unused keys are displayed by `mcabber` in the log window
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
168 when pressing the key, for example "Unknown key=265". +
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
169 "/bind keycode" displays the command line bound to the given keycode; +
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
170 "/bind keycode =" unbinds the given keycode. +
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
171 "/bind" displays a list of the bound keycodes. +
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
172 Note: aliases can be used in key bindings. +
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
173 Example: "/bind 265 = status online" (265 is F1 for me, but it may
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
174 depend on your ncurses installation).
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
175
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
176 /buffer clear|purge|top|bottom|date|%|search_backward|search_forward::
876
e583d617838a Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 870
diff changeset
177 /buffer scroll_lock|scroll_unlock|scroll_toggle::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
178 The 'buffer' command manipulates the current buddy's buffer
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
179 (chat window).
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
180
465
52171a3dc199 Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents: 450
diff changeset
181 'clear';; clear the current buddy chat window
876
e583d617838a Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 870
diff changeset
182 'purge';; clear the current buddy chat window and empty all contents of the chat buffer
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 506
diff changeset
183 'bottom';; jump to the bottom of the current buddy chat buffer
465
52171a3dc199 Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents: 450
diff changeset
184 'top';; jump to the top of the current buddy chat buffer
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 506
diff changeset
185 'up' [n];; scroll the buffer up n lines (default: half a screen)
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 506
diff changeset
186 'down' [n];; scroll the buffer down n lines (default: half a screen)
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
187 'date' date;; jump to the first line after the specified date in the chat buffer (date format: "YYYY-mm-dd[THH:MM:SS]", "-" and ":" are optional)
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
188 '%' n;; jump to position %n of the buddy chat buffer
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
189 'search_backward' text;; search for "text" in the current buddy chat buffer
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
190 'search_forward' text;; search for "text" in the current buddy chat buffer
876
e583d617838a Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 870
diff changeset
191 'scroll_lock';; lock buffer scrolling
e583d617838a Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 870
diff changeset
192 'scroll_unlock';; unlock buffer scrolling
e583d617838a Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 870
diff changeset
193 'scroll_toggle';; toggle buffer scrolling (lock/unlock)
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
194
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
195 /clear::
206
766167c0c57f [/trunk] Changeset 218 by mikael
mikael
parents: 205
diff changeset
196 The 'clear' command is actually an alias for "/buffer clear".
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
197
870
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
198 /help [command]::
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
199 Display generic help or help about a specific mcabber command.
4b77a2ab18e5 Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 854
diff changeset
200
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
201 /quit::
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
202 Disconnect and leave `mcabber(1)`.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
203
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
204 /version::
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
205 Display mcabber version
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
206
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
207 COMMANDS RELATED TO THE SERVER AND CONNECTION
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
208 ---------------------------------------------
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
209 /connect::
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
210 Establish connection to the Jabber server.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
211
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
212 /disconnect::
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
213 Terminate connection to the Jabber server. Note: the roster is only
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
214 available when the connection to the server is active, so the
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
215 buddylist is empty when disconnected.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
216
829
114f08e3c29a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 813
diff changeset
217 /event #n|* accept|ignore|reject::
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
218 /event list::
829
114f08e3c29a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 813
diff changeset
219 Tell mcabber what to do about a pending event. +
114f08e3c29a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 813
diff changeset
220 If the first parameter is "*", the command will apply to all
114f08e3c29a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 813
diff changeset
221 queued events.
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
222
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
223 'accept';; accept the event #n
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
224 'ignore';; remove the event #n from the list
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
225 'reject';; reject the event #n
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
226 'list';; list all pending events
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
227
901
45ddb3ada74f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 886
diff changeset
228 /rawxml send string::
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
229 'send' string: send string (raw XML format) to the Jabber server. No check is done on the string provided. BEWARE! Use this only if you know what you are doing, or you could terminate the connection.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
230
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
231 COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
232 ---------------------------------------------------
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
233 /add [jid [nickname]]::
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
234 Add the "jid" Jabber user to our roster (default group), and send a
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
235 notification request to this buddy. If no nickname is specified, the
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
236 jid is used. If no jid (or an empty string "") is provided or if jid
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
237 is ".", the current buddy is used.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
238
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
239 /authorization allow|cancel|request|request_unsubscribe [jid]::
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
240 Manage the presence subscriptions. +
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
241 If no jid is provided, the current buddy is used.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
242
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
243 'allow';; allow the buddy to receive your presence updates
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
244 'cancel';; cancel the buddy' subscription to your presence updates
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
245 'request';; request a subscription to the buddy's presence updates
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
246 'request_unsubscribe';; request unsubscription from the buddy's presence updates
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
247
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
248 /del::
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
249 Delete the current buddy from our roster, unsubscribe from its presence
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
250 notification and unsubscribe it from ours.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
251
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
252 /group fold|unfold|toggle::
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
253 The 'group' command changes the current group display.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
254
637
aff6df4b408b Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 630
diff changeset
255 'fold';; fold (shrink) the current group tree in the roster
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
256 'unfold';; unfold (expand) the current group tree in the roster
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
257 'toggle';; toggle the state (fold/unfold) of the current tree
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
258
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
259 /info::
440
264f40222872 Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents: 436
diff changeset
260 Display info on the selected entry (user, agent, group...). +
264f40222872 Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents: 436
diff changeset
261 For users, resources are displayed with the status, priority and
264f40222872 Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents: 436
diff changeset
262 status message (if available) of each resource.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
263
210
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
264 /move [groupname]::
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
265 Move the current buddy to the requested group. If no group is
623
7d9841ea20d8 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 618
diff changeset
266 specified, then the buddy is moved to the default group. +
506
74dcd0df532e "/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents: 497
diff changeset
267 Tip: if the chatmode is enabled, you can use "/roster alternate"
74dcd0df532e "/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents: 497
diff changeset
268 to jump to the moved buddy.
210
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
269
839
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
270 /msay begin|verbatim|send|send_to|toggle|toggle_verbatim|abort::
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
271 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
272 lines, the 'multi-line mode' should be used. +
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
273 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
274 line will be added to the multi-line message. Once the message is
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
275 finished, it can be sent to the current selected buddy with the "/msay
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
276 send" command. +
810
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
277 The 'begin' subcommand enables multi-line mode. Note that it allows
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
278 a message subject to be specified. +
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
279 The 'verbatim' multi-line mode disables commands, so that it is
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
280 possible to enter lines starting with a slash. Only the "/msay"
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
281 command (with send or abort parameters) can be used to exit verbatim
799
7362ed14dee0 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 788
diff changeset
282 mode. +
839
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
283 The 'toggle' and 'toggle_verbatim' subcommands can be bound to a key to
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
284 use the multi-line mode quickly (for example, "bind M109 = msay toggle"
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
285 to switch using the Meta-m combination).
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
286
810
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
287 'begin' [subject];; enter multi-line mode
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
288 'verbatim';; enter verbatim multi-line mode
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
289 'send';; send the current multi-line message to the currently selected buddy
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
290 'send_to' jid;; send the current multi-line message to "jid"
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
291 'toggle';; switch to/from multi-line mode (begin/send)
839
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
292 'toggle_verbatim';; same with verbatim multi-line mode
810
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
293 'abort';; leave multi-line mode without sending the message
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
294
886
e58ae191a25c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 876
diff changeset
295 /rename name::
e58ae191a25c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 876
diff changeset
296 Rename current buddy or group to the given name.
e58ae191a25c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 876
diff changeset
297 Please note that a group name change is only done when the server's
e58ae191a25c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 876
diff changeset
298 acknowledgment is received, so a slight delay can be noticed.
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
299
700
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 674
diff changeset
300 /request time|version [jid]::
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 674
diff changeset
301 Send a "IQ" query to the current buddy, or to the specified Jabber
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 674
diff changeset
302 user. If the resource is not provided with the jid, mcabber will
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 674
diff changeset
303 send the query to all known resources for this user.
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 674
diff changeset
304
601
803973541c22 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 593
diff changeset
305 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy::
593
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
306 /room invite|kick|ban|role|affil::
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
307 The 'room' command handles Multi-User Chat room actions.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
308
901
45ddb3ada74f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 886
diff changeset
309 '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.
487
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
310 'leave' [message];; leave the current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
311 'names';; display members of the current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
312 'nick' nick;; change your nickname in the current room
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
313 'privmsg' nick msg;; send private message "msg" to "nick"
487
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
314 'remove';; remove the current room from the roster (you must have left this room before)
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
315 'topic';; set topic for current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
316 'unlock';; unlock current room (if you are the owner)
601
803973541c22 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 593
diff changeset
317 'destroy' [reason];; destroy the current room (use with care!)
573
4df43fcdabc4 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 545
diff changeset
318 'whois' nick;; display MUC information about "nick"
593
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
319 'ban' jid [reason];; ban jid from the current room
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
320 'invite' jid [reason];; invite jid to the current room
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
321 'kick' nick [reason];; kick "nick" from the current room
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
322 'role' jid role [reason];; change jid's role (role can be "none", "visitor", "participant", "moderator")
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
323 'affil' jid affil [reason];; change jid's affiliation (affil can be "none", "member", "admin", "owner")
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
324
330
a9013124ede6 Add "/roster alternate"
Mikael Berthe <mikael@lilotux.net>
parents: 320
diff changeset
325 /roster bottom|top|hide_offline|show_offline|toggle_offline::
710
0311d7e2bb1c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 700
diff changeset
326 /roster hide|show|toggle::
330
a9013124ede6 Add "/roster alternate"
Mikael Berthe <mikael@lilotux.net>
parents: 320
diff changeset
327 /roster alternate|unread_first|unread_next::
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
328 /roster search bud::
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
329 The 'roster' command manipulates the roster/buddylist. Here are the available parameters:
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
330
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
331 'bottom';; jump to the bottom of the roster
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
332 'top';; jump to the top of the roster
377
00809e3e327e Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents: 372
diff changeset
333 'up';; move up in the roster
00809e3e327e Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents: 372
diff changeset
334 'down';; move down in the roster
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
335 'hide_offline';; hide offline buddies
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
336 'show_offline';; show offline buddies
290
f63839a4cb35 Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents: 289
diff changeset
337 'toggle_offline';; toggle display of offline buddies
710
0311d7e2bb1c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 700
diff changeset
338 'hide';; hide roster (full-width chat window)
0311d7e2bb1c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 700
diff changeset
339 'show';; show roster
0311d7e2bb1c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 700
diff changeset
340 'toggle';; toggle roster visibility
916
0032c43431df Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 913
diff changeset
341 'search' bud;; search for a buddy with a name or jid containing "bud" (only in the displayed buddylist)
330
a9013124ede6 Add "/roster alternate"
Mikael Berthe <mikael@lilotux.net>
parents: 320
diff changeset
342 '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_first")
236
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 234
diff changeset
343 'unread_first';; jump to the first unread message
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 234
diff changeset
344 'unread_next';; jump to the next unread message
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
345
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
346 /say text::
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
347 Send the "text" message to the currently selected buddy. Can be useful
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
348 if you want to send a message beginning with a slash, for example.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
349
480
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
350 /say_to jid text::
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
351 Send the "text" message to the specified jid.
480
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
352 Please note that this command doesn't set the default resource for
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
353 a contact, so if you want to send several messages to a specific
916
0032c43431df Update manpage
Mikael Berthe <mikael@lilotux.net>
parents: 913
diff changeset
354 resource you will have to use "/say_to" for each message.
480
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
355
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
356 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]]::
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
357 Show or set the current status. +
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
358 If no status is specified, display the current status. +
320
dce1dd4d0ca8 Update documentation for "/status status message"
Mikael Berthe <mikael@lilotux.net>
parents: 310
diff changeset
359 If a status message is specified, it will overrride the message*
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
360 variables (these variables can be set in the configuration file).
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
361 If no relevant message* variable is set and no status message provided,
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
362 the current status message is kept. If StatusMessage is "-", the
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
363 current status message is cleared.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
364
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
365 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]::
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
366 Send the requested status to the specified Jabber user. +
660
ef7f0b58a159 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 639
diff changeset
367 If the specified jid is ".", the current buddy is used. +
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
368 Note: this status will be overridden by subsequent "/status" commands.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
369 If you are using the auto-away feature, the status will overridden
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
370 too. +
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
371 Note: The jid can include a resource (i.e. user@server/resource).
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
372
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
373 CONFIGURATION FILE
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
374 ------------------
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
375 See the provided sample configuration file, which should be self-documenting.
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
376
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
377 FILES
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
378 -----
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
379 The following files can be used by `mcabber(1)`:
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
380
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
381 $HOME/.mcabber/mcabberrc Default configuration file
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
382 $HOME/.mcabberrc Configuration file used if no other has been found
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
383 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
384
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
385 BUGS
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
386 ----
349
3f5e7962bb47 A lot of bugs? No! ;-)
Mikael Berthe <mikael@lilotux.net>
parents: 347
diff changeset
387 Certainly. Please tell me if you find one! :-)
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
388
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
389 AUTHOR
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
390 ------
222
882029ebd052 [/trunk] Changeset 234 by mikael
mikael
parents: 210
diff changeset
391 Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. +
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
392 Originally based on http://cabber.sourceforge.net[Cabber], please
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
393 consult the AUTHORS file for details.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
394
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
395 RESOURCES
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
396 ---------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
397 http://www.lilotux.net/~mikael/mcabber/[Main web site]
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
398
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
399 COPYING
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
400 -------
700
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 674
diff changeset
401 Copyright (C) 2005, 2006 Mikael Berthe. +
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
402 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[].
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
403
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
404 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
405 License (GPL).
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
406