diff options
author | Wilmer van der Gaast <wilmer@gaast.net> | 2010-05-03 01:52:08 +0100 |
---|---|---|
committer | Wilmer van der Gaast <wilmer@gaast.net> | 2010-05-03 01:52:08 +0100 |
commit | f92456381b2a1487036848fc4e0105b8a439facd (patch) | |
tree | 38dd931c315ad03dafcd4af8f374c48ad45ff553 /doc/user-guide | |
parent | 6a9d068e73b6d08056302fdc85dd706a2dd647a5 (diff) | |
parent | 6824fb355a31ed46c22740ef184332440d3981ce (diff) |
Mainline merge.
Diffstat (limited to 'doc/user-guide')
-rw-r--r-- | doc/user-guide/commands.xml | 87 |
1 files changed, 74 insertions, 13 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 2949c6ce..e681429c 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -20,7 +20,7 @@ <description> <para> - Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ) and Yahoo. For more information about adding an account, see <emphasis>help account add <protocol></emphasis>. + Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ), Yahoo and Twitter. For more information about adding an account, see <emphasis>help account add <protocol></emphasis>. </para> </description> @@ -72,11 +72,15 @@ </para> <para> - By default all your Twitter contacts will show up in your contact list and their tweets will show up as private messages or in &bitlbee depending on your settings. If you want them in a separate channel, use the use_groupchat setting (see <emphasis>help set use_groupchat</emphasis>). + By default all your Twitter contacts will come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>). </para> <para> - To send tweets yourself, send them to any of your Twitter contacts via /query (doesn't matter who), or just write in the groupchat channel if you enabled that option. + 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> @@ -658,6 +662,26 @@ </bitlbee-setting> + <bitlbee-setting name="mode" type="string" scope="account"> + <possible-values>one, many, chat</possible-values> + <default>one</default> + + <description> + <para> + By default, everything from the Twitter module will come from one nick, twitter_(yourusername). If you prefer to have individual nicks for everyone, you can set this setting to "many" instead. + </para> + + <para> + If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat". + </para> + + <para> + In the last two modes, you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet. + </para> + </description> + + </bitlbee-setting> + <bitlbee-setting name="nick" type="string" scope="chat"> <description> @@ -682,6 +706,25 @@ </description> </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> <possible-values>both, root, user, none</possible-values> @@ -817,6 +860,16 @@ </description> </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. Online-users will get op, away-users voice and offline users none of both. 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> @@ -866,6 +919,24 @@ </description> </bitlbee-setting> + <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account"> + <default>false</default> + + <description> + <para> + Turn on this flag if you have difficulties talking to offline/invisible contacts. + </para> + + <para> + With this setting enabled, BitlBee will send keepalives to MSN switchboards with offline/invisible contacts every twenty seconds. This should keep the server and client on the other side from shutting it down. + </para> + + <para> + This is useful because BitlBee doesn't support MSN offline messages yet and the MSN servers won't let the user reopen switchboards to offline users. Once offline messaging is supported, this flag might be removed. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="timezone" type="string" scope="global"> <default>local</default> <possible-values>local, utc, gmt, timezone-spec</possible-values> @@ -919,16 +990,6 @@ </description> </bitlbee-setting> - <bitlbee-setting name="use_groupchat" type="boolean" scope="account"> - <default>false</default> - - <description> - <para> - By default the Twitter module shows all Twitter contacts and their Tweet in &bitlbee and/or private messages. With this setting enabled the module will show all contacts and their Tweets in a separate channel. - </para> - </description> - </bitlbee-setting> - <bitlbee-setting name="web_aware" type="string" scope="account"> <default>false</default> |