Changes in doc/user-guide/commands.xml [823de9d:57d8421]
- File:
-
- 1 edited
-
doc/user-guide/commands.xml (modified) (11 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/commands.xml
r823de9d r57d8421 125 125 <description> 126 126 <para> 127 This command gives you a list of all the accounts known by BitlBee , including the numbers you'll need for most account commands.127 This command gives you a list of all the accounts known by BitlBee. 128 128 </para> 129 129 </description> … … 138 138 <description> 139 139 <para> 140 This accountcan 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>.140 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>. 141 141 </para> 142 142 143 143 <para> 144 For more infomation about a setting, see <emphasis>help set <setting></emphasis>. For details about the syntax of this command, see <emphasis>help set</emphasis>.144 For more infomation about a setting, see <emphasis>help set <setting></emphasis>. 145 145 </para> 146 146 147 147 <para> 148 148 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. 149 </para> 150 </description> 151 </bitlbee-command> 152 </bitlbee-command> 153 154 <bitlbee-command name="chat"> 155 <short-description>Chatroom list maintenance</short-description> 156 <syntax>chat <action> [<arguments>]</syntax> 157 158 <description> 159 160 <para> 161 Available actions: add, del, list, with and set. See <emphasis>help chat <action></emphasis> for more information. 162 </para> 163 164 </description> 165 166 <bitlbee-command name="add"> 167 <syntax>chat add <account> <room> [<channel>]</syntax> 168 169 <description> 170 <para> 171 Add a chatroom to the list of chatrooms you're interested in. BitlBee needs this list to map room names to a proper IRC channel name. 172 </para> 173 174 <para> 175 After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See <emphasis>chat set</emphasis>) 176 </para> 177 178 <para> 179 Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join. 180 </para> 181 </description> 182 183 </bitlbee-command> 184 185 <bitlbee-command name="del"> 186 <syntax>chat del <chat id></syntax> 187 188 <description> 189 <para> 190 This commands deletes an chatroom from your list. 191 </para> 192 193 <para> 194 The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel. 195 </para> 196 </description> 197 </bitlbee-command> 198 199 <bitlbee-command name="list"> 200 <syntax>chat list</syntax> 201 202 <description> 203 <para> 204 This command gives you a list of all the chatrooms known by BitlBee. 205 </para> 206 </description> 207 </bitlbee-command> 208 209 <bitlbee-command name="with"> 210 <syntax>chat with <nickname></syntax> 211 212 <description> 213 <para> 214 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. 215 </para> 216 </description> 217 </bitlbee-command> 218 219 <bitlbee-command name="set"> 220 <syntax>chat set <chat id></syntax> 221 <syntax>chat set <chat id>/<setting></syntax> 222 <syntax>chat set <chat id>/<setting> <value></syntax> 223 <syntax>chat set -del <chat id>/<setting></syntax> 224 225 <description> 226 <para> 227 This command can be used to change various settings for chatrooms. 228 </para> 229 230 <para> 231 For more infomation about a setting, see <emphasis>help set <setting></emphasis>. 232 </para> 233 234 <para> 235 The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel. 149 236 </para> 150 237 </description> … … 239 326 </para> 240 327 </description> 241 </bitlbee-command>242 243 <bitlbee-command name="otr">244 <short-description>Off-the-Record encryption control</short-description>245 <syntax>otr <subcommand> [<arguments>]</syntax>246 247 <description>248 249 <para>250 Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr <subcommand></emphasis> for more information.251 </para>252 253 </description>254 255 <bitlbee-command name="connect">256 <syntax>otr connect <nick></syntax>257 258 <description>259 260 <para>261 Attempts to establish an encrypted connection with the specified user by sending a magic string.262 </para>263 264 </description>265 266 </bitlbee-command>267 268 <bitlbee-command name="disconnect">269 <syntax>otr disconnect <nick></syntax>270 271 <description>272 273 <para>274 Resets the connection with the specified user to cleartext.275 </para>276 277 </description>278 279 </bitlbee-command>280 281 <bitlbee-command name="smp">282 <syntax>otr smp <nick> <secret></syntax>283 284 <description>285 286 <para>287 Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.288 </para>289 290 <para>291 If an SMP challenge has already been received from the given user, responds with the specified secret. Otherwise, a challenge for the secret will be sent. If the protocol succeeds (i.e. both parties gave the same secret), the fingerprint will be trusted.292 </para>293 294 </description>295 296 </bitlbee-command>297 298 <bitlbee-command name="trust">299 <syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax>300 301 <description>302 303 <para>304 Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.305 </para>306 307 </description>308 309 </bitlbee-command>310 311 <bitlbee-command name="info">312 <syntax>otr info</syntax>313 <syntax>otr info <nick></syntax>314 315 <description>316 317 <para>318 Shows information about the OTR state. The first form lists our private keys and current OTR contexts. The second form displays information about the connection with a given user, including the list of their known fingerprints.319 </para>320 321 </description>322 323 </bitlbee-command>324 325 <bitlbee-command name="keygen">326 <syntax>otr keygen <account-no></syntax>327 328 <description>329 330 <para>331 Generates a new OTR private key for the given account.332 </para>333 334 </description>335 336 </bitlbee-command>337 338 <bitlbee-command name="forget">339 <syntax>otr forget <thing> <arguments></syntax>340 341 <description>342 343 <para>344 Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information.345 </para>346 347 </description>348 349 <bitlbee-command name="fingerprint">350 <syntax>otr forget fingerprint <nick> <fingerprint></syntax>351 352 <description>353 354 <para>355 Drops the specified fingerprint from the given user's OTR connection context. It is allowed to specify only a (unique) prefix of the desired fingerprint.356 </para>357 358 </description>359 360 </bitlbee-command>361 362 <bitlbee-command name="context">363 <syntax>otr forget context <nick></syntax>364 365 <description>366 367 <para>368 Forgets the entire OTR context associated with the given user. This includes current message and protocol states, as well as any fingerprints for that user.369 </para>370 371 </description>372 373 </bitlbee-command>374 375 <bitlbee-command name="key">376 <syntax>otr forget key <fingerprint></syntax>377 378 <description>379 380 <para>381 Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.382 </para>383 384 </description>385 386 </bitlbee-command>387 388 </bitlbee-command>389 390 328 </bitlbee-command> 391 329 … … 452 390 </bitlbee-setting> 453 391 392 <bitlbee-setting name="auto_join" type="boolean" scope="chat"> 393 <default>false</default> 394 395 <description> 396 <para> 397 With this option enabled, BitlBee will automatically join this chatroom when you log in. 398 </para> 399 </description> 400 </bitlbee-setting> 401 454 402 <bitlbee-setting name="auto_reconnect" type="boolean" scope="both"> 455 403 <default>false</default> … … 542 490 <para> 543 491 Most systems use UTF-8 these days. On older systems, an iso8859 charset may work better. For example, iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://www.unicodecharacter.com/charsets/iso8859.html 544 </para>545 </description>546 547 </bitlbee-setting>548 549 <bitlbee-setting name="color_encrypted" type="boolean" scope="global">550 <default>true</default>551 552 <description>553 <para>554 If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.555 492 </para> 556 493 </description> … … 624 561 </bitlbee-setting> 625 562 626 <bitlbee-setting name="halfop_buddies" type="string" scope="global">627 <default>encrypted</default>628 <possible-values>encrypted, trusted, notaway, false</possible-values>629 630 <description>631 <para>632 Specifies under which circumstances BitlBee should give the "halfop" mode flag (+h) to buddies.633 </para>634 635 <para>636 If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.637 </para>638 </description>639 640 </bitlbee-setting>641 642 563 <bitlbee-setting name="lcnicks" type="boolean" scope="global"> 643 564 <default>true</default> … … 662 583 </bitlbee-setting> 663 584 664 <bitlbee-setting name="op_buddies" type="string" scope="global"> 665 <default>trusted</default> 666 <possible-values>encrypted, trusted, notaway, false</possible-values> 667 668 <description> 669 <para> 670 Specifies under which circumstances BitlBee should give the "op" mode flag (+o) to buddies. 671 </para> 672 673 <para> 674 If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key. 675 </para> 676 </description> 677 678 </bitlbee-setting> 679 680 <bitlbee-setting name="op_root" type="bool" scope="global"> 681 <default>true</default> 682 683 <description> 684 <para> 685 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can set the desired state for root using this setting. 686 </para> 687 </description> 688 </bitlbee-setting> 689 690 <bitlbee-setting name="op_user" type="bool" scope="global"> 691 <default>true</default> 692 693 <description> 694 <para> 695 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can set the desired state for yourself using this setting. 696 </para> 697 </description> 698 </bitlbee-setting> 699 700 <bitlbee-setting name="otr_policy" type="string" scope="global"> 701 <default>opportunistic</default> 702 <possible-values>never, opportunistic, manual, always</possible-values> 703 704 <description> 705 <para> 706 This setting controls the policy for establishing Off-the-Record connections. 707 </para> 708 <para> 709 A value of "never" effectively disables the OTR subsystem. In "opportunistic" mode, a magic whitespace pattern will be appended to the first message sent to any user. If the peer is also running opportunistic OTR, an encrypted connection will be set up automatically. On "manual", on the other hand, OTR connections must be established explicitly using <emphasis>otr connect</emphasis>. Finally, the setting "always" enforces encrypted communication by causing BitlBee to refuse to send any cleartext messages at all. 585 <bitlbee-setting name="nick" type="string" scope="chat"> 586 587 <description> 588 <para> 589 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. 590 </para> 591 </description> 592 </bitlbee-setting> 593 594 <bitlbee-setting name="ops" type="string" scope="global"> 595 <default>both</default> 596 <possible-values>both, root, user, none</possible-values> 597 598 <description> 599 <para> 600 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. 601 </para> 602 603 <para> 604 The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status. 710 605 </para> 711 606 </description> … … 791 686 <bitlbee-setting name="resource_select" type="string" scope="account"> 792 687 <default>priority</default> 793 <possible-values>priority, time</possible-values>688 <possible-values>priority, activity</possible-values> 794 689 795 690 <description> … … 799 694 800 695 <para> 801 Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis> time</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected).696 Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>activity</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). 802 697 </para> 803 698 </description> … … 901 796 </para> 902 797 </description> 903 </bitlbee-setting>904 905 <bitlbee-setting name="voice_buddies" type="string" scope="global">906 <default>trusted</default>907 <possible-values>encrypted, trusted, notaway, false</possible-values>908 909 <description>910 <para>911 Specifies under which circumstances BitlBee should give the "voice" mode flag (+v) to buddies.912 </para>913 914 <para>915 If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.916 </para>917 </description>918 919 798 </bitlbee-setting> 920 799 … … 1081 960 1082 961 </bitlbee-command> 1083 1084 <bitlbee-command name="join_chat">1085 <short-description>Join a named groupchat/conference room</short-description>1086 <syntax>join_chat <connection> <room name> [<channel name>] [<room nickname>] [<password>]</syntax>1087 1088 <description>1089 <para>1090 On most IM-networks groupchats can be started using the /join command. (<emphasis>/join #foo</emphasis> to start a chatroom with you and <emphasis>foo</emphasis>) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command.1091 </para>1092 1093 <para>1094 The first two arguments are required. <emphasis>room name</emphasis> is the name of the chatroom on the IM-network. <emphasis>channel name</emphasis> is the IRC channel name BitlBee should map this to. <emphasis>room nickname</emphasis> is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses.1095 </para>1096 1097 <para>1098 The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&bitlbee-help</emphasis> because <emphasis>&bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>.1099 </para>1100 </description>1101 1102 <ircexample>1103 <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me</ircline>1104 </ircexample>1105 1106 </bitlbee-command>1107 962 </chapter>
Note: See TracChangeset
for help on using the changeset viewer.
