Mercurial > ~mikael > mcabber > hg

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[/trunk] Changeset 214 by mikael * Improve AsciiDoc
author mikael
date Sat, 07 May 2005 15:37:25 +0000
parents f042a2400809
children 5ff01a4a38b6
comparison
equal deleted inserted replaced
201:78c645333fb7 202:9bdc6d9996f6
1 MCABBER(1) 1 MCABBER(1)
2 =========== 2 ===========
3 Mikael BERTHE <bmikael@lists.lilotux.net> 3 Mikael BERTHE <bmikael@lists.lilotux.net>
4 May 2005 4 v0.6.0, May 2005
5 5
6 NAME 6 NAME
7 ---- 7 ----
8 mcabber - a simple Jabber console client 8 mcabber - a simple Jabber console client
9 9
11 -------- 11 --------
12 'mcabber' [ -f configfile ] [ --help | -h ] 12 'mcabber' [ -f configfile ] [ --help | -h ]
13 13
14 DESCRIPTION 14 DESCRIPTION
15 ----------- 15 -----------
16 'mcabber'(1) is a small Jabber console client. 16 `mcabber(1)` is a small Jabber console client with (optional) SSL support. +
17 For now it needs a configuration file to start, so please copy the sample 17 For now it needs a configuration file to start, so please copy the sample
18 mcabberrc file and update your connection options. 18 mcabberrc file and update your connection options.
19 19
20 The mcabber(1) screen is divided into 4 regions. 20 The `mcabber(1)` screen is divided into 4 regions.
21 The 'roster', alias 'buddylist', is on the left. The 'chat window', or chat 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, 22 buffer, is on the right. The 'input line' lies at the bottom of the screen,
23 under a small 'log window'. 23 under a small 'log window'.
24 24
25 Commands completion. If possible, mcabber(1) will try to complete your 25 Commands completion. If possible, `mcabber(1)` will try to complete your
26 commands line if you hit the Tab key. 26 commands line if you hit the Tab key.
27 27
28 Chat mode. When 'chat mode' is enabled, the buddies chat buffers are 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 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 30 pressing enter, and leave chat mode with the ESC key. Sending a message also
31 enables chat mode implicitly. 31 enables chat mode implicitly.
32 32
33 History logging. If enabled (see the CONFIGURATION FILE section), mcabber(1) 33 History logging. If enabled (see the CONFIGURATION FILE section),
34 can save discussions to history log files. 34 `mcabber(1)` can save discussions to history log files.
35 35
36 External actions. Some 'events' (like receiving a message) can trigger an 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 37 external action, for example a shell script (you need to enable it in your
38 configuration file). 38 configuration file).
39 39
40 OPTIONS 40 OPTIONS
41 ------- 41 -------
42 --help, -h:: 42 --help, -h::
43 Quick help usage message 43 Quick help usage message
44 44
45 -f configfile:: 45 -f configfile::
46 Use configuration file 'configfile' 46 Use configuration file 'configfile'
47 47
48 KEYS 48 KEYS
49 ---- 49 ----
50 50
51 Text typing happens in the 'input line'; basic operations are supported (left 51 Text typing happens in the 'input line'; basic operations are supported (left
79 /add jid:: 79 /add jid::
80 Add the 'jid' Jabber user to our roster, and send a notification 80 Add the 'jid' Jabber user to our roster, and send a notification
81 request to this buddy 81 request to this buddy
82 82
83 /buffer clear|top|bottom:: 83 /buffer clear|top|bottom::
84 The 'buffer' command manipulates the current buddy's buffer 84 The 'buffer' command manipulates the current buddy's buffer
85 (chat window). 85 (chat window).
86 86
87 clear: clear the current buddy chat window 87 'clear';; clear the current buddy chat window
88 88 'top';; jump to the top of the current buddy chat buffer
89 top: jump to the top of the current buddy chat buffer 89 'bottom';; jump to the bottom of the current buddy chat buffer
90
91 bottom: jump to the bottom of the current buddy chat buffer
92 90
93 /clear:: 91 /clear::
94 The 'clear' command is an alias for "/buffer clear". 92 The 'clear' command is an alias for "/buffer clear".
95 93
96 /group expand|shrink|toggle:: 94 /group expand|shrink|toggle::
97 The 'group' command changes the group display settings. 95 The 'group' command changes the group display settings.
98 96
99 expand: expand (unfold) the current group tree in the roster 97 'expand';; expand the current group tree in the roster (syn: 'unfold')
100 98 'shrink';; shrink the current group tree in the roster (syn: 'fold')
101 shrink: shrink (fold) the current group tree in the roster 99 'toggle';; toggle the fold/unfold state of the current tree
102
103 toggle: toggle the fold/unfold state of the current tree
104
105 Note: the "fold" and "unfold" keywords are accepted.
106 100
107 /info:: 101 /info::
108 Display info on the selected entry (user, agent, group...) 102 Display info on the selected entry (user, agent, group...)
109 103
110 /quit:: 104 /quit::
111 Disconnect and leave mcabber(1) 105 Disconnect and leave `mcabber(1)`
112 106
113 /roster hide_offline|show_offline|top|bottom:: 107 /roster hide_offline|show_offline|top|bottom::
114 The 'roster' command manipulates the roster/buddylist. 108 The 'roster' command manipulates the roster/buddylist.
115 109
116 hide_offline: hide offline buddies 110 'hide_offline';; hide offline buddies
117 111 'show_offline';; show offline buddies
118 show_offline: show offline buddies 112 'top';; jump to the top of the roster
119 113 'bottom';; jump to the bottom of the roster
120 top: jump to the top of the roster
121
122 bottom: jump to the bottom of the roster
123 114
124 /say text:: 115 /say text::
125 Send the text message to the currently selected buddy. Can be useful 116 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. 117 if you want to send a message beginning with a slash, for example.
127 118
128 /status [online|avail|invisible|free|dnd|busy|notavail|away]:: 119 /status [online|avail|invisible|free|dnd|busy|notavail|away]::
129 Set the current status. If no status is specified, display the 120 Set the current status. If no status is specified, display the
130 current status. 121 current status.
133 ------------------ 124 ------------------
134 See the provided sample configuration file, which should be self-documented. 125 See the provided sample configuration file, which should be self-documented.
135 126
136 FILES 127 FILES
137 ----- 128 -----
138 The following files can be used by mcabber(1): 129 The following files can be used by `mcabber(1)`:
139 130
140 $HOME/.mcabber/mcabberrc Default configuration file 131 $HOME/.mcabber/mcabberrc Default configuration file
141 $HOME/.mcabberrc Configuration file used if no other has been found 132 $HOME/.mcabberrc Configuration file used if no other has been found
142 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled 133 $HOME/.mcabber/histo/ Default directory for storing chat history files, if enabled
143 134
144 BUGS 135 BUGS
145 ---- 136 ----
146 Certainly a lot. 137 Certainly a lot. Please tell me if you find one! :-)
147 138
148 AUTHOR 139 AUTHOR
149 ------ 140 ------
150 Written by Mikael BERTHE, <bmikael@lists.ilotux.net>. 141 Written by mailto:bmikael@lists.ilotux.ne[Mikael BERTHE]. +
151 Originally based on cabber (see <http://cabber.sourceforge.net>), please 142 Originally based on cabber
143 (http://cabber.sourceforge.net[Cabber homepage]), please
152 consult the AUTHORS file for details. 144 consult the AUTHORS file for details.
153 145
154 RESOURCES 146 RESOURCES
155 --------- 147 ---------
156 Main web site: http://www.lilotux.net/~mikael/mcabber/ 148 http://www.lilotux.net/~mikael/mcabber/[Main web site]
157 149
158 COPYING 150 COPYING
159 ------- 151 -------
160 Copyright (C) 2005 Mikael Berthe. 152 Copyright (C) 2005 Mikael Berthe. +
161 Some portions are Copyright (C) 2002-2004 <cabber@ajmacias.com>. 153 Some portions are Copyright (C) 2002-2004 mailto:cabber@ajmacias.com[].
162 154
163 Free use of this software is granted under the terms of the GNU General Public 155 Free use of this software is granted under the terms of the GNU General Public
164 License (GPL). 156 License (GPL).
165 157