Changeset 1999fe5


Ignore:
Timestamp:
2016-12-26T00:18:55Z (3 years ago)
Author:
dequis <dx@…>
Branches:
master
Children:
6908ab7
Parents:
15a8c94
git-author:
dequis <dx@…> (25-12-16 22:07:48)
git-committer:
dequis <dx@…> (26-12-16 00:18:55)
Message:

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'
Location:
doc
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • doc/README

    r15a8c94 r1999fe5  
    161161file COPYING for this license.
    162162
    163 The Yahoo! library used by BitlBee is libyahoo2 <http://libyahoo2.sf.net/>,
    164 also licensed under the GPL.
    165 
    166163
    167164        BitlBee - An IRC to other chat networks gateway
  • doc/bitlbee.8

    r15a8c94 r1999fe5  
    3939networks and acts as a gateway. Users can connect to the server
    4040with any normal IRC client and see their 'buddy list' in
    41 &bitlbee. It currently supports Oscar (AIM and ICQ),
    42 MSN, Jabber, Yahoo! and Twitter.
     41&bitlbee.
    4342
    4443\fBbitlbee\fP should be called by
  • doc/user-guide/Installation.xml

    r15a8c94 r1999fe5  
    3636settings and buddy information. <filename>/var/lib/bitlbee/</filename>
    3737is the default value.</para></listitem>
    38 <listitem><para>msn, jabber, oscar, yahoo - By default, support for all
     38<listitem><para>msn, jabber, oscar, twitter - By default, support for all
    3939these IM-protocols (OSCAR is the protocol used by both ICQ and AIM) will
    4040be compiled in. To make the binary a bit smaller, you can use these options
  • doc/user-guide/commands.xml

    r15a8c94 r1999fe5  
    2121                        <description>
    2222                                <para>
    23                                         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 &lt;protocol&gt;</emphasis>.
     23                                        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 &lt;protocol&gt;</emphasis>.
    2424                                </para>
    2525
     
    338338                <description>
    339339                        <para>
    340                                 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.
     340                                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.
    341341                        </para>
    342342                </description>
     
    10531053                <description>
    10541054                        <para>
    1055                                 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.
     1055                                Some protocols can notify via IM about new e-mail. If you want these notifications, you can enable this setting.
    10561056                        </para>
    10571057                </description>
  • doc/user-guide/help.xml

    r15a8c94 r1999fe5  
    1818  <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry>
    1919  <varlistentry><term>nick_changes</term><listitem><para>Changing your nickname without losing any settings</para></listitem></varlistentry>
    20   <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry>
     20  <varlistentry><term>identify_methods</term><listitem><para>A list of ways to (auto-)identify to your account</para></listitem></varlistentry>
    2121</variablelist>
    2222
     
    4949  <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry>
    5050  <varlistentry><term>nick_changes</term><listitem><para>Changing your nickname without losing any settings</para></listitem></varlistentry>
    51   <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry>
     51  <varlistentry><term>identify_methods</term><listitem><para>A list of ways to (auto-)identify to your account</para></listitem></varlistentry>
    5252</variablelist>
    5353
  • doc/user-guide/misc.xml

    r15a8c94 r1999fe5  
    7777
    7878<para>
    79 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.
    80 </para>
    81 
     79Some 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.
     80</para>
     81
     82<para>
     83If 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.
     84</para>
    8285</sect1>
    8386
     
    265268everything in the handle up to the first @.
    266269</para>
     270
     271</sect1>
     272
     273<sect1 id="identify_methods">
     274<title>Identifying to your BitlBee account</title>
     275
     276<para>There are several methods to identify (log in) to your registered BitlBee account. All of these are equivalent:</para>
     277
     278<variablelist>
     279        <varlistentry>
     280                <term>The 'identify' command</term>
     281                <listitem><para>sent to &amp;bitlbee or root. See <emphasis>help identify</emphasis> for details.</para></listitem>
     282        </varlistentry>
     283        <varlistentry>
     284                <term>/msg nickserv identify</term>
     285                <listitem><para>Same as above, but sent to NickServ. Useful with some auto-identify scripts.</para></listitem>
     286        </varlistentry>
     287        <varlistentry>
     288                <term>/nickserv or /ns</term>
     289                <listitem><para>Same as above, but using the command aliases to NickServ.</para></listitem>
     290        </varlistentry>
     291        <varlistentry>
     292                <term>Server password</term>
     293                <listitem><para>A field in the server connection settings of your irc client.</para></listitem>
     294        </varlistentry>
     295        <varlistentry>
     296                <term>SASL PLAIN</term>
     297                <listitem><para>A newer method, good choice if your client supports it. (Note: "SASL" is <emphasis>not</emphasis> related to "SSL")</para></listitem>
     298        </varlistentry>
     299</variablelist>
     300
     301<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>
     302
     303<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>
    267304
    268305</sect1>
  • doc/user-guide/quickstart.xml

    r15a8c94 r1999fe5  
    33
    44<para>
    5 Welcome to BitlBee, your IRC gateway to ICQ, MSN, AOL, Jabber, Yahoo! and Twitter.
     5Welcome to BitlBee, your IRC gateway to other instant messaging protocols.
    66</para>
    77
     
    4343
    4444<para>
    45 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>.
     45Other 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.
     46</para>
     47
     48<para>
     49For 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>.
    4650</para>
    4751
     
    136140
    137141<para>
    138 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!
     142If you're still looking for something, please visit us in #bitlbee on the OFTC network (irc.oftc.net). Good luck and enjoy the Bee!
    139143</para>
    140144
Note: See TracChangeset for help on using the changeset viewer.