Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1 @ 1842:cec7cbeb1c2e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manpage
author Mikael Berthe <mikael@lilotux.net>
date Sun, 28 Mar 2010 11:55:34 +0200
parents 921429804e20
children 41699679b121
comparison
equal deleted inserted replaced
1841:8ad982f83fd6 1842:cec7cbeb1c2e
1 '\" t 1 '\" t
2 .\" Title: mcabber 2 .\" Title: mcabber
3 .\" Author: [see the "AUTHOR" section] 3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> 4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5 .\" Date: 03/13/2010 5 .\" Date: 03/28/2010
6 .\" Manual: \ \& 6 .\" Manual: \ \&
7 .\" Source: \ \& 0.10.0-dev 7 .\" Source: \ \& 0.10.0-dev
8 .\" Language: English 8 .\" Language: English
9 .\" 9 .\"
10 .TH "MCABBER" "1" "03/13/2010" "\ \& 0\&.10\&.0\-dev" "\ \&" 10 .TH "MCABBER" "1" "03/28/2010" "\ \& 0\&.10\&.0\-dev" "\ \&"
11 .\" ----------------------------------------------------------------- 11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff 12 .\" * Define some portability stuff
13 .\" ----------------------------------------------------------------- 13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673 15 .\" http://bugs.debian.org/507673
292 .RE 292 .RE
293 .sp 293 .sp
294 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&. 294 Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&.
295 .SH "MCABBER\(cqS ROSTER" 295 .SH "MCABBER\(cqS ROSTER"
296 .sp 296 .sp
297 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\&. 297 The first listed item 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\&.
298 .sp 298 .sp
299 Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&. 299 Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&.
300 .sp 300 .sp
301 For every real Jabber resource, the roster displays four pieces of information: the resource\(cqs name or alias, its online status, its authorization status, and whether there are unread messages from the resource waiting for you\&. 301 For every real Jabber contact, the roster displays four pieces of information: the buddy\(cqs name or alias, its online status, its authorization status, and whether there are unread messages from the buddy waiting for you\&.
302 .sp 302 .sp
303 The online status is one of the following: 303 The online status is one of the following:
304 .PP 304 .PP
305 \fIo\fR 305 \fIo\fR
306 .RS 4 306 .RS 4
339 offline (or invisible to you) 339 offline (or invisible to you)
340 .RE 340 .RE
341 .PP 341 .PP
342 \fI?\fR 342 \fI?\fR
343 .RS 4 343 .RS 4
344 unknown, usually meaning you are not authorized to see this resource\(cqs status 344 unknown, usually meaning you are not authorized to see this buddy\(cqs status
345 .RE 345 .RE
346 .PP 346 .PP
347 \fIx\fR 347 \fIx\fR
348 .RS 4 348 .RS 4
349 a conference room in which you are not participating 349 a conference room in which you are not participating
352 \fIC\fR 352 \fIC\fR
353 .RS 4 353 .RS 4
354 a conference room in which you are participating 354 a conference room in which you are participating
355 .RE 355 .RE
356 .sp 356 .sp
357 The authorization status indicates whether a resource is authorized to receive your online status updates, and is displayed by the brackets surrounding the resource\(cqs 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\&. 357 The authorization status indicates whether a buddy is authorized to receive your online status updates, and is displayed by the brackets surrounding the buddy\(cqs online status\&. Square brackets, like \fI[o]\fR, indicate that this buddy is authorized to receive your status\&. Curly braces, like \fI{o}\fR, indicate that they are not authorized to receive your status\&.
358 .sp 358 .sp
359 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\(cqs message log\&. 359 When there are unread messages from a buddy which you have not looked at, a hash mark (\fI#\fR) appears in the leftmost section of the roster for that buddy\&. The hash mark disappears once you view that buddy\(cqs message buffer\&. When the user attention is requested (or when you receive a message containing your nickname in a MUC room), the hash mark is replaced with the \fIattention sign\fR, an exclamation mark (\fI!\fR)\&.
360 .sp 360 .sp
361 Examples: 361 Examples:
362 .PP 362 .PP
363 \fI\-\-\- Buds\fR 363 \fI\-\-\- Buds\fR
364 .RS 4 364 .RS 4
513 .RE 513 .RE
514 .RE 514 .RE
515 .PP 515 .PP
516 /buffer clear|close|close_all|purge|list, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle, /buffer save filename 516 /buffer clear|close|close_all|purge|list, /buffer top|bottom|date|%|search_backward|search_forward, /buffer scroll_lock|scroll_unlock|scroll_toggle, /buffer save filename
517 .RS 4 517 .RS 4
518 Buddy\(cqs buffer manipulation command\&. Eg\&. you can search through buffer for "text", clear chat window etc\&. 518 Buddy\(cqs buffer manipulation command\&. E\&.g\&. you can search through buffer for "text", clear chat window etc\&.
519 .PP 519 .PP
520 \fIclear\fR 520 \fIclear\fR
521 .RS 4 521 .RS 4
522 Clear the current buddy chat window 522 Clear the current buddy chat window
523 .RE 523 .RE
881 Loads specified module\&. If \-f flag is specified, most of module loading errors will be ignored\&. 881 Loads specified module\&. If \-f flag is specified, most of module loading errors will be ignored\&.
882 .RE 882 .RE
883 .PP 883 .PP
884 \fIunload\fR [\-f] module 884 \fIunload\fR [\-f] module
885 .RS 4 885 .RS 4
886 Unloads specified module\&. Note: The force flag will not remove any dependent on this modules! 886 Unloads specified module\&. Note: The force flag will not remove any dependency on this module!
887 .RE 887 .RE
888 .PP 888 .PP
889 \fIinfo\fR module 889 \fIinfo\fR module
890 .RS 4 890 .RS 4
891 Shows available information about this module\&. 891 Shows available information about this module\&.
1342 /screen_refresh 1342 /screen_refresh
1343 .RS 4 1343 .RS 4
1344 Refresh the mcabber screen\&. 1344 Refresh the mcabber screen\&.
1345 .RE 1345 .RE
1346 .PP 1346 .PP
1347 /set option [= value] 1347 /set [option [= value]]
1348 .RS 4 1348 .RS 4
1349 Display or set an option value\&. 1349 Display or set an option value\&.
1350
1351 Without arguments prints a list of all set options with their values
1350 .RE 1352 .RE
1351 .PP 1353 .PP
1352 /source pattern 1354 /source pattern
1353 .RS 4 1355 .RS 4
1354 Read configuration files, that match glob pattern (sorted in alphabetical order)\&. 1356 Read configuration files, that match glob pattern (sorted in alphabetical order)\&.
1411 .sp 1413 .sp
1412 Written by \m[blue]\fBMikael BERTHE\fR\m[]\&\s-2\u[1]\d\s+2 and others (see AUTHORS file)\&. 1414 Written by \m[blue]\fBMikael BERTHE\fR\m[]\&\s-2\u[1]\d\s+2 and others (see AUTHORS file)\&.
1413 .SH "RESOURCES" 1415 .SH "RESOURCES"
1414 .sp 1416 .sp
1415 \m[blue]\fBMain web site\fR\m[]\&\s-2\u[2]\d\s+2 1417 \m[blue]\fBMain web site\fR\m[]\&\s-2\u[2]\d\s+2
1418 .sp
1419 \m[blue]\fBOfficial wiki\fR\m[]\&\s-2\u[3]\d\s+2
1420 .sp
1421 \m[blue]\fBMCabber MUC room\fR\m[]\&\s-2\u[4]\d\s+2
1416 .SH "COPYING" 1422 .SH "COPYING"
1417 .sp 1423 .sp
1418 Copyright (C) 2005\-2010 Mikael Berthe and others\&. 1424 Copyright (C) 2005\-2010 Mikael Berthe and others\&.
1419 .sp 1425 .sp
1420 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. 1426 Free use of this software is granted under the terms of the GNU General Public License (GPL)\&.
1427 .IP " 2." 4 1433 .IP " 2." 4
1428 Main web site 1434 Main web site
1429 .RS 4 1435 .RS 4
1430 \%http://mcabber.com/ 1436 \%http://mcabber.com/
1431 .RE 1437 .RE
1438 .IP " 3." 4
1439 Official wiki
1440 .RS 4
1441 \%http://wiki.mcabber.com/
1442 .RE
1443 .IP " 4." 4
1444 MCabber MUC room
1445 .RS 4
1446 \%xmpp:mcabber@conf.lilotux.net
1447 .RE