source: doc/user-guide/commands.xml @ 58f5ef7

<chapter id="commands">
        <title>Bitlbee commands</title>

        <command-list/>

        <bitlbee-command name="account">
                <short-description>IM-account list maintenance</short-description>
                <syntax>account &lt;action&gt; [&lt;arguments&gt;]</syntax>

                <description>

                        <para>
                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
                        </para>

                </description>

                <bitlbee-command name="add">
                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>

                        <description>
                                <para>
                                        Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ), Yahoo and Twitter. For more information about adding an account, see <emphasis>help account add &lt;protocol&gt;</emphasis>.
                                </para>
                        </description>
                        
                        <bitlbee-command name="jabber">
                                <syntax>account add jabber &lt;handle@server.tld&gt; &lt;password&gt;</syntax>

                                <description>
                                        <para>
                                                The handle should be a full handle, including the domain name. You can specify a servername if necessary. Normally BitlBee doesn't need this though, since it's able to find out the server by doing DNS SRV lookups.
                                        </para>

                                        <para>
                                                In previous versions it was also possible to specify port numbers and/or SSL in the server tag. This is deprecated and should now be done using the <emphasis>account set</emphasis> command. This also applies to specifying a resource in the handle (like <emphasis>wilmer@bitlbee.org/work</emphasis>).
                                        </para>
                                </description>
                        </bitlbee-command>

                        <bitlbee-command name="msn">
                                <syntax>account add msn &lt;handle@server.tld&gt; &lt;password&gt;</syntax>

                                <description>
                                        <para>
                                                For MSN connections there are no special arguments.
                                        </para>
                                </description>
                        </bitlbee-command>
                        
                        <bitlbee-command name="oscar">
                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt;</syntax>

                                <description>
                                        <para>
                                                OSCAR is the protocol used to connect to AIM and/or ICQ. The servers will automatically detect if you're using a numeric or non-numeric username so there's no need to tell which network you want to connect to.
                                        </para>
                                </description>

                                <ircexample>
                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
                                        <ircline nick="root">Account successfully added</ircline>
                                </ircexample>
                        </bitlbee-command>
                        
                        <bitlbee-command name="twitter">
                                <syntax>account add twitter &lt;handle&gt; &lt;password&gt;</syntax>

                                <description>
                                        <para>
                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
                                        </para>
                                        
                                        <para>
                                                By default all your Twitter contacts will come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
                                        </para>
                                        
                                        <para>
                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
                                        </para>

                                        <para>
                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
                                        </para>
                                </description>
                        </bitlbee-command>

                        <bitlbee-command name="yahoo">
                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>

                                <description>
                                        <para>
                                                For Yahoo! connections there are no special arguments.
                                        </para>
                                </description>
                        </bitlbee-command>

                </bitlbee-command>

                <bitlbee-command name="del">
                        <syntax>account del &lt;account id&gt;</syntax>

                        <description>
                                <para>
                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
                                </para>


                                <para>
                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
                                </para>
                        </description>
                </bitlbee-command>

                <bitlbee-command name="on">
                        <syntax>account on [&lt;account id&gt;]</syntax>

                        <description>
                                <para>
                                        This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts that have the auto_connect flag set.
                                </para>

                                <para>
                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
                                </para>
                        </description>

                </bitlbee-command>

                <bitlbee-command name="off">
                        <syntax>account off [&lt;account id&gt;]</syntax>

                        <description>
                                <para>
                                        This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts and cancel all pending reconnects.
                                </para>

                                <para>
                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
                                </para>
                        </description>
                </bitlbee-command>

                <bitlbee-command name="list">
                        <syntax>account list</syntax>

                        <description>
                                <para>
                                        This command gives you a list of all the accounts known by BitlBee.
                                </para>
                        </description>
                </bitlbee-command>

                <bitlbee-command name="set">
                        <syntax>account set &lt;account id&gt;</syntax>
                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
                        <syntax>account set -del &lt;account id&gt;/&lt;setting&gt;</syntax>

                        <description>
                                <para>
                                        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 &lt;account id&gt;</emphasis>.
                                </para>
                                
                                <para>
                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
                                </para>
                                
                                <para>
                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
                                </para>
                        </description>
                </bitlbee-command>
        </bitlbee-command>

        <bitlbee-command name="chat">
                <short-description>Chatroom list maintenance</short-description>
                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>

                <description>

                        <para>
                                Available actions: add, del, list, with and set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
                        </para>

                </description>

                <bitlbee-command name="add">
                        <syntax>chat add &lt;account&gt; &lt;room&gt; [&lt;channel&gt;]</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 &lt;chat id&gt;</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 &lt;nickname&gt;</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 &lt;chat id&gt;</syntax>
                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
                        <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</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 &lt;setting&gt;</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 &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>

                <description>
                        <para>
                                Adds the given buddy at the specified connection to your buddy list. The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
                        </para>

                        <para>
                                If you want, you can also tell BitlBee what nick to give the new contact. The -tmp option adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications.
                        </para>
                </description>

                <ircexample>
                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
                </ircexample>
        </bitlbee-command>

        <bitlbee-command name="info">
                <short-description>Request user information</short-description>
                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
                <syntax>info &lt;nick&gt;</syntax>

                <description>
                        <para>
                                Requests IM-network-specific information about the specified user. The amount of information you'll get differs per protocol. For some protocols (ATM Yahoo! and MSN) it'll give you an URL which you can visit with a normal web browser to get the information.
                        </para>
                </description>

                <ircexample>
                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
                </ircexample>

        </bitlbee-command>

        <bitlbee-command name="remove">
                <short-description>Remove a buddy from your contact list</short-description>
                <syntax>remove &lt;nick&gt;</syntax>

                <description>
                        <para>
                                Removes the specified nick from your buddy list. 
                        </para>
                </description>

                <ircexample>
                        <ircline nick="ctrlsoft">remove gryp</ircline>
                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
                </ircexample>

        </bitlbee-command>

        <bitlbee-command name="block">
                <short-description>Block someone</short-description>
                <syntax>block &lt;nick&gt;</syntax>
                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
                <syntax>block &lt;connection&gt;</syntax>

                <description>
                        <para>
                                Puts the specified user on your ignore list. Either specify the user's nick when you have him/her in your contact list or a connection number and a user handle.
                        </para>
                        
                        <para>
                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
                        </para>
                </description>
        </bitlbee-command>

        <bitlbee-command name="allow">
                <short-description>Unblock someone</short-description>
                <syntax>allow &lt;nick&gt;</syntax>
                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>

                <description>
                        <para>
                                Reverse of block. Unignores the specified user or user handle on specified connection.
                        </para>
                        
                        <para>
                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
                        </para>
                </description>
        </bitlbee-command>

        <bitlbee-command name="set">
                <short-description>Miscellaneous settings</short-description>
                <syntax>set</syntax>
                <syntax>set &lt;variable&gt;</syntax>
                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
                <syntax>set -del &lt;variable&gt;</syntax>

                <description>

                        <para>
                                Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. With <emphasis>-del</emphasis> you can reset a setting to its default value.
                        </para>

                        <para>
                                To get more help information about a setting, try:
                        </para>

                </description>

                <ircexample>
                        <ircline nick="ctrlsoft">help set private</ircline>
                </ircexample>

        </bitlbee-command>

        <bitlbee-command name="help">
                <short-description>BitlBee help system</short-description>

                <syntax>help [subject]</syntax>

                <description>
                        <para>
                                This command gives you the help information you're reading right now. If you don't give any arguments, it'll give a short help index.
                        </para>
                </description>
        </bitlbee-command>

        <bitlbee-command name="save">
                <short-description>Save your account data</short-description>
                <syntax>save</syntax>

                <description>
                        <para>
                                This command saves all your nicks and accounts immediately. Handy if you have the autosave functionality disabled, or if you don't trust the program's stability... ;-)
                        </para>
                </description>
        </bitlbee-command>

        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
                <default>true</default>

                <description>
                        <para>
                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
                        </para>
                        
                        <para>
                                This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_connect</emphasis> setting is disabled!)
                        </para>
                </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>true</default>

                <description>
                        <para>
                                If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting.
                        </para>

                        <para>
                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
                        </para>

                        <para>
                                This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_reconnect</emphasis> setting is disabled!)
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
                <default>5*3&lt;900</default>

                <description>
                        <para>
                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
                        </para>

                        <para>
                                This can be one integer, for a constant delay. One can also set it to something like &quot;10*10&quot;, which means wait for ten seconds on the first reconnect, multiply it by ten on every failure. Once successfully connected, this delay is re-set to the initial value. With &lt; you can give a maximum delay.
                        </para>

                        <para>
                                See also the <emphasis>auto_reconnect</emphasis> setting.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="away" type="string" scope="both">
                <description>
                        <para>
                                To mark yourself as away, it is recommended to just use <emphasis>/away</emphasis>, like on normal IRC networks. If you want to mark yourself as away on only one IM network, you can use this per-account setting.
                        </para>

                        <para>
                                You can set it to any value and BitlBee will try to map it to the most appropriate away state for every open IM connection, or set it as a free-form away message where possible.
                        </para>

                        <para>
                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
                <default>true</default>

                <description>
                        <para>
                                With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
                <default>false</default>

                <description>
                        <para>
                                By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data.
                        </para>

                        <para>
                                Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
                        </para>

                        <para>
                                Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
                <default>200</default>

                <description>

                        <para>
                                Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds.
                        </para>

                        <para>
                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="charset" type="string" scope="global">
                <default>utf-8</default>
                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>

                <description>
                        <para>
                                This setting tells BitlBee what your IRC client sends and expects. It should be equal to the charset setting of your IRC client if you want to be able to send and receive non-ASCII text properly.
                        </para>

                        <para>
                                Most systems use UTF-8 these days. On older systems, an iso8859 charset may work better. For example, iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://www.unicodecharacter.com/charsets/iso8859.html
                        </para>
                </description>

        </bitlbee-setting>

        <bitlbee-setting name="control_channel" type="string" scope="global">
                <default>&amp;bitlbee</default>

                <description>
                        <para>
                                Normally the control channel where you can see all your contacts is called "&amp;bitlbee". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="debug" type="boolean" scope="global">
                <default>false</default>

                <description>
                        <para>
                                Some debugging messages can be sent to the control channel if you wish. They're probably not really useful for you, unless you're doing some development on BitlBee.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="default_target" type="string" scope="global">
                <default>root</default>
                <possible-values>root, last</possible-values>

                <description>
                        <para>
                                With this value set to <emphasis>root</emphasis>, lines written in the control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in the control channel, set this to <emphasis>last</emphasis>.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="display_name" type="string" scope="account">
                <description>
                        <para>
                                Currently only available for MSN connections. This setting allows you to read and change your "friendly name" for this connection. Since this is a server-side setting, it can't be changed when the account is off-line.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
                <default>false</default>

                <description>
                        <para>
                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
                <default>true</default>

                <description>
                        <para>
                                When incoming messages are old (i.e. offline messages and channel backlogs), BitlBee will prepend them with a timestamp. If you find them ugly or useless, you can use this setting to hide them.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="handle_unknown" type="string" scope="global">
                <default>root</default>
                <possible-values>root, add, add_private, add_channel, ignore</possible-values>

                <description>
                        <para>
                                Messages from unknown users are echoed like this by default:
                        </para>

                        <ircexample>
                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
                        </ircexample>

                        <para>
                                If you want this lame user to be added automatically, you can set this setting to "add". If you prefer to ignore messages from people you don't know, you can set this one to "ignore". "add_private" and "add_channel" are like add, but you can use them to make messages from unknown buddies appear in the channel instead of a query window.
                        </para>

                        <note>
                                <para>
                                        Auto-added users aren't added to your real contact list. This is because you don't want the user to get authorization requests. So when you restart BitlBee, the auto-added user will be gone. If you want to keep the person in your buddy-list, you have to fixate the add using the <emphasis>add</emphasis> command.
                                </para>
                        </note>
                </description>

        </bitlbee-setting>

        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
                <default>true</default>

                <description>
                        <para>
                                Only supported by OSCAR so far, you can use this setting to ignore ICQ authorization requests, which are hardly used for legitimate (i.e. non-spam) reasons anymore.
                        </para>
                </description>

        </bitlbee-setting>

        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
                <default>true</default>

                <description>
                        <para>
                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
                        </para>
                </description>

        </bitlbee-setting>

        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
                <default>false</default>

                <description>
                        <para>
                                Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting.
                        </para>
                </description>

        </bitlbee-setting>

        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
                <default>false</default>

                <description>
                        <para>
                                Some protocols (MSN, Yahoo!) can notify via IM about new e-mail. Since most people use their Hotmail/Yahoo! addresses as a spam-box, this is disabled default. If you want these notifications, you can enable this setting.
                        </para>
                </description>

        </bitlbee-setting>

        <bitlbee-setting name="message_length" type="integer" scope="account">
                <default>140</default>

                <description>
                        <para>
                                Since Twitter rejects messages longer than 140 characters, BitlBee can count message length and emit a warning instead of waiting for Twitter to reject it.
                        </para>

                        <para>
                                You can change this limit here but this won't disable length checks on Twitter's side. You can also set it to 0 to disable the check in case you believe BitlBee doesn't count the characters correctly.
                        </para>
                </description>

        </bitlbee-setting>

        <bitlbee-setting name="mode" type="string" scope="account">
                <possible-values>one, many, chat</possible-values>
                <default>one</default>

                <description>
                        <para>
                                By default, everything from the Twitter module will come from one nick, twitter_(yourusername). If you prefer to have individual nicks for everyone, you can set this setting to "many" instead.
                        </para>
                        
                        <para>
                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
                        </para>
                        
                        <para>
                                In the last two modes, you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
                        </para>
                </description>

        </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="nick_source" type="string" scope="account">
                <default>handle</default>
                <possible-values>handle, full_name, first_name</possible-values>

                <description>
                        <para>
                                By default, BitlBee generates a nickname for every contact by taking its handle and chopping off everything after the @. In some cases, this gives very inconvenient nicknames. The Facebook XMPP server is a good example, as all Facebook XMPP handles are numeric.
                        </para>

                        <para>
                                With this setting set to <emphasis>full_name</emphasis>, the person's full name is used to generate a nickname. Or if you don't like long nicknames, set this setting to <emphasis>first_name</emphasis> instead and only the first word will be used. Note that the full name can be full of non-ASCII characters which will be stripped off.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="oauth" type="boolean" scope="account">
                <default>true</default>

                <description>
                        <para>
                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
                        </para>

                        <para>
                                With OAuth enabled, you shouldn't tell BitlBee your Twitter password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with Twitter. If this succeeds, Twitter will return a PIN code which you can give back to BitlBee to finish the process.
                        </para>

                        <para>
                                The resulting access token will be saved permanently, so you have to do this only once.
                        </para>
                </description>

        </bitlbee-setting>

        <bitlbee-setting name="ops" type="string" scope="global">
                <default>both</default>
                <possible-values>both, root, user, none</possible-values>

                <description>
                        <para>
                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can change these states using this setting.
                        </para>

                        <para>
                                The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="password" type="string" scope="both">
                <description>
                        <para>
                                Use this global setting to change your "NickServ" password.
                        </para>
                        
                        <para>
                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
                        </para>
                        
                        <para>
                                Note that BitlBee will always say this setting is empty. This doesn't mean there is no password, it just means that, for security reasons, BitlBee stores passwords somewhere else so they can't just be retrieved in plain text.
                        </para>
                </description>
        </bitlbee-setting>
        
        <bitlbee-setting name="port" type="integer" scope="account">
                <description>
                        <para>
                                Currently only available for Jabber connections. Specifies the port number to connect to. Usually this should be set to 5222, or 5223 for SSL-connections.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="priority" type="integer" scope="account">
                <default>0</default>

                <description>
                        <para>
                                Can be set for Jabber connections. When connecting to one account from multiple places, this priority value will help the server to determine where to deliver incoming messages (that aren't addressed to a specific resource already).
                        </para>

                        <para>
                                According to RFC 3921 servers will always deliver messages to the server with the highest priority value. Mmessages will not be delivered to resources with a negative priority setting (and should be saved as an off-line message if all available resources have a negative priority value).
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="private" type="boolean" scope="global">
                <default>true</default>

                <description>
                        <para>
                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
                        </para>

                        <para>
                                This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="query_order" type="string" scope="global">
                <default>lifo</default>
                <possible-values>lifo, fifo</possible-values>

                <description>
                        <para>
                                This changes the order in which the questions from root (usually authorization requests from buddies) should be answered. When set to <emphasis>lifo</emphasis>, BitlBee immediately displays all new questions and they should be answered in reverse order. When this is set to <emphasis>fifo</emphasis>, BitlBee displays the first question which comes in and caches all the others until you answer the first one.
                        </para>

                        <para>
                                Although the <emphasis>fifo</emphasis> setting might sound more logical (and used to be the default behaviour in older BitlBee versions), it turned out not to be very convenient for many users when they missed the first question (and never received the next ones).
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="resource" type="string" scope="account">
                <default>BitlBee</default>

                <description>
                        <para>
                                Can be set for Jabber connections. You can use this to connect to your Jabber account from multiple clients at once, with every client using a different resource string.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="resource_select" type="string" scope="account">
                <default>activity</default>
                <possible-values>priority, activity</possible-values>

                <description>
                        <para>
                                Because the IRC interface makes it pretty hard to specify the resource to talk to (when a buddy is online through different resources), this setting was added.
                        </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>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>

        <bitlbee-setting name="root_nick" type="string" scope="global">
                <default>root</default>

                <description>
                        <para>
                                Normally the "bot" that takes all your BitlBee commands is called "root". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
                <default>true</default>

                <description>
                        <para>
                                If enabled causes BitlBee to save all current settings and account details when user disconnects. This is enabled by default, and these days there's not really a reason to have it disabled anymore.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="server" type="string" scope="account">
                <description>
                        <para>
                                Can be set for Jabber- and OSCAR-connections. For Jabber, you might have to set this if the servername isn't equal to the part after the @ in the Jabber handle. For OSCAR this shouldn't be necessary anymore in recent BitlBee versions.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="show_offline" type="boolean" scope="global">
                <default>false</default>

                <description>
                        <para>
                                If enabled causes BitlBee to also show offline users in Channel. Online-users will get op, away-users voice and offline users none of both. This option takes effect as soon as you reconnect.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
                <default>true</default>

                <description>
                        <para>
                                Some IRC clients parse quit messages sent by the IRC server to see if someone really left or just disappeared because of a netsplit. By default, BitlBee tries to simulate netsplit-like quit messages to keep the control channel window clean. If you don't like this (or if your IRC client doesn't support this) you can disable this setting.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="ssl" type="boolean" scope="account">
                <default>false</default>

                <description>
                        <para>
                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="status" type="string" scope="both">
                <description>
                        <para>
                                Certain protocols (like Jabber/XMPP) support status messages, similar to away messages. They can be used to indicate things like your location or activity, without showing up as away/busy.
                        </para>

                        <para>
                                This setting can be used to set such a message. It will be available as a per-account setting for protocols that support it, and also as a global setting (which will then automatically be used for all protocols that support it).
                        </para>

                        <para>
                                Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To un-set the setting, use <emphasis>set -del status</emphasis>.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="strip_html" type="boolean" scope="global">
                <default>true</default>

                <description>
                        <para>
                                Determines what BitlBee should do with HTML in messages. Normally this is turned on and HTML will be stripped from messages, if BitlBee thinks there is HTML.
                        </para>
                        <para>
                                If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
                <default>false</default>

                <description>
                        <para>
                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
                        </para>
                        
                        <para>
                                With this setting enabled, BitlBee will send keepalives to MSN switchboards with offline/invisible contacts every twenty seconds. This should keep the server and client on the other side from shutting it down.
                        </para>
                        
                        <para>
                                This is useful because BitlBee doesn't support MSN offline messages yet and the MSN servers won't let the user reopen switchboards to offline users. Once offline messaging is supported, this flag might be removed.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="timezone" type="string" scope="global">
                <default>local</default>
                <possible-values>local, utc, gmt, timezone-spec</possible-values>

                <description>
                        <para>
                                If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting.
                        </para>

                        <para>
                                Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="tls" type="boolean" scope="account">
                <default>try</default>

                <description>
                        <para>
                                Newer Jabber servers allow clients to convert a plain-text session to a TLS/SSL-encrypted session. Normally (with this setting set to <emphasis>try</emphasis>) BitlBee will do this, if possible.
                        </para>

                        <para>
                                If you want to force BitlBee to use TLS sessions only (and to give up if that doesn't seem to be possible) you can set this setting to <emphasis>true</emphasis>. Set it to <emphasis>false</emphasis> if you want the session to remain plain-text.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="to_char" type="string" scope="global">
                <default>": "</default>

                <description>
                        <para>
                                It's customary that messages meant for one specific person on an IRC channel are prepended by his/her alias followed by a colon ':'. BitlBee does this by default. If you prefer a different character, you can set it using <emphasis>set to_char</emphasis>.
                        </para>

                        <para>
                                Please note that this setting is only used for incoming messages. For outgoing messages you can use ':' (colon) or ',' to separate the destination nick from the message, and this is not configurable.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
                <default>false</default>

                <description>
                        <para>
                                Sends you a /notice when a user starts typing a message (if supported by the IM protocol and the user's client). To use this, you most likely want to use a script in your IRC client to show this information in a more sensible way.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="web_aware" type="string" scope="account">
                <default>false</default>

                <description>
                        <para>
                                ICQ allows people to see if you're on-line via a CGI-script. (http://status.icq.com/online.gif?icq=UIN) This can be nice to put on your website, but it seems that spammers also use it to see if you're online without having to add you to their contact list. So to prevent ICQ spamming, recent versions of BitlBee disable this feature by default.
                        </para>

                        <para>
                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
                <default>false</default>

                <description>
                        <para>
                                The Jabber module allows you to add a buddy <emphasis>xmlconsole</emphasis> to your contact list, which will then show you the raw XMPP stream between you and the server. You can also send XMPP packets to this buddy, which will then be sent to the server.
                        </para>
                        <para>
                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
                        </para>
                </description>
        </bitlbee-setting>

        <bitlbee-command name="rename">
                <short-description>Rename (renick) a buddy</short-description>
                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>

                <description>
                        <para>
                                Renick a user in your buddy list. Very useful, in fact just very important, if you got a lot of people with stupid account names (or hard ICQ numbers).
                        </para>
                </description>

                <ircexample>
                        <ircline nick="itsme">rename itsme_ you</ircline>
                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
                </ircexample>

        </bitlbee-command>

        <bitlbee-command name="yes">
                <short-description>Accept a request</short-description>
                <syntax>yes [&lt;number&gt;]</syntax>

                <description>
                        <para>
                                Sometimes an IM-module might want to ask you a question. (Accept this user as your buddy or not?) To accept a question, use the <emphasis>yes</emphasis> command.
                        </para>

                        <para>
                                By default, this answers the first unanswered question. You can also specify a different question as an argument. You can use the <emphasis>qlist</emphasis> command for a list of questions.
                        </para>
                </description>

        </bitlbee-command>

        <bitlbee-command name="no">
                <short-description>Deny a request</short-description>
                <syntax>no [&lt;number&gt;]</syntax>

                <description>
                        <para>
                                Sometimes an IM-module might want to ask you a question. (Accept this user as your buddy or not?) To reject a question, use the <emphasis>no</emphasis> command.
                        </para>

                        <para>
                                By default, this answers the first unanswered question. You can also specify a different question as an argument. You can use the <emphasis>qlist</emphasis> command for a list of questions.
                        </para>
                </description>
        </bitlbee-command>

        <bitlbee-command name="qlist">
                <short-description>List all the unanswered questions root asked</short-description>
                <syntax>qlist</syntax>

                <description>
                        <para>
                                This gives you a list of all the unanswered questions from root.
                        </para>
                </description>

        </bitlbee-command>

        <bitlbee-command name="register">
                <short-description>Register yourself</short-description>
                <syntax>register &lt;password&gt;</syntax>

                <description>
                        <para>
                                BitlBee can save your settings so you won't have to enter all your IM passwords every time you log in. If you want the Bee to save your settings, use the <emphasis>register</emphasis> command.
                        </para>

                        <para>
                                Please do pick a secure password, don't just use your nick as your password. Please note that IRC is not an encrypted protocol, so the passwords still go over the network in plaintext. Evil people with evil sniffers will read it all. (So don't use your root password.. ;-)
                        </para>

                        <para>
                                To identify yourself in later sessions, you can use the <emphasis>identify</emphasis> command. To change your password later, you can use the <emphasis>set password</emphasis> command.
                        </para>
                </description>

        </bitlbee-command>

        <bitlbee-command name="identify">
                <syntax>identify &lt;password&gt;</syntax>
                <short-description>Identify yourself with your password</short-description>

                <description>
                        <para>
                                BitlBee saves all your settings (contacts, accounts, passwords) on-server. To prevent other users from just logging in as you and getting this information, you'll have to identify yourself with your password. You can register this password using the <emphasis>register</emphasis> command.
                        </para>

                        <para>
                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
                        </para>
                </description>
        </bitlbee-command>

        <bitlbee-command name="drop">
                <syntax>drop &lt;password&gt;</syntax>
                <short-description>Drop your account</short-description>

                <description>
                        <para>
                                Drop your BitlBee registration. Your account files will be removed and your password will be forgotten. For obvious security reasons, you have to specify your NickServ password to make this command work.
                        </para>
                </description>
        </bitlbee-command>

        <bitlbee-command name="blist">
                <syntax>blist [all|online|offline|away]</syntax>
                <short-description>List all the buddies in your contact list</short-description>

                <description>
                        <para>
                                You can get a better readable buddy list using the <emphasis>blist</emphasis> command. If you want a complete list (including the offline users) you can use the <emphasis>all</emphasis> argument.
                        </para>
                </description>

        </bitlbee-command>

        <bitlbee-command name="nick">
                <short-description>Change friendly name, nick</short-description>
                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
                <syntax>nick &lt;connection&gt;</syntax>

                <description>
                        <para>
                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
                        </para>
                </description>

                <ircexample>
                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
                </ircexample>

        </bitlbee-command>
        
        <bitlbee-command name="transfers">
                <short-description>Monitor, cancel, or reject file transfers</short-description>
                <syntax>transfers [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
                
                <description>
                        <para>
                                Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfers &lt;action&gt;</emphasis> for more information.
                        </para>

                        <ircexample>
                                <ircline nick="ulim">transfers</ircline>
                        </ircexample>
                </description>
                
                <bitlbee-command name="cancel">
                        <short-description>Cancels the file transfer with the given id</short-description>
                        <syntax>transfers &lt;cancel&gt; id</syntax>

                        <description>
                                <para>Cancels the file transfer with the given id</para>
                        </description>

                        <ircexample>
                                <ircline nick="ulim">transfers cancel 1</ircline>
                                <ircline nick="root">Canceling file transfer for test</ircline>
                        </ircexample>
                </bitlbee-command>

                <bitlbee-command name="reject">
                        <short-description>Rejects all incoming transfers</short-description>
                        <syntax>transfers &lt;reject&gt;</syntax>

                        <description>
                                <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is neccessary. Or is it?</para>
                        </description>

                        <ircexample>
                                <ircline nick="ulim">transfers reject</ircline>
                        </ircexample>
                </bitlbee-command>
        </bitlbee-command>
        
</chapter>