Mercurial > ~mikael > mcabber > hg
diff mcabber/doc/mcabber.1 @ 1842:cec7cbeb1c2e
Update manpage
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sun, 28 Mar 2010 11:55:34 +0200 |
parents | 921429804e20 |
children | 41699679b121 |
line wrap: on
line diff
--- a/mcabber/doc/mcabber.1 Sun Mar 28 10:56:42 2010 +0200 +++ b/mcabber/doc/mcabber.1 Sun Mar 28 11:55:34 2010 +0200 @@ -2,12 +2,12 @@ .\" Title: mcabber .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 03/13/2010 +.\" Date: 03/28/2010 .\" Manual: \ \& .\" Source: \ \& 0.10.0-dev .\" Language: English .\" -.TH "MCABBER" "1" "03/13/2010" "\ \& 0\&.10\&.0\-dev" "\ \&" +.TH "MCABBER" "1" "03/28/2010" "\ \& 0\&.10\&.0\-dev" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -294,11 +294,11 @@ Additional key bindings may be specified using the \fI/bind\fR command described in the COMMANDS section\&. .SH "MCABBER\(cqS ROSTER" .sp -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\&. +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\&. .sp -Group names are displayed above the resources that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&. +Group names are displayed above the items that are within them, and are indicated by \fI\-\-\-\fR to the left of the name\&. .sp -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\&. +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\&. .sp The online status is one of the following: .PP @@ -341,7 +341,7 @@ .PP \fI?\fR .RS 4 -unknown, usually meaning you are not authorized to see this resource\(cqs status +unknown, usually meaning you are not authorized to see this buddy\(cqs status .RE .PP \fIx\fR @@ -354,9 +354,9 @@ a conference room in which you are participating .RE .sp -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\&. +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\&. .sp -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\&. +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)\&. .sp Examples: .PP @@ -515,7 +515,7 @@ .PP /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 .RS 4 -Buddy\(cqs buffer manipulation command\&. Eg\&. you can search through buffer for "text", clear chat window etc\&. +Buddy\(cqs buffer manipulation command\&. E\&.g\&. you can search through buffer for "text", clear chat window etc\&. .PP \fIclear\fR .RS 4 @@ -883,7 +883,7 @@ .PP \fIunload\fR [\-f] module .RS 4 -Unloads specified module\&. Note: The force flag will not remove any dependent on this modules! +Unloads specified module\&. Note: The force flag will not remove any dependency on this module! .RE .PP \fIinfo\fR module @@ -1344,9 +1344,11 @@ Refresh the mcabber screen\&. .RE .PP -/set option [= value] +/set [option [= value]] .RS 4 Display or set an option value\&. + +Without arguments prints a list of all set options with their values .RE .PP /source pattern @@ -1413,6 +1415,10 @@ .SH "RESOURCES" .sp \m[blue]\fBMain web site\fR\m[]\&\s-2\u[2]\d\s+2 +.sp +\m[blue]\fBOfficial wiki\fR\m[]\&\s-2\u[3]\d\s+2 +.sp +\m[blue]\fBMCabber MUC room\fR\m[]\&\s-2\u[4]\d\s+2 .SH "COPYING" .sp Copyright (C) 2005\-2010 Mikael Berthe and others\&. @@ -1429,3 +1435,13 @@ .RS 4 \%http://mcabber.com/ .RE +.IP " 3." 4 +Official wiki +.RS 4 +\%http://wiki.mcabber.com/ +.RE +.IP " 4." 4 +MCabber MUC room +.RS 4 +\%xmpp:mcabber@conf.lilotux.net +.RE