diff options
Diffstat (limited to 'doc/user-guide')
| -rw-r--r-- | doc/user-guide/commands.xml | 96 | ||||
| -rw-r--r-- | doc/user-guide/misc.xml | 22 |
2 files changed, 108 insertions, 10 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index af566de4..c8f2de4c 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -435,6 +435,22 @@ </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> @@ -494,6 +510,16 @@ </bitlbee-setting> + <bitlbee-setting name="control_channel" type="string" scope="global"> + <default>&bitlbee</default> + + <description> + <para> + Normally the control channel where you can see all your contacts is called "&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> @@ -560,6 +586,17 @@ </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> @@ -571,6 +608,17 @@ </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> @@ -591,6 +639,21 @@ </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="ops" type="string" scope="global"> <default>both</default> <possible-values>both, root, user, none</possible-values> @@ -684,7 +747,7 @@ </bitlbee-setting> <bitlbee-setting name="resource_select" type="string" scope="account"> - <default>priority</default> + <default>activity</default> <possible-values>priority, activity</possible-values> <description> @@ -746,6 +809,22 @@ </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> @@ -759,6 +838,21 @@ </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> diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index 68b44e95..a926775a 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -85,31 +85,35 @@ Some protocols (like Jabber) also support named groupchats. BitlBee now supports <title>Away states</title> <para> -As you might've expected, you can just use the <emphasis>/away</emphasis> command in your IRC client to set an away-state. BitlBee supports most away-states supported by the protocols. +To mark yourself as away, you can just use the <emphasis>/away</emphasis> command in your IRC client. BitlBee supports most away-states supported by the protocols. </para> <para> -Not all away states are supported by all protocols, and some protocols have different names for them. BitlBee will try to pick the best available alias from this list for every connection: +Away states have different names accross different protocols. BitlBee will try to pick the best available option for every connection: </para> <simplelist> - <member>Away from computer, Away, Extended away</member> - <member>NA, N/A, Not available</member> - <member>Busy, Do not disturb, DND, Occupied</member> - <member>Be right back, BRB</member> - <member>On the phone, Phone, On phone</member> - <member>Out to lunch, Lunch, Food</member> + <member>Away</member> + <member>NA</member> + <member>Busy, DND</member> + <member>BRB</member> + <member>Phone</member> + <member>Lunch, Food</member> <member>Invisible, Hidden</member> </simplelist> <para> -So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your MSN connection, and for most other connections the default, "Away" or "Away from computer" will be chosen. +So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your MSN connection, and for most other connections the default, "Away" will be chosen. </para> <para> You can also add more information to your away message. Setting it to "Busy - Fixing BitlBee bugs" will set your IM-away-states to Busy, but your away message will be more descriptive for people on IRC. Most IM-protocols can also show this additional information to your buddies. </para> +<para> +If you want to set an away state for only one of your connections, you can use the per-account <emphasis>away</emphasis> setting. See <emphasis>help set away</emphasis>. +</para> + </sect1> </chapter> |