Changeset f537044 for doc/user-guide
- Timestamp:
- 2010-07-04T14:31:50Z (14 years ago)
- Branches:
- master
- Children:
- 006a84f
- Parents:
- 5c7b45c
- Location:
- doc/user-guide
- Files:
-
- 3 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/commands.xml
r5c7b45c rf537044 160 160 <description> 161 161 <para> 162 This command can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account set <account id></emphasis>.162 This command can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account <account id> set</emphasis>. 163 163 </para> 164 164 … … 172 172 </description> 173 173 </bitlbee-command> 174 </bitlbee-command> 175 176 <bitlbee-command name="channel"> 177 <short-description>Channel list maintenance</short-description> 178 <syntax>channel [<account id>] <action> [<arguments>]</syntax> 179 180 <description> 181 <para> 182 Available actions: del, list, set. See <emphasis>help chat <action></emphasis> for more information. 183 </para> 184 185 <para> 186 There is no <emphasis>channel add</emphasis> command. To create a new channel, just use the IRC <emphasis>/join</emphasis> command. See also <emphasis>help channels</emphasis> and <emphasis>help groupchats</emphasis>. 187 </para> 188 </description> 189 190 <bitlbee-command name="del"> 191 <syntax>channel <channel id> del</syntax> 192 193 <description> 194 <para> 195 Remove a channel and forget all its settings. You can only remove channels you're not currently in, and can't remove the main control channel. (You can, however, leave it.) 196 </para> 197 </description> 198 199 </bitlbee-command> 200 201 <bitlbee-command name="list"> 202 <syntax>channel list</syntax> 203 204 <description> 205 <para> 206 This command gives you a list of all the channels you configured. 207 </para> 208 </description> 209 210 </bitlbee-command> 211 212 <bitlbee-command name="set"> 213 <syntax>channel <channel id> set</syntax> 214 <syntax>channel <channel id> set <setting></syntax> 215 <syntax>channel <channel id> set <setting> <value></syntax> 216 <syntax>channel <channel id> set -del <setting></syntax> 217 218 <description> 219 <para> 220 This command can be used to change various settings for channels. Different channel types support different settings. You can see the settings available for a channel by typing <emphasis>channel <channel id> set</emphasis>. 221 </para> 222 223 <para> 224 For more infomation about a setting, see <emphasis>help set <setting></emphasis>. 225 </para> 226 227 <para> 228 The channel ID can be a number (see <emphasis>channel list</emphasis>), or (part of) its name, as long as it matches only one channel. 229 </para> 230 </description> 231 </bitlbee-command> 232 174 233 </bitlbee-command> 175 234 … … 353 412 </bitlbee-command> 354 413 414 <bitlbee-setting name="account" type="string" scope="channel"> 415 416 <description> 417 <para> 418 For control channels with <emphasis>fill_by</emphasis> set to <emphasis>account</emphasis>: Set this setting to the account id (numeric, or part of the username) of the account containing the contacts you want to see in this channel. 419 </para> 420 </description> 421 </bitlbee-setting> 422 355 423 <bitlbee-setting name="auto_connect" type="boolean" scope="both"> 356 424 <default>true</default> … … 367 435 </bitlbee-setting> 368 436 369 <bitlbee-setting name="auto_join" type="boolean" scope="cha t">437 <bitlbee-setting name="auto_join" type="boolean" scope="channel"> 370 438 <default>false</default> 371 439 372 440 <description> 373 441 <para> 374 With this option enabled, BitlBee will automatically join this cha troomwhen you log in.442 With this option enabled, BitlBee will automatically join this channel when you log in. 375 443 </para> 376 444 </description> … … 479 547 </bitlbee-setting> 480 548 549 <bitlbee-setting name="chat_type" type="string" scope="channel"> 550 <default>groupchat</default> 551 <possible-values>groupchat, room</possible-values> 552 553 <description> 554 <para> 555 There are two kinds of chat channels: simple groupchats (basically normal IM chats with more than two participants) and names chatrooms, more similar to IRC channels. 556 </para> 557 558 <para> 559 BitlBee supports both types. With this setting set to <emphasis>groupchat</emphasis> (the default), you can just invite people into the room and start talking. 560 </para> 561 562 <para> 563 For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command. 564 </para> 565 </description> 566 </bitlbee-setting> 567 481 568 <bitlbee-setting name="debug" type="boolean" scope="global"> 482 569 <default>false</default> … … 524 611 <para> 525 612 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. 613 </para> 614 </description> 615 </bitlbee-setting> 616 617 <bitlbee-setting name="fill_by" type="string" scope="channel"> 618 <default>all</default> 619 <possible-values>all, group, account, protocol</possible-values> 620 621 <description> 622 <para> 623 For control channels only: This setting determines which contacts the channel gets populated with. 624 </para> 625 626 <para> 627 By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol. 628 </para> 629 630 <para> 631 Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection. 632 </para> 633 634 <para> 635 Note that, when creating a new channel, BitlBee will try to preconfigure the channel for you, based on the channel name. See <emphasis>help channels</emphasis>. 636 </para> 637 </description> 638 </bitlbee-setting> 639 640 <bitlbee-setting name="group" type="string" scope="channel"> 641 642 <description> 643 <para> 644 For control channels with <emphasis>fill_by</emphasis> set to <emphasis>group</emphasis>: Set this setting to the name of the group containing the contacts you want to see in this channel. 526 645 </para> 527 646 </description> … … 777 896 </bitlbee-setting> 778 897 898 <bitlbee-setting name="protocol" type="string" scope="channel"> 899 900 <description> 901 <para> 902 For control channels with <emphasis>fill_by</emphasis> set to <emphasis>protocol</emphasis>: Set this setting to the name of the IM protocol of all contacts you want to see in this channel. 903 </para> 904 </description> 905 </bitlbee-setting> 906 779 907 <bitlbee-setting name="query_order" type="string" scope="global"> 780 908 <default>lifo</default> … … 961 1089 <para> 962 1090 Please note that this setting is only used for incoming messages. For outgoing messages you can use ':' (colon) or ',' to separate the destination nick from the message, and this is not configurable. 1091 </para> 1092 </description> 1093 </bitlbee-setting> 1094 1095 <bitlbee-setting name="type" type="string" scope="channel"> 1096 <default>control</default> 1097 <possible-values>control, chat</possible-values> 1098 1099 <description> 1100 <para> 1101 BitlBee supports two kinds of channels: control channels (usually with a name starting with a &) and chatroom channels (name usually starts with a #). 1102 </para> 1103 1104 <para> 1105 See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee. 963 1106 </para> 964 1107 </description> … … 1154 1297 1155 1298 <ircexample> 1156 <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>1299 <ircline nick="wouter">account 1 set display_name "The majestik møøse"</ircline> 1157 1300 <ircline nick="root">display_name = `The majestik møøse'</ircline> 1158 1301 </ircexample> -
doc/user-guide/help.xml
r5c7b45c rf537044 16 16 <varlistentry><term>channels</term><listitem><para>About creating and customizing channels</para></listitem></varlistentry> 17 17 <varlistentry><term>away</term><listitem><para>About setting away states</para></listitem></varlistentry> 18 <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry> 19 <varlistentry><term>nick_changes</term><listitem><para>Changing your nickname without losing any settings</para></listitem></varlistentry> 18 20 <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry> 19 <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry>20 21 </variablelist> 21 22 … … 44 45 <varlistentry><term>quickstart</term><listitem><para>A short introduction into BitlBee</para></listitem></varlistentry> 45 46 <varlistentry><term>commands</term><listitem><para>All available commands and settings</para></listitem></varlistentry> 47 <varlistentry><term>channels</term><listitem><para>About creating and customizing channels</para></listitem></varlistentry> 46 48 <varlistentry><term>away</term><listitem><para>About setting away states</para></listitem></varlistentry> 49 <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry> 50 <varlistentry><term>nick_changes</term><listitem><para>Changing your nickname without losing any settings</para></listitem></varlistentry> 47 51 <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry> 48 <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry>49 52 </variablelist> 50 53 -
doc/user-guide/misc.xml
r5c7b45c rf537044 167 167 168 168 <para> 169 Any valid account ID (so a number, protocol name or part of screenname, as long as it's unique) can also be used as a channel name. So if you just join &msn, it will contain all your MSN contacts (as long as you have only one MSN account set up). And if you have a Facebook account set up, you can see its contacts by just joining &facebook.169 Any valid account ID (so a number, protocol name or part of screenname, as long as it's unique) can also be used as a channel name. So if you just join &msn, it will contain all your MSN contacts. And if you have a Facebook account set up, you can see its contacts by just joining &facebook. 170 170 </para> 171 171
Note: See TracChangeset
for help on using the changeset viewer.
