annotate mcabber/doc/mcabber.1.txt @ 573:4df43fcdabc4

Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Sat, 03 Dec 2005 23:53:44 +0100
parents 9b6e3e5779b0
children 29d9a54ac69f
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>
545
9b6e3e5779b0 Post-0.7.1 changes
Mikael Berthe <mikael@lilotux.net>
parents: 543
diff changeset
4 v0.7.2-dev, November 2005
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
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
23 The `mcabber(1)` screen is divided into 4 regions.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
24 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
25 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
26 under a small 'log window'.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
27
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
28 To display buddies chat buffers, you will have to enter 'chat mode'.
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
29 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
30 key. Simply sending a message will also enable chat mode.
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
31
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
32 Here are some of the features of `mcabber`:
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
33
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
34 - 'SSL support'.
467
73aa14eba3c7 Update manual
Mikael Berthe <mikael@lilotux.net>
parents: 465
diff changeset
35 - 'MUC support' (Multi-User Chat).
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
36 - 'History logging:' If enabled (see the CONFIGURATION FILE section),
432
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 423
diff changeset
37 `mcabber` can save discussions to history log files.
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 423
diff changeset
38 - 'Commands completion:' If possible, `mcabber` will try to complete your
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
39 command line if you hit the Tab key.
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
40 - 'External actions:' Some events (like receiving a message) can trigger an
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
41 external action, for example a shell script (you need to enable it in your
432
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 423
diff changeset
42 configuration file). A sample events script ("eventcmd") is provided with
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 423
diff changeset
43 `mcabber` source code, in the contrib directory.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
44
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
45 OPTIONS
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
46 -------
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
47 --help, -h::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
48 Quick help usage message
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
49
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
50 -f configfile::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
51 Use configuration file 'configfile'
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
52
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
53 KEYS
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
54 ----
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
55
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
56 Text typing occurs in the 'input line'; basic operations are supported
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
57 (left arrow, right arrow, home/end keys, insert, delete, backspace...).
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
58
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
59 PageUp and PageDown keys are used to move in the roster.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
60
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
61 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
62 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
63 interpreted as a command (see the COMMAND section below). Hit escape to
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
64 leave the chat mode.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
65
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
66 Here is a quick description of the key bindings:
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
67
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
68 Ctrl-a:: Go to the beginning of the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
69 Ctrl-e:: Go to the end of the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
70 Ctrl-l:: Force a resize
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
71 PgUp/PgDown:: Move inside the roster (buddylist)
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
72 Tab:: Complete current word, in the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
73 Ctrl-g:: Cancel completion / ctrl-g
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
74 Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode)
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
75 Ctrl-u:: Delete from beginning of the line to the cursor
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
76 Ctrl-k:: Delete from the cursor to the end of line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
77 Ctrl-w:: Backward kill word
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
78 Ctrl-t:: Transpose chars
263
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
79 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
80 Ctrl-q:: Jump to the next unread message
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
81
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
82 COMMANDS
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
83 --------
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
84
245
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
85 /add jid [nickname]::
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
86 Add the "jid" Jabber user to our roster (default group), and send a
245
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
87 notification request to this buddy. If no nickname is specified, the
7ca7ca850270 [/trunk] Changeset 258 by mikael
mikael
parents: 240
diff changeset
88 jid is used.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
89
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
90 /alias name = command line::
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
91 Add "name" as an alias for "command line". +
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
92 Aliases are expanded only once, thus they can not be chained. +
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
93 "/alias name" displays the value associated with the "name" alias;
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
94 "/alias name =" unsets the "name" alias. +
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
95 Example: "/alias away = status away".
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
96
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
97 /bind keycode = command line::
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
98 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
99 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
100 when pressing the key, for example "Unknown key=265". +
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
101 "/bind keycode" displays the command line bound to the given keycode;
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
102 "/bind keycode" unbinds the given keycode. +
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
103 Note: aliases can be used in key bindings. +
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
104 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
105 depend on your ncurses installation).
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
106
465
52171a3dc199 Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents: 450
diff changeset
107 /buffer clear|top|bottom|search_backward|search_forward|date|%::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
108 The 'buffer' command manipulates the current buddy's buffer
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
109 (chat window).
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
110
465
52171a3dc199 Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents: 450
diff changeset
111 'clear';; clear the current buddy chat window
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 506
diff changeset
112 '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
113 'top';; jump to the top of the current buddy chat buffer
511
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 506
diff changeset
114 'up' [n];; scroll the buffer up n lines (default: half a screen)
c7cdb9c6d7aa Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 506
diff changeset
115 'down' [n];; scroll the buffer down n lines (default: half a screen)
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
116 '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
117 'search_forward' text;; search for "text" in the current buddy chat buffer
465
52171a3dc199 Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents: 450
diff changeset
118 '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)
52171a3dc199 Update manual page (/buffer command)
Mikael Berthe <mikael@lilotux.net>
parents: 450
diff changeset
119 '%' n;; jump to position %n of the buddy chat buffer
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
120
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
121 /clear::
206
766167c0c57f [/trunk] Changeset 218 by mikael
mikael
parents: 205
diff changeset
122 The 'clear' command is actually an alias for "/buffer clear".
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
123
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
124 /connect::
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
125 Establish connection to the Jabber server.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
126
205
e01bf6d9b4b8 [/trunk] Changeset 217 by mikael
mikael
parents: 204
diff changeset
127 /del::
e01bf6d9b4b8 [/trunk] Changeset 217 by mikael
mikael
parents: 204
diff changeset
128 Delete the current buddy from our roster, unsubscribe from its presence
e01bf6d9b4b8 [/trunk] Changeset 217 by mikael
mikael
parents: 204
diff changeset
129 notification and unsubscribe it from ours.
e01bf6d9b4b8 [/trunk] Changeset 217 by mikael
mikael
parents: 204
diff changeset
130
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
131 /disconnect::
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
132 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
133 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
134 buddylist is empty when disconnected.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
135
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
136 /group fold|unfold|toggle::
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
137 The 'group' command changes the current group display.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
138
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
139 'fold';; fold (shrink) the current group tree in the roster
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
140 'unfold';; unfold (expand) the current group tree in the roster
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
141 'toggle';; toggle the state (fold/unfold) of the current tree
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
142
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
143 /info::
440
264f40222872 Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents: 436
diff changeset
144 Display info on the selected entry (user, agent, group...). +
264f40222872 Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents: 436
diff changeset
145 For users, resources are displayed with the status, priority and
264f40222872 Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents: 436
diff changeset
146 status message (if available) of each resource.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
147
210
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
148 /move [groupname]::
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
149 Move the current buddy to the requested group. If no group is
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
150 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
151 This command only works with users (not agents), at the moment. +
74dcd0df532e "/move" does not jump to the buddy in the new group
Mikael Berthe <mikael@lilotux.net>
parents: 497
diff changeset
152 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
153 to jump to the moved buddy.
210
f64818ba3503 [/trunk] Changeset 222 by mikael
mikael
parents: 208
diff changeset
154
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
155 /msay begin|verbatim|send|abort::
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
156 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
157 lines, the 'multi-line mode' should be used. +
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
158 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
159 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
160 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
161 send" command. +
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
162 The 'verbatim' multi-line mode disables commands, so that it is
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
163 possible to enter lines starting with a slash. Only the "/msay"
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
164 command (with send or abort parameters) can be used to exit verbatim
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
165 mode.
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
166
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
167 'begin';; enter multi-line mode
260
33e1a05864a6 Add "verbatim multi-line" mode, with commands disabled
mikael@frmp8452
parents: 254
diff changeset
168 'verbatim';; enter verbatim multi-line mode
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
169 'send';; send the current multi-line message to the currently selected buddy
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
170 'abort';; leave multi-line mode without sending the message
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
171
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
172 /quit::
208
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
173 Disconnect and leave `mcabber(1)`.
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
174
436
802da817a684 Add /rawxml command
Mikael Berthe <mikael@lilotux.net>
parents: 434
diff changeset
175 /rawxml send::
802da817a684 Add /rawxml command
Mikael Berthe <mikael@lilotux.net>
parents: 434
diff changeset
176 '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.
802da817a684 Add /rawxml command
Mikael Berthe <mikael@lilotux.net>
parents: 434
diff changeset
177
208
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
178 /rename nickname::
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
179 Rename current buddy to the given nickname.
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 222
diff changeset
180 This command does not work for groups, at the moment (but you can move
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
181 the buddies to another group with the "/move" command).
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
182
573
4df43fcdabc4 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 545
diff changeset
183 /room join|leave|names|nick|privmsg|remove|topic|unlock::
4df43fcdabc4 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 545
diff changeset
184 /room invite|kick|ban::
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
185 The 'room' command handles Multi-User Chat room actions.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
186
573
4df43fcdabc4 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 545
diff changeset
187 'ban' jid [reason];; ban jid from the current room
487
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
188 'invite' jid [reason];; invite jid to the current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
189 'join' room nick;; join "room", using "nick" as nickname
573
4df43fcdabc4 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 545
diff changeset
190 'kick' nick [reason];; kick "nick" from the current room
487
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
191 'leave' [message];; leave the current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
192 'names';; display members of the current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
193 'nick' nick;; change your nickname in the current room
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
194 'privmsg' nick msg;; send private message "msg" to "nick"
487
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
195 '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
196 'topic';; set topic for current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
197 'unlock';; unlock current room (if you are the owner)
573
4df43fcdabc4 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 545
diff changeset
198 'whois' nick;; display MUC information about "nick"
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
199
330
a9013124ede6 Add "/roster alternate"
Mikael Berthe <mikael@lilotux.net>
parents: 320
diff changeset
200 /roster bottom|top|hide_offline|show_offline|toggle_offline::
a9013124ede6 Add "/roster alternate"
Mikael Berthe <mikael@lilotux.net>
parents: 320
diff changeset
201 /roster alternate|unread_first|unread_next::
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
202 /roster search bud::
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
203 The 'roster' command manipulates the roster/buddylist. Here are the available parameters:
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
204
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
205 'bottom';; jump to the bottom of the roster
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
206 '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
207 'up';; move up in the roster
00809e3e327e Add "/roster up" and "/roster down"
Mikael Berthe <mikael@lilotux.net>
parents: 372
diff changeset
208 'down';; move down in the roster
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
209 'hide_offline';; hide offline buddies
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
210 'show_offline';; show offline buddies
290
f63839a4cb35 Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents: 289
diff changeset
211 'toggle_offline';; toggle display of offline buddies
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
212 'search' bud;; search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist)
330
a9013124ede6 Add "/roster alternate"
Mikael Berthe <mikael@lilotux.net>
parents: 320
diff changeset
213 '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
214 'unread_first';; jump to the first unread message
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 234
diff changeset
215 'unread_next';; jump to the next unread message
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
216
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
217 /say text::
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
218 Send the "text" message to the currently selected buddy. Can be useful
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
219 if you want to send a message beginning with a slash, for example.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
220
480
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
221 /say_to jid text::
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
222 Send the "text" message to the specified jid.
480
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
223 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
224 a contact, so if you want to send several messages to a specific
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
225 ressource you will have to use "/say_to" for each message.
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
226
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
227 /status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]]::
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
228 Show or set the current status. +
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
229 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
230 If a status message is specified, it will overrride the message*
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
231 variables (these variables can be set in the configuration file).
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
232 If no relevant message* variable is set and no status message provided,
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
233 the current status message is kept. If StatusMessage is "-", the
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
234 current status message is cleared.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
235
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
236 /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]::
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
237 Send the requested status to the specified Jabber user. +
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
238 Note: this status will be overridden by subsequent "/status" commands.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
239 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
240 too. +
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
241 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
242
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
243 CONFIGURATION FILE
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
244 ------------------
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
245 See the provided sample configuration file, which should be self-documented.
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
246
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
247 FILES
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
248 -----
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
249 The following files can be used by `mcabber(1)`:
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
250
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
251 $HOME/.mcabber/mcabberrc Default configuration file
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
252 $HOME/.mcabberrc Configuration file used if no other has been found
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
253 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
254
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
255 BUGS
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
256 ----
349
3f5e7962bb47 A lot of bugs? No! ;-)
Mikael Berthe <mikael@lilotux.net>
parents: 347
diff changeset
257 Certainly. Please tell me if you find one! :-)
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
258
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
259 AUTHOR
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
260 ------
222
882029ebd052 [/trunk] Changeset 234 by mikael
mikael
parents: 210
diff changeset
261 Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. +
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
262 Originally based on http://cabber.sourceforge.net[Cabber], please
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
263 consult the AUTHORS file for details.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
264
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
265 RESOURCES
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
266 ---------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
267 http://www.lilotux.net/~mikael/mcabber/[Main web site]
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
268
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
269 COPYING
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
270 -------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
271 Copyright (C) 2005 Mikael Berthe. +
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
272 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[].
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
273
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
274 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
275 License (GPL).
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
276