annotate mcabber/doc/mcabber.1.txt @ 199:e574c859190a

[/trunk] Changeset 211 by mikael * Complete doc...
author mikael
date Sat, 07 May 2005 08:49:57 +0000
parents 4cfea50155bf
children f042a2400809
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>
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
4 May 2005
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 ----
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
8 mcabber - a simple jabber console client
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 -----------
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
16 'mcabber'(1) is a small jabber console client.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
17 Please copy the sample mcabberrc file and update your connection options.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
18
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
19 COMMANDS
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
20 --------
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
21
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
22 /add jid::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
23 Add the 'jid' Jabber user to our roster, and send a notification
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
24 request to this buddy
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
25
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
26 /buffer clear|top|bottom::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
27 The 'buffer' command manipulates the current buddy's buffer
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
28 (chat window).
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
29
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
30 clear: clear the current buddy chat window
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
31
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
32 top: jump to the top of the current buddy chat buffer
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
33
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
34 bottom: jump to the bottom of the current buddy chat buffer
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
35
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
36 /clear::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
37 The 'clear' command is an alias for "/buffer clear".
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
38
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
39 /group expand|shrink|toggle::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
40 The 'group' command changes the group display settings.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
41
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
42 expand: expand (unfold) the current group tree in the roster
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
43
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
44 shrink: shrink (fold) the current group tree in the roster
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
45
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
46 toggle: toggle the fold/unfold state of the current tree
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
47
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
48 Note: the "fold" and "unfold" keywords are accepted.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
49
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
50 /info::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
51 Display info on the selected entry (user, agent, group...)
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
52
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
53 /quit::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
54 Disconnect and leave mcabber(1)
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
55
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
56 /roster hide_offline|show_offline|top|bottom::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
57 The 'roster' command manipulates the roster/buddylist.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
58
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
59 hide_offline: hide offline buddies
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
60
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
61 show_offline: show offline buddies
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
62
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
63 top: jump to the top of the roster
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
64
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
65 bottom: jump to the bottom of the roster
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
66
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
67 /say text::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
68 Send the text message to the currently selected buddy. Can be useful
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
69 if you want to send a message beginning with a slash, for example.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
70
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
71 /status [online|avail|invisible|free|dnd|busy|notavail|away]::
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
72 Set the current status. If no status is specified, display the
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
73 current status.
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
74
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
75 OPTIONS
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
76 -------
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
77 --help, -h::
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
78 Quick help usage message
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
79
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
80 -f configfile::
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
81 Use configuration file 'configfile'.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
82
199
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
83 CONFIGURATION FILE
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
84 ------------------
e574c859190a [/trunk] Changeset 211 by mikael
mikael
parents: 198
diff changeset
85 See the provided sample configuration file, which should be self-documented.
198
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
86
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
87 BUGS
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
88 ----
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
89 Certainly a lot.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
90
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
91 AUTHOR
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
92 ------
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
93 Written by Mikael BERTHE, <bmikael@lists.ilotux.net>.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
94 Originally based on cabber (see <http://cabber.sourceforge.net>), please
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
95 consult the AUTHORS file for details.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
96
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
97 RESOURCES
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
98 ---------
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
99 Main web site: http://www.lilotux.net/~mikael/mcabber/
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
100
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
101 COPYING
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
102 -------
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
103 Copyright (C) 2005 Mikael Berthe.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
104 Some portions are Copyright (C) 2002-2004 <cabber@ajmacias.com>.
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
105
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
106 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
107 License (GPL).
4cfea50155bf [/trunk] Changeset 210 by mikael
mikael
parents:
diff changeset
108