Ignore:
Timestamp:
2018-03-10T11:30:39Z (7 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Children:
5447c59
Parents:
3f44e43 (diff), 4a9c6b0 (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:

Merge branch 'master' into HEAD

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user-guide/commands.xml

    r3f44e43 r7a9d968  
    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
     
    184184        <bitlbee-command name="channel">
    185185                <short-description>Channel list maintenance</short-description>
    186                 <syntax>channel [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
     186                <syntax>channel [&lt;channel id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
    187187
    188188                <description>
     
    277277                        <description>
    278278                                <para>
    279                                         List existing chatrooms provided by an account. BitlBee needs this to propogate an internal list of chats. The existing chat can then be added with <emphasis>chat add</emphasis>, using the number in the index column after a "!" as a shortcut.
     279                                        List existing named chatrooms provided by an account. Chats from this list can be referenced from <emphasis>chat add</emphasis> by using the number in the index column after a "!" as a shortcut.
     280                                </para>
     281
     282                                <para>
     283                                        The server parameter is optional and currently only used by jabber.
    280284                                </para>
    281285                        </description>
     
    338342                <description>
    339343                        <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.
     344                                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.
    341345                        </para>
    342346                </description>
     
    887891                <description>
    888892                        <para>
    889                                 With this setting enabled, you can use some commands in your Twitter channel/query. The commands are simple and not documented in too much detail:
    890                         </para>
    891 
    892                         <variablelist>
    893                                 <varlistentry><term>undo #[&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
    894                                 <varlistentry><term>rt &lt;screenname|#id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
    895                                 <varlistentry><term>reply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with a reply-to reference)</para></listitem></varlistentry>
    896                                 <varlistentry><term>rawreply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with no reply-to reference)</para></listitem></varlistentry>
    897                                 <varlistentry><term>report &lt;screenname|#id&gt;</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>
    898                                 <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
    899                                 <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
    900                                 <varlistentry><term>favourite &lt;screenname|#id&gt;</term><listitem><para>Favo<emphasis>u</emphasis>rite the given user's most recent tweet, or the given tweet ID.</para></listitem></varlistentry>
    901                                 <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
    902                                 <varlistentry><term>url &lt;screenname|#id&gt;</term><listitem><para>Show URL for a tweet to open it in a browser (and see context)</para></listitem></varlistentry>
    903                         </variablelist>
    904 
    905                         <para>
    906                                 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.
     893                                With this setting enabled, you can use some commands in your Twitter channel/query. See <emphasis>help twitter</emphasis> for the list of extra commands available.
    907894                        </para>
    908895                </description>
     
    1004991        </bitlbee-setting>
    1005992
    1006         <bitlbee-setting name="handle_unknown" type="string" scope="global">
     993        <bitlbee-setting name="handle_unknown" type="string" scope="account,global">
    1007994                <default>add_channel</default>
    1008                 <possible-values>root, add, add_private, add_channel, ignore</possible-values>
    1009 
    1010                 <description>
    1011                         <para>
    1012                                 By default, messages from people who aren't in your contact list are shown in a control channel instead of as a private message.
     995                <possible-values>add_private, add_channel, ignore</possible-values>
     996
     997                <description>
     998                        <para>
     999                                By default, messages from people who aren't in your contact list are shown in a control channel (add_channel) instead of as a private message (add_private)
    10131000                        </para>
    10141001
    10151002                        <para>
    10161003                                If you prefer to ignore messages from people you don't know, you can set this one to "ignore". "add_private" and "add_channel" are like add, but you can use them to make messages from unknown buddies appear in the channel instead of a query window.
     1004                        </para>
     1005
     1006                        <para>
     1007                                This can be set to individual accounts, which is useful to only ignore accounts that are targeted by spammers, without missing messages from legitimate unknown contacts in others. Note that incoming add requests are visible regardless of this setting.
    10171008                        </para>
    10181009
     
    10371028        </bitlbee-setting>
    10381029
    1039         <bitlbee-setting name="lcnicks" type="boolean" scope="global">
    1040                 <default>true</default>
    1041 
    1042                 <description>
    1043                         <para>
    1044                                 Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
    1045                         </para>
    1046                 </description>
    1047 
    1048         </bitlbee-setting>
    1049 
    10501030        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
    10511031                <default>false</default>
     
    10641044                <description>
    10651045                        <para>
    1066                                 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.
     1046                                Some protocols can notify via IM about new e-mail. If you want these notifications, you can enable this setting.
    10671047                        </para>
    10681048                </description>
     
    12121192                        </para>
    12131193                </description>
     1194        </bitlbee-setting>
     1195
     1196        <bitlbee-setting name="nick_lowercase" type="boolean" scope="global">
     1197                <default>true</default>
     1198
     1199                <description>
     1200                        <para>
     1201                                If enabled, all nicknames are turned into lower case.
     1202                        </para>
     1203
     1204                        <para>
     1205                                See also the <emphasis>nick_underscores</emphasis> setting. This setting was previously known as <emphasis>lcnicks</emphasis>.
     1206                        </para>
     1207                </description>
     1208
     1209        </bitlbee-setting>
     1210
     1211        <bitlbee-setting name="nick_underscores" type="boolean" scope="global">
     1212                <default>true</default>
     1213
     1214                <description>
     1215                        <para>
     1216                                If enabled, spaces in nicknames are turned into underscores instead of being stripped.
     1217                        </para>
     1218
     1219                        <para>
     1220                                See also the <emphasis>nick_lowercase</emphasis> setting.
     1221                        </para>
     1222                </description>
     1223
    12141224        </bitlbee-setting>
    12151225
     
    18501860        <bitlbee-command name="plugins">
    18511861                <short-description>List all the external plugins and protocols</short-description>
    1852                 <syntax>plugins</syntax>
     1862                <syntax>plugins [info &lt;name&gt;]</syntax>
    18531863
    18541864                <description>
    18551865                        <para>
    18561866                                This gives you a list of all the external plugins and protocols.
     1867                        </para>
     1868
     1869                        <para>
     1870                                Use the <emphasis>info</emphasis> subcommand to get more details about a plugin.
    18571871                        </para>
    18581872                </description>
Note: See TracChangeset for help on using the changeset viewer.