Changeset 2288705 for doc/user-guide


Ignore:
Timestamp:
2009-12-07T21:54:19Z (15 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
1c3008a
Parents:
aac4017 (diff), 36cf9fd (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merging head.

Location:
doc/user-guide
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/Makefile

    raac4017 r2288705  
    1313
    1414%.html: %.db.xml
    15         xsltproc --output $@ http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $<
     15        xsltproc --output $@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl $<
    1616
    1717%.pdf: %.db.xml

  • doc/user-guide/commands.xml

    raac4017 r2288705  
    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
     178                                <para>
     179                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
     180                                </para>
     181                        </description>
     182
     183                </bitlbee-command>
     184
     185                <bitlbee-command name="del">
     186                        <syntax>chat del &lt;chat id&gt;</syntax>
     187
     188                        <description>
     189                                <para>
     190                                        This commands deletes an chatroom from your list.
     191                                </para>
     192
     193                                <para>
     194                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
     195                                </para>
     196                        </description>
     197                </bitlbee-command>
     198
     199                <bitlbee-command name="list">
     200                        <syntax>chat list</syntax>
     201
     202                        <description>
     203                                <para>
     204                                        This command gives you a list of all the chatrooms known by BitlBee.
     205                                </para>
     206                        </description>
     207                </bitlbee-command>
     208
     209                <bitlbee-command name="with">
     210                        <syntax>chat with &lt;nickname&gt;</syntax>
     211
     212                        <description>
     213                                <para>
     214                                        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.
     215                                </para>
     216                        </description>
     217                </bitlbee-command>
     218
     219                <bitlbee-command name="set">
     220                        <syntax>chat set &lt;chat id&gt;</syntax>
     221                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
     222                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
     223                        <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</syntax>
     224
     225                        <description>
     226                                <para>
     227                                        This command can be used to change various settings for chatrooms.
     228                                </para>
     229                               
     230                                <para>
     231                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
     232                                </para>
     233                               
     234                                <para>
     235                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
    149236                                </para>
    150237                        </description>
    … …  
    303390        </bitlbee-setting>
    304391
     392        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
     393                <default>false</default>
     394
     395                <description>
     396                        <para>
     397                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
     398                        </para>
     399                </description>
     400        </bitlbee-setting>
     401
    305402        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
    306403                <default>false</default>
    … …  
    486583        </bitlbee-setting>
    487584
     585        <bitlbee-setting name="nick" type="string" scope="chat">
     586
     587                <description>
     588                        <para>
     589                                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.
     590                        </para>
     591                </description>
     592        </bitlbee-setting>
     593
    488594        <bitlbee-setting name="ops" type="string" scope="global">
    489595                <default>both</default>
    … …  
    580686        <bitlbee-setting name="resource_select" type="string" scope="account">
    581687                <default>priority</default>
    582                 <possible-values>priority, time</possible-values>
     688                <possible-values>priority, activity</possible-values>
    583689
    584690                <description>
    … …  
    588694
    589695                        <para>
    590                                 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).
     696                                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).
    591697                        </para>
    592698                </description>
    … …  
    851957                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
    852958                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
    853                 </ircexample>
    854 
    855         </bitlbee-command>
    856 
    857         <bitlbee-command name="join_chat">
    858                 <short-description>Join a named groupchat/conference room</short-description>
    859                 <syntax>join_chat &lt;connection&gt; &lt;room name&gt; [&lt;channel name&gt;] [&lt;room nickname&gt;] [&lt;password&gt;]</syntax>
    860 
    861                 <description>
    862                         <para>
    863                                 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.
    864                         </para>
    865 
    866                         <para>
    867                                 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.
    868                         </para>
    869 
    870                         <para>
    871                                 The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&amp;bitlbee-help</emphasis> because <emphasis>&amp;bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>.
    872                         </para>
    873                 </description>
    874 
    875                 <ircexample>
    876                         <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &amp;bitlbee-help help-me</ircline>
    877959                </ircexample>
    878960

  • doc/user-guide/help.xml

    raac4017 r2288705  
    1 <?xml version="1.0" encoding="iso-8859-1"?>
     1<?xml version="1.0" encoding="utf-8"?>
    22<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
    33

  • doc/user-guide/misc.xml

    raac4017 r2288705  
    6969
    7070<para>
    71 If you want to start a groupchat with the person <emphasis>lisa_msn</emphasis> in it, just join the channel <emphasis>#lisa_msn</emphasis>. BitlBee will refuse to join you to the channel with that name, but it will create a new virtual channel with root, you and lisa_msn in it.
     71To open a groupchat, use the <emphasis>chat with</emphasis> command. For example,  to start a groupchat with the person <emphasis>lisa_msn</emphasis> in it, just type <emphasis>chat with lisa_msn</emphasis>. BitlBee will create a new virtual channel with root, you and lisa_msn in it.
    7272</para>
    7373
    7474<para>
    75 Of course a channel with only two people isn't really exciting yet. So the next step is to invite some other people to the channel. For this, you can use the <emphasis>/invite</emphasis> command of your IRC client. Please do keep in mind that all the people have to be on the same network and contact list! You can't invite Yahoo! buddies into an MSN groupchat.
     75Then, just use the ordinary IRC <emphasis>/invite</emphasis> command to invite more people. Please do keep in mind that all the people have to be on the same network and contact list! You can't invite Yahoo! buddies into an MSN groupchat.
    7676</para>
    7777
    7878<para>
    79 Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>join_chat</emphasis> command to join them. See <emphasis>help join_chat</emphasis> for more information.
     79Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>chat add</emphasis> command to join them. See <emphasis>help chat add</emphasis> for more information.
    8080</para>
    8181

  • doc/user-guide/user-guide.xml

    raac4017 r2288705  
    1 <?xml version="1.0" encoding="iso-8859-1"?>
     1<?xml version="1.0" encoding="utf-8"?>
    22<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
    33
Note: See TracChangeset for help on using the changeset viewer.