Changeset 2945c6f for doc/user-guide
- Timestamp:
- 2010-07-24T21:16:18Z (14 years ago)
- Branches:
- master
- Children:
- f1f7b5e
- Parents:
- ef14a83 (diff), 593971d (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. - Location:
- doc/user-guide
- Files:
-
- 4 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/Makefile
ref14a83 r2945c6f 1 1 -include ../../Makefile.settings 2 ifdef SRCDIR 3 SRCDIR := $(SRCDIR)doc/user-guide/ 4 endif 5 2 6 EXTRAPARANEWLINE = 1 3 7 # EXTRAPARANEWLINE = 0 … … 38 42 chmod 0755 $(DESTDIR)$(DATADIR) 39 43 rm -f $(DESTDIR)$(DATADIR)/help.txt # Prevent help function from breaking in running sessions 40 install -m 0644 help.txt $(DESTDIR)$(DATADIR)/help.txt44 install -m 0644 $(SRCDIR)help.txt $(DESTDIR)$(DATADIR)/help.txt 41 45 42 46 uninstall: -
doc/user-guide/commands.xml
ref14a83 r2945c6f 6 6 <bitlbee-command name="account"> 7 7 <short-description>IM-account list maintenance</short-description> 8 <syntax>account <action> [<arguments>]</syntax>8 <syntax>account [<account id>] <action> [<arguments>]</syntax> 9 9 10 10 <description> … … 99 99 100 100 <bitlbee-command name="del"> 101 <syntax>account del <account id></syntax>101 <syntax>account <account id> del</syntax> 102 102 103 103 <description> … … 108 108 109 109 <para> 110 The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.110 The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. 111 111 </para> 112 112 </description> … … 114 114 115 115 <bitlbee-command name="on"> 116 <syntax>account on [<account id>]</syntax>116 <syntax>account [<account id>] on</syntax> 117 117 118 118 <description> … … 122 122 123 123 <para> 124 The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.124 The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. 125 125 </para> 126 126 </description> … … 129 129 130 130 <bitlbee-command name="off"> 131 <syntax>account off [<account id>]</syntax>131 <syntax>account [<account id>] off</syntax> 132 132 133 133 <description> … … 137 137 138 138 <para> 139 The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.139 The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. 140 140 </para> 141 141 </description> … … 153 153 154 154 <bitlbee-command name="set"> 155 <syntax>account set <account id></syntax>156 <syntax>account set <account id>/<setting></syntax>157 <syntax>account set <account id>/<setting> <value></syntax>158 <syntax>account set -del <account id>/<setting></syntax>155 <syntax>account <account id> set</syntax> 156 <syntax>account <account id> set <setting></syntax> 157 <syntax>account <account id> set <setting> <value></syntax> 158 <syntax>account <account id> set -del <setting></syntax> 159 159 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 … … 168 168 169 169 <para> 170 The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.170 The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. 171 171 </para> 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. If you want to change settings of the current channel, you can omit the channel ID. 229 </para> 230 </description> 231 </bitlbee-command> 232 174 233 </bitlbee-command> 175 234 … … 181 240 182 241 <para> 183 Available actions: add, del, list, with and set. See <emphasis>help chat <action></emphasis> for more information.242 Available actions: add, with. See <emphasis>help chat <action></emphasis> for more information. 184 243 </para> 185 244 … … 187 246 188 247 <bitlbee-command name="add"> 189 <syntax>chat add <account > <room> [<channel>]</syntax>248 <syntax>chat add <account id> <room> [<channel>]</syntax> 190 249 191 250 <description> … … 205 264 </bitlbee-command> 206 265 207 <bitlbee-command name=" del">208 <syntax>chat del <chat id></syntax>266 <bitlbee-command name="with"> 267 <syntax>chat with <nickname></syntax> 209 268 210 269 <description> 211 270 <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. 271 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. 217 272 </para> 218 273 </description> 219 274 </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 231 <bitlbee-command name="with">232 <syntax>chat with <nickname></syntax>233 234 <description>235 <para>236 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 <chat id></syntax>243 <syntax>chat set <chat id>/<setting></syntax>244 <syntax>chat set <chat id>/<setting> <value></syntax>245 <syntax>chat set -del <chat id>/<setting></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 <setting></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.258 </para>259 </description>260 </bitlbee-command>261 275 </bitlbee-command> 262 276 263 277 <bitlbee-command name="add"> 264 278 <short-description>Add a buddy to your contact list</short-description> 265 <syntax>add < connection> <handle> [<nick>]</syntax>266 <syntax>add -tmp < connection> <handle> [<nick>]</syntax>279 <syntax>add <account id> <handle> [<nick>]</syntax> 280 <syntax>add -tmp <account id> <handle> [<nick>]</syntax> 267 281 268 282 <description> … … 273 287 <para> 274 288 If you want, you can also tell BitlBee what nick to give the new contact. The -tmp option adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications. 289 </para> 290 291 <para> 292 If you use this command in a control channel containing people from only one group, the new contact will be added to that group automatically. 275 293 </para> 276 294 </description> … … 398 416 </bitlbee-command> 399 417 418 <bitlbee-setting name="account" type="string" scope="channel"> 419 420 <description> 421 <para> 422 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. 423 </para> 424 </description> 425 </bitlbee-setting> 426 427 <bitlbee-setting name="allow_takeover" type="boolean" scope="global"> 428 <default>true</default> 429 430 <description> 431 <para> 432 When you're already connected to a BitlBee server and you connect (and identify) again, BitlBee will offer to migrate your existing session to the new connection. If for whatever reason you don't want this, you can disable this setting. 433 </para> 434 </description> 435 </bitlbee-setting> 436 400 437 <bitlbee-setting name="auto_connect" type="boolean" scope="both"> 401 438 <default>true</default> … … 412 449 </bitlbee-setting> 413 450 414 <bitlbee-setting name="auto_join" type="boolean" scope="cha t">451 <bitlbee-setting name="auto_join" type="boolean" scope="channel"> 415 452 <default>false</default> 416 453 417 454 <description> 418 455 <para> 419 With this option enabled, BitlBee will automatically join this cha troomwhen you log in.456 With this option enabled, BitlBee will automatically join this channel when you log in. 420 457 </para> 421 458 </description> … … 481 518 With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled. 482 519 </para> 520 521 <para> 522 Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>. 523 </para> 524 </description> 525 </bitlbee-setting> 526 527 <bitlbee-setting name="away_reply_timeout" type="integer" scope="global"> 528 <default>3600</default> 529 530 <description> 531 <para> 532 Most IRC servers send a user's away message every time s/he gets a private message, to inform the sender that they may not get a response immediately. With this setting set to 0, BitlBee will also behave like this. 533 </para> 534 535 <para> 536 Since not all IRC clients do an excellent job at suppressing these messages, this setting lets BitlBee do it instead. BitlBee will wait this many seconds (or until the away state/message changes) before re-informing you that the person's away. 537 </para> 483 538 </description> 484 539 </bitlbee-setting> … … 498 553 <para> 499 554 Keep two things in mind: When not using Twitter, you <emphasis>must</emphasis> also disable the <emphasis>oauth</emphasis> setting as it currently only works with Twitter. If you're still having issues, make sure there is <emphasis>no</emphasis> slash at the end of the URL you enter here. 500 </para>501 </description>502 </bitlbee-setting>503 504 <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">505 <default>false</default>506 507 <description>508 <para>509 By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data.510 </para>511 512 <para>513 Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.514 </para>515 516 <para>517 Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases.518 </para>519 </description>520 </bitlbee-setting>521 522 <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">523 <default>200</default>524 525 <description>526 527 <para>528 Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds.529 </para>530 531 <para>532 See also the <emphasis>buddy_sendbuffer</emphasis> setting.533 555 </para> 534 556 </description> … … 561 583 </bitlbee-setting> 562 584 585 <bitlbee-setting name="chat_type" type="string" scope="channel"> 586 <default>groupchat</default> 587 <possible-values>groupchat, room</possible-values> 588 589 <description> 590 <para> 591 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. 592 </para> 593 594 <para> 595 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. 596 </para> 597 598 <para> 599 For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command. 600 </para> 601 </description> 602 </bitlbee-setting> 603 563 604 <bitlbee-setting name="debug" type="boolean" scope="global"> 564 605 <default>false</default> … … 610 651 </bitlbee-setting> 611 652 653 <bitlbee-setting name="fill_by" type="string" scope="channel"> 654 <default>all</default> 655 <possible-values>all, group, account, protocol</possible-values> 656 657 <description> 658 <para> 659 For control channels only: This setting determines which contacts the channel gets populated with. 660 </para> 661 662 <para> 663 By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol. 664 </para> 665 666 <para> 667 Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection. 668 </para> 669 670 <para> 671 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>. 672 </para> 673 </description> 674 </bitlbee-setting> 675 676 <bitlbee-setting name="group" type="string" scope="channel"> 677 678 <description> 679 <para> 680 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. 681 </para> 682 </description> 683 </bitlbee-setting> 684 612 685 <bitlbee-setting name="handle_unknown" type="string" scope="global"> 613 <default> root</default>686 <default>add_channel</default> 614 687 <possible-values>root, add, add_private, add_channel, ignore</possible-values> 615 688 … … 717 790 718 791 <bitlbee-setting name="nick" type="string" scope="chat"> 719 720 792 <description> 721 793 <para> 722 794 You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname. 795 </para> 796 </description> 797 </bitlbee-setting> 798 799 <bitlbee-setting name="nick_format" type="string" scope="both"> 800 <default>%-@nick</default> 801 802 <description> 803 <para> 804 By default, BitlBee tries to derive sensible nicknames for all your contacts from their IM handles. In some cases, IM modules (ICQ for example) will provide a nickname suggestion, which will then be used instead. This setting lets you change this behaviour. 805 </para> 806 807 <para> 808 Whenever this setting is set for an account, it will be used for all its contacts. If it's not set, the global value will be used. 809 </para> 810 811 <para> 812 It's easier to describe this setting using a few examples: 813 </para> 814 815 <para> 816 FB-%full_name will make all nicknames start with "FB-", followed by the person's full name. For example you can set this format for your Facebook account so all Facebook contacts are clearly marked. 817 </para> 818 819 <para> 820 [%group]%-@nick will make all nicknames start with the group the contact is in between square brackets, followed by the nickname suggestions from the IM module if available, or otherwise the handle. Because of the "-@" part, everything from the first @ will be stripped. 821 </para> 822 823 <para> 824 See <emphasis>help nick_format</emphasis> for more information. 723 825 </para> 724 826 </description> … … 789 891 </description> 790 892 </bitlbee-setting> 893 894 <bitlbee-setting name="paste_buffer" type="boolean" scope="global"> 895 <default>false</default> 896 897 <description> 898 <para> 899 By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data. 900 </para> 901 902 <para> 903 Using the <emphasis>paste_buffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent. 904 </para> 905 906 <para> 907 Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases. 908 </para> 909 </description> 910 </bitlbee-setting> 911 912 <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global"> 913 <default>200</default> 914 915 <description> 916 917 <para> 918 Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds. 919 </para> 920 921 <para> 922 See also the <emphasis>paste_buffer</emphasis> setting. 923 </para> 924 </description> 925 </bitlbee-setting> 791 926 792 927 <bitlbee-setting name="port" type="integer" scope="account"> … … 822 957 <para> 823 958 This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect. 959 </para> 960 </description> 961 </bitlbee-setting> 962 963 <bitlbee-setting name="protocol" type="string" scope="channel"> 964 965 <description> 966 <para> 967 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. 824 968 </para> 825 969 </description> … … 901 1045 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. 902 1046 </para> 1047 1048 <para> 1049 Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>. 1050 </para> 1051 </description> 1052 </bitlbee-setting> 1053 1054 <bitlbee-setting name="show_users" type="string" scope="channel"> 1055 <default>online+,away</default> 1056 1057 <description> 1058 <para> 1059 Comma-separated list of statuses of users you want in the channel, 1060 and any modes they should have. The following statuses are currently 1061 recognised: <emphasis>online</emphasis> (i.e. available, not 1062 away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>. 1063 </para> 1064 1065 <para> 1066 If a status is followed by a valid channel mode character 1067 (@, % or +), it will be given to users with that status. 1068 For example, <emphasis>online@,away+,offline</emphasis> will 1069 show all users in the channel. Online people will 1070 have +o, people who are online but away will have +v, 1071 and others will have no special modes. 1072 </para> 903 1073 </description> 904 1074 </bitlbee-setting> … … 967 1137 <para> 968 1138 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. 1139 </para> 1140 </description> 1141 </bitlbee-setting> 1142 1143 <bitlbee-setting name="tag" type="string" scope="account"> 1144 <description> 1145 <para> 1146 For every account you have, you can set a tag you can use to uniquely identify that account. This tag can be used instead of the account number (or protocol name, or part of the screenname) when using commands like <emphasis>account</emphasis>, <emphasis>add</emphasis>, etc. You can't have two accounts with one and the same account tag. 1147 </para> 1148 1149 <para> 1150 By default, it will be set to the name of the IM protocol. Once you add a second account on an IM network, a numeric suffix will be added, starting with 2. 969 1151 </para> 970 1152 </description> … … 1010 1192 <para> 1011 1193 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. 1194 </para> 1195 </description> 1196 </bitlbee-setting> 1197 1198 <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel"> 1199 <default>true</default> 1200 1201 <description> 1202 <para> 1203 IRC's nickname namespace is quite limited compared to most IM protocols. Not any non-ASCII characters are allowed, in fact nicknames have to be mostly alpha-numeric. Also, BitlBee has to add underscores sometimes to avoid nickname collisions. 1204 </para> 1205 1206 <para> 1207 While normally the BitlBee user is the only one seeing these names, they may be exposed to other chatroom participants for example when addressing someone in the channel (with or without tab completion). By default BitlBee will translate these stripped nicknames back to the original nick. If you don't want this, disable this setting. 1208 </para> 1209 </description> 1210 </bitlbee-setting> 1211 1212 <bitlbee-setting name="type" type="string" scope="channel"> 1213 <default>control</default> 1214 <possible-values>control, chat</possible-values> 1215 1216 <description> 1217 <para> 1218 BitlBee supports two kinds of channels: control channels (usually with a name starting with a &) and chatroom channels (name usually starts with a #). 1219 </para> 1220 1221 <para> 1222 See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee. 1012 1223 </para> 1013 1224 </description> … … 1146 1357 1147 1358 <bitlbee-command name="identify"> 1148 <syntax>identify <password></syntax>1359 <syntax>identify [-noload|-force] <password></syntax> 1149 1360 <short-description>Identify yourself with your password</short-description> 1150 1361 … … 1156 1367 <para> 1157 1368 Once you're registered, you can change your password using <emphasis>set password <password></emphasis>. 1369 </para> 1370 1371 <para> 1372 The <emphasis>-noload</emphasis> and <emphasis>-force</emphasis> flags can be used to identify when you're logged into some IM accounts already. <emphasis>-force</emphasis> will let you identify yourself and load all saved accounts (and keep the accounts you're logged into already). 1373 </para> 1374 1375 <para> 1376 <emphasis>-noload</emphasis> will log you in but not load any accounts and settings saved under your current nickname. These will be overwritten once you save your settings (i.e. when you disconnect). 1158 1377 </para> 1159 1378 </description> … … 1183 1402 </bitlbee-command> 1184 1403 1185 <bitlbee-command name="nick"> 1186 <short-description>Change friendly name, nick</short-description> 1187 <syntax>nick <connection> [<new nick>]</syntax> 1188 <syntax>nick <connection></syntax> 1189 1190 <description> 1191 <para> 1192 Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information. 1193 </para> 1194 </description> 1195 1196 <ircexample> 1197 <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline> 1198 <ircline nick="root">display_name = `The majestik møøse'</ircline> 1199 </ircexample> 1200 1201 </bitlbee-command> 1404 <bitlbee-command name="group"> 1405 <short-description>Contact group management</short-description> 1406 <syntax>group list</syntax> 1407 1408 <description> 1409 <para> 1410 Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far. 1411 </para> 1412 </description> 1413 </bitlbee-command> 1414 1415 <bitlbee-command name="transfers"> 1416 <short-description>Monitor, cancel, or reject file transfers</short-description> 1417 <syntax>transfers [<cancel> id | <reject>]</syntax> 1418 1419 <description> 1420 <para> 1421 Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfers <action></emphasis> for more information. 1422 </para> 1423 1424 <ircexample> 1425 <ircline nick="ulim">transfers</ircline> 1426 </ircexample> 1427 </description> 1428 1429 <bitlbee-command name="cancel"> 1430 <short-description>Cancels the file transfer with the given id</short-description> 1431 <syntax>transfers <cancel> id</syntax> 1432 1433 <description> 1434 <para>Cancels the file transfer with the given id</para> 1435 </description> 1436 1437 <ircexample> 1438 <ircline nick="ulim">transfers cancel 1</ircline> 1439 <ircline nick="root">Canceling file transfer for test</ircline> 1440 </ircexample> 1441 </bitlbee-command> 1442 1443 <bitlbee-command name="reject"> 1444 <short-description>Rejects all incoming transfers</short-description> 1445 <syntax>transfers <reject></syntax> 1446 1447 <description> 1448 <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is neccessary. Or is it?</para> 1449 </description> 1450 1451 <ircexample> 1452 <ircline nick="ulim">transfers reject</ircline> 1453 </ircexample> 1454 </bitlbee-command> 1455 </bitlbee-command> 1456 1202 1457 </chapter> -
doc/user-guide/help.xml
ref14a83 r2945c6f 14 14 <varlistentry><term>quickstart</term><listitem><para>A short introduction into BitlBee</para></listitem></varlistentry> 15 15 <varlistentry><term>commands</term><listitem><para>All available commands and settings</para></listitem></varlistentry> 16 <varlistentry><term>channels</term><listitem><para>About creating and customizing channels</para></listitem></varlistentry> 16 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> 17 20 <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry> 18 <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry>19 21 </variablelist> 20 22 … … 43 45 <varlistentry><term>quickstart</term><listitem><para>A short introduction into BitlBee</para></listitem></varlistentry> 44 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> 45 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> 46 51 <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry> 47 <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry>48 52 </variablelist> 49 53 -
doc/user-guide/misc.xml
ref14a83 r2945c6f 117 117 </sect1> 118 118 119 <sect1 id="nick_changes"> 120 <title>Changing your nickname</title> 121 122 <para> 123 BitlBee now allows you to change your nickname. So far this was not possible because it made managing saved accounts more complicated. 124 </para> 125 126 <para> 127 The restriction no longer exists now though. When you change your nick (just using the <emphasis>/nick</emphasis> command), your logged-in status will be reset, which means any changes made to your settings/accounts will not be saved. 128 </para> 129 130 <para> 131 To restore your logged-in status, you need to either use the <emphasis>register</emphasis> command to create an account under the new nickname, or use <emphasis>identify -noload</emphasis> to re-identify yourself under the new nickname. The <emphasis>-noload</emphasis> flag tells the command to verify your password and log you in, but not load any new settings. See <emphasis>help identify</emphasis> for more information. 132 </para> 133 134 </sect1> 135 136 <sect1 id="channels"> 137 <title>Dealing with channels</title> 138 139 <para> 140 You can have as many channels in BitlBee as you want. You maintain your channel list using the <emphasis>channel</emphasis> command. You can create new channels by just joining them, like on regular IRC networks. 141 </para> 142 143 <para> 144 You can create two kinds of channels. Control channels, and groupchat channels. By default, BitlBee will set up new channels as control channels if their name starts with an &, and as chat channels if it starts with a #. 145 </para> 146 147 <para> 148 Control channels are where you see your contacts. By default, you will have one control channel called &bitlbee, containing all your contacts. But you can create more, if you want, and divide your contact list accross several channels. 149 </para> 150 151 <para> 152 For example, you can have one channel with all contacts from your MSN Messenger account in it. Or all contacts from the group called "Work". 153 </para> 154 155 <para> 156 Type <emphasis>help channels2</emphasis> to read more. 157 </para> 158 159 </sect1> 160 161 <sect1 id="channels2"> 162 <title>Creating a channel</title> 163 164 <para> 165 When you create a new channel, BitlBee will try to guess from its name which contacts to fill it with. For example, if the channel name (excluding the &) matches the name of a group in which you have one or more contacts, the channel will contain all those contacts. 166 </para> 167 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. And if you have a Facebook account set up, you can see its contacts by just joining &facebook. 170 </para> 171 172 <para> 173 To start a simple group chat, you simply join a channel which a name starting with #, and invite people into it. All people you invite have to be on the same IM network and contact list. 174 </para> 175 176 <para> 177 If you want to configure your own channels, you can use the <emphasis>channel set</emphasis>. 178 </para> 179 180 </sect1> 181 182 <sect1 id="nick_format"> 183 <title>Nickname formatting</title> 184 185 <para> 186 The <emphasis>nick_format</emphasis> setting can be set globally using 187 the <emphasis>set</emphasis> command, or per account using <emphasis>account 188 set</emphasis> (so that you can set a per-account suffix/prefix or have 189 nicknames generated from full names for certain accounts). 190 </para> 191 192 <para> 193 The setting is basically some kind of format string. It can contain normal 194 text that will be copied to the nick, combined with several variables: 195 </para> 196 197 <variablelist> 198 <varlistentry><term>%nick</term><listitem><para>Nickname suggested for this contact by the IM protocol, or just the handle if no nickname was suggested.</para></listitem></varlistentry> 199 <varlistentry><term>%handle</term><listitem><para>The handle/screenname of the contact.</para></listitem></varlistentry> 200 <varlistentry><term>%full_name</term><listitem><para>The full name of the contact.</para></listitem></varlistentry> 201 <varlistentry><term>%first_name</term><listitem><para>The first name of the contact (the full name up to the first space).</para></listitem></varlistentry> 202 <varlistentry><term>%group</term><listitem><para>The name of the group this contact is a member of</para></listitem></varlistentry> 203 </variablelist> 204 205 <para> 206 Invalid characters (like spaces) will always be stripped. Depending on your 207 locale settings, characters with accents will be converted to ASCII. 208 </para> 209 210 <para> 211 See <emphasis>set nick_format2</emphasis> for some more information. 212 </para> 213 214 </sect1> 215 216 <sect1 id="nick_format2"> 217 <title>Nickname formatting - modifiers</title> 218 219 <para> 220 Two modifiers ares currently available: You can include only the first few 221 characters of a variable by putting a number right after the %. For 222 example, <emphasis>[%3group]%-@nick</emphasis> will include only the first 223 three characters of the group name in the nick. 224 </para> 225 226 <para> 227 Also, you can truncate variables from a certain character using 228 the <emphasis>-</emphasis> modifier. For example, you may want to leave out 229 everything after the @. <emphasis>%-@handle</emphasis> will expand to 230 everything in the handle up to the first @. 231 </para> 232 233 </sect1> 234 119 235 </chapter>
Note: See TracChangeset
for help on using the changeset viewer.
