diff options
Diffstat (limited to 'doc/user-guide')
| -rw-r--r-- | doc/user-guide/commands.xml | 45 | ||||
| -rw-r--r-- | doc/user-guide/help.xml | 2 | ||||
| -rw-r--r-- | doc/user-guide/misc.xml | 10 |
3 files changed, 46 insertions, 11 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 12bbf4bc..3af469c6 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -68,7 +68,7 @@ </bitlbee-command> <bitlbee-command name="twitter"> - <syntax>account add twitter <handle> [<password>]</syntax> + <syntax>account add twitter <handle></syntax> <description> <para> @@ -94,11 +94,11 @@ </bitlbee-command> <bitlbee-command name="identica"> - <syntax>account add identica <handle> [<password>]</syntax> + <syntax>account add identica <handle></syntax> <description> <para> - Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca, and with OAuth disabled. + Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca. It also works with OAuth (so don't specify your password). </para> </description> </bitlbee-command> @@ -834,6 +834,7 @@ <bitlbee-setting name="commands" type="boolean" scope="account"> <default>true</default> + <possible-values>true, false, strict</possible-values> <description> <para> @@ -847,11 +848,12 @@ <varlistentry><term>report <screenname|#id></term><listitem><para>Report the given user (or the user who posted the tweet with the given ID) for sending spam. This will also block them.</para></listitem></varlistentry> <varlistentry><term>follow <screenname></term><listitem><para>Start following a person</para></listitem></varlistentry> <varlistentry><term>unfollow <screenname></term><listitem><para>Stop following a person</para></listitem></varlistentry> + <varlistentry><term>favourite <screenname|#id></term><listitem><para>Favo<emphasis>u</emphasis>rite the given user's most recent tweet, or the given tweet ID.</para></listitem></varlistentry> <varlistentry><term>post <message></term><listitem><para>Post a tweet</para></listitem></varlistentry> </variablelist> <para> - Anything that doesn't look like a command will be treated as a tweet. Watch out for typos! :-) + Anything that doesn't look like a command will be treated as a tweet. Watch out for typos, or to avoid this behaviour, you can set this setting to <emphasis>strict</emphasis>, which causes the <emphasis>post</emphasis> command to become mandatory for posting a tweet. </para> </description> </bitlbee-setting> @@ -927,6 +929,10 @@ </para> <para> + With a ! prefix an inverted channel can be created, for example with this setting set to <emphasis>!group</emphasis> you can create a channel with all users <emphasis>not</emphasis> in that group. + </para> + + <para> Note that, when creating a new channel, BitlBee will try to preconfigure the channel for you, based on the channel name. See <emphasis>help channels</emphasis>. </para> </description> @@ -1021,6 +1027,21 @@ </description> </bitlbee-setting> + + <bitlbee-setting name="stream" type="boolean" scope="account"> + <default>true</default> + + <description> + <para> + For Twitter accounts, this setting enables use of the Streaming API. This automatically gives you incoming DMs as well. + </para> + + <para> + For other Twitter-like services, this setting is not supported. + </para> + </description> + + </bitlbee-setting> <bitlbee-setting name="target_url_length" type="integer" scope="account"> <default>20</default> @@ -1336,7 +1357,7 @@ </bitlbee-setting> <bitlbee-setting name="show_ids" type="boolean" scope="account"> - <default>false</default> + <default>true</default> <description> <para> @@ -1500,15 +1521,15 @@ </bitlbee-setting> <bitlbee-setting name="tls" type="boolean" scope="account"> - <default>try</default> + <default>true</default> <description> <para> - Newer Jabber servers allow clients to convert a plain-text session to a TLS/SSL-encrypted session. Normally (with this setting set to <emphasis>try</emphasis>) BitlBee will do this, if possible. + By default (with this setting enabled), BitlBee will require Jabber servers to offer encryption via StartTLS and refuse to connect if they don't. </para> <para> - If you want to force BitlBee to use TLS sessions only (and to give up if that doesn't seem to be possible) you can set this setting to <emphasis>true</emphasis>. Set it to <emphasis>false</emphasis> if you want the session to remain plain-text. + If you set this to "try", BitlBee will use StartTLS only if it's offered. With the setting disabled, StartTLS support will be ignored and avoided entirely. </para> </description> </bitlbee-setting> @@ -1766,11 +1787,15 @@ <bitlbee-command name="group"> <short-description>Contact group management</short-description> - <syntax>group list</syntax> + <syntax>group [ list | info <group> ]</syntax> <description> <para> - Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far. + The <emphasis>group list</emphasis> command shows a list of all groups defined so far. + </para> + + <para> + The <emphasis>group info</emphasis> command shows a list of all members of a the group <group>. </para> <para> diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml index 48ed8a48..e40a04d1 100644 --- a/doc/user-guide/help.xml +++ b/doc/user-guide/help.xml @@ -25,7 +25,7 @@ You can read more about them with <emphasis>help <subject></emphasis> </para> <para> -BitlBee is written by Wilmer van der Gaast together with Jelmer Vernooij, Maurits Dijkstra and others. Bugs can be reported at <ulink link="http://bugs.bitlbee.org/">http://bugs.bitlbee.org/</ulink>. +Some more help can be found on <ulink link="http://wiki.bitlbee.org/">http://wiki.bitlbee.org/</ulink>. Bugs can be reported at <ulink link="http://bugs.bitlbee.org/">http://bugs.bitlbee.org/</ulink>. </para> <para> diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index 3eb5dd68..ac2734ca 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -385,4 +385,14 @@ by updating your <emphasis>bitlbee.conf</emphasis>. </para> </sect1> +<sect1 id="whatsnew030200"> +<title>New stuff in BitlBee 3.2</title> + +<para> +Upgradeed to Twitter API version 1.1. This is necessary because previous +versions will stop working from March 2013. At the same time, BitlBee now +supports the streaming API and incoming direct messages. +</para> +</sect1> + </chapter> |