Mercurial > hg
changeset 522:fdd1637db7f3
Update documentation
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sat, 19 Nov 2005 16:54:42 +0100 |
parents | cc8c969ab6e5 |
children | fc6bc26f891e |
files | mcabber/README mcabber/doc/mcabber.1 mcabber/doc/mcabber.1.html mcabber/doc/mcabber.1.txt mcabber/mcabberrc.example |
diffstat | 5 files changed, 32 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/mcabber/README Sat Nov 19 16:30:49 2005 +0100 +++ b/mcabber/README Sat Nov 19 16:54:42 2005 +0100 @@ -1,6 +1,6 @@ Hello, and thanks for trying mcabber. -For installation instruction, have a look at the INSTALL file. +For installation instructions, have a look at the INSTALL file. A configuration file is necessary to start mcabber. Its name is $HOME/.mcabber/mcabberrc (or $HOME/.mcabberrc). @@ -8,12 +8,14 @@ A sample configuration file, "mcabberrc.example", is provided in this directory. Copy it and modify it to fit your needs. - You can use mcabber "-f" option to specify another configuration file. This software is under development, please give me some feedback (and some patches if you can!). Or just tell me you're using it... ;-) +There is a Mercurial repository on mcabber's website + <http://www.lilotux.net/~mikael/mcabber/> +and a Jabber conference room: <jid:mcabber@conf.lilotux.net>. + Mikael <mcabber@lilotux.net> -
--- a/mcabber/doc/mcabber.1 Sat Nov 19 16:30:49 2005 +0100 +++ b/mcabber/doc/mcabber.1 Sat Nov 19 16:54:42 2005 +0100 @@ -240,8 +240,12 @@ 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\&. .TP -\fB/status\fR [online|avail|invisible|free|dnd|notavail|away [StatusMessage]] -Set the current status\&. If no status is specified, display the current status\&. If a status message is specified, it will overrride the message* variables\&. +\fB/status\fR [online|avail|invisible|free|dnd|notavail|away [\-|StatusMessage]] +Show or set the current status\&. + +If no status is specified, display the current status\&. + +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\&. .TP \fB/status_to\fR jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]
--- a/mcabber/doc/mcabber.1.html Sat Nov 19 16:30:49 2005 +0100 +++ b/mcabber/doc/mcabber.1.html Sat Nov 19 16:54:42 2005 +0100 @@ -654,13 +654,16 @@ ressource you will have to use "/say_to" for each message. </dd> <dt><b> -/status [online|avail|invisible|free|dnd|notavail|away [StatusMessage]] +/status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]] </b></dt> <dd> - Set the current status. If no status is specified, display the - current status.<br /> + Show or set the current status.<br /> + If no status is specified, display the current status.<br /> If a status message is specified, it will overrride the message* - variables. + 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. </dd> <dt><b> /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] @@ -696,7 +699,7 @@ <div id="footer"> <p> Version 0.7.1-dev<br /> -Last updated 12-Nov-2005 17:44:00 CEST +Last updated 19-Nov-2005 16:44:06 CEST </p> </div> </div>
--- a/mcabber/doc/mcabber.1.txt Sat Nov 19 16:30:49 2005 +0100 +++ b/mcabber/doc/mcabber.1.txt Sat Nov 19 16:54:42 2005 +0100 @@ -220,11 +220,14 @@ a contact, so if you want to send several messages to a specific ressource you will have to use "/say_to" for each message. -/status [online|avail|invisible|free|dnd|notavail|away [StatusMessage]]:: - Set the current status. If no status is specified, display the - current status. + +/status [online|avail|invisible|free|dnd|notavail|away [-|StatusMessage]]:: + Show or set the current status. + + If no status is specified, display the current status. + If a status message is specified, it will overrride the message* - variables. + 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. /status_to jid online|avail|invisible|free|dnd|notavail|away [StatusMessage]:: Send the requested status to the specified Jabber user. +
--- a/mcabber/mcabberrc.example Sat Nov 19 16:30:49 2005 +0100 +++ b/mcabber/mcabberrc.example Sat Nov 19 16:54:42 2005 +0100 @@ -45,6 +45,7 @@ # mcabber will change your status to away if no real activity is detected # (command, message, move in the buddylist...). Note: auto-away only changes # the status when it is "available" (online) or "free_for_chat". +# See 'message_autoaway' below. #set autoaway = 0 # History logging @@ -88,7 +89,11 @@ #set message_dnd = Please do not disturb #set message_notavail = I'm not available #set message_away = I'm away -#set message_autoaway = Auto-away +# +# The auto-away message is only used when 'autoaway' is set. The previous +# message will be restored when leaving auto-away status. If this message +# isn't defined, the status message will stay unchanged. +set message_autoaway = Auto-away (idle) # Colors # Colors are: black, red, green, yellow, blue, magenta, cyan, white