annotate mcabber/doc/mcabber.1.txt @ 202:9bdc6d9996f6

[/trunk] Changeset 214 by mikael * Improve AsciiDoc
author mikael
date Sat, 07 May 2005 15:37:25 +0000
parents f042a2400809
children 5ff01a4a38b6
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 -----------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
16 `mcabber(1)` is a small Jabber console client with (optional) SSL support. +
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
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
18 mcabberrc file and update your connection options.
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
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
25 Commands completion. If possible, `mcabber(1)` will try to complete your
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
26 commands line if you hit the Tab key.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
27
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
28 Chat mode. When 'chat mode' is enabled, the buddies chat buffers are
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
29 displayed. Otherwise, the chat window is empty. You can enter chat mode by
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
30 pressing enter, and leave chat mode with the ESC key. Sending a message also
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
31 enables chat mode implicitly.
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
32
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
33 History logging. If enabled (see the CONFIGURATION FILE section),
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
34 `mcabber(1)` can save discussions to history log files.
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
35
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
36 External actions. Some 'events' (like receiving a message) can trigger an
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
37 external action, for example a shell script (you need to enable it in your
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
38 configuration file).
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
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
81 request to this buddy
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::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
92 The 'clear' command is an alias for "/buffer clear".
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
93
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
94 /group expand|shrink|toggle::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
95 The 'group' command changes the group display settings.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
96
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
97 'expand';; expand the current group tree in the roster (syn: 'unfold')
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
98 'shrink';; shrink the current group tree in the roster (syn: 'fold')
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
99 'toggle';; toggle the fold/unfold state of the current tree
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
100
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
101 /info::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
102 Display info on the selected entry (user, agent, group...)
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
103
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
104 /quit::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
105 Disconnect and leave `mcabber(1)`
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
106
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
107 /roster hide_offline|show_offline|top|bottom::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
108 The 'roster' command manipulates the roster/buddylist.
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
109
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
110 'hide_offline';; hide offline buddies
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
111 'show_offline';; show offline buddies
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
112 'top';; jump to the top of the roster
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
113 'bottom';; jump to the bottom of the roster
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
114
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
115 /say text::
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
116 Send the text message to the currently selected buddy. Can be useful
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
117 if you want to send a message beginning with a slash, for example.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
118
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
119 /status [online|avail|invisible|free|dnd|busy|notavail|away]::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
120 Set the current status. If no status is specified, display the
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
121 current status.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
122
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
123 CONFIGURATION FILE
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
124 ------------------
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
125 See the provided sample configuration file, which should be self-documented.
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
126
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
127 FILES
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
128 -----
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
129 The following files can be used by `mcabber(1)`:
200
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
130
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
131 $HOME/.mcabber/mcabberrc Default configuration file
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
132 $HOME/.mcabberrc Configuration file used if no other has been found
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
133 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
f042a2400809 [/trunk] Changeset 212 by mikael
mikael
parents: 199
diff changeset
134
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
135 BUGS
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
136 ----
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
137 Certainly a lot. Please tell me if you find one! :-)
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
138
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
139 AUTHOR
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
140 ------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
141 Written by mailto:bmikael@lists.ilotux.ne[Mikael BERTHE]. +
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
142 Originally based on cabber
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
143 (http://cabber.sourceforge.net[Cabber homepage]), please
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
144 consult the AUTHORS file for details.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
145
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
146 RESOURCES
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
147 ---------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
148 http://www.lilotux.net/~mikael/mcabber/[Main web site]
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
149
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
150 COPYING
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
151 -------
202
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
152 Copyright (C) 2005 Mikael Berthe. +
9bdc6d9996f6 [/trunk] Changeset 214 by mikael
mikael
parents: 200
diff changeset
153 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[].
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
154
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
155 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
156 License (GPL).
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
157