198
|
1 MCABBER(1)
|
|
2 ===========
|
222
|
3 Mikael BERTHE <mcabber@lilotux.net>
|
254
|
4 v0.6.2, June 2005
|
198
|
5
|
|
6 NAME
|
|
7 ----
|
200
|
8 mcabber - a simple Jabber console client
|
198
|
9
|
|
10 SYNOPSIS
|
|
11 --------
|
|
12 'mcabber' [ -f configfile ] [ --help | -h ]
|
|
13
|
|
14 DESCRIPTION
|
|
15 -----------
|
204
|
16 `mcabber(1)` is a small Jabber console client. +
|
200
|
17 For now it needs a configuration file to start, so please copy the sample
|
208
|
18 mcabberrc file and adapt your connection settings.
|
200
|
19
|
202
|
20 The `mcabber(1)` screen is divided into 4 regions.
|
200
|
21 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat
|
|
22 buffer, is on the right. The 'input line' lies at the bottom of the screen,
|
|
23 under a small 'log window'.
|
|
24
|
204
|
25 To display buddies chat buffers, you will have to enter 'chat mode'.
|
|
26 You can enter chat mode by pressing enter, and leave chat mode with the ESC
|
229
|
27 key. Simply sending a message will also enable chat mode.
|
204
|
28
|
|
29 Here are some of the features of `mcabber`:
|
200
|
30
|
204
|
31 - 'SSL support'.
|
|
32 - 'History logging:' If enabled (see the CONFIGURATION FILE section),
|
|
33 `mcabber(1)` can save discussions to history log files.
|
|
34 - 'Commands completion:' If possible, `mcabber(1)` will try to complete your
|
229
|
35 command line if you hit the Tab key.
|
204
|
36 - 'External actions:' Some events (like receiving a message) can trigger an
|
|
37 external action, for example a shell script (you need to enable it in your
|
|
38 configuration file).
|
200
|
39
|
|
40 OPTIONS
|
|
41 -------
|
|
42 --help, -h::
|
202
|
43 Quick help usage message
|
200
|
44
|
|
45 -f configfile::
|
202
|
46 Use configuration file 'configfile'
|
200
|
47
|
|
48 KEYS
|
|
49 ----
|
|
50
|
229
|
51 Text typing occurs in the 'input line'; basic operations are supported
|
|
52 (left arrow, right arrow, home/end keys, insert, delete, backspace...).
|
200
|
53
|
|
54 PageUp and PageDown keys are used to move in the roster.
|
|
55
|
|
56 To send a message, move to the choosen buddy in the buddylist, type your
|
|
57 message and hit enter. If the line begins with a slash, this will be
|
|
58 interpreted as a command (see the COMMAND section below). Hit escape to
|
|
59 leave the chat mode.
|
|
60
|
|
61 Here is a quick description of the key bindings:
|
|
62
|
|
63 Ctrl-a:: Go to the beginning of the input line
|
|
64 Ctrl-e:: Go to the end of the input line
|
|
65 Ctrl-l:: Force a resize
|
|
66 PgUp/PgDown:: Move inside the roster (buddylist)
|
|
67 Tab:: Complete current word, in the input line
|
|
68 Ctrl-g:: Cancel completion / ctrl-g
|
|
69 Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode)
|
|
70 Ctrl-u:: Delete from beginning of the line to the cursor
|
|
71 Ctrl-k:: Delete from the cursor to the end of line
|
|
72 Ctrl-w:: Backward kill word
|
|
73 Ctrl-t:: Transpose chars
|
236
|
74 Ctrl-q:: Jump to the next unread message
|
198
|
75
|
199
|
76 COMMANDS
|
|
77 --------
|
|
78
|
245
|
79 /add jid [nickname]::
|
|
80 Add the 'jid' Jabber user to our roster (default group), and send a
|
|
81 notification request to this buddy. If no nickname is specified, the
|
|
82 jid is used.
|
199
|
83
|
|
84 /buffer clear|top|bottom::
|
202
|
85 The 'buffer' command manipulates the current buddy's buffer
|
|
86 (chat window).
|
199
|
87
|
202
|
88 'clear';; clear the current buddy chat window
|
|
89 'top';; jump to the top of the current buddy chat buffer
|
|
90 'bottom';; jump to the bottom of the current buddy chat buffer
|
199
|
91
|
|
92 /clear::
|
206
|
93 The 'clear' command is actually an alias for "/buffer clear".
|
199
|
94
|
205
|
95 /del::
|
|
96 Delete the current buddy from our roster, unsubscribe from its presence
|
|
97 notification and unsubscribe it from ours.
|
|
98
|
240
|
99 /group fold|unfold|toggle::
|
|
100 The 'group' command changes the current group display.
|
199
|
101
|
240
|
102 'fold';; fold (shrink) the current group tree in the roster
|
|
103 'unfold';; unfold (expand) the current group tree in the roster
|
|
104 'toggle';; toggle the state (fold/unfold) of the current tree
|
199
|
105
|
|
106 /info::
|
208
|
107 Display info on the selected entry (user, agent, group...).
|
199
|
108
|
210
|
109 /move [groupname]::
|
|
110 Move the current buddy to the requested group. If no group is
|
|
111 specified, then the buddy is moved to the default group.
|
229
|
112 This command only works with users (not agents), at the moment.
|
210
|
113
|
238
|
114 /msay begin|send|abort::
|
|
115 Send a multi-line message. To write a single message with several
|
|
116 lines, the 'multi-line mode' should be used. In multi-line mode,
|
|
117 each line (except command lines) typed in the input line will
|
|
118 be added to the multi-line message. Once the message is finished, it
|
|
119 can be sent to the current selected buddy with the "msay /send"
|
|
120 command.
|
|
121
|
|
122 'begin';; enter multi-line mode
|
|
123 'send';; send the current multi-line message to the currently selected buddy
|
|
124 'abort';; leave multi-line mode without sending the message
|
|
125
|
199
|
126 /quit::
|
208
|
127 Disconnect and leave `mcabber(1)`.
|
|
128
|
|
129 /rename nickname::
|
|
130 Rename current buddy to the given nickname.
|
229
|
131 This command does not work for groups, at the moment (but you can move
|
210
|
132 the buddies to another group with the /move command).
|
199
|
133
|
|
134 /roster hide_offline|show_offline|top|bottom::
|
202
|
135 The 'roster' command manipulates the roster/buddylist.
|
199
|
136
|
202
|
137 'hide_offline';; hide offline buddies
|
|
138 'show_offline';; show offline buddies
|
|
139 'top';; jump to the top of the roster
|
|
140 'bottom';; jump to the bottom of the roster
|
236
|
141 'unread_first';; jump to the first unread message
|
|
142 'unread_next';; jump to the next unread message
|
199
|
143
|
|
144 /say text::
|
202
|
145 Send the text message to the currently selected buddy. Can be useful
|
199
|
146 if you want to send a message beginning with a slash, for example.
|
|
147
|
|
148 /status [online|avail|invisible|free|dnd|busy|notavail|away]::
|
|
149 Set the current status. If no status is specified, display the
|
|
150 current status.
|
|
151
|
|
152 CONFIGURATION FILE
|
|
153 ------------------
|
|
154 See the provided sample configuration file, which should be self-documented.
|
198
|
155
|
200
|
156 FILES
|
|
157 -----
|
202
|
158 The following files can be used by `mcabber(1)`:
|
200
|
159
|
|
160 $HOME/.mcabber/mcabberrc Default configuration file
|
|
161 $HOME/.mcabberrc Configuration file used if no other has been found
|
|
162 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
|
|
163
|
198
|
164 BUGS
|
|
165 ----
|
202
|
166 Certainly a lot. Please tell me if you find one! :-)
|
198
|
167
|
|
168 AUTHOR
|
|
169 ------
|
222
|
170 Written by mailto:mcabber@lilotux.net[Mikael BERTHE]. +
|
204
|
171 Originally based on http://cabber.sourceforge.net[Cabber], please
|
198
|
172 consult the AUTHORS file for details.
|
|
173
|
|
174 RESOURCES
|
|
175 ---------
|
202
|
176 http://www.lilotux.net/~mikael/mcabber/[Main web site]
|
198
|
177
|
|
178 COPYING
|
|
179 -------
|
202
|
180 Copyright (C) 2005 Mikael Berthe. +
|
|
181 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[].
|
198
|
182
|
|
183 Free use of this software is granted under the terms of the GNU General Public
|
|
184 License (GPL).
|
|
185
|