|
198
|
1 MCABBER(1)
|
|
|
2 ===========
|
|
|
3 Mikael BERTHE <bmikael@lists.lilotux.net>
|
|
|
4 May 2005
|
|
|
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 -----------
|
|
200
|
16 'mcabber'(1) is a small Jabber console client.
|
|
|
17 For now it needs a configuration file to start, so please copy the sample
|
|
|
18 mcabberrc file and update your connection options.
|
|
|
19
|
|
|
20 The mcabber(1) screen is divided into 4 regions.
|
|
|
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
|
|
|
25 Commands completion. If possible, mcabber(1) will try to complete your
|
|
|
26 commands line if you hit the Tab key.
|
|
|
27
|
|
|
28 Chat mode. When 'chat mode' is enabled, the buddies chat buffers are
|
|
|
29 displayed. Otherwise, the chat window is empty. You can enter chat mode by
|
|
|
30 pressing enter, and leave chat mode with the ESC key. Sending a message also
|
|
|
31 enables chat mode implicitly.
|
|
|
32
|
|
|
33 History logging. If enabled (see the CONFIGURATION FILE section), mcabber(1)
|
|
|
34 can save discussions to history log files.
|
|
|
35
|
|
|
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).
|
|
|
39
|
|
|
40 OPTIONS
|
|
|
41 -------
|
|
|
42 --help, -h::
|
|
|
43 Quick help usage message
|
|
|
44
|
|
|
45 -f configfile::
|
|
|
46 Use configuration file 'configfile'
|
|
|
47
|
|
|
48 KEYS
|
|
|
49 ----
|
|
|
50
|
|
|
51 Text typing happens in the 'input line'; basic operations are supported (left
|
|
|
52 arrow, right arrow, home/end keys, insert, delete, backspace...).
|
|
|
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
|
|
|
74 Ctrl-q:: Jump to the next unread message (Not yet implemented)
|
|
198
|
75
|
|
199
|
76 COMMANDS
|
|
|
77 --------
|
|
|
78
|
|
|
79 /add jid::
|
|
|
80 Add the 'jid' Jabber user to our roster, and send a notification
|
|
|
81 request to this buddy
|
|
|
82
|
|
|
83 /buffer clear|top|bottom::
|
|
|
84 The 'buffer' command manipulates the current buddy's buffer
|
|
|
85 (chat window).
|
|
|
86
|
|
|
87 clear: clear the current buddy chat window
|
|
|
88
|
|
|
89 top: jump to the top of the current buddy chat buffer
|
|
|
90
|
|
|
91 bottom: jump to the bottom of the current buddy chat buffer
|
|
|
92
|
|
|
93 /clear::
|
|
|
94 The 'clear' command is an alias for "/buffer clear".
|
|
|
95
|
|
|
96 /group expand|shrink|toggle::
|
|
|
97 The 'group' command changes the group display settings.
|
|
|
98
|
|
|
99 expand: expand (unfold) the current group tree in the roster
|
|
|
100
|
|
|
101 shrink: shrink (fold) the current group tree in the roster
|
|
|
102
|
|
|
103 toggle: toggle the fold/unfold state of the current tree
|
|
|
104
|
|
|
105 Note: the "fold" and "unfold" keywords are accepted.
|
|
|
106
|
|
|
107 /info::
|
|
|
108 Display info on the selected entry (user, agent, group...)
|
|
|
109
|
|
|
110 /quit::
|
|
|
111 Disconnect and leave mcabber(1)
|
|
|
112
|
|
|
113 /roster hide_offline|show_offline|top|bottom::
|
|
|
114 The 'roster' command manipulates the roster/buddylist.
|
|
|
115
|
|
|
116 hide_offline: hide offline buddies
|
|
|
117
|
|
|
118 show_offline: show offline buddies
|
|
|
119
|
|
|
120 top: jump to the top of the roster
|
|
|
121
|
|
|
122 bottom: jump to the bottom of the roster
|
|
|
123
|
|
|
124 /say text::
|
|
|
125 Send the text message to the currently selected buddy. Can be useful
|
|
|
126 if you want to send a message beginning with a slash, for example.
|
|
|
127
|
|
|
128 /status [online|avail|invisible|free|dnd|busy|notavail|away]::
|
|
|
129 Set the current status. If no status is specified, display the
|
|
|
130 current status.
|
|
|
131
|
|
|
132 CONFIGURATION FILE
|
|
|
133 ------------------
|
|
|
134 See the provided sample configuration file, which should be self-documented.
|
|
198
|
135
|
|
200
|
136 FILES
|
|
|
137 -----
|
|
|
138 The following files can be used by mcabber(1):
|
|
|
139
|
|
|
140 $HOME/.mcabber/mcabberrc Default configuration file
|
|
|
141 $HOME/.mcabberrc Configuration file used if no other has been found
|
|
|
142 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
|
|
|
143
|
|
198
|
144 BUGS
|
|
|
145 ----
|
|
|
146 Certainly a lot.
|
|
|
147
|
|
|
148 AUTHOR
|
|
|
149 ------
|
|
|
150 Written by Mikael BERTHE, <bmikael@lists.ilotux.net>.
|
|
|
151 Originally based on cabber (see <http://cabber.sourceforge.net>), please
|
|
|
152 consult the AUTHORS file for details.
|
|
|
153
|
|
|
154 RESOURCES
|
|
|
155 ---------
|
|
|
156 Main web site: http://www.lilotux.net/~mikael/mcabber/
|
|
|
157
|
|
|
158 COPYING
|
|
|
159 -------
|
|
|
160 Copyright (C) 2005 Mikael Berthe.
|
|
|
161 Some portions are Copyright (C) 2002-2004 <cabber@ajmacias.com>.
|
|
|
162
|
|
|
163 Free use of this software is granted under the terms of the GNU General Public
|
|
|
164 License (GPL).
|
|
|
165
|
