Changeset c1333754


Ignore:
Timestamp:
2008-08-31T23:19:32Z (16 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
35529ae
Parents:
07054a5
Message:

Added documentation on the "chat" command.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/commands.xml

    r07054a5 rc1333754  
    125125                        <description>
    126126                                <para>
    127                                         This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands.
     127                                        This command gives you a list of all the accounts known by BitlBee.
    128128                                </para>
    129129                        </description>
    … …  
    138138                        <description>
    139139                                <para>
    140                                         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 &lt;account id&gt;</emphasis>.
     140                                        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>.
    141141                                </para>
    142142                               
    143143                                <para>
    144                                         For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>. For details about the syntax of this command, see <emphasis>help set</emphasis>.
     144                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
    145145                                </para>
    146146                               
    147147                                <para>
    148148                                        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.
     149                                </para>
     150                        </description>
     151                </bitlbee-command>
     152        </bitlbee-command>
     153
     154        <bitlbee-command name="chat">
     155                <short-description>Chatroom list maintenance</short-description>
     156                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
     157
     158                <description>
     159
     160                        <para>
     161                                Available actions: add, del, list, with and set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
     162                        </para>
     163
     164                </description>
     165
     166                <bitlbee-command name="add">
     167                        <syntax>chat add &lt;account&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
     168
     169                        <description>
     170                                <para>
     171                                        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.
     172                                </para>
     173
     174                                <para>
     175                                        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>)
     176                                </para>
     177                        </description>
     178
     179                </bitlbee-command>
     180
     181                <bitlbee-command name="del">
     182                        <syntax>chat del &lt;chat id&gt;</syntax>
     183
     184                        <description>
     185                                <para>
     186                                        This commands deletes an chatroom from your list.
     187                                </para>
     188
     189                                <para>
     190                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
     191                                </para>
     192                        </description>
     193                </bitlbee-command>
     194
     195                <bitlbee-command name="list">
     196                        <syntax>chat list</syntax>
     197
     198                        <description>
     199                                <para>
     200                                        This command gives you a list of all the chatrooms known by BitlBee.
     201                                </para>
     202                        </description>
     203                </bitlbee-command>
     204
     205                <bitlbee-command name="with">
     206                        <syntax>chat with &lt;nickname&gt;</syntax>
     207
     208                        <description>
     209                                <para>
     210                                        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.
     211                                </para>
     212                        </description>
     213                </bitlbee-command>
     214
     215                <bitlbee-command name="set">
     216                        <syntax>chat set &lt;chat id&gt;</syntax>
     217                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
     218                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
     219                        <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</syntax>
     220
     221                        <description>
     222                                <para>
     223                                        This command can be used to change various settings for chatrooms.
     224                                </para>
     225                               
     226                                <para>
     227                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
     228                                </para>
     229                               
     230                                <para>
     231                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
    149232                                </para>
    150233                        </description>
    … …  
    303386        </bitlbee-setting>
    304387
     388        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
     389                <default>false</default>
     390
     391                <description>
     392                        <para>
     393                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
     394                        </para>
     395                </description>
     396        </bitlbee-setting>
     397
    305398        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
    306399                <default>false</default>
    … …  
    486579        </bitlbee-setting>
    487580
     581        <bitlbee-setting name="nick" type="string" scope="chat">
     582
     583                <description>
     584                        <para>
     585                                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.
     586                        </para>
     587                </description>
     588        </bitlbee-setting>
     589
    488590        <bitlbee-setting name="ops" type="string" scope="global">
    489591                <default>both</default>
Note: See TracChangeset for help on using the changeset viewer.