annotate mcabber/doc/mcabber.1.txt @ 208:8b08f34922c5

[/trunk] Changeset 220 by mikael * jabglue: add jb_updatebuddy() * commands: add /rename command * documentation: small changes and updates
author mikael
date Sat, 07 May 2005 20:09:15 +0000
parents 766167c0c57f
children f64818ba3503
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 ===========
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
3 Mikael BERTHE <bmikael@lists.lilotux.net>
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
4 v0.6.0, May 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
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
20 The `mcabber(1)` screen is divided into 4 regions.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
21 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
22 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
23 under a small 'log window'.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
24
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
25 To display buddies chat buffers, you will have to enter 'chat mode'.
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
26 You can enter chat mode by pressing enter, and leave chat mode with the ESC
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
27 key. Sending a message also enables chat mode implicitly.
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
28
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
29 Here are some of the features of `mcabber`:
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
30
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
31 - 'SSL support'.
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
32 - 'History logging:' If enabled (see the CONFIGURATION FILE section),
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
33 `mcabber(1)` can save discussions to history log files.
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
34 - 'Commands completion:' If possible, `mcabber(1)` will try to complete your
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
35 commands line if you hit the Tab key.
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
36 - 'External actions:' Some events (like receiving a message) can trigger an
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
37 external action, for example a shell script (you need to enable it in your
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
38 configuration file).
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
39
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
40 OPTIONS
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
41 -------
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
42 --help, -h::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
43 Quick help usage message
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 -f configfile::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
46 Use configuration file 'configfile'
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
47
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
48 KEYS
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
49 ----
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
50
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
51 Text typing happens in the 'input line'; basic operations are supported (left
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
52 arrow, right arrow, home/end keys, insert, delete, backspace...).
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
53
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
54 PageUp and PageDown keys are used to move in the roster.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
55
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
56 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
57 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
58 interpreted as a command (see the COMMAND section below). Hit escape to
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
59 leave the chat mode.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
60
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
61 Here is a quick description of the key bindings:
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
62
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
63 Ctrl-a:: Go to the beginning of the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
64 Ctrl-e:: Go to the end of the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
65 Ctrl-l:: Force a resize
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
66 PgUp/PgDown:: Move inside the roster (buddylist)
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
67 Tab:: Complete current word, in the input line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
68 Ctrl-g:: Cancel completion / ctrl-g
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
69 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
70 Ctrl-u:: Delete from beginning of the line to the cursor
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
71 Ctrl-k:: Delete from the cursor to the end of line
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
72 Ctrl-w:: Backward kill word
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
73 Ctrl-t:: Transpose chars
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
74 Ctrl-q:: Jump to the next unread message (Not yet implemented)
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
75
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
76 COMMANDS
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
77 --------
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
78
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
79 /add jid::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
80 Add the 'jid' Jabber user to our roster, and send a notification
208
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
81 request to this buddy.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
82
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
83 /buffer clear|top|bottom::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
84 The 'buffer' command manipulates the current buddy's buffer
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
85 (chat window).
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
86
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
87 'clear';; clear the current buddy chat window
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
88 'top';; jump to the top of the current buddy chat buffer
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
89 'bottom';; jump to the bottom of the current buddy chat buffer
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
90
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
91 /clear::
206
766167c0c57f [/trunk] Changeset 218 by mikael
mikael
parents: 205
diff changeset
92 The 'clear' command is actually an alias for "/buffer clear".
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
93
205
e01bf6d9b4b8 [/trunk] Changeset 217 by mikael
mikael
parents: 204
diff changeset
94 /del::
e01bf6d9b4b8 [/trunk] Changeset 217 by mikael
mikael
parents: 204
diff changeset
95 Delete the current buddy from our roster, unsubscribe from its presence
e01bf6d9b4b8 [/trunk] Changeset 217 by mikael
mikael
parents: 204
diff changeset
96 notification and unsubscribe it from ours.
e01bf6d9b4b8 [/trunk] Changeset 217 by mikael
mikael
parents: 204
diff changeset
97
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
98 /group expand|shrink|toggle::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
99 The 'group' command changes the group display settings.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
100
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
101 'expand';; expand the current group tree in the roster (syn: 'unfold')
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
102 'shrink';; shrink the current group tree in the roster (syn: 'fold')
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
103 'toggle';; toggle the fold/unfold state of the current tree
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
104
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
105 /info::
208
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
106 Display info on the selected entry (user, agent, group...).
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
107
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
108 /quit::
208
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
109 Disconnect and leave `mcabber(1)`.
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
110
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
111 /rename nickname::
8b08f34922c5 [/trunk] Changeset 220 by mikael
mikael
parents: 206
diff changeset
112 Rename current buddy to the given nickname.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
113
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
114 /roster hide_offline|show_offline|top|bottom::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
115 The 'roster' command manipulates the roster/buddylist.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
116
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
117 'hide_offline';; hide offline buddies
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
118 'show_offline';; show offline buddies
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
119 'top';; jump to the top of the roster
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
120 'bottom';; jump to the bottom of the roster
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
121
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
122 /say text::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
123 Send the text message to the currently selected buddy. Can be useful
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
124 if you want to send a message beginning with a slash, for example.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
125
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
126 /status [online|avail|invisible|free|dnd|busy|notavail|away]::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
127 Set the current status. If no status is specified, display the
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
128 current status.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
129
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
130 CONFIGURATION FILE
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
131 ------------------
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
132 See the provided sample configuration file, which should be self-documented.
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
133
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
134 FILES
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
135 -----
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
136 The following files can be used by `mcabber(1)`:
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
137
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
138 $HOME/.mcabber/mcabberrc Default configuration file
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
139 $HOME/.mcabberrc Configuration file used if no other has been found
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
140 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
141
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
142 BUGS
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
143 ----
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
144 Certainly a lot. Please tell me if you find one! :-)
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
145
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
146 AUTHOR
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
147 ------
203
5ff01a4a38b6 [/trunk] Changeset 215 by mikael
mikael
parents: 202
diff changeset
148 Written by mailto:bmikael@lists.lilotux.net[Mikael BERTHE]. +
204
dcb5ed79f719 [/trunk] Changeset 216 by mikael
mikael
parents: 203
diff changeset
149 Originally based on http://cabber.sourceforge.net[Cabber], please
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
150 consult the AUTHORS file for details.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
151
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
152 RESOURCES
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
153 ---------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
154 http://www.lilotux.net/~mikael/mcabber/[Main web site]
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
155
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
156 COPYING
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
157 -------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
158 Copyright (C) 2005 Mikael Berthe. +
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
159 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[].
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
160
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
161 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
162 License (GPL).
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
163