Changeset 6d8cc05 for doc/user-guide

Timestamp:

2010-07-18T23:50:27Z (14 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

5a61bf59

Parents:

94d5da9c

Message:

Adding easy migration from old show_offline/away_devoice settings, and
documentation.

File:

• doc/user-guide/commands.xml (modified) (2 diffs)

doc/user-guide/commands.xml

@@ -518 +518 @@
                                 With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled.
                         </para>
+                        
+                        <para>
+                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
+                        </para>
                 </description>
         </bitlbee-setting>
@@ -1040 +1044 @@
                         <para>
                                 If enabled causes BitlBee to also show offline users in Channel. Online-users will get op, away-users voice and offline users none of both. This option takes effect as soon as you reconnect.
+                        </para>
+                        
+                        <para>
+                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
+        <bitlbee-setting name="show_users" type="string" scope="channel">
+                <default>online+,away</default>
+
+                <description>
+                        <para>
+                                Comma-separated list of statuses of users you want in the channel,
+                                and any modes they should have. The following statuses are currently
+                                recognised: <emphasis>online</emphasis> (i.e. available, not
+                                away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
+                        </para>
+                        
+                        <para>
+                                If a status is followed by a valid channel mode character
+                                (@, % or +), it will be given to users with that status.
+                                For example, <emphasis>online@,away+,offline</emphasis> will
+                                show all users in the channel. Online people will
+                                have +o, people who are online but away will have +v,
+                                and others will have no special modes.
                         </para>
                 </description>