diff options
Diffstat (limited to 'doc/user-guide')
| -rw-r--r-- | doc/user-guide/Makefile | 2 | ||||
| -rw-r--r-- | doc/user-guide/commands.xml | 79 | ||||
| -rw-r--r-- | doc/user-guide/help.xsl | 5 |
3 files changed, 46 insertions, 40 deletions
diff --git a/doc/user-guide/Makefile b/doc/user-guide/Makefile index 98c4e99f..eb31fc0f 100644 --- a/doc/user-guide/Makefile +++ b/doc/user-guide/Makefile @@ -27,7 +27,7 @@ help.xml: commands.xml %.db.xml: %.xml docbook.xsl xsltproc --xinclude --output $@ docbook.xsl $< -help.txt: help.xml help.xsl +help.txt: help.xml help.xsl commands.xml misc.xml quickstart.xml xsltproc --stringparam extraparanewline "$(EXTRAPARANEWLINE)" --xinclude help.xsl $< | perl -0077 -pe 's/\n\n%/\n%/s; s/_b_/\002/g;' > $@ clean: diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index d28a8531..fd855360 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -295,8 +295,8 @@ </description> </bitlbee-command> - <bitlbee-setting name="auto_connect" type="boolean"> - <default>True</default> + <bitlbee-setting name="auto_connect" type="boolean" scope="both"> + <default>true</default> <description> <para> @@ -309,8 +309,8 @@ </description> </bitlbee-setting> - <bitlbee-setting name="auto_reconnect" type="boolean"> - <default>False</default> + <bitlbee-setting name="auto_reconnect" type="boolean" scope="both"> + <default>false</default> <description> <para> @@ -320,11 +320,14 @@ <para> See also the <emphasis>auto_reconnect_delay</emphasis> setting. </para> - </description> + <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="integer"> + <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global"> <default>300</default> <description> @@ -338,8 +341,8 @@ </description> </bitlbee-setting> - <bitlbee-setting name="away_devoice" type="boolean"> - <default>True</default> + <bitlbee-setting name="away_devoice" type="boolean" scope="global"> + <default>true</default> <description> <para> @@ -348,8 +351,8 @@ </description> </bitlbee-setting> - <bitlbee-setting name="buddy_sendbuffer" type="boolean"> - <default>False</default> + <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global"> + <default>false</default> <description> <para> @@ -366,7 +369,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="buddy_sendbuffer_delay" type="integer"> + <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global"> <default>200</default> <description> @@ -381,7 +384,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="charset" type="string"> + <bitlbee-setting name="charset" type="string" scope="global"> <default>iso8859-1</default> <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values> @@ -397,8 +400,8 @@ </bitlbee-setting> - <bitlbee-setting name="debug" type="boolean"> - <default>False</default> + <bitlbee-setting name="debug" type="boolean" scope="global"> + <default>false</default> <description> <para> @@ -407,7 +410,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="default_target" type="string"> + <bitlbee-setting name="default_target" type="string" scope="global"> <default>root</default> <possible-values>root, last</possible-values> @@ -418,7 +421,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="display_name" type="string"> + <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. @@ -426,15 +429,15 @@ </description> </bitlbee-setting> - <bitlbee-setting name="display_namechanges" type="boolean"> - <default>False</default> + <bitlbee-setting name="display_namechanges" type="boolean" scope="global"> + <default>false</default> <para> With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". </para> </bitlbee-setting> - <bitlbee-setting name="handle_unknown" type="string"> + <bitlbee-setting name="handle_unknown" type="string" scope="global"> <default>root</default> <possible-values>root, add, add_private, add_channel, ignore</possible-values> @@ -461,8 +464,8 @@ </bitlbee-setting> - <bitlbee-setting name="lcnicks" type="boolean"> - <default>True</default> + <bitlbee-setting name="lcnicks" type="boolean" scope="global"> + <default>true</default> <description> <para> @@ -472,7 +475,7 @@ </bitlbee-setting> - <bitlbee-setting name="ops" type="string"> + <bitlbee-setting name="ops" type="string" scope="global"> <default>both</default> <possible-values>both, root, user, none</possible-values> @@ -487,7 +490,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="password" type="string"> + <bitlbee-setting name="password" type="string" scope="both"> <description> <para> Use this global setting to change your "NickServ" password. @@ -503,7 +506,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="port" type="integer"> + <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. @@ -511,8 +514,8 @@ </description> </bitlbee-setting> - <bitlbee-setting name="private" type="boolean"> - <default>True</default> + <bitlbee-setting name="private" type="boolean" scope="global"> + <default>true</default> <description> <para> @@ -525,7 +528,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="query_order" type="string"> + <bitlbee-setting name="query_order" type="string" scope="global"> <default>lifo</default> <possible-values>lifo, fifo</possible-values> @@ -540,7 +543,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="resource" type="string"> + <bitlbee-setting name="resource" type="string" scope="account"> <default>BitlBee</default> <description> @@ -550,8 +553,8 @@ </description> </bitlbee-setting> - <bitlbee-setting name="save_on_quit" type="boolean"> - <default>True</default> + <bitlbee-setting name="save_on_quit" type="boolean" scope="global"> + <default>true</default> <description> <para> @@ -560,7 +563,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="server" type="string"> + <bitlbee-setting name="server" type="string" scope="account"> <description> <para> Can be set for Jabber- and OSCAR-connections. For OSCAR, this must be set to <emphasis>login.icq.com</emphasis> if it's an ICQ connection, or <emphasis>login.oscar.aol.com</emphasis> if it's an AIM connection. For Jabber, you have to set this if the servername isn't equal to the part after the @ in the Jabber handle. @@ -568,8 +571,8 @@ </description> </bitlbee-setting> - <bitlbee-setting name="ssl" type="boolean"> - <default>False</default> + <bitlbee-setting name="ssl" type="boolean" scope="account"> + <default>false</default> <description> <para> @@ -578,8 +581,8 @@ </description> </bitlbee-setting> - <bitlbee-setting name="strip_html" type="boolean"> - <default>True</default> + <bitlbee-setting name="strip_html" type="boolean" scope="global"> + <default>true</default> <description> <para> @@ -591,7 +594,7 @@ </description> </bitlbee-setting> - <bitlbee-setting name="to_char" type="string"> + <bitlbee-setting name="to_char" type="string" scope="global"> <default>": "</default> <description> @@ -605,8 +608,8 @@ </description> </bitlbee-setting> - <bitlbee-setting name="typing_notice" type="boolean"> - <default>False</default> + <bitlbee-setting name="typing_notice" type="boolean" scope="global"> + <default>false</default> <description> <para> diff --git a/doc/user-guide/help.xsl b/doc/user-guide/help.xsl index 394530a7..dec6a671 100644 --- a/doc/user-guide/help.xsl +++ b/doc/user-guide/help.xsl @@ -57,7 +57,10 @@ <xsl:message><xsl:text>Processing setting '</xsl:text><xsl:value-of select="@name"/><xsl:text>'</xsl:text></xsl:message> <xsl:text>?set </xsl:text><xsl:value-of select="@name"/><xsl:text> </xsl:text> <xsl:text>_b_Type:_b_ </xsl:text><xsl:value-of select="@type"/><xsl:text> </xsl:text> - <xsl:text>_b_Default:_b_ </xsl:text><xsl:value-of select="default"/><xsl:text> </xsl:text> + <xsl:text>_b_Scope:_b_ </xsl:text><xsl:value-of select="@scope"/><xsl:text> </xsl:text> + <xsl:if test="default"> + <xsl:text>_b_Default:_b_ </xsl:text><xsl:value-of select="default"/><xsl:text> </xsl:text> + </xsl:if> <xsl:if test="possible-values"> <xsl:text>_b_Possible Values:_b_ </xsl:text><xsl:value-of select="possible-values"/><xsl:text> </xsl:text> </xsl:if> |