Changeset b308cf9 for doc/user-guide


Ignore:
Timestamp:
2010-06-05T23:21:02Z (15 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
1fdb0a4
Parents:
3ab1d31 (diff), e774815 (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:

Merging libpurple branch into killerbee. It's fairly usable already, and
Debian packaging is now properly separated. This also picks up a load of
stuff from mainline it seems.

Location:
doc/user-guide
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/Makefile

    r3ab1d31 rb308cf9  
    11-include ../../Makefile.settings
     2ifdef SRCDIR
     3SRCDIR := $(SRCDIR)doc/user-guide/
     4endif
     5
    26EXTRAPARANEWLINE = 1
    37# EXTRAPARANEWLINE = 0
    … …  
    3842        chmod 0755 $(DESTDIR)$(DATADIR)
    3943        rm -f $(DESTDIR)$(DATADIR)/help.txt # Prevent help function from breaking in running sessions
    40         install -m 0644 help.txt $(DESTDIR)$(DATADIR)/help.txt
     44        install -m 0644 $(SRCDIR)help.txt $(DESTDIR)$(DATADIR)/help.txt
    4145
    4246uninstall:

  • doc/user-guide/commands.xml

    r3ab1d31 rb308cf9  
    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) and Yahoo. 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. 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>.
    2424                                </para>
    2525                        </description>
    … …  
    6363                                </ircexample>
    6464                        </bitlbee-command>
     65                       
     66                        <bitlbee-command name="twitter">
     67                                <syntax>account add twitter &lt;handle&gt; &lt;password&gt;</syntax>
     68
     69                                <description>
     70                                        <para>
     71                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
     72                                        </para>
     73                                       
     74                                        <para>
     75                                                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>).
     76                                        </para>
     77                                       
     78                                        <para>
     79                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
     80                                        </para>
     81
     82                                        <para>
     83                                                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>.)
     84                                        </para>
     85                                </description>
     86                        </bitlbee-command>
    6587
    6688                        <bitlbee-command name="yahoo">
    … …  
    401423
    402424        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
    403                 <default>false</default>
     425                <default>true</default>
    404426
    405427                <description>
    … …  
    556578                        <para>
    557579                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
     580                        </para>
     581                </description>
     582        </bitlbee-setting>
     583
     584        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
     585                <default>true</default>
     586
     587                <description>
     588                        <para>
     589                                When incoming messages are old (i.e. offline messages and channel backlogs), BitlBee will prepend them with a timestamp. If you find them ugly or useless, you can use this setting to hide them.
    558590                        </para>
    559591                </description>
    … …  
    609641        </bitlbee-setting>
    610642
     643        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
     644                <default>false</default>
     645
     646                <description>
     647                        <para>
     648                                Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting.
     649                        </para>
     650                </description>
     651
     652        </bitlbee-setting>
     653
    611654        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
    612655                <default>false</default>
    … …  
    615658                        <para>
    616659                                Some protocols (MSN, Yahoo!) 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.
     660                        </para>
     661                </description>
     662
     663        </bitlbee-setting>
     664
     665        <bitlbee-setting name="message_length" type="integer" scope="account">
     666                <default>140</default>
     667
     668                <description>
     669                        <para>
     670                                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.
     671                        </para>
     672
     673                        <para>
     674                                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.
     675                        </para>
     676                </description>
     677
     678        </bitlbee-setting>
     679
     680        <bitlbee-setting name="mode" type="string" scope="account">
     681                <possible-values>one, many, chat</possible-values>
     682                <default>one</default>
     683
     684                <description>
     685                        <para>
     686                                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.
     687                        </para>
     688                       
     689                        <para>
     690                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
     691                        </para>
     692                       
     693                        <para>
     694                                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.
    617695                        </para>
    618696                </description>
    … …  
    644722        </bitlbee-setting>
    645723
     724        <bitlbee-setting name="oauth" type="boolean" scope="account">
     725                <default>true</default>
     726
     727                <description>
     728                        <para>
     729                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
     730                        </para>
     731
     732                        <para>
     733                                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.
     734                        </para>
     735
     736                        <para>
     737                                The resulting access token will be saved permanently, so you have to do this only once.
     738                        </para>
     739                </description>
     740
     741        </bitlbee-setting>
     742
    646743        <bitlbee-setting name="ops" type="string" scope="global">
    647744                <default>both</default>
    … …  
    779876        </bitlbee-setting>
    780877
     878        <bitlbee-setting name="show_offline" type="boolean" scope="global">
     879                <default>false</default>
     880
     881                <description>
     882                        <para>
     883                                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.
     884                        </para>
     885                </description>
     886        </bitlbee-setting>
     887
    781888        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
    782889                <default>true</default>
    … …  
    824931                        <para>
    825932                                If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too.
     933                        </para>
     934                </description>
     935        </bitlbee-setting>
     936
     937        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
     938                <default>false</default>
     939
     940                <description>
     941                        <para>
     942                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
     943                        </para>
     944                       
     945                        <para>
     946                                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.
     947                        </para>
     948                       
     949                        <para>
     950                                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.
     951                        </para>
     952                </description>
     953        </bitlbee-setting>
     954
     955        <bitlbee-setting name="timezone" type="string" scope="global">
     956                <default>local</default>
     957                <possible-values>local, utc, gmt, timezone-spec</possible-values>
     958
     959                <description>
     960                        <para>
     961                                If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting.
     962                        </para>
     963
     964                        <para>
     965                                Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time.
    826966                        </para>
    827967                </description>
Note: See TracChangeset for help on using the changeset viewer.