diff options
author | dequis <dx@dxzone.com.ar> | 2016-12-25 19:07:48 -0300 |
---|---|---|
committer | dequis <dx@dxzone.com.ar> | 2016-12-25 21:18:55 -0300 |
commit | 1999fe5eadc7c7575e33542da42b0e21b10366d9 (patch) | |
tree | 2a99dc97fa68a9f407cc00f6e052f4419a043aba | |
parent | 15a8c94f4e559bf7b9f201bd1b93e816948a5d43 (diff) |
Misc documentation updates
- Remove a bunch of mentions of yahoo
- Remove 'smileys' topic from help index
- Add 'identify_methods' help topic
- Mention new commands like 'chat list' or 'plugins'
-rw-r--r-- | doc/README | 3 | ||||
-rw-r--r-- | doc/bitlbee.8 | 3 | ||||
-rw-r--r-- | doc/user-guide/Installation.xml | 2 | ||||
-rw-r--r-- | doc/user-guide/commands.xml | 6 | ||||
-rw-r--r-- | doc/user-guide/help.xml | 4 | ||||
-rw-r--r-- | doc/user-guide/misc.xml | 39 | ||||
-rw-r--r-- | doc/user-guide/quickstart.xml | 10 |
7 files changed, 52 insertions, 15 deletions
@@ -160,9 +160,6 @@ LEGAL BitlBee is distributed under the GPL (GNU General Public License). See the file COPYING for this license. -The Yahoo! library used by BitlBee is libyahoo2 <http://libyahoo2.sf.net/>, -also licensed under the GPL. - BitlBee - An IRC to other chat networks gateway <http://www.bitlbee.org/> diff --git a/doc/bitlbee.8 b/doc/bitlbee.8 index b5aa7705..2170270d 100644 --- a/doc/bitlbee.8 +++ b/doc/bitlbee.8 @@ -38,8 +38,7 @@ BitlBee \- IRC gateway to IM chat networks BitlBee is an IRC daemon that can talk to instant messaging networks and acts as a gateway. Users can connect to the server with any normal IRC client and see their 'buddy list' in -&bitlbee. It currently supports Oscar (AIM and ICQ), -MSN, Jabber, Yahoo! and Twitter. +&bitlbee. \fBbitlbee\fP should be called by .BR inetd (8), diff --git a/doc/user-guide/Installation.xml b/doc/user-guide/Installation.xml index 75568936..9d555d46 100644 --- a/doc/user-guide/Installation.xml +++ b/doc/user-guide/Installation.xml @@ -35,7 +35,7 @@ specify them all separately, just specifying prefix (or keeping the default <listitem><para>config - The place where BitlBee will save all the per-user settings and buddy information. <filename>/var/lib/bitlbee/</filename> is the default value.</para></listitem> -<listitem><para>msn, jabber, oscar, yahoo - By default, support for all +<listitem><para>msn, jabber, oscar, twitter - By default, support for all these IM-protocols (OSCAR is the protocol used by both ICQ and AIM) will be compiled in. To make the binary a bit smaller, you can use these options to leave out support for protocols you're not planning to use.</para></listitem> diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index e27356b8..6b725156 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), Yahoo and Twitter. 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. For a list of supported protocols, use the <emphasis>plugins</emphasis> command. For more information about adding an account, see <emphasis>help account add <protocol></emphasis>. </para> <para> @@ -337,7 +337,7 @@ <description> <para> - Requests IM-network-specific information about the specified user. The amount of information you'll get differs per protocol. For some protocols (ATM Yahoo! and MSN) it'll give you an URL which you can visit with a normal web browser to get the information. + Requests IM-network-specific information about the specified user. The amount of information you'll get differs per protocol. For some protocols it'll give you an URL which you can visit with a normal web browser to get the information. </para> </description> @@ -1052,7 +1052,7 @@ <description> <para> - Some protocols (MSN, Yahoo!, GTalk) can notify via IM about new e-mail. Since most people use their Hotmail/Yahoo! addresses as a spam-box, this is disabled default. If you want these notifications, you can enable this setting. + Some protocols can notify via IM about new e-mail. If you want these notifications, you can enable this setting. </para> </description> diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml index e40a04d1..1b68413a 100644 --- a/doc/user-guide/help.xml +++ b/doc/user-guide/help.xml @@ -17,7 +17,7 @@ These are the available help subjects: <varlistentry><term>away</term><listitem><para>About setting away states</para></listitem></varlistentry> <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry> <varlistentry><term>nick_changes</term><listitem><para>Changing your nickname without losing any settings</para></listitem></varlistentry> - <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry> + <varlistentry><term>identify_methods</term><listitem><para>A list of ways to (auto-)identify to your account</para></listitem></varlistentry> </variablelist> <para> @@ -48,7 +48,7 @@ These are the available help subjects: <varlistentry><term>away</term><listitem><para>About setting away states</para></listitem></varlistentry> <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry> <varlistentry><term>nick_changes</term><listitem><para>Changing your nickname without losing any settings</para></listitem></varlistentry> - <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry> + <varlistentry><term>identify_methods</term><listitem><para>A list of ways to (auto-)identify to your account</para></listitem></varlistentry> </variablelist> <para> diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index 36720914..a95c5442 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -76,9 +76,12 @@ Then, just use the ordinary IRC <emphasis>/invite</emphasis> command to invite m </para> <para> -Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>chat add</emphasis> command to join them. See <emphasis>help chat add</emphasis> for more information. +Some protocols (like Jabber) also support named groupchats. BitlBee supports these too. You can use the <emphasis>chat add</emphasis> command to join them. See <emphasis>help chat add</emphasis> for more information. </para> +<para> +If you don't know the name of a named groupchat, you can try the <emphasis>chat list</emphasis> command to get a list of chatrooms from a server. See <emphasis>help chat list</emphasis> for usage instructions. +</para> </sect1> <sect1 id="away"> @@ -267,6 +270,40 @@ everything in the handle up to the first @. </sect1> +<sect1 id="identify_methods"> +<title>Identifying to your BitlBee account</title> + +<para>There are several methods to identify (log in) to your registered BitlBee account. All of these are equivalent:</para> + +<variablelist> + <varlistentry> + <term>The 'identify' command</term> + <listitem><para>sent to &bitlbee or root. See <emphasis>help identify</emphasis> for details.</para></listitem> + </varlistentry> + <varlistentry> + <term>/msg nickserv identify</term> + <listitem><para>Same as above, but sent to NickServ. Useful with some auto-identify scripts.</para></listitem> + </varlistentry> + <varlistentry> + <term>/nickserv or /ns</term> + <listitem><para>Same as above, but using the command aliases to NickServ.</para></listitem> + </varlistentry> + <varlistentry> + <term>Server password</term> + <listitem><para>A field in the server connection settings of your irc client.</para></listitem> + </varlistentry> + <varlistentry> + <term>SASL PLAIN</term> + <listitem><para>A newer method, good choice if your client supports it. (Note: "SASL" is <emphasis>not</emphasis> related to "SSL")</para></listitem> + </varlistentry> +</variablelist> + +<para>To configure your client to auto-identify, the last two methods are recommended. SASL if you have it, but server password is often the easiest.</para> + +<para>Note: If you changed bitlbee.conf to have <emphasis>AuthMode = Closed</emphasis>, server password will be used for that instead. If you have never heard of that setting before, you can ignore it and just use it.</para> + +</sect1> + <sect1 id="whatsnew010206"> <title>New stuff in BitlBee 1.2.6</title> diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml index c929cf19..2eda6be1 100644 --- a/doc/user-guide/quickstart.xml +++ b/doc/user-guide/quickstart.xml @@ -2,7 +2,7 @@ <title>Quickstart</title> <para> -Welcome to BitlBee, your IRC gateway to ICQ, MSN, AOL, Jabber, Yahoo! and Twitter. +Welcome to BitlBee, your IRC gateway to other instant messaging protocols. </para> <para> @@ -42,7 +42,11 @@ For instance, suppose you have a Jabber account at jabber.org with handle <empha </ircexample> <para> -Other available IM protocols are msn, oscar, yahoo and twitter. OSCAR is the protocol used by ICQ and AOL. For more information about the <emphasis>account add</emphasis> command, see <emphasis>help account add</emphasis>. +Other built-in IM protocols include msn, oscar and twitter. OSCAR is the protocol used by ICQ and AOL. Some protocols may be available as plugins that you can install, such as facebook, steam, discord and omegle. And you can get even more protocols by using the libpurple variant of BitlBee. +</para> + +<para> +For a list of currently supported protocols, use the <emphasis>plugins</emphasis> command. For more information about the <emphasis>account add</emphasis> command, see <emphasis>help account add</emphasis>. </para> <para> @@ -135,7 +139,7 @@ For more subjects (like groupchats and away states), please type <emphasis>help </para> <para> -If you're still looking for something, please visit us in #bitlbee on the OFTC network (you can connect via irc.bitlbee.org), or mail us your problem/suggestion. Good luck and enjoy the Bee! +If you're still looking for something, please visit us in #bitlbee on the OFTC network (irc.oftc.net). Good luck and enjoy the Bee! </para> </sect1> |