Changeset bb09b3c for doc/user-guide

Timestamp:

2010-06-03T21:13:57Z (15 years ago)

Author:

Sven Moritz Hallberg <pesco@…>

Branches:

master

Children:

1dd3470

Parents:

a6b2f13 (diff), df1ae622 (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:

merge in bitlbee 1.2.7

File:

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

doc/user-guide/commands.xml

@@ -79 +79 @@
                                                 To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
                                         </para>
+
+                                        <para>
+                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
+                                        </para>
                                 </description>
                         </bitlbee-command>
@@ -776 +780 @@
         <bitlbee-setting name="halfop_buddies" type="string" scope="global">
                 <default>encrypted</default>
-                <possible-values>encrypted, trusted, notaway, false</possible-values>
+                <possible-values>encrypted, trusted, notaway, online, false</possible-values>
 
                 <description>
@@ -784 +788 @@
                         
                         <para>
-                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
+                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key. On "online", the flag is set whenever the user is online; only meaningful in conjunction with "show_offline".
                         </para>
                 </description>
@@ -834 +838 @@
         <bitlbee-setting name="op_buddies" type="string" scope="global">
                 <default>trusted</default>
-                <possible-values>encrypted, trusted, notaway, false</possible-values>
+                <possible-values>encrypted, trusted, notaway, online, false</possible-values>
 
                 <description>
@@ -842 +846 @@
                         
                         <para>
-                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
+                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key. On "online", the flag is set whenever the user is online; only meaningful in conjunction with "show_offline".
                         </para>
                 </description>
@@ -882 +886 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="message_length" type="integer" scope="account">
+                <default>140</default>
+
+                <description>
+                        <para>
+                                Since Twitter rejects messages longer than 140 characters, BitlBee can count message length and emit a warning instead of waiting for Twitter to reject it.
+                        </para>
+
+                        <para>
+                                You can change this limit here but this won't disable length checks on Twitter's side. You can also set it to 0 to disable the check in case you believe BitlBee doesn't count the characters correctly.
+                        </para>
+                </description>
+
+        </bitlbee-setting>
+
         <bitlbee-setting name="mode" type="string" scope="account">
                 <possible-values>one, many, chat</possible-values>
@@ -925 +944 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="oauth" type="boolean" scope="account">
+                <default>true</default>
+
+                <description>
+                        <para>
+                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
+                        </para>
+
+                        <para>
+                                With OAuth enabled, you shouldn't tell BitlBee your Twitter password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with Twitter. If this succeeds, Twitter will return a PIN code which you can give back to BitlBee to finish the process.
+                        </para>
+
+                        <para>
+                                The resulting access token will be saved permanently, so you have to do this only once.
+                        </para>
+                </description>
+
+        </bitlbee-setting>
+
         <bitlbee-setting name="ops" type="string" scope="global">
                 <default>both</default>
@@ -1060 +1098 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="show_offline" type="boolean" scope="global">
+                <default>false</default>
+
+                <description>
+                        <para>
+                                If enabled causes BitlBee to also show offline users in Channel. You may want to adjust the settings "voice_buddies", "halfop_buddies" and "op_buddies" according to your liking. A reasonable candidate is "voice_buddies=online", "halfop_buddies=false", "op_buddies=notaway".
+                        </para>
+                        <para>
+                                This option takes effect as soon as you reconnect.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
         <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
                 <default>true</default>
@@ -1181 +1232 @@
 
         <bitlbee-setting name="voice_buddies" type="string" scope="global">
-                <default>trusted</default>
-                <possible-values>encrypted, trusted, notaway, false</possible-values>
+                <default>notaway</default>
+                <possible-values>encrypted, trusted, notaway, online, false</possible-values>
 
                 <description>
@@ -1190 +1241 @@
                         
                         <para>
-                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
+                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key. On "online", the flag is set whenever the user is online; only meaningful in conjunction with "show_offline".
                         </para>
                 </description>