Mercurial > ~mikael > mcabber > hg
changeset 904:9d11c1b1af7a
English help files
Thanks to Salvador and Lione for their work.
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,5 @@ + + /HELP [command|+topic] + +Display some help about a command or a topic. +If no argument provided a usage of this command is printed.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_add.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,9 @@ + + /ADD [jid [nickname]] + +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. + +/add [jid [nickname]] + Add to our roster [jid] as [nickname] + +Example: "/add somebody@jabber.server.com Somebody"
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_alias.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,16 @@ + + /ALIAS [name [= command line]] + +This command let you to add aliases which can simplify sophisticated commands. +You can manage your aliases by: + +/alias + Print list of currently defined aliases +/alias name + Print the value of alias called [name] +/alias name= + Unset alias called [name] +/alias name = command line + Set alias called [name] with value [command line] + +Example: "/alias away = status away"
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_authorization.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,14 @@ + + /AUTHORIZATION allow|cancel|request|request_unsubscribe [jid] + +This command manages presence subscriptions: it allows you to request presence subscriptions from others on your roster, and allows you to control who receives your presence notifications. +If no JID is provided, the currently-selected buddy is used. + +/authorization allow + Allow the buddy to receive your presence updates +/authorization cancel + Cancel the buddy's subscription to your presence updates +/authorization request + Request a subscription to the buddy's presence updates +/authorization request_unsubscribe + Request unsubscription from the buddy's presence updates
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_bind.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,17 @@ + + /BIND [keycode [= command line]] + +Bind the command to the key given as [keycode]. To examine which keys are currently not used look at `mcabber` log window and press examined key. For example: "Unknown key=265" means that you can bind some command to key #265. + +/bind + Display list of current bindings +/bind keycode + Display the command line bound to this key +/bind keycode= + Unbind key with code [keycode] +/bind keycode = command line + Bind [command line] to the key with code [keycode] + +Example: "/bind 265 = status away" (265 is F1). +Note: keycodes can be different depending on your ncurses configuration. +Tip: aliases also can be used instead of commands.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_buffer.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,32 @@ + + /BUFFER [clear|purge|top|bottom|date|%|search_backward|search_forward] + /BUFFER [scroll_lock|scroll_unlock|scroll_toggle] + +Buddy's buffer manipulation command. Eg. you can search through buffer for "text", clear chat window etc. + +/buffer clear + Clear the current buddy chat window +/buffer purge + Clear the current buddy chat window and empty all contents of the chat buffer +/buffer bottom + Jump to the bottom of the current buddy chat buffer +/buffer top + Jump to the top of the current buddy chat buffer +/buffer up [n] + Scroll the buffer up [n] lines (default: half a screen) +/buffer down [n] + Scroll the buffer down [n] lines (default: half a screen) +/buffer date [date] + Jump to the first line after the specified [date] in the chat buffer (date format: "YYYY-mm-dd") +/buffer % n + Jump to position %n of the buddy chat buffer +/buffer search_backward text + Search for [text] in the current buddy chat buffer +/buffer search_forward text + Search for [text] in the current buddy chat buffer +/buffer scroll_lock + Lock buffer scrolling +/buffer scroll_unlock + Unlock buffer scrolling +/buffer scroll_toggle + Toggle buffer scrolling (lock/unlock)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_clear.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,4 @@ + + /CLEAR + +This command is actually an alias for "/buffer clear". It clears the current buddy chat window.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_connect.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,4 @@ + + /CONNECT + +Establish connection to the Jabber server.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_del.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,4 @@ + + /DEL + +Delete the current buddy from our roster, unsubscribe from its presence notification and unsubscribe it from ours.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_disconnect.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,5 @@ + + /DISCONNECT + +Terminate the 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.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_event.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,15 @@ + + /EVENT #N|* accept|ignore|reject + /EVENT list + +Tell mcabber what to do about pending events. +If the first parameter is '*', the command will apply to all queued events. + +/event #N|all accept + Event number #N/All events will be accepted +/event #N|all ignore + Event number #N/All events will be ignored +/event #N|all reject + Event number #N/All events will be rejected +/event list + List all pending events
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_group.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,11 @@ + + /GROUP fold|unfold|toggle + +This command changes the current group display. + +/group fold + Fold (shrink) the current group tree in the roster +/group unfold + Unfold (expand) the current group tree in the roster +/group toggle + Toggle the state (fold/unfold) of the current tree
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_help.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,5 @@ + + /HELP command + +Display help for command [command] +Example: "/help buffer"
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_info.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,5 @@ + + /INFO + +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.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_move.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,5 @@ + + /MOVE [groupname] + +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.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_msay.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,21 @@ + + /MSAY begin|verbatim|send|send_to|toggle|abort + +Send a multi-line message. To write a single message with several lines, the 'multi-line mode' should be used. +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. +The 'begin' subcommand enables multi-line mode. Note that it allows a message subject to be specified. +The 'verbatim' 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. +The 'toggle' subcommand can be bound to a key to use the multi-line mode quickly (for example, "bind M13 = msay toggle" to switch using the Meta-Enter combination). + +/msay begin [subject] + Enter multi-line mode +/msay verbatim + Enter verbatim multi-line mode +/msay send + Send the current multi-line message to the currently selected buddy +/msay send_to [jid] + Send the current multi-line message to [jid] +/msay toggle + Switch to/from multi-line mode (begin/send) +/msay abort + Leave multi-line mode without sending the message
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_quit.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,4 @@ + + /QUIT + +This command closes all connections and quit mcabber.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_rawxml.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,10 @@ + + /RAWXML send 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. + +Example: "/rawxml send <presence><show>away</show></presence>"
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_rename.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,4 @@ + + /RENAME name + +Rename the current buddy or group to the given [name].
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_request.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,9 @@ + + /REQUEST time|version [jid] + +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. + +/request time + Request time from the buddy +/request version + Request version from the buddy
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_room.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,36 @@ + + /ROOM join|leave|names|nick|remove|topic|unlock|destroy + /ROOM privmsg|invite|kick|ban|role|affil + +The 'room' command handles Multi-User Chat room actions. + +/room join [room [nick [pass]]] + Join "room", using "nick" as nickname. If no nickname is provided (or if it is an empty string), 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. A password can be provided to enter protected rooms. If your nickname contains space characters, use quotes. +/room leave [message] + Leave the current room +/room names + Display members of the current room +/room nick nick + Change your nickname in the current room +/room privmsg nick msg + Send private message "msg" to "nick" +/room remove + Remove the current room from the roster (you must have left this room before) +/room topic + Set topic for current room +/room unlock + Unlock current room (if you are the owner) +/room destroy [reason] + Destroy the current room (use with care!) +/room whois nick + Display MUC information about "nick" +/room ban jid [reason] + Ban jid from the current room +/room invite jid [reason] + Invite jid to the current room +/room kick nick [reason] + Kick "nick" from the current room +/room role jid role [reason] + Change jid's role (role can be "none", "visitor", "participant", "moderator") +/room affil jid affil [reason] + Change jid's affiliation (affil can be "none", "member", "admin", "owner")
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_roster.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,37 @@ + + /ROSTER bottom|top|hide_offline|show_offline|toggle_offline + /ROSTER hide|show|toggle + /ROSTER alternate|unread_first|unread_next + /ROSTER search bud + +The 'roster' command manipulates the roster/buddylist. +Here are the available parameters: + +/roster bottom + Jump to the bottom of the roster +/roster top + Jump to the top of the roster +/roster up + Move up in the roster +/roster down + Move down in the roster +/roster hide_offline + Hide offline buddies +/roster show_offline + Show offline buddies +/roster toggle_offline + Toggle display of offline buddies +/roster hide + Hide roster (full-width chat window) +/roster show + Show roster +/roster toggle + Toggle roster visibility +/roster search bud + Search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) +/roster alternate + 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") +/roster unread_first + Jump to the first unread message +/roster unread_next + Jump to the next unread message
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_say.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,4 @@ + + /SAY [text] + +Send the [text] message to the currently selected buddy. It can be useful if you want to send a message beginning with a slash, for example.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_say_to.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,5 @@ + + /SAY_TO jid text + +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.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_set.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,4 @@ + + /SET option [= value] + +Display or set an option value.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_status.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,8 @@ + + /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 (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.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mcabber/doc/help/en/hlp_status_to.txt Wed Jun 21 20:55:28 2006 +0200 @@ -0,0 +1,7 @@ + + /STATUS_TO jid online|avail|invisible|free|dnd|notavail|away [StatusMessage] + +Send the requested status to the specified Jabber user. +If the specified jid is ".", the current buddy is used. +Note: this status will be overridden by subsequent "/status" commands. If you are using the auto-away feature, the status will overridden too. +Note: The jid can include a resource (i.e. user@server/resource).