Changeset 89a1809 for doc/user-guide


Ignore:
Timestamp:
2006-07-14T18:27:02Z (18 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
04026d4
Parents:
00a5270
Message:

More documentation updates: Added a Scope: line for every setting (for
per-account and global settings) and leaving out the Default: line when
there is no default specified in XML (like with the display_name setting).

Location:
doc/user-guide
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/Makefile

    r00a5270 r89a1809  
    2828        xsltproc --xinclude --output $@ docbook.xsl $<
    2929
    30 help.txt: help.xml help.xsl
     30help.txt: help.xml help.xsl commands.xml misc.xml quickstart.xml
    3131        xsltproc --stringparam extraparanewline "$(EXTRAPARANEWLINE)" --xinclude help.xsl $< | perl -0077 -pe 's/\n\n%/\n%/s; s/_b_/\002/g;' > $@
    3232

  • doc/user-guide/commands.xml

    r00a5270 r89a1809  
    296296        </bitlbee-command>
    297297
    298         <bitlbee-setting name="auto_connect" type="boolean">
    299                 <default>True</default>
     298        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
     299                <default>true</default>
    300300
    301301                <description>
    … …  
    310310        </bitlbee-setting>
    311311
    312         <bitlbee-setting name="auto_reconnect" type="boolean">
    313                 <default>False</default>
     312        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
     313                <default>false</default>
    314314
    315315                <description>
    … …  
    321321                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
    322322                        </para>
    323                 </description>
    324 
    325         </bitlbee-setting>
    326 
    327         <bitlbee-setting name="auto_reconnect_delay" type="integer">
     323
     324                        <para>
     325                                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!)
     326                        </para>
     327                </description>
     328        </bitlbee-setting>
     329
     330        <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global">
    328331                <default>300</default>
    329332
    … …  
    339342        </bitlbee-setting>
    340343
    341         <bitlbee-setting name="away_devoice" type="boolean">
    342                 <default>True</default>
     344        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
     345                <default>true</default>
    343346
    344347                <description>
    … …  
    349352        </bitlbee-setting>
    350353
    351         <bitlbee-setting name="buddy_sendbuffer" type="boolean">
    352                 <default>False</default>
     354        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
     355                <default>false</default>
    353356
    354357                <description>
    … …  
    367370        </bitlbee-setting>
    368371
    369         <bitlbee-setting name="buddy_sendbuffer_delay" type="integer">
     372        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
    370373                <default>200</default>
    371374
    … …  
    382385        </bitlbee-setting>
    383386
    384         <bitlbee-setting name="charset" type="string">
     387        <bitlbee-setting name="charset" type="string" scope="global">
    385388                <default>iso8859-1</default>
    386389                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
    … …  
    398401        </bitlbee-setting>
    399402
    400         <bitlbee-setting name="debug" type="boolean">
    401                 <default>False</default>
     403        <bitlbee-setting name="debug" type="boolean" scope="global">
     404                <default>false</default>
    402405
    403406                <description>
    … …  
    408411        </bitlbee-setting>
    409412
    410         <bitlbee-setting name="default_target" type="string">
     413        <bitlbee-setting name="default_target" type="string" scope="global">
    411414                <default>root</default>
    412415                <possible-values>root, last</possible-values>
    … …  
    419422        </bitlbee-setting>
    420423
    421         <bitlbee-setting name="display_name" type="string">
     424        <bitlbee-setting name="display_name" type="string" scope="account">
    422425                <description>
    423426                        <para>
    … …  
    427430        </bitlbee-setting>
    428431
    429         <bitlbee-setting name="display_namechanges" type="boolean">
    430                 <default>False</default>
     432        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
     433                <default>false</default>
    431434
    432435                <para>
    … …  
    435438        </bitlbee-setting>
    436439
    437         <bitlbee-setting name="handle_unknown" type="string">
     440        <bitlbee-setting name="handle_unknown" type="string" scope="global">
    438441                <default>root</default>
    439442                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
    … …  
    462465        </bitlbee-setting>
    463466
    464         <bitlbee-setting name="lcnicks" type="boolean">
    465                 <default>True</default>
     467        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
     468                <default>true</default>
    466469
    467470                <description>
    … …  
    473476        </bitlbee-setting>
    474477
    475         <bitlbee-setting name="ops" type="string">
     478        <bitlbee-setting name="ops" type="string" scope="global">
    476479                <default>both</default>
    477480                <possible-values>both, root, user, none</possible-values>
    … …  
    488491        </bitlbee-setting>
    489492
    490         <bitlbee-setting name="password" type="string">
     493        <bitlbee-setting name="password" type="string" scope="both">
    491494                <description>
    492495                        <para>
    … …  
    504507        </bitlbee-setting>
    505508       
    506         <bitlbee-setting name="port" type="integer">
     509        <bitlbee-setting name="port" type="integer" scope="account">
    507510                <description>
    508511                        <para>
    … …  
    512515        </bitlbee-setting>
    513516
    514         <bitlbee-setting name="private" type="boolean">
    515                 <default>True</default>
     517        <bitlbee-setting name="private" type="boolean" scope="global">
     518                <default>true</default>
    516519
    517520                <description>
    … …  
    526529        </bitlbee-setting>
    527530
    528         <bitlbee-setting name="query_order" type="string">
     531        <bitlbee-setting name="query_order" type="string" scope="global">
    529532                <default>lifo</default>
    530533                <possible-values>lifo, fifo</possible-values>
    … …  
    541544        </bitlbee-setting>
    542545
    543         <bitlbee-setting name="resource" type="string">
     546        <bitlbee-setting name="resource" type="string" scope="account">
    544547                <default>BitlBee</default>
    545548
    … …  
    551554        </bitlbee-setting>
    552555
    553         <bitlbee-setting name="save_on_quit" type="boolean">
    554                 <default>True</default>
     556        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
     557                <default>true</default>
    555558
    556559                <description>
    … …  
    561564        </bitlbee-setting>
    562565
    563         <bitlbee-setting name="server" type="string">
     566        <bitlbee-setting name="server" type="string" scope="account">
    564567                <description>
    565568                        <para>
    … …  
    569572        </bitlbee-setting>
    570573
    571         <bitlbee-setting name="ssl" type="boolean">
    572                 <default>False</default>
     574        <bitlbee-setting name="ssl" type="boolean" scope="account">
     575                <default>false</default>
    573576
    574577                <description>
    … …  
    579582        </bitlbee-setting>
    580583
    581         <bitlbee-setting name="strip_html" type="boolean">
    582                 <default>True</default>
     584        <bitlbee-setting name="strip_html" type="boolean" scope="global">
     585                <default>true</default>
    583586
    584587                <description>
    … …  
    592595        </bitlbee-setting>
    593596
    594         <bitlbee-setting name="to_char" type="string">
     597        <bitlbee-setting name="to_char" type="string" scope="global">
    595598                <default>": "</default>
    596599
    … …  
    606609        </bitlbee-setting>
    607610
    608         <bitlbee-setting name="typing_notice" type="boolean">
    609                 <default>False</default>
     611        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
     612                <default>false</default>
    610613
    611614                <description>

  • doc/user-guide/help.xsl

    r00a5270 r89a1809  
    5858                        <xsl:text>?set </xsl:text><xsl:value-of select="@name"/><xsl:text>&#10;</xsl:text>
    5959                        <xsl:text>_b_Type:_b_ </xsl:text><xsl:value-of select="@type"/><xsl:text>&#10;</xsl:text>
    60                         <xsl:text>_b_Default:_b_ </xsl:text><xsl:value-of select="default"/><xsl:text>&#10;</xsl:text>
     60                        <xsl:text>_b_Scope:_b_ </xsl:text><xsl:value-of select="@scope"/><xsl:text>&#10;</xsl:text>
     61                        <xsl:if test="default">
     62                                <xsl:text>_b_Default:_b_ </xsl:text><xsl:value-of select="default"/><xsl:text>&#10;</xsl:text>
     63                        </xsl:if>
    6164                        <xsl:if test="possible-values">
    6265                                <xsl:text>_b_Possible Values:_b_ </xsl:text><xsl:value-of select="possible-values"/><xsl:text>&#10;</xsl:text>
Note: See TracChangeset for help on using the changeset viewer.