comparison mcabber/doc/mcabber.1.txt @ 1973:9fe1c0a54e73

Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Sat, 19 Mar 2011 13:20:22 +0100
parents c55f62570573
children 3f4c97805218
comparison
equal deleted inserted replaced
1972:45f0f0f60656 1973:9fe1c0a54e73
1 MCABBER(1) 1 MCABBER(1)
2 =========== 2 ===========
3 Mikael BERTHE <mcabber@lilotux.net> 3 Mikael BERTHE <mcabber@lilotux.net>
4 v0.10.2-dev, December 2010 4 v0.10.2-dev, March 2011
5 5
6 NAME 6 NAME
7 ---- 7 ----
8 mcabber - a simple Jabber (XMPP) console client 8 mcabber - a simple Jabber (XMPP) console client
9 9
135 'o';; online 135 'o';; online
136 'f';; free for chat 136 'f';; free for chat
137 'a';; away 137 'a';; away
138 'n';; not available (labeled 'extended away' in some clients) 138 'n';; not available (labeled 'extended away' in some clients)
139 'd';; do not disturb 139 'd';; do not disturb
140 'i';; invisible (displayed only for your resource)
141 '_';; offline (or invisible to you) 140 '_';; offline (or invisible to you)
142 '?';; unknown, usually meaning you are not authorized to see this buddy's status 141 '?';; unknown, usually meaning you are not authorized to see this buddy's status
143 'x';; a conference room in which you are not participating 142 'x';; a conference room in which you are not participating
144 'C';; a conference room in which you are participating 143 'C';; a conference room in which you are participating
145 144
491 Without arguments prints a list of all set options with their values 490 Without arguments prints a list of all set options with their values
492 491
493 /source pattern:: 492 /source pattern::
494 Read configuration files, that match glob pattern (sorted in alphabetical order). 493 Read configuration files, that match glob pattern (sorted in alphabetical order).
495 494
496 /status [online|avail|invisible|free|dnd|notavail|away [-|statusmessage]]:: 495 /status [online|avail|free|dnd|notavail|away [-|statusmessage]]::
497 /status message -|statusmessage:: 496 /status message -|statusmessage::
498 Show or set the current status. + 497 Show or set the current status. +
499 If no status is specified, display the current status. + 498 If no status is specified, display the current status. +
500 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file). + 499 If a status message is specified, it will overrride the message* variables (these variables can be set in the configuration file). +
501 If no relevant message* variable is set and no status message provided, the current status message is kept. + 500 If no relevant message* variable is set and no status message provided, the current status message is kept. +
502 If StatusMessage is "-", the current status message is cleared. + 501 If StatusMessage is "-", the current status message is cleared. +
503 With the "/status message" command, mcabber will update the message while preserving the status. 502 With the "/status message" command, mcabber will update the message while preserving the status.
504 503
505 /status_to jid online|avail|invisible|free|dnd|notavail|away [statusmessage]:: 504 /status_to jid online|avail|free|dnd|notavail|away [statusmessage]::
506 /status_to jid message statusmessage:: 505 /status_to jid message statusmessage::
507 Send the requested status to the specified Jabber user. + 506 Send the requested status to the specified Jabber user. +
508 If the specified jid is ".", the current buddy is used. + 507 If the specified jid is ".", the current buddy is used. +
509 Note: this status will be overridden by subsequent "/status" commands. If you are using the auto-away feature, the status will overridden too. + 508 Note: this status will be overridden by subsequent "/status" commands. If you are using the auto-away feature, the status will overridden too. +
510 Note: The jid can include a resource (i.e. \user@server/resource). 509 Note: The jid can include a resource (i.e. \user@server/resource).
542 http://wiki.mcabber.com/[Official wiki] + 541 http://wiki.mcabber.com/[Official wiki] +
543 xmpp:mcabber@conf.lilotux.net[MCabber MUC room] 542 xmpp:mcabber@conf.lilotux.net[MCabber MUC room]
544 543
545 COPYING 544 COPYING
546 ------- 545 -------
547 Copyright \(C) 2005-2010 Mikael Berthe and others. + 546 Copyright \(C) 2005-2011 Mikael Berthe and others. +
548 547
549 Free use of this software is granted under the terms of the GNU General Public 548 Free use of this software is granted under the terms of the GNU General Public
550 License (GPL). 549 License (GPL).