Changeset e907683 for doc/user-guide


Ignore:
Timestamp:
2010-06-26T23:39:31Z (14 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
84c3a72
Parents:
92c8d41
Message:

Changed account set (and other account commands) syntax. Instead of
"account set acc/key value" you now do "account acc set key value". So just
the regular set syntax with a "account acc" prefix. The slash has been a
source of confusion for long enough now.

For consistency, commands like "account on acc" should now also be
"account acc on" instead. Same for the new "channel" comand, of course.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/commands.xml

    r92c8d41 re907683  
    66        <bitlbee-command name="account">
    77                <short-description>IM-account list maintenance</short-description>
    8                 <syntax>account &lt;action&gt; [&lt;arguments&gt;]</syntax>
     8                <syntax>account [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
    99
    1010                <description>
    … …  
    9999
    100100                <bitlbee-command name="del">
    101                         <syntax>account del &lt;account id&gt;</syntax>
     101                        <syntax>account &lt;account id&gt; del</syntax>
    102102
    103103                        <description>
    … …  
    114114
    115115                <bitlbee-command name="on">
    116                         <syntax>account on [&lt;account id&gt;]</syntax>
     116                        <syntax>account [&lt;account id&gt;] on</syntax>
    117117
    118118                        <description>
    … …  
    129129
    130130                <bitlbee-command name="off">
    131                         <syntax>account off [&lt;account id&gt;]</syntax>
     131                        <syntax>account [&lt;account id&gt;] off</syntax>
    132132
    133133                        <description>
    … …  
    153153
    154154                <bitlbee-command name="set">
    155                         <syntax>account set &lt;account id&gt;</syntax>
    156                         <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
    157                         <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
    158                         <syntax>account set -del &lt;account id&gt;/&lt;setting&gt;</syntax>
     155                        <syntax>account &lt;account id&gt; set</syntax>
     156                        <syntax>account &lt;account id&gt; set &lt;setting&gt;</syntax>
     157                        <syntax>account &lt;account id&gt; set &lt;setting&gt; &lt;value&gt;</syntax>
     158                        <syntax>account &lt;account id&gt; set -del &lt;setting&gt;</syntax>
    159159
    160160                        <description>
    … …  
    181181
    182182                        <para>
    183                                 Available actions: add, del, list, with and set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
     183                                Available actions: add, with. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
    184184                        </para>
    185185
    … …  
    205205                </bitlbee-command>
    206206
    207                 <bitlbee-command name="del">
    208                         <syntax>chat del &lt;chat id&gt;</syntax>
    209 
    210                         <description>
    211                                 <para>
    212                                         This commands deletes an chatroom from your list.
    213                                 </para>
    214 
    215                                 <para>
    216                                         The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
    217                                 </para>
    218                         </description>
    219                 </bitlbee-command>
    220 
    221                 <bitlbee-command name="list">
    222                         <syntax>chat list</syntax>
    223 
    224                         <description>
    225                                 <para>
    226                                         This command gives you a list of all the chatrooms known by BitlBee.
    227                                 </para>
    228                         </description>
    229                 </bitlbee-command>
    230 
    231207                <bitlbee-command name="with">
    232208                        <syntax>chat with &lt;nickname&gt;</syntax>
    … …  
    235211                                <para>
    236212                                        While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions.
    237                                 </para>
    238                         </description>
    239                 </bitlbee-command>
    240 
    241                 <bitlbee-command name="set">
    242                         <syntax>chat set &lt;chat id&gt;</syntax>
    243                         <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
    244                         <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
    245                         <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</syntax>
    246 
    247                         <description>
    248                                 <para>
    249                                         This command can be used to change various settings for chatrooms.
    250                                 </para>
    251                                
    252                                 <para>
    253                                         For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
    254                                 </para>
    255                                
    256                                 <para>
    257                                         The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
    258213                                </para>
    259214                        </description>
Note: See TracChangeset for help on using the changeset viewer.