annotate mcabber/doc/mcabber.1 @ 854:bfaab692a683

Update manpage (pmw) This is Philip M. White's manpage update patch, slightly modified.
author Mikael Berthe <mikael@lilotux.net>
date Sat, 13 May 2006 22:26:15 +0200
parents f8c0447beec2
children 4b77a2ab18e5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
2 .de Sh \" Subsection
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
3 .br
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
4 .if t .Sp
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
5 .ne 5
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
6 .PP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
7 \fB\\$1\fR
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
8 .PP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
9 ..
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
10 .de Sp \" Vertical space (when we can't use .PP)
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
11 .if t .sp .5v
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
12 .if n .sp
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
13 ..
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
14 .de Ip \" List item
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
15 .br
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
16 .ie \\n(.$>=3 .ne \\$3
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
17 .el .ne 3
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
18 .IP "\\$1" \\$2
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
19 ..
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
20 .TH "MCABBER" 1 "" "" ""
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
21 .SH NAME
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
22 mcabber \- a simple Jabber console client
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
23 .SH "SYNOPSIS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
24
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
25
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
26 mcabber [ \-f configfile ] [ --help | \-h ]
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
27
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
28 .SH "DESCRIPTION"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
29
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
30
227
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
31 mcabber(1) is a small Jabber console client\&. For now it needs a configuration file to start, so please copy the sample mcabberrc file and adapt your connection settings\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
32
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
33
360
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 330
diff changeset
34 You also need to have an existing Jabber account to use this software, as it cannot (un)register accounts yet\&.
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 330
diff changeset
35
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 330
diff changeset
36
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
37 Here are some of the features of mcabber:
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
38
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
39 .TP 3
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
40 \(bu
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
41 SSL support\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
42 .TP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
43 \(bu
467
73aa14eba3c7 Update manual
Mikael Berthe <mikael@lilotux.net>
parents: 465
diff changeset
44 MUC support (Multi\-User Chat)\&.
73aa14eba3c7 Update manual
Mikael Berthe <mikael@lilotux.net>
parents: 465
diff changeset
45 .TP
73aa14eba3c7 Update manual
Mikael Berthe <mikael@lilotux.net>
parents: 465
diff changeset
46 \(bu
432
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 377
diff changeset
47 History logging: If enabled (see the CONFIGURATION FILE section), mcabber can save discussions to history log files\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
48 .TP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
49 \(bu
432
3a613e1d229b Ready for 0.6.8 release
Mikael Berthe <mikael@lilotux.net>
parents: 377
diff changeset
50 Commands completion: If possible, mcabber will try to complete your command line if you hit the Tab key\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
51 .TP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
52 \(bu
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
53 Input line history: Any message or command entered is in the input line history and can be reused easily\&.
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
54 .TP
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
55 \(bu
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
56 External actions: Some events (like receiving a message) can trigger an external action such as a shell script if you enable it in your configuration file\&. A sample events script ("eventcmd") is provided with mcabber source code, in the contrib directory\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
57 .LP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
58
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
59 .SH "OPTIONS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
60
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
61 .TP
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
62 \-\-help, \-h
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
63 Quick help usage message
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
64
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
65 .TP
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
66 \-f configfile
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
67 Use configuration file configfile
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
68
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
69 .SH "WINDOWS/PANES"
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
70
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
71
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
72 The mcabber(1) screen is divided into 4 regions\&. The \fIroster\fR, alias \fIbuddylist\fR, is on the left\&. The \fIchat window\fR, or chat buffer, is on the right\&. The \fIinput line\fR lies at the bottom of the screen, under a small \fIlog window\fR\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
73
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
74
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
75 Two status lines surround the log window\&. The bottom status line is the "main status line" and reflects mcabber general status\&. The other line is the "chat status line" and shows the status of the currently selected buddy\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
76
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
77
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
78 To display buddies chat buffers, you will have to enter \fIchat mode\fR\&. You can enter chat mode by pressing enter, and leave chat mode with the ESC key\&. Simply sending a message will also enable chat mode\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
79
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
80
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
81 There are several advantages to the two\-mode implementation: first, it allows accurate "unread" message functionality, as described in the next section; without this, merely scrolling to a specific buddy will "read" the new messages of all buddies in\-between\&. Second, it allows quickly hiding the conversation with a single keystroke\&. Third, it allows jumping between the few buddies with whom you are conversing with the \fI/roster alternate\fR command described in another section, without having to manually scroll back and forth\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
82
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
83 .SH "KEYS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
84
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
85
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
86 Text typing occurs in the \fIinput line\fR; basic operations are supported (left arrow, right arrow, home/end keys, insert, delete, backspace...)\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
87
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
88
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
89 PageUp and PageDown keys are used to move in the roster\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
90
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
91
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
92 Up and Down arrow keys can be used to move in the input line history; they jump to the previous/next line from the history beginning with the same string (from first column to the cursor column)\&.
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
93
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
94
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
95 To send a message, move to the choosen buddy in the buddylist, type your message and hit enter\&. If the line begins with a slash, this will be interpreted as a command (see the COMMAND section below)\&. Hit escape to leave the chat mode\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
96
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
97
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
98 Here is a quick description of the key bindings:
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
99
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
100 Ctrl\-a Go to the beginning of the input line
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
101
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
102 Ctrl\-e Go to the end of the input line
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
103
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
104 Ctrl\-l Force a refresh
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
105
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
106 Up/Down Move in the input line history
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
107
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
108 PgUp/PgDown Move inside the roster (buddylist)
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
109
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
110 Tab Complete current word, in the input line
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
111
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
112 Ctrl\-g Cancel completion / ctrl\-g
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
113
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
114 Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode)
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
115
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
116 Ctrl\-Left Move the cursor back to the start of the current or previous word
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
117
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
118 Ctrl\-Right Move the cursor forward to the end of the current or next word
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
119
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
120 Ctrl\-u Delete from beginning of the line to the cursor
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
121
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
122 Ctrl\-k Delete from the cursor to the end of line
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
123
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
124 Ctrl\-w Backward kill word
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
125
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
126 Ctrl\-t Transpose chars
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
127
263
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
128 Ctrl\-o Accept line and put the next history line in the input line (accept\-line\-and\-down\-history)
1bcc3eec08f0 Add Ctrl-o: accept-line-and-down-history
mikael@frmp8452
parents: 260
diff changeset
129
236
72fd1273f2b7 [/trunk] Changeset 249 by mikael
mikael
parents: 229
diff changeset
130 Ctrl\-q Jump to the next unread message
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
131
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
132 Additional key bindings may be specified using the /bind command described
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
133 in the COMMANDS section\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
134
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
135 .SH "MCABBER'S ROSTER"
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
136
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
137
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
138 The first listed resource on the roster is \fI[status]\fR, which keeps a log of everything that appears in the short log window below the main chat area\&. While the log window was designed for showing the latest few elements, the dedicated \fI[status]\fR buffer allows more comfortable viewing of the log, as well as scrolling it in a standard manner\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
139
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
140
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
141 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
142
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
143
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
144 For every real Jabber resource, the roster displays four pieces of information: the resource's name or alias, its online status, its authorization status, and whether there are unread messages from the resource waiting for you\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
145
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
146
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
147 The online status is one of the following:
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
148
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
149 \fBo\fR online
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
150 \fBf\fR free for chat
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
151 \fBa\fR away
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
152 \fBn\fR not available (labeled \fIextended away\fR in some clients)
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
153 \fBd\fR do not disturb
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
154 \fBi\fR invisible (displayed only for your resource)
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
155 \fB_\fR offline (or invisible to you)
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
156 \fB?\fR unknown, usually meaning you are not authorized to see this resource's status
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
157 \fBx\fR a conference room in which you are not participating
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
158 \fBC\fR a conference room in which you are participating
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
159
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
160
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
161 The authorization status indicates whether a resource is authorized to receive your online status updates, and is displayed by the brackets surrounding the resource's online status\&. Square brackets, like \fI[o]\fR, indicate that this resource is authorized to receive your status\&. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
162
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
163
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
164 When there are unread messages from the resource which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that resource\&. The hash mark disappears once you view that resource's message log\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
165
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
166
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
167 Examples:
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
168
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
169 \fB \-\-\- Buds\fR This is a group named \fIBuds\fR
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
170 \fB#[o] John\fR John is online, can see your status, and sent you a message that you did not read yet
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
171 \fB {?} Sally\fR Neither you nor Sally have authorized each other to see your online status
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
172 \fB {a} Jane\fR Jane is away, but she cannot see your online status
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
173 \fB#[C] x@y\&.c\fR You are participating in x@y\&.c conference room, and there are unread messages
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
174
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
175
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
176 .SH "COMMANDS RELATED TO MCABBER"
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
177
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
178 .TP
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
179 \fB/alias\fR name = command line
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
180 Add "name" as an alias for "command line"\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
181
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
182 Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
183
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
184 Example: "/alias away = status away"\&.
289
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
185
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
186 .TP
72fa52203651 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 286
diff changeset
187 \fB/bind\fR keycode = command line
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
188 Bind a command line to the key with the "keycode" code number\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
189
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
190 Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
191
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
192 Note: aliases can be used in key bindings\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
193
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
194 Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation)\&.
286
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
195
a3d65d7f0bc3 Add /alias documentation
Mikael Berthe <mikael@lilotux.net>
parents: 277
diff changeset
196 .TP
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
197 \fB/buffer\fR clear|top|bottom|date|%|search_backward|search_forward
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
198 The buffer command manipulates the current buddy's buffer (chat window)\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
199
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
200 \fBclear\fR clear the current buddy chat window
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
201 \fBbottom\fR jump to the bottom of the current buddy chat buffer
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
202 \fBtop\fR jump to the top of the current buddy chat buffer
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
203 \fBup\fR [n] scroll the buffer up n lines (default: half a screen)
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
204 \fBdown\fR [n] scroll the buffer down n lines (default: half a screen)
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
205 \fBdate\fR date jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
206 \fB%\fR n jump to position %n of the buddy chat buffer
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
207 \fBsearch_backward\fR text search for "text" in the current buddy chat buffer
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
208 \fBsearch_forward\fR text search for "text" in the current buddy chat buffer
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
209
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
210 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
211 \fB/clear\fR
227
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
212 The clear command is actually an alias for "/buffer clear"\&.
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
213
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
214 .TP
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
215 \fB/quit\fR
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
216 Disconnect and leave mcabber(1)\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
217
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
218 .TP
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
219 \fB/version\fR
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
220 Display mcabber version
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
221
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
222 .SH "COMMANDS RELATED TO THE SERVER AND CONNECTION"
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
223
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
224 .TP
298
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
225 \fB/connect\fR
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
226 Establish connection to the Jabber server\&.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
227
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
228 .TP
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
229 \fB/disconnect\fR
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
230 Terminate connection to the Jabber server\&. Note: the roster is only available when the connection to the server is active, so the buddylist is empty when disconnected\&.
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
231
35cda94e570d Add /connect and /disconnect commands
Mikael Berthe <mikael@lilotux.net>
parents: 290
diff changeset
232 .TP
829
114f08e3c29a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 811
diff changeset
233 \fB/event\fR #n|* accept|ignore|reject, \fB/event\fR list
114f08e3c29a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 811
diff changeset
234 Tell mcabber what to do about a pending event\&. If the first parameter is "*", the command will apply to all queued events\&.
114f08e3c29a Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 811
diff changeset
235
775
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
236 \fBaccept\fR accept the event #n
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
237 \fBignore\fR remove the event #n from the list
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
238 \fBreject\fR reject the event #n
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
239 \fBlist\fR list all pending events
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
240
b4befb3052e5 Update NEWS, ChangeLog and documentation
Mikael Berthe <mikael@lilotux.net>
parents: 710
diff changeset
241 .TP
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
242 \fB/rawxml\fR send
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
243 \fBsend\fR string: send string (raw XML format) to the Jabber server\&. No check is done on the string provided\&. BEWARE! Use this only if you know what you are doing, or you could terminate the connection\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
244
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
245 .SH "COMMANDS RELATED TO THE ROSTER AND JABBER RESOURCES"
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
246
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
247 .TP
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
248 \fB/add\fR [jid [nickname]]
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
249 Add the "jid" Jabber user to our roster (default group), and send a notification request to this buddy\&. If no nickname is specified, the jid is used\&. If no jid (or an empty string "") is provided or if jid is "\&.", the current buddy is used\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
250
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
251 .TP
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
252 \fB/authorization\fR allow|cancel|request|request_unsubscribe [jid]
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
253 Manage the presence subscriptions\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
254
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
255 If no jid is provided, the current buddy is used\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
256
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
257 \fBallow\fR allow the buddy to receive your presence updates
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
258 \fBcancel\fR cancel the buddy' subscription to your presence updates
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
259 \fBrequest\fR request a subscription to the buddy's presence updates
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
260 \fBrequest_unsubscribe\fR request unsubscription from the buddy's presence updates
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
261
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
262 .TP
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
263 \fB/del\fR
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
264 Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours\&.
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
265
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
266 .TP
240
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
267 \fB/group\fR fold|unfold|toggle
723433a677f0 [/trunk] Changeset 253 by mikael
mikael
parents: 238
diff changeset
268 The group command changes the current group display\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
269
637
aff6df4b408b Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 623
diff changeset
270 \fBfold\fR fold (shrink) the current group tree in the roster
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
271 \fBunfold\fR unfold (expand) the current group tree in the roster
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
272 \fBtoggle\fR toggle the state (fold/unfold) of the current tree
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
273
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
274 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
275 \fB/info\fR
440
264f40222872 Update documentation (/info command)
Mikael Berthe <mikael@lilotux.net>
parents: 436
diff changeset
276 Display info on the selected entry (user, agent, group...)\&. For users, resources are displayed with the status, priority and status message (if available) of each resource\&.
227
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
277
365818971234 [/trunk] Changeset 239 by mikael
mikael
parents: 226
diff changeset
278 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
279 \fB/move\fR [groupname]
623
7d9841ea20d8 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 618
diff changeset
280 Move the current buddy to the requested group\&. If no group is specified, then the buddy is moved to the default group\&. Tip: if the chatmode is enabled, you can use "/roster alternate" to jump to the moved buddy\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
281
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
282 .TP
839
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
283 \fB/msay\fR begin|verbatim|send|send_to|toggle|toggle_verbatim|abort
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
284 Send a multi\-line message\&. To write a single message with several lines, the \fImulti\-line mode\fR should be used\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
285
810
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
286 The \fIbegin\fR subcommand enables multi\-line mode\&. Note that it allows a message subject to be specified\&.
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
287
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
288 In multi\-line mode, each line (except command lines) typed in the input line will be added to the multi\-line message\&. Once the message is finished, it can be sent to the current selected buddy with the "/msay send" command\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
289
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
290 The \fIverbatim\fR multi\-line mode disables commands, so that it is possible to enter lines starting with a slash\&. Only the "/msay" command (with send or abort parameters) can be used to exit verbatim mode\&.
238
8e30b2bb380e [/trunk] Changeset 251 by mikael
mikael
parents: 236
diff changeset
291
839
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
292 The \fItoggle\fR and \fItoggle_verbatim\fR subcommands can be bound to a key to use the multi\-line mode quickly (for example, "bind M109 = msay toggle" to switch using the Meta\-m combination)\&.
799
7362ed14dee0 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 775
diff changeset
293
810
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
294 \fBbegin\fR [subject] enter multi\-line mode
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
295 \fBverbatim\fR enter verbatim multi\-line mode
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
296 \fBsend\fR send the current multi\-line message to the currently selected buddy
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
297 \fBsend_to\fR jid send the current multi\-line message to "jid"
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
298 \fBtoggle\fR switch to/from multi\-line mode (begin/send)
839
5759770c1968 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 836
diff changeset
299 \fBtoggle_verbatim\fR same with verbatim multi\-line mode
810
8c45ec4bf9bc Ready for release 0.7.6
Mikael Berthe <mikael@lilotux.net>
parents: 799
diff changeset
300 \fBabort\fR leave multi\-line mode without sending the message
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
301
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
302 .TP
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
303 \fB/rename\fR nickname
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
304 Rename current buddy to the given nickname\&. This command does not work for groups, at the moment (but you can move the buddies to another group with the "/move" command)\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
305
700
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 660
diff changeset
306 .TP
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 660
diff changeset
307 \fB/request\fR time|version [jid]
3f3c5765a459 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 660
diff changeset
308 Send a "IQ" query to the current buddy, or to the specified Jabber user\&. If the resource is not provided with the jid, mcabber will send the query to all known resources for this user\&.
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
309
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
310 .TP
573
4df43fcdabc4 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
311 \fB/room\fR
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
312 The room command handles Multi\-User Chat room actions\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
313
841
f8c0447beec2 Allow "/room join . [nick]" if the current item is a MUC room
Mikael Berthe <mikael@lilotux.net>
parents: 839
diff changeset
314 \fBjoin\fR [room [nick]] join "room", using "nick" as nickname\&. If no nickname is provided, the "nickname" option value is used (see sample configuration file)\&. If the currently selected entry is correctly recognized as a room by mcabber, the shortcut "\&." can be used instead of the full room id\&.
487
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
315 \fBleave\fR [message] leave the current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
316 \fBnames\fR display members of the current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
317 \fBnick\fR nick change your nickname in the current room
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
318 \fBprivmsg\fR nick msg send private message "msg" to "nick"
487
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
319 \fBremove\fR remove the current room from the roster (you must have left this room before)
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
320 \fBtopic\fR set topic for current room
b03def7beb78 Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 480
diff changeset
321 \fBunlock\fR unlock current room (if you are the owner)
601
803973541c22 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 593
diff changeset
322 \fBdestroy\fR [reason] destroy the current room (use with care!)
573
4df43fcdabc4 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 522
diff changeset
323 \fBwhois\fR nick display MUC information about "nick"
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
324
593
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
325 \fBinvite\fR jid [reason] invite jid to the current room
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
326 \fBkick\fR nick [reason] kick "nick" from the current room
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
327 \fBban\fR jid [reason] ban jid from the current room
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
328 \fBrole\fR jid role [reason] change jid's role (role can be "none", "visitor", "participant", "moderator")
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
329 \fBaffil\fR jid affil [reason] change jid's affiliation (affil can be "none", "member", "admin", "owner")
29d9a54ac69f Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 573
diff changeset
330
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
331 .TP
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
332 \fB/roster\fR
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
333 The roster command manipulates the roster/buddylist\&. Here are the available parameters:
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
334
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
335 \fBbottom\fR jump to the bottom of the roster
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
336 \fBtop\fR jump to the top of the roster
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
337 \fBup\fR move up in the roster
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
338 \fBdown\fR move down in the roster
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
339 \fBhide_offline\fR hide offline buddies
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
340 \fBshow_offline\fR show offline buddies
290
f63839a4cb35 Add /roster toggle_offline
Mikael Berthe <mikael@lilotux.net>
parents: 289
diff changeset
341 \fBtoggle_offline\fR toggle display of offline buddies
710
0311d7e2bb1c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 700
diff changeset
342 \fBhide\fR hide roster (full\-width chat window)
0311d7e2bb1c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 700
diff changeset
343 \fBshow\fR show roster
0311d7e2bb1c Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 700
diff changeset
344 \fBtoggle\fR toggle roster visibility
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
345 \fBsearch\fR bud search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist)
618
341568185492 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 601
diff changeset
346 \fBalternate\fR jump to alternate buddy\&. The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first")
265
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
347 \fBunread_first\fR jump to the first unread message
49e9e02dd6d0 Add "/roster search" command
mikael@frmp8452
parents: 263
diff changeset
348 \fBunread_next\fR jump to the next unread message
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
349
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
350 .TP
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
351 \fB/say\fR text
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
352 Send the "text" message to the currently selected buddy\&. Can be useful if you want to send a message beginning with a slash, for example\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
353
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
354 .TP
480
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
355 \fB/say_to\fR jid text
491
28f67990ce7b Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 487
diff changeset
356 Send the "text" message to the specified jid\&. Please note that this command doesn't set the default resource for a contact, so if you want to send several messages to a specific ressource you will have to use "/say_to" for each message\&.
480
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
357
882e1acae422 Add /say_to command
Mikael Berthe <mikael@lilotux.net>
parents: 475
diff changeset
358 .TP
522
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
359 \fB/status\fR [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]]
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
360 Show or set the current status\&.
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
361
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
362 If no status is specified, display the current status\&.
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
363
fdd1637db7f3 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 511
diff changeset
364 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file)\&. If no relevant message* variable is set and no status message provided, the current status message is kept\&. If StatusMessage is "\-", the current status message is cleared\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
365
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
366 .TP
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
367 \fB/status_to\fR jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
368 Send the requested status to the specified Jabber user\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
369
660
ef7f0b58a159 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 639
diff changeset
370 If the specified jid is "\&.", the current buddy is used\&.
ef7f0b58a159 Update documentation
Mikael Berthe <mikael@lilotux.net>
parents: 639
diff changeset
371
450
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
372 Note: this status will be overridden by subsequent "/status" commands\&. If you are using the auto\-away feature, the status will overridden too\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
373
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
374 Note: The jid can include a resource (i\&.e\&. user@server/resource)\&.
fa93f47a08fe Update manual page
Mikael Berthe <mikael@lilotux.net>
parents: 440
diff changeset
375
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
376 .SH "CONFIGURATION FILE"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
377
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
378
854
bfaab692a683 Update manpage (pmw)
Mikael Berthe <mikael@lilotux.net>
parents: 841
diff changeset
379 See the provided sample configuration file, which should be self\-documenting\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
380
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
381 .SH "FILES"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
382
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
383
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
384 The following files can be used by mcabber(1):
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
385
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
386 .nf
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
387 $HOME/\&.mcabber/mcabberrc Default configuration file
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
388 $HOME/\&.mcabberrc Configuration file used if no other has been found
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
389 $HOME/\&.mcabber/histo/ Default directory for storing chat history files, if enabled
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
390 .fi
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
391
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
392 .SH "BUGS"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
393
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
394
360
20283b69db99 Doc: Say a Jabber account should already exist for using mcabber
Mikael Berthe <mikael@lilotux.net>
parents: 330
diff changeset
395 Certainly\&. Please tell me if you find one! :\-)
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
396
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
397 .SH "AUTHOR"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
398
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
399
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
400 Written by Mikael BERTHE <\fImcabber@lilotux.net\fR>\&.
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
401 Originally based on cabber (Cabber homepage: <\fIhttp://cabber.sourceforge.net\fR>), please consult the AUTHORS file for details\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
402
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
403 .SH "RESOURCES"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
404
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
405
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
406 Main web site: <\fIhttp://www.lilotux.net/~mikael/mcabber/\fR>
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
407
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
408 .SH "COPYING"
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
409
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
410
811
d9c1901e6a7b Replace copyright character with (C) in the manpage (lintian check)
Mikael Berthe <mikael@lilotux.net>
parents: 810
diff changeset
411 Copyright (C) 2005, 2006 Mikael Berthe\&.
229
bfc14cfb068e [/trunk] Changeset 241 by mikael
mikael
parents: 227
diff changeset
412
811
d9c1901e6a7b Replace copyright character with (C) in the manpage (lintian check)
Mikael Berthe <mikael@lilotux.net>
parents: 810
diff changeset
413 Some portions are Copyright (C) 2002\-2004 <cabber@ajmacias\&.com>\&.
226
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
414
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
415
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
416 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
bebefc0aa5a9 [/trunk] Changeset 238 by mikael
mikael
parents:
diff changeset
417