diff options
Diffstat (limited to 'doc/user-guide/commands.xml')
| -rw-r--r-- | doc/user-guide/commands.xml | 140 |
1 files changed, 111 insertions, 29 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index f22f6177..de22641b 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -124,7 +124,7 @@ <description> <para> - This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands. + This command gives you a list of all the accounts known by BitlBee. </para> </description> </bitlbee-command> @@ -137,11 +137,11 @@ <description> <para> - This account can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account set <account id></emphasis>. + This command can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account set <account id></emphasis>. </para> <para> - For more infomation about a setting, see <emphasis>help set <setting></emphasis>. For details about the syntax of this command, see <emphasis>help set</emphasis>. + For more infomation about a setting, see <emphasis>help set <setting></emphasis>. </para> <para> @@ -151,6 +151,93 @@ </bitlbee-command> </bitlbee-command> + <bitlbee-command name="chat"> + <short-description>Chatroom list maintenance</short-description> + <syntax>chat <action> [<arguments>]</syntax> + + <description> + + <para> + Available actions: add, del, list, with and set. See <emphasis>help chat <action></emphasis> for more information. + </para> + + </description> + + <bitlbee-command name="add"> + <syntax>chat add <account> <room> [<channel>]</syntax> + + <description> + <para> + Add a chatroom to the list of chatrooms you're interested in. BitlBee needs this list to map room names to a proper IRC channel name. + </para> + + <para> + After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See <emphasis>chat set</emphasis>) + </para> + + <para> + Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="del"> + <syntax>chat del <chat id></syntax> + + <description> + <para> + This commands deletes an chatroom from your list. + </para> + + <para> + The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="list"> + <syntax>chat list</syntax> + + <description> + <para> + This command gives you a list of all the chatrooms known by BitlBee. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="with"> + <syntax>chat with <nickname></syntax> + + <description> + <para> + While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="set"> + <syntax>chat set <chat id></syntax> + <syntax>chat set <chat id>/<setting></syntax> + <syntax>chat set <chat id>/<setting> <value></syntax> + <syntax>chat set -del <chat id>/<setting></syntax> + + <description> + <para> + This command can be used to change various settings for chatrooms. + </para> + + <para> + For more infomation about a setting, see <emphasis>help set <setting></emphasis>. + </para> + + <para> + The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel. + </para> + </description> + </bitlbee-command> + </bitlbee-command> + <bitlbee-command name="add"> <short-description>Add a buddy to your contact list</short-description> <syntax>add <connection> <handle> [<nick>]</syntax> @@ -302,6 +389,16 @@ </description> </bitlbee-setting> + <bitlbee-setting name="auto_join" type="boolean" scope="chat"> + <default>false</default> + + <description> + <para> + With this option enabled, BitlBee will automatically join this chatroom when you log in. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="auto_reconnect" type="boolean" scope="both"> <default>false</default> @@ -485,6 +582,15 @@ </bitlbee-setting> + <bitlbee-setting name="nick" type="string" scope="chat"> + + <description> + <para> + You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="ops" type="string" scope="global"> <default>both</default> <possible-values>both, root, user, none</possible-values> @@ -579,7 +685,7 @@ <bitlbee-setting name="resource_select" type="string" scope="account"> <default>priority</default> - <possible-values>priority, time</possible-values> + <possible-values>priority, activity</possible-values> <description> <para> @@ -587,7 +693,7 @@ </para> <para> - Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>time</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). + Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>activity</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). </para> </description> </bitlbee-setting> @@ -853,30 +959,6 @@ </ircexample> </bitlbee-command> - - <bitlbee-command name="join_chat"> - <short-description>Join a named groupchat/conference room</short-description> - <syntax>join_chat <connection> <room name> [<channel name>] [<room nickname>] [<password>]</syntax> - - <description> - <para> - On most IM-networks groupchats can be started using the /join command. (<emphasis>/join #foo</emphasis> to start a chatroom with you and <emphasis>foo</emphasis>) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command. - </para> - - <para> - The first two arguments are required. <emphasis>room name</emphasis> is the name of the chatroom on the IM-network. <emphasis>channel name</emphasis> is the IRC channel name BitlBee should map this to. <emphasis>room nickname</emphasis> is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses. - </para> - - <para> - The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&bitlbee-help</emphasis> because <emphasis>&bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>. - </para> - </description> - - <ircexample> - <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me</ircline> - </ircexample> - - </bitlbee-command> <bitlbee-command name="transfers"> <short-description>Monitor, cancel, or reject file transfers</short-description> |