source: doc/user-guide/commands.xml @ a33ee0f

Last change on this file since a33ee0f was a33ee0f, checked in by jgeboski <jgeboski@…>, at 2016-09-20T03:39:05Z

Added an interface for the listing of existing chatrooms

Several protocols can provide a list of existing chatrooms that a user
is able join. This is crucial for the usage of several protocols, most
notably Purple and Facebook.

Plugins wishing to support this extended functionality must implement
the new prpl->chat_list() function. This implemented function will in
most cases send a remote request for the list of chatrooms. Once the
list of chatrooms is obtained, a bee_chat_info_t GSList must be created
and assigned to the im_connection->chatlist field. Then a call to the
bee_chat_list_finish() is needed to display the list to the user.

The chat list is maintained entirely by the plugin, so it is important
to ensure all pointers related to the chat list remain valid until the
chat list is set to NULL. This list is used internally by bitlbee to
calculate indexes, which then allows the user to join a chat with an
index, rather than some random identifier. It also important to ensure
the list is properly freed whenever it is updated, or when the account
is disconnect via the prpl->logout() function.

On the user interface side of things, the 'chat list' subcommand was
recommissioned. For a user to list the existing chat rooms:

chat list <account id>

Afterwards a user can join a chatroom in the list with its index. This
extends the functionality of the 'chat add' subcommand by adding in
support for the exclamation point operator to denote an index.

chat add <account id> !<index> [channel]

  • Property mode set to 100644
File size: 78.8 KB
1<chapter id="commands">
2        <title>Bitlbee commands</title>
4        <command-list/>
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
10                <description>
12                        <para>
13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
14                        </para>
16                </description>
18                <bitlbee-command name="add">
19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; [&lt;password&gt;]</syntax>
21                        <description>
22                                <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>.
24                                </para>
26                                <para>
27                                        You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs.
28                                </para>
29                        </description>
31                        <bitlbee-command name="jabber">
32                                <syntax>account add jabber &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
34                                <description>
35                                        <para>
36                                                The handle should be a full handle, including the domain name. You can specify a servername if necessary. Normally BitlBee doesn't need this though, since it's able to find out the server by doing DNS SRV lookups.
37                                        </para>
39                                        <para>
40                                                In previous versions it was also possible to specify port numbers and/or SSL in the server tag. This is deprecated and should now be done using the <emphasis>account set</emphasis> command. This also applies to specifying a resource in the handle (like <emphasis></emphasis>).
41                                        </para>
42                                </description>
43                        </bitlbee-command>
45                        <bitlbee-command name="msn">
46                                <syntax>account add msn &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
48                                <description>
49                                        <para>
50                                                For MSN connections there are no special arguments.
51                                        </para>
52                                </description>
53                        </bitlbee-command>
55                        <bitlbee-command name="oscar">
56                                <syntax>account add oscar &lt;handle&gt; [&lt;password&gt;]</syntax>
58                                <description>
59                                        <para>
60                                                OSCAR is the protocol used to connect to AIM and/or ICQ. The servers will automatically detect if you're using a numeric or non-numeric username so there's no need to tell which network you want to connect to.
61                                        </para>
62                                </description>
64                                <ircexample>
65                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
66                                        <ircline nick="root">Account successfully added</ircline>
67                                </ircexample>
68                        </bitlbee-command>
70                        <bitlbee-command name="twitter">
71                                <syntax>account add twitter &lt;handle&gt;</syntax>
73                                <description>
74                                        <para>
75                                                This module gives you simple access to Twitter and Twitter API compatible services.
76                                        </para>
78                                        <para>
79                                                By default all your Twitter contacts will appear in a new channel called #twitter_yourusername. You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
80                                        </para>
82                                        <para>
83                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
84                                        </para>
86                                        <para>
87                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
88                                        </para>
90                                        <para>
91                                                To use a non-Twitter service, change the <emphasis>base_url</emphasis> setting. For, you can simply use <emphasis>account add identica</emphasis>.
92                                        </para>
93                                </description>
94                        </bitlbee-command>
96                        <bitlbee-command name="identica">
97                                <syntax>account add identica &lt;handle&gt;</syntax>
99                                <description>
100                                        <para>
101                                                Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at It also works with OAuth (so don't specify your password).
102                                        </para>
103                                </description>
104                        </bitlbee-command>
106                        <bitlbee-command name="yahoo">
107                                <syntax>account add yahoo &lt;handle&gt; [&lt;password&gt;]</syntax>
109                                <description>
110                                        <para>
111                                                For Yahoo! connections there are no special arguments.
112                                        </para>
113                                </description>
114                        </bitlbee-command>
116                </bitlbee-command>
118                <bitlbee-command name="del">
119                        <syntax>account &lt;account id&gt; del</syntax>
121                        <description>
122                                <para>
123                                        This command deletes an account from your account list. You should signoff the account before deleting it.
124                                </para>
127                                <para>
128                                        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.
129                                </para>
130                        </description>
131                </bitlbee-command>
133                <bitlbee-command name="on">
134                        <syntax>account [&lt;account id&gt;] on</syntax>
136                        <description>
137                                <para>
138                                        This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts that have the auto_connect flag set.
139                                </para>
141                                <para>
142                                        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.
143                                </para>
144                        </description>
146                </bitlbee-command>
148                <bitlbee-command name="off">
149                        <syntax>account [&lt;account id&gt;] off</syntax>
151                        <description>
152                                <para>
153                                        This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts and cancel all pending reconnects.
154                                </para>
156                                <para>
157                                        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.
158                                </para>
159                        </description>
160                </bitlbee-command>
162                <bitlbee-command name="list">
163                        <syntax>account list</syntax>
165                        <description>
166                                <para>
167                                        This command gives you a list of all the accounts known by BitlBee.
168                                </para>
169                        </description>
170                </bitlbee-command>
172                <bitlbee-command name="set">
173                        <syntax>account &lt;account id&gt; set</syntax>
174                        <syntax>account &lt;account id&gt; set &lt;setting&gt;</syntax>
175                        <syntax>account &lt;account id&gt; set &lt;setting&gt; &lt;value&gt;</syntax>
176                        <syntax>account &lt;account id&gt; set -del &lt;setting&gt;</syntax>
178                        <description>
179                                <para>
180                                        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 &lt;account id&gt; set</emphasis>.
181                                </para>
183                                <para>
184                                        For more information about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
185                                </para>
187                                <para>
188                                        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.
189                                </para>
190                        </description>
191                </bitlbee-command>
192        </bitlbee-command>
194        <bitlbee-command name="channel">
195                <short-description>Channel list maintenance</short-description>
196                <syntax>channel [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
198                <description>
199                        <para>
200                                Available actions: del, list, set. See <emphasis>help channel &lt;action&gt;</emphasis> for more information.
201                        </para>
203                        <para>
204                                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>.
205                        </para>
206                </description>
208                <bitlbee-command name="del">
209                        <syntax>channel &lt;channel id&gt; del</syntax>
211                        <description>
212                                <para>
213                                        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.)
214                                </para>
215                        </description>
217                </bitlbee-command>
219                <bitlbee-command name="list">
220                        <syntax>channel list</syntax>
222                        <description>
223                                <para>
224                                        This command gives you a list of all the channels you configured.
225                                </para>
226                        </description>
228                </bitlbee-command>
230                <bitlbee-command name="set">
231                        <syntax>channel [&lt;channel id&gt;] set</syntax>
232                        <syntax>channel [&lt;channel id&gt;] set &lt;setting&gt;</syntax>
233                        <syntax>channel [&lt;channel id&gt;] set &lt;setting&gt; &lt;value&gt;</syntax>
234                        <syntax>channel [&lt;channel id&gt;] set -del &lt;setting&gt;</syntax>
236                        <description>
237                                <para>
238                                        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 &lt;channel id&gt; set</emphasis>.
239                                </para>
241                                <para>
242                                        For more information about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
243                                </para>
245                                <para>
246                                        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.
247                                </para>
248                        </description>
249                </bitlbee-command>
251        </bitlbee-command>
253        <bitlbee-command name="chat">
254                <short-description>Chatroom list maintenance</short-description>
255                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
257                <description>
259                        <para>
260                                Available actions: add, with. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
261                        </para>
263                </description>
265                <bitlbee-command name="add">
266                        <syntax>chat add &lt;account id&gt; &lt;room|!index&gt; [&lt;channel&gt;]</syntax>
268                        <description>
269                                <para>
270                                        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.
271                                </para>
273                                <para>
274                                        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>)
275                                </para>
277                                <para>
278                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
279                                </para>
280                        </description>
282                </bitlbee-command>
284                <bitlbee-command name="list">
285                        <syntax>chat list &lt;account id&gt; [&lt;server&gt;]</syntax>
287                        <description>
288                                <para>
289                                        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>.
290                                </para>
291                        </description>
292                </bitlbee-command>
294                <bitlbee-command name="with">
295                        <syntax>chat with &lt;nickname&gt;</syntax>
297                        <description>
298                                <para>
299                                        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.
300                                </para>
301                        </description>
302                </bitlbee-command>
303        </bitlbee-command>
305        <bitlbee-command name="add">
306                <short-description>Add a buddy to your contact list</short-description>
307                <syntax>add &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
308                <syntax>add -tmp &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
310                <description>
311                        <para>
312                                Adds the given buddy at the specified connection to your buddy list. 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.
313                        </para>
315                        <para>
316                                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.
317                        </para>
319                        <para>
320                                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.
321                        </para>
322                </description>
324                <ircexample>
325                        <ircline nick="ctrlsoft">add 3 grijp</ircline>
326                        <ircaction nick="grijp" hostmask="">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
327                </ircexample>
328        </bitlbee-command>
330        <bitlbee-command name="info">
331                <short-description>Request user information</short-description>
332                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
333                <syntax>info &lt;nick&gt;</syntax>
335                <description>
336                        <para>
337                                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.
338                        </para>
339                </description>
341                <ircexample>
342                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
343                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail:</ircline>
344                </ircexample>
346        </bitlbee-command>
348        <bitlbee-command name="remove">
349                <short-description>Remove a buddy from your contact list</short-description>
350                <syntax>remove &lt;nick&gt;</syntax>
352                <description>
353                        <para>
354                                Removes the specified nick from your buddy list.
355                        </para>
356                </description>
358                <ircexample>
359                        <ircline nick="ctrlsoft">remove gryp</ircline>
360                        <ircaction nick="gryp" hostmask="">has quit <emphasis>[Leaving...]</emphasis></ircaction>
361                </ircexample>
363        </bitlbee-command>
365        <bitlbee-command name="block">
366                <short-description>Block someone</short-description>
367                <syntax>block &lt;nick&gt;</syntax>
368                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
369                <syntax>block &lt;connection&gt;</syntax>
371                <description>
372                        <para>
373                                Puts the specified user on your ignore list. Either specify the user's nick when you have him/her in your contact list or a connection number and a user handle.
374                        </para>
376                        <para>
377                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
378                        </para>
379                </description>
380        </bitlbee-command>
382        <bitlbee-command name="allow">
383                <short-description>Unblock someone</short-description>
384                <syntax>allow &lt;nick&gt;</syntax>
385                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
387                <description>
388                        <para>
389                                Reverse of block. Unignores the specified user or user handle on specified connection.
390                        </para>
392                        <para>
393                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
394                        </para>
395                </description>
396        </bitlbee-command>
398        <bitlbee-command name="otr">
399                <short-description>Off-the-Record encryption control</short-description>
400                <syntax>otr &lt;subcommand&gt; [&lt;arguments&gt;]</syntax>
402                <description>
404                        <para>
405                                Available subcommands: connect, disconnect, reconnect, smp, smpq, trust, info, keygen, and forget. See <emphasis>help otr &lt;subcommand&gt;</emphasis> for more information.
406                        </para>
408                </description>
410                <bitlbee-command name="connect">
411                        <syntax>otr connect &lt;nick&gt;</syntax>
413                        <description>
415                                <para>
416                                        Attempts to establish an encrypted connection with the specified user by sending a magic string.
417                                </para>
419                        </description>
421                </bitlbee-command>
423                <bitlbee-command name="disconnect">
424                        <syntax>otr disconnect &lt;nick&gt;</syntax>
425                        <syntax>otr disconnect *</syntax>
427                        <description>
429                                <para>
430                                        Resets the connection with the specified user/all users to cleartext.
431                                </para>
433                        </description>
435                </bitlbee-command>
437                <bitlbee-command name="reconnect">
438                        <syntax>otr reconnect &lt;nick&gt;</syntax>
440                        <description>
442                                <para>
443                                        Breaks and re-establishes the encrypted connection with the specified user. Useful if something got desynced.
444                                </para>
446                                <para>
447                                        Equivalent to <emphasis>otr disconnect</emphasis> followed by <emphasis>otr connect</emphasis>.
448                                </para>
450                        </description>
452                </bitlbee-command>
454                <bitlbee-command name="smp">
455                        <syntax>otr smp &lt;nick&gt; &lt;secret&gt;</syntax>
457                        <description>
459                                <para>
460                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
461                                </para>
463                                <para>
464                                        If an SMP challenge has been received from the given user, responds with the specified secret/answer. Otherwise, sends a challenge for the given secret.
465                                </para>
467                                <para>
468                                        Note that there are two flavors of SMP challenges: "shared-secret" and "question &amp; answer". This command is used to respond to both of them, or to initiate a shared-secret style exchange. Use the <emphasis>otr smpq</emphasis> command to initiate a "Q&amp;A" session.
469                                </para>
471                                <para>
472                                        When responding to a "Q&amp;A" challenge, the local trust value is not altered. Only the <emphasis>asking party</emphasis> sets trust in the case of success. Use <emphasis>otr smpq</emphasis> to pose your challenge. In a shared-secret exchange, both parties set their trust according to the outcome.
473                                </para>
475                        </description>
477                </bitlbee-command>
479                <bitlbee-command name="smpq">
480                        <syntax>otr smpq &lt;nick&gt; &lt;question&gt; &lt;answer&gt;</syntax>
482                        <description>
484                                <para>
485                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol, Q&amp;A style.
486                                </para>
488                                <para>
489                                        Initiates an SMP session in "question &amp; answer" style. The question is transmitted with the initial SMP packet and used to prompt the other party. You must be confident that only they know the answer. If the protocol succeeds (i.e. they answer correctly), the fingerprint will be trusted. Note that the answer must be entered exactly, case and punctuation count!
490                                </para>
492                                <para>
493                                        Note that this style of SMP only affects the trust setting on your side. Expect your opponent to send you their own challenge. Alternatively, if you and the other party have a shared secret, use the <emphasis>otr smp</emphasis> command.
494                                </para>
496                        </description>
498                </bitlbee-command>
500                <bitlbee-command name="trust">
501                        <syntax>otr trust &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</syntax>
503                        <description>
505                                <para>
506                                        Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
507                                </para>
509                        </description>
511                </bitlbee-command>
513                <bitlbee-command name="info">
514                        <syntax>otr info</syntax>
515                        <syntax>otr info &lt;nick&gt;</syntax>
517                        <description>
519                                <para>
520                                        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.
521                                </para>
523                        </description>
525                </bitlbee-command>
527                <bitlbee-command name="keygen">
528                        <syntax>otr keygen &lt;account-no&gt;</syntax>
530                        <description>
532                                <para>
533                                        Generates a new OTR private key for the given account.
534                                </para>
536                        </description>
538                </bitlbee-command>
540                <bitlbee-command name="forget">
541                        <syntax>otr forget &lt;thing&gt; &lt;arguments&gt;</syntax>
543                        <description>
545                                <para>
546                                        Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget &lt;thing&gt;</emphasis> for more information.
547                                </para>
549                        </description>
551                        <bitlbee-command name="fingerprint">
552                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</syntax>
554                                <description>
556                                        <para>
557                                                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.
558                                        </para>
560                                </description>
562                        </bitlbee-command>
564                        <bitlbee-command name="context">
565                                <syntax>otr forget context &lt;nick&gt;</syntax>
567                                <description>
569                                        <para>
570                                                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.
571                                        </para>
573                                </description>
575                        </bitlbee-command>
577                        <bitlbee-command name="key">
578                                <syntax>otr forget key &lt;fingerprint&gt;</syntax>
580                                <description>
582                                        <para>
583                                                Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
584                                        </para>
586                                </description>
588                        </bitlbee-command>
590                </bitlbee-command>
592        </bitlbee-command>
594        <bitlbee-command name="set">
595                <short-description>Miscellaneous settings</short-description>
596                <syntax>set</syntax>
597                <syntax>set &lt;variable&gt;</syntax>
598                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
599                <syntax>set -del &lt;variable&gt;</syntax>
601                <description>
603                        <para>
604                                Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. With <emphasis>-del</emphasis> you can reset a setting to its default value.
605                        </para>
607                        <para>
608                                To get more help information about a setting, try:
609                        </para>
611                </description>
613                <ircexample>
614                        <ircline nick="ctrlsoft">help set private</ircline>
615                </ircexample>
617        </bitlbee-command>
619        <bitlbee-command name="help">
620                <short-description>BitlBee help system</short-description>
622                <syntax>help [subject]</syntax>
624                <description>
625                        <para>
626                                This command gives you the help information you're reading right now. If you don't give any arguments, it'll give a short help index.
627                        </para>
628                </description>
629        </bitlbee-command>
631        <bitlbee-command name="save">
632                <short-description>Save your account data</short-description>
633                <syntax>save</syntax>
635                <description>
636                        <para>
637                                This command saves all your nicks and accounts immediately. Handy if you have the autosave functionality disabled, or if you don't trust the program's stability... ;-)
638                        </para>
639                </description>
640        </bitlbee-command>
642        <bitlbee-setting name="account" type="string" scope="channel">
644                <description>
645                        <para>
646                                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.
647                        </para>
648                </description>
649        </bitlbee-setting>
651        <bitlbee-setting name="allow_takeover" type="boolean" scope="global">
652                <default>true</default>
654                <description>
655                        <para>
656                                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.
657                        </para>
658                </description>
659        </bitlbee-setting>
661        <bitlbee-setting name="always_use_nicks" type="boolean" scope="channel">
662                <default>false</default>
664                <description>
665                        <para>
666                                Jabber groupchat specific. This setting ensures that the nicks defined by the other members of a groupchat are used, instead of the username part of their JID. This only applies to groupchats where their real JID is known (either "non-anonymous" ones, or "semi-anonymous" from the point of view of the channel moderators)
667                        </para>
669                        <para>
670                                Enabling this may have the side effect of changing the nick of existing contacts, either in your buddy list or in other groupchats. If a contact is in multiple groupchats with different nicks, enabling this setting for all those would result in multiple nick changes when joining, and the order of those changes may vary.
671                        </para>
673                        <para>
674                                Note that manual nick changes done through the <emphasis>rename</emphasis> command always take priority
675                        </para>
676                </description>
677        </bitlbee-setting>
679        <bitlbee-setting name="auto_connect" type="boolean" scope="account,global">
680                <default>true</default>
682                <description>
683                        <para>
684                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
685                        </para>
687                        <para>
688                                This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_connect</emphasis> setting is disabled!)
689                        </para>
690                </description>
691        </bitlbee-setting>
693        <bitlbee-setting name="auto_join" type="boolean" scope="channel">
694                <default>false</default>
696                <description>
697                        <para>
698                                With this option enabled, BitlBee will automatically join this channel when you log in.
699                        </para>
700                </description>
701        </bitlbee-setting>
703        <bitlbee-setting name="auto_reconnect" type="boolean" scope="account,global">
704                <default>true</default>
706                <description>
707                        <para>
708                                If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting.
709                        </para>
711                        <para>
712                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
713                        </para>
715                        <para>
716                                This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_reconnect</emphasis> setting is disabled!)
717                        </para>
718                </description>
719        </bitlbee-setting>
721        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
722                <default>5*3&lt;900</default>
724                <description>
725                        <para>
726                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
727                        </para>
729                        <para>
730                                This can be one integer, for a constant delay. One can also set it to something like &quot;10*10&quot;, which means wait for ten seconds on the first reconnect, multiply it by ten on every failure. Once successfully connected, this delay is re-set to the initial value. With &lt; you can give a maximum delay.
731                        </para>
733                        <para>
734                                See also the <emphasis>auto_reconnect</emphasis> setting.
735                        </para>
736                </description>
737        </bitlbee-setting>
739        <bitlbee-setting name="auto_reply_timeout" type="integer" scope="account">
740                <default>10800</default>
742                <description>
743                        <para>
744                                For Twitter accounts: If you respond to Tweets IRC-style (like "nickname: reply"), this will automatically be converted to the usual Twitter format ("@screenname reply").
745                        </para>
747                        <para>
748                                By default, BitlBee will then also add a reference to that person's most recent Tweet, unless that message is older than the value of this setting in seconds.
749                        </para>
751                        <para>
752                                If you want to disable this feature, just set this to 0. Alternatively, if you want to write a message once that is <emphasis>not</emphasis> a reply, use the Twitter reply syntax (@screenname).
753                        </para>
754                </description>
755        </bitlbee-setting>
757        <bitlbee-setting name="away" type="string" scope="account,global">
758                <description>
759                        <para>
760                                To mark yourself as away, it is recommended to just use <emphasis>/away</emphasis>, like on normal IRC networks. If you want to mark yourself as away on only one IM network, you can use this per-account setting.
761                        </para>
763                        <para>
764                                You can set it to any value and BitlBee will try to map it to the most appropriate away state for every open IM connection, or set it as a free-form away message where possible.
765                        </para>
767                        <para>
768                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
769                        </para>
770                </description>
771        </bitlbee-setting>
773        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
774                <default>true</default>
776                <description>
777                        <para>
778                                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.
779                        </para>
781                        <para>
782                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
783                        </para>
784                </description>
785        </bitlbee-setting>
787        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
788                <default>3600</default>
790                <description>
791                        <para>
792                                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.
793                        </para>
795                        <para>
796                                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.
797                        </para>
798                </description>
799        </bitlbee-setting>
801        <bitlbee-setting name="base_url" type="string" scope="account">
802                <default></default>
804                <description>
805                        <para>
806                                There are more services that understand the Twitter API than just BitlBee can connect to all Twitter API implementations.
807                        </para>
809                        <para>
810                                For example, set this setting to <emphasis></emphasis> to use
811                        </para>
813                        <para>
814                                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.
815                        </para>
816                </description>
817        </bitlbee-setting>
819        <bitlbee-setting name="carbons" type="boolean" scope="account">
820                <default>true</default>
822                <description>
823                        <para>
824                                Jabber specific. "Message carbons" (XEP-0280) is a server feature to get copies of outgoing messages sent from other clients connected to the same account. It's not widely supported by most public XMPP servers (easier if you host your own), but this will probably change in the next few years.
825                        </para>
826                        <para>
827                                This defaults to true, which will enable it if the server supports it, or fail silently if it's not. This setting only exists to allow disabling the feature if anyone considers it undesirable.
828                        </para>
829                        <para>
830                                See also the <emphasis>self_messages</emphasis> setting.
831                        </para>
832                </description>
833        </bitlbee-setting>
835        <bitlbee-setting name="charset" type="string" scope="global">
836                <default>utf-8</default>
837                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
839                <description>
840                        <para>
841                                This setting tells BitlBee what your IRC client sends and expects. It should be equal to the charset setting of your IRC client if you want to be able to send and receive non-ASCII text properly.
842                        </para>
844                        <para>
845                                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
846                        </para>
847                </description>
849        </bitlbee-setting>
851        <bitlbee-setting name="color_encrypted" type="boolean" scope="global">
852                <default>true</default>
854                <description>
855                        <para>
856                                If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
857                        </para>
858                </description>
859        </bitlbee-setting>
861        <bitlbee-setting name="chat_type" type="string" scope="channel">
862                <default>groupchat</default>
863                <possible-values>groupchat, room</possible-values>
865                <description>
866                        <para>
867                                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.
868                        </para>
870                        <para>
871                                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.
872                        </para>
874                        <para>
875                                For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command.
876                        </para>
877                </description>
878        </bitlbee-setting>
880        <bitlbee-setting name="commands" type="boolean" scope="account">
881                <default>true</default>
882                <possible-values>true, false, strict</possible-values>
884                <description>
885                        <para>
886                                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:
887                        </para>
889                        <variablelist>
890                                <varlistentry><term>undo #[&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
891                                <varlistentry><term>rt &lt;screenname|#id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
892                                <varlistentry><term>reply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with a reply-to reference)</para></listitem></varlistentry>
893                                <varlistentry><term>rawreply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with no reply-to reference)</para></listitem></varlistentry>
894                                <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>
895                                <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
896                                <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
897                                <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>
898                                <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
899                                <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>
900                        </variablelist>
902                        <para>
903                                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.
904                        </para>
905                </description>
906        </bitlbee-setting>
908        <bitlbee-setting name="debug" type="boolean" scope="global">
909                <default>false</default>
911                <description>
912                        <para>
913                                Some debugging messages can be logged if you wish. They're probably not really useful for you, unless you're doing some development on BitlBee.
914                        </para>
916                        <para>
917                                This feature is not currently used for anything so don't expect this to generate any output.
918                        </para>
919                </description>
920        </bitlbee-setting>
922        <bitlbee-setting name="default_target" type="string" scope="global">
923                <default>root</default>
924                <possible-values>root, last</possible-values>
926                <description>
927                        <para>
928                                With this value set to <emphasis>root</emphasis>, lines written in a control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in that control channel, set this to <emphasis>last</emphasis>.
929                        </para>
930                </description>
931        </bitlbee-setting>
933        <bitlbee-setting name="display_name" type="string" scope="account">
934                <description>
935                        <para>
936                                Currently only available for MSN connections, and for jabber groupchats.
937                        </para>
938                        <para>
939                                For MSN: This setting allows you to read and change your "friendly name" for this connection. Since this is a server-side setting, it can't be changed when the account is off-line.
940                        </para>
941                        <para>
942                                For jabber groupchats: this sets the default value of 'nick' for newly created groupchats. There is no way to set an account-wide nick like MSN.
943                        </para>
944                </description>
945        </bitlbee-setting>
947        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
948                <default>false</default>
950                <description>
951                        <para>
952                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
953                        </para>
954                </description>
955        </bitlbee-setting>
957        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
958                <default>true</default>
960                <description>
961                        <para>
962                                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.
963                        </para>
964                </description>
965        </bitlbee-setting>
967        <bitlbee-setting name="fill_by" type="string" scope="channel">
968                <default>all</default>
969                <possible-values>all, group, account, protocol</possible-values>
971                <description>
972                        <para>
973                                For control channels only: This setting determines which contacts the channel gets populated with.
974                        </para>
976                        <para>
977                                By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol.
978                        </para>
980                        <para>
981                                Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection.
982                        </para>
984                        <para>
985                                With a ! prefix an inverted channel can be created, for example with this setting set to <emphasis>!group</emphasis> you can create a channel with all users <emphasis>not</emphasis> in that group.
986                        </para>
988                        <para>
989                                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>.
990                        </para>
991                </description>
992        </bitlbee-setting>
994        <bitlbee-setting name="group" type="string" scope="channel">
996                <description>
997                        <para>
998                                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.
999                        </para>
1000                </description>
1001        </bitlbee-setting>
1003        <bitlbee-setting name="handle_unknown" type="string" scope="global">
1004                <default>add_channel</default>
1005                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
1007                <description>
1008                        <para>
1009                                By default, messages from people who aren't in your contact list are shown in a control channel instead of as a private message.
1010                        </para>
1012                        <para>
1013                                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.
1014                        </para>
1016                        <note>
1017                                <para>
1018                                        Although these users will appear in your control channel, they aren't added to your real contact list. When you restart BitlBee, these auto-added users will be gone. If you want to keep someone in your list, you have to fixate the add using the <emphasis>add</emphasis> command.
1019                                </para>
1020                        </note>
1021                </description>
1023        </bitlbee-setting>
1025        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
1026                <default>false</default>
1028                <description>
1029                        <para>
1030                                Only supported by OSCAR so far, you can use this setting to ignore ICQ authorization requests, which are hardly used for legitimate (i.e. non-spam) reasons anymore.
1031                        </para>
1032                </description>
1034        </bitlbee-setting>
1036        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
1037                <default>true</default>
1039                <description>
1040                        <para>
1041                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
1042                        </para>
1043                </description>
1045        </bitlbee-setting>
1047        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
1048                <default>false</default>
1050                <description>
1051                        <para>
1052                                Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting.
1053                        </para>
1054                </description>
1056        </bitlbee-setting>
1058        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
1059                <default>false</default>
1061                <description>
1062                        <para>
1063                                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.
1064                        </para>
1065                </description>
1067        </bitlbee-setting>
1069        <bitlbee-setting name="mail_notifications_handle" type="string" scope="account">
1070                <default>empty</default>
1072                <description>
1073                        <para>
1074                                This setting is available for protocols with e-mail notification functionality. If set to empty all e-mail notifications will go to control channel, if set to some string - this will be the name of a contact who will PRIVMSG you on every new notification.
1075                        </para>
1076                </description>
1078        </bitlbee-setting>
1080        <bitlbee-setting name="message_length" type="integer" scope="account">
1081                <default>140</default>
1083                <description>
1084                        <para>
1085                                Since Twitter rejects messages longer than 140 characters, BitlBee can count message length and emit a warning instead of waiting for Twitter to reject it.
1086                        </para>
1088                        <para>
1089                                You can change this limit here but this won't disable length checks on Twitter's side. You can also set it to 0 to disable the check in case you believe BitlBee doesn't count the characters correctly.
1090                        </para>
1091                </description>
1093        </bitlbee-setting>
1095        <bitlbee-setting name="stream" type="boolean" scope="account">
1096                <default>true</default>
1098                <description>
1099                        <para>
1100                                For Twitter accounts, this setting enables use of the Streaming API. This automatically gives you incoming DMs as well.
1101                        </para>
1103                        <para>
1104                                For other Twitter-like services, this setting is not supported.
1105                        </para>
1106                </description>
1108        </bitlbee-setting>
1110        <bitlbee-setting name="target_url_length" type="integer" scope="account">
1111                <default>20</default>
1113                <description>
1114                        <para>
1115                                Twitter replaces every URL with fixed-length URLs. BitlBee is able to take urls into account when calculating <emphasis>message_length</emphasis> replacing the actual URL length with target_url_length. Setting target_url_length to 0 disables this feature.
1116                        </para>
1118                        <para>
1119                                This setting is disabled for identica accounts by default and will not affect anything other than message safety checks (i.e. Twitter will still replace your URLs with links, even if that makes them longer).
1120                        </para>
1121                </description>
1123        </bitlbee-setting>
1125        <bitlbee-setting name="mode" type="string" scope="account">
1126                <possible-values>one, many, chat</possible-values>
1127                <default>chat</default>
1129                <description>
1130                        <para>
1131                                By default, BitlBee will create a separate channel (called #twitter_yourusername) for all your Twitter contacts/messages.
1132                        </para>
1134                        <para>
1135                                If you don't want an extra channel, you can set this setting to "one" (everything will come from one nick, twitter_yourusername), or to "many" (individual nicks for everyone).
1136                        </para>
1138                        <para>
1139                                With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Incoming DMs are only fetched if the "stream" setting is on (default).
1140                        </para>
1142                        <para>
1143                                With modes "many" and "one", you can post tweets by /msg'ing the twitter_yourusername contact. In mode "chat", messages posted in the Twitter channel will also be posted as tweets.
1144                        </para>
1145                </description>
1147        </bitlbee-setting>
1149        <bitlbee-setting name="mobile_is_away" type="boolean" scope="global">
1150                <default>false</default>
1152                <description>
1153                        <para>
1154                                Most IM networks have a mobile version of their client. People who use these may not be paying that much attention to messages coming in. By enabling this setting, people using mobile clients will always be shown as away.
1155                        </para>
1156                </description>
1158        </bitlbee-setting>
1160        <bitlbee-setting name="nick" type="string" scope="chat">
1161                <description>
1162                        <para>
1163                                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.
1164                        </para>
1165                </description>
1166        </bitlbee-setting>
1168        <bitlbee-setting name="nick_format" type="string" scope="account,global">
1169                <default>%-@nick</default>
1171                <description>
1172                        <para>
1173                                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.
1174                        </para>
1176                        <para>
1177                                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.
1178                        </para>
1180                        <para>
1181                                It's easier to describe this setting using a few examples:
1182                        </para>
1184                        <para>
1185                                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.
1186                        </para>
1188                        <para>
1189                                [%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.
1190                        </para>
1192                        <para>
1193                                See <emphasis>help nick_format</emphasis> for more information.
1194                        </para>
1195                </description>
1196        </bitlbee-setting>
1198        <bitlbee-setting name="nick_source" type="string" scope="account">
1199                <default>handle</default>
1200                <possible-values>handle, full_name, first_name</possible-values>
1202                <description>
1203                        <para>
1204                                By default, BitlBee generates a nickname for every contact by taking its handle and chopping off everything after the @. In some cases, this gives very inconvenient nicknames. Some servers use internal identifiers, which are often just numbers.
1205                        </para>
1207                        <para>
1208                                With this setting set to <emphasis>full_name</emphasis>, the person's full name is used to generate a nickname. Or if you don't like long nicknames, set this setting to <emphasis>first_name</emphasis> instead and only the first word will be used. Note that the full name can be full of non-ASCII characters which will be stripped off.
1209                        </para>
1210                </description>
1211        </bitlbee-setting>
1213        <bitlbee-setting name="oauth" type="boolean" scope="account">
1214                <default>true</default>
1216                <description>
1217                        <para>
1218                                This enables OAuth authentication for an IM account; right now the Twitter (working for Twitter only) and Jabber (for Google Talk only) module support it.
1219                        </para>
1221                        <para>
1222                                With OAuth enabled, you shouldn't tell BitlBee your account password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with the service. If this succeeds, you will get a PIN code which you can give back to BitlBee to finish the process.
1223                        </para>
1225                        <para>
1226                                The resulting access token will be saved permanently, so you have to do this only once. If for any reason you want to/have to reauthenticate, you can use <emphasis>account set</emphasis> to reset the account password to something random.
1227                        </para>
1228                </description>
1230        </bitlbee-setting>
1232        <bitlbee-setting name="anonymous" type="boolean" scope="account">
1233                <default>false</default>
1235                <description>
1236                        <para>
1237                                This enables SASL ANONYMOUS login for jabber accounts, as specified by XEP-0175.
1238                        </para>
1240                        <para>
1241                                With this setting enabled, if the server allows this method, a password isn't required and the username part of the JID is ignored (you can use Servers will usually assign you a random numeric username instead.
1242                        </para>
1243                </description>
1245        </bitlbee-setting>
1247        <bitlbee-setting name="ops" type="string" scope="global">
1248                <default>both</default>
1249                <possible-values>both, root, user, none</possible-values>
1251                <description>
1252                        <para>
1253                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can change these states using this setting.
1254                        </para>
1256                        <para>
1257                                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.
1258                        </para>
1259                </description>
1260        </bitlbee-setting>
1262        <bitlbee-setting name="otr_policy" type="string" scope="global">
1263                <default>opportunistic</default>
1264                <possible-values>never, opportunistic, manual, always</possible-values>
1266                <description>
1267                        <para>
1268                                This setting controls the policy for establishing Off-the-Record connections.
1269                        </para>
1270                        <para>
1271                                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.
1272                        </para>
1273                </description>
1274        </bitlbee-setting>
1276        <bitlbee-setting name="password" type="string" scope="account,global">
1277                <description>
1278                        <para>
1279                                Use this global setting to change your "NickServ" password.
1280                        </para>
1282                        <para>
1283                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
1284                        </para>
1286                        <para>
1287                                Note that BitlBee will always say this setting is empty. This doesn't mean there is no password, it just means that, for security reasons, BitlBee stores passwords somewhere else so they can't just be retrieved in plain text.
1288                        </para>
1289                </description>
1290        </bitlbee-setting>
1292        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
1293                <default>false</default>
1295                <description>
1296                        <para>
1297                                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.
1298                        </para>
1300                        <para>
1301                                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.
1302                        </para>
1304                        <para>
1305                                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.
1306                        </para>
1307                </description>
1308        </bitlbee-setting>
1310        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
1311                <default>200</default>
1313                <description>
1315                        <para>
1316                                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.
1317                        </para>
1319                        <para>
1320                                See also the <emphasis>paste_buffer</emphasis> setting.
1321                        </para>
1322                </description>
1323        </bitlbee-setting>
1325        <bitlbee-setting name="port" type="integer" scope="account">
1326                <description>
1327                        <para>
1328                                Currently only available for Jabber connections. Specifies the port number to connect to. Usually this should be set to 5222, or 5223 for SSL-connections.
1329                        </para>
1330                </description>
1331        </bitlbee-setting>
1333        <bitlbee-setting name="priority" type="integer" scope="account">
1334                <default>0</default>
1336                <description>
1337                        <para>
1338                                Can be set for Jabber connections. When connecting to one account from multiple places, this priority value will help the server to determine where to deliver incoming messages (that aren't addressed to a specific resource already).
1339                        </para>
1341                        <para>
1342                                According to RFC 3921 servers will always deliver messages to the server with the highest priority value. Mmessages will not be delivered to resources with a negative priority setting (and should be saved as an off-line message if all available resources have a negative priority value).
1343                        </para>
1344                </description>
1345        </bitlbee-setting>
1347        <bitlbee-setting name="private" type="boolean" scope="global">
1348                <default>true</default>
1350                <description>
1351                        <para>
1352                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in a control channel.
1353                        </para>
1355                        <para>
1356                                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.
1357                        </para>
1358                </description>
1359        </bitlbee-setting>
1361        <bitlbee-setting name="protocol" type="string" scope="channel">
1363                <description>
1364                        <para>
1365                                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.
1366                        </para>
1367                </description>
1368        </bitlbee-setting>
1370        <bitlbee-setting name="proxy" type="string" scope="account">
1371                <default>&lt;local&gt;&lt;auto&gt;</default>
1373                <description>
1374                        <para>
1375                                A list of <emphasis>file transfer proxies</emphasis> for jabber. This isn't the connection proxy. Sorry, look in bitlbee.conf for those.
1376                        </para>
1378                        <para>
1379                                It's a semicolon-separated list of items that can be either <emphasis>JID,HOST,PORT</emphasis> or two special values, <emphasis>&lt;local&gt;</emphasis> (to try a direct connection first) and <emphasis>&lt;auto&gt;</emphasis> (to try to discover a proxy). For example, "&lt;local&gt;;,,7777".
1380                        </para>
1381                        <para>
1382                                The address should point to a SOCKS5 bytestreams server, usually provided by jabber servers. This is only used for sending files. Note that the host address might not match what DNS tells you, and the port isn't always the same.
1383                        </para>
1384                        <para>
1385                                The correct way to get a socks proxy host/port is a mystery, and the file transfer might fail anyway. Maybe just try using dropbox instead.
1386                        </para>
1387                </description>
1388        </bitlbee-setting>
1390        <bitlbee-setting name="query_order" type="string" scope="global">
1391                <default>lifo</default>
1392                <possible-values>lifo, fifo</possible-values>
1394                <description>
1395                        <para>
1396                                This changes the order in which the questions from root (usually authorization requests from buddies) should be answered. When set to <emphasis>lifo</emphasis>, BitlBee immediately displays all new questions and they should be answered in reverse order. When this is set to <emphasis>fifo</emphasis>, BitlBee displays the first question which comes in and caches all the others until you answer the first one.
1397                        </para>
1399                        <para>
1400                                Although the <emphasis>fifo</emphasis> setting might sound more logical (and used to be the default behaviour in older BitlBee versions), it turned out not to be very convenient for many users when they missed the first question (and never received the next ones).
1401                        </para>
1402                </description>
1403        </bitlbee-setting>
1405        <bitlbee-setting name="resource" type="string" scope="account">
1406                <default>BitlBee</default>
1408                <description>
1409                        <para>
1410                                Can be set for Jabber connections. You can use this to connect to your Jabber account from multiple clients at once, with every client using a different resource string.
1411                        </para>
1412                </description>
1413        </bitlbee-setting>
1415        <bitlbee-setting name="resource_select" type="string" scope="account">
1416                <default>activity</default>
1417                <possible-values>priority, activity</possible-values>
1419                <description>
1420                        <para>
1421                                Because the IRC interface makes it pretty hard to specify the resource to talk to (when a buddy is online through different resources), this setting was added.
1422                        </para>
1424                        <para>
1425                                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).
1426                        </para>
1427                </description>
1428        </bitlbee-setting>
1430        <bitlbee-setting name="root_nick" type="string" scope="global">
1431                <default>root</default>
1433                <description>
1434                        <para>
1435                                Normally the "bot" that takes all your BitlBee commands is called "root". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
1436                        </para>
1437                </description>
1438        </bitlbee-setting>
1440        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1441                <default>true</default>
1443                <description>
1444                        <para>
1445                                If enabled causes BitlBee to save all current settings and account details when user disconnects. This is enabled by default, and these days there's not really a reason to have it disabled anymore.
1446                        </para>
1447                </description>
1448        </bitlbee-setting>
1450        <bitlbee-setting name="self_messages" type="string" scope="global">
1451                <default>true</default>
1452                <possible-values>true, false, prefix, prefix_notice</possible-values>
1454                <description>
1455                        <para>
1456                                Change this setting to customize how (or whether) to show self-messages, which are messages sent by yourself from other locations (for example, mobile clients), for IM protocols that support it.
1457                        </para>
1459                        <para>
1460                                When this is set to "true", it will send those messages in the "standard" way, which is a PRIVMSG with source and target fields swapped.
1461                        </para>
1463                        <para>
1464                                Since this isn't very well supported by some clients (the messages might appear in the wrong window), you can set it to "prefix" to show them as a normal message prefixed with "-> ", or use "prefix_notice" which is the same thing but with a NOTICE instead.
1465                        </para>
1467                        <para>
1468                                You can also set it to "false" to disable these messages completely.
1469                        </para>
1471                        <para>
1472                                This setting only applies to private messages. Self messages in groupchats are always shown, since they haven't caused issues in any clients so far.
1473                        </para>
1475                        <para>
1476                                More information: <emphasis></emphasis>
1477                        </para>
1478                </description>
1479        </bitlbee-setting>
1481        <bitlbee-setting name="server" type="string" scope="account">
1482                <description>
1483                        <para>
1484                                Can be set for Jabber- and OSCAR-connections. For Jabber, you might have to set this if the servername isn't equal to the part after the @ in the Jabber handle. For OSCAR this shouldn't be necessary anymore in recent BitlBee versions.
1485                        </para>
1486                </description>
1487        </bitlbee-setting>
1489        <bitlbee-setting name="show_ids" type="boolean" scope="account">
1490                <default>true</default>
1492                <description>
1493                        <para>
1494                                Enable this setting on a Twitter account to have BitlBee include a two-digit "id" in front of every message. This id can then be used for replies and retweets.
1495                        </para>
1496                </description>
1497        </bitlbee-setting>
1499        <bitlbee-setting name="show_offline" type="boolean" scope="global">
1500                <default>false</default>
1502                <description>
1503                        <para>
1504                                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.
1505                        </para>
1507                        <para>
1508                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
1509                        </para>
1510                </description>
1511        </bitlbee-setting>
1513        <bitlbee-setting name="show_users" type="string" scope="channel">
1514                <default>online+,special%,away</default>
1516                <description>
1517                        <para>
1518                                Comma-separated list of statuses of users you want in the channel,
1519                                and any modes they should have. The following statuses are currently
1520                                recognised: <emphasis>online</emphasis> (i.e. available, not
1521                                away), <emphasis>special</emphasis> (specific to the protocol),
1522                                <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
1523                        </para>
1525                        <para>
1526                                If a status is followed by a valid channel mode character
1527                                (@, % or +), it will be given to users with that status.
1528                                For example, <emphasis>online@,special%,away+,offline</emphasis> 
1529                                will show all users in the channel. Online people will
1530                                have +o, people who are online but away will have +v,
1531                                and others will have no special modes.
1532                        </para>
1533                </description>
1534        </bitlbee-setting>
1536        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1537                <default>true</default>
1539                <description>
1540                        <para>
1541                                Some IRC clients parse quit messages sent by the IRC server to see if someone really left or just disappeared because of a netsplit. By default, BitlBee tries to simulate netsplit-like quit messages to keep the control channels window clean. If you don't like this (or if your IRC client doesn't support this) you can disable this setting.
1542                        </para>
1543                </description>
1544        </bitlbee-setting>
1546        <bitlbee-setting name="ssl" type="boolean" scope="account">
1547                <default>false</default>
1549                <description>
1550                        <para>
1551                                Currently only available for Jabber connections. Set this to true if you want to connect to the server on an SSL-enabled port (usually 5223).
1552                        </para>
1554                        <para>
1555                                Please note that this method of establishing a secure connection to the server has long been deprecated. You are encouraged to look at the <emphasis>tls</emphasis> setting instead.
1556                        </para>
1557                </description>
1558        </bitlbee-setting>
1560        <bitlbee-setting name="status" type="string" scope="account,global">
1561                <description>
1562                        <para>
1563                                Most IM protocols support status messages, similar to away messages. They can be used to indicate things like your location or activity, without showing up as away/busy.
1564                        </para>
1566                        <para>
1567                                This setting can be used to set such a message. It will be available as a per-account setting for protocols that support it, and also as a global setting (which will then automatically be used for all protocols that support it).
1568                        </para>
1570                        <para>
1571                                Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To clear the setting, use <emphasis>set -del status</emphasis>.
1572                        </para>
1573                </description>
1574        </bitlbee-setting>
1576        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1577                <default>true</default>
1579                <description>
1580                        <para>
1581                                Determines what BitlBee should do with HTML in messages. Normally this is turned on and HTML will be stripped from messages, if BitlBee thinks there is HTML.
1582                        </para>
1583                        <para>
1584                                If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too.
1585                        </para>
1586                </description>
1587        </bitlbee-setting>
1589        <bitlbee-setting name="strip_newlines" type="boolean" scope="account">
1590                <default>false</default>
1592                <description>
1593                        <para>
1594                                Turn on this flag to prevent tweets from spanning over multiple lines.
1595                        </para>
1596                </description>
1597        </bitlbee-setting>
1599        <bitlbee-setting name="show_old_mentions" type="integer" scope="account">
1600                <default>20</default>
1602                <description>
1603                        <para>
1604                                This setting specifies the number of old mentions to fetch on connection. Must be less or equal to 200. Setting it to 0 disables this feature.
1605                        </para>
1606                </description>
1607        </bitlbee-setting>
1609        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1610                <default>false</default>
1612                <description>
1613                        <para>
1614                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1615                        </para>
1617                        <para>
1618                                With this setting enabled, BitlBee will send keepalives to MSN switchboards with offline/invisible contacts every twenty seconds. This should keep the server and client on the other side from shutting it down.
1619                        </para>
1621                        <para>
1622                                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.
1623                        </para>
1624                </description>
1625        </bitlbee-setting>
1627        <bitlbee-setting name="tag" type="string" scope="account">
1628                <description>
1629                        <para>
1630                                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.
1631                        </para>
1633                        <para>
1634                                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.
1635                        </para>
1636                </description>
1637        </bitlbee-setting>
1639        <bitlbee-setting name="timezone" type="string" scope="global">
1640                <default>local</default>
1641                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1643                <description>
1644                        <para>
1645                                If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting.
1646                        </para>
1648                        <para>
1649                                Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time.
1650                        </para>
1651                </description>
1652        </bitlbee-setting>
1654        <bitlbee-setting name="tls" type="boolean" scope="account">
1655                <default>true</default>
1657                <description>
1658                        <para>
1659                                By default (with this setting enabled), BitlBee will require Jabber servers to offer encryption via StartTLS and refuse to connect if they don't.
1660                        </para>
1662                        <para>
1663                                If you set this to "try", BitlBee will use StartTLS only if it's offered. With the setting disabled, StartTLS support will be ignored and avoided entirely.
1664                        </para>
1665                </description>
1666        </bitlbee-setting>
1668        <bitlbee-setting name="tls_verify" type="boolean" scope="account">
1669                <default>true</default>
1671                <description>
1672                        <para>
1673                                Currently only available for Jabber connections in combination with the <emphasis>tls</emphasis> setting. Set this to <emphasis>true</emphasis> if you want BitlBee to strictly verify the server's certificate against a list of trusted certificate authorities.
1674                        </para>
1676                        <para>
1677                                The hostname used in the certificate verification is the value of the <emphasis>server</emphasis> setting if the latter is nonempty and the domain of the username else. If you get a hostname related error when connecting to Google Talk with a username from the or domain, please try to empty the <emphasis>server</emphasis> setting.
1678                        </para>
1680                        <para>
1681                                Please note that no certificate verification is performed when the <emphasis>ssl</emphasis> setting is used, or when the <emphasis>CAfile</emphasis> setting in <emphasis>bitlbee.conf</emphasis> is not set.
1682                        </para>
1683                </description>
1684        </bitlbee-setting>
1686        <bitlbee-setting name="to_char" type="string" scope="global">
1687                <default>": "</default>
1689                <description>
1690                        <para>
1691                                It's customary that messages meant for one specific person on an IRC channel are prepended by his/her alias followed by a colon ':'. BitlBee does this by default. If you prefer a different character, you can set it using <emphasis>set to_char</emphasis>.
1692                        </para>
1694                        <para>
1695                                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.
1696                        </para>
1697                </description>
1698        </bitlbee-setting>
1700        <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel">
1701                <default>true</default>
1703                <description>
1704                        <para>
1705                                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.
1706                        </para>
1708                        <para>
1709                                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.
1710                        </para>
1711                </description>
1712        </bitlbee-setting>
1714        <bitlbee-setting name="type" type="string" scope="channel">
1715                <default>control</default>
1716                <possible-values>control, chat</possible-values>
1718                <description>
1719                        <para>
1720                                BitlBee supports two kinds of channels: control channels (usually with a name starting with a &amp;) and chatroom channels (name usually starts with a #).
1721                        </para>
1723                        <para>
1724                                See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee.
1725                        </para>
1726                </description>
1727        </bitlbee-setting>
1729        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1730                <default>false</default>
1732                <description>
1733                        <para>
1734                                Sends you a /notice when a user starts typing a message (if supported by the IM protocol and the user's client). To use this, you most likely want to use a script in your IRC client to show this information in a more sensible way.
1735                        </para>
1736                </description>
1737        </bitlbee-setting>
1739        <bitlbee-setting name="user_agent" type="string" scope="account">
1740                <default>BitlBee</default>
1742                <description>
1743                        <para>
1744                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
1745                        </para>
1747                        <para>
1748                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
1749                        </para>
1750                </description>
1751        </bitlbee-setting>
1753        <bitlbee-setting name="utf8_nicks" type="boolean" scope="global">
1754                <default>false</default>
1756                <description>
1757                        <para>
1758                                Officially, IRC nicknames are restricted to ASCII. Recently some clients and servers started supporting Unicode nicknames though. To enable UTF-8 nickname support (contacts only) in BitlBee, enable this setting.
1759                        </para>
1761                        <para>
1762                                To avoid confusing old clients, this setting is disabled by default. Be careful when you try it, and be prepared to be locked out of your BitlBee in case your client interacts poorly with UTF-8 nicknames.
1763                        </para>
1764                </description>
1765        </bitlbee-setting>
1767        <bitlbee-setting name="web_aware" type="string" scope="account">
1768                <default>false</default>
1770                <description>
1771                        <para>
1772                                ICQ allows people to see if you're on-line via a CGI-script. ( This can be nice to put on your website, but it seems that spammers also use it to see if you're online without having to add you to their contact list. So to prevent ICQ spamming, recent versions of BitlBee disable this feature by default.
1773                        </para>
1775                        <para>
1776                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1777                        </para>
1778                </description>
1779        </bitlbee-setting>
1781        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1782                <default>false</default>
1784                <description>
1785                        <para>
1786                                The Jabber module allows you to add a buddy <emphasis>xmlconsole</emphasis> to your contact list, which will then show you the raw XMPP stream between you and the server. You can also send XMPP packets to this buddy, which will then be sent to the server.
1787                        </para>
1788                        <para>
1789                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1790                        </para>
1791                </description>
1792        </bitlbee-setting>
1794        <bitlbee-command name="rename">
1795                <short-description>Rename (renick) a buddy</short-description>
1796                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1797                <syntax>rename -del &lt;oldnick&gt;</syntax>
1799                <description>
1800                        <para>
1801                                Renick a user in your buddy list. Very useful, in fact just very important, if you got a lot of people with stupid account names (or hard ICQ numbers).
1802                        </para>
1804                        <para>
1805                                <emphasis>rename -del</emphasis> can be used to erase your manually set nickname for a contact and reset it to what was automatically generated.
1806                        </para>
1807                </description>
1809                <ircexample>
1810                        <ircline nick="itsme">rename itsme_ you</ircline>
1811                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1812                </ircexample>
1814        </bitlbee-command>
1816        <bitlbee-command name="yes">
1817                <short-description>Accept a request</short-description>
1818                <syntax>yes [&lt;number&gt;]</syntax>
1820                <description>
1821                        <para>
1822                                Sometimes an IM-module might want to ask you a question. (Accept this user as your buddy or not?) To accept a question, use the <emphasis>yes</emphasis> command.
1823                        </para>
1825                        <para>
1826                                By default, this answers the first unanswered question. You can also specify a different question as an argument. You can use the <emphasis>qlist</emphasis> command for a list of questions.
1827                        </para>
1828                </description>
1830        </bitlbee-command>
1832        <bitlbee-command name="no">
1833                <short-description>Deny a request</short-description>
1834                <syntax>no [&lt;number&gt;]</syntax>
1836                <description>
1837                        <para>
1838                                Sometimes an IM-module might want to ask you a question. (Accept this user as your buddy or not?) To reject a question, use the <emphasis>no</emphasis> command.
1839                        </para>
1841                        <para>
1842                                By default, this answers the first unanswered question. You can also specify a different question as an argument. You can use the <emphasis>qlist</emphasis> command for a list of questions.
1843                        </para>
1844                </description>
1845        </bitlbee-command>
1847        <bitlbee-command name="plugins">
1848                <short-description>List all the external plugins and protocols</short-description>
1849                <syntax>plugins</syntax>
1851                <description>
1852                        <para>
1853                                This gives you a list of all the external plugins and protocols.
1854                        </para>
1855                </description>
1857        </bitlbee-command>
1859        <bitlbee-command name="qlist">
1860                <short-description>List all the unanswered questions root asked</short-description>
1861                <syntax>qlist</syntax>
1863                <description>
1864                        <para>
1865                                This gives you a list of all the unanswered questions from root.
1866                        </para>
1867                </description>
1869        </bitlbee-command>
1871        <bitlbee-command name="register">
1872                <short-description>Register yourself</short-description>
1873                <syntax>register [&lt;password&gt;]</syntax>
1875                <description>
1876                        <para>
1877                                BitlBee can save your settings so you won't have to enter all your IM passwords every time you log in. If you want the Bee to save your settings, use the <emphasis>register</emphasis> command.
1878                        </para>
1880                        <para>
1881                                Please do pick a secure password, don't just use your nick as your password. Please note that IRC is not an encrypted protocol, so the passwords still go over the network in plaintext. Evil people with evil sniffers will read it all. (So don't use your root password.. ;-)
1882                        </para>
1884                        <para>
1885                                To identify yourself in later sessions, you can use the <emphasis>identify</emphasis> command. To change your password later, you can use the <emphasis>set password</emphasis> command.
1886                        </para>
1888                        <para>
1889                                You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs.
1890                        </para>
1891                </description>
1893        </bitlbee-command>
1895        <bitlbee-command name="identify">
1896                <syntax>identify [-noload|-force] [&lt;password&gt;]</syntax>
1897                <short-description>Identify yourself with your password</short-description>
1899                <description>
1900                        <para>
1901                                BitlBee saves all your settings (contacts, accounts, passwords) on-server. To prevent other users from just logging in as you and getting this information, you'll have to identify yourself with your password. You can register this password using the <emphasis>register</emphasis> command.
1902                        </para>
1904                        <para>
1905                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1906                        </para>
1908                        <para>
1909                                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).
1910                        </para>
1912                        <para>
1913                                <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).
1914                        </para>
1916                        <para>
1917                                You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs.
1918                        </para>
1919                </description>
1920        </bitlbee-command>
1922        <bitlbee-command name="drop">
1923                <syntax>drop &lt;password&gt;</syntax>
1924                <short-description>Drop your account</short-description>
1926                <description>
1927                        <para>
1928                                Drop your BitlBee registration. Your account files will be removed and your password will be forgotten. For obvious security reasons, you have to specify your NickServ password to make this command work.
1929                        </para>
1930                </description>
1931        </bitlbee-command>
1933        <bitlbee-command name="blist">
1934                <syntax>blist [all|online|offline|away] [&lt;pattern&gt;]</syntax>
1935                <short-description>List all the buddies in the current channel</short-description>
1937                <description>
1938                        <para>
1939                                You can get a more readable buddy list using the <emphasis>blist</emphasis> command. If you want a complete list (including the offline users) you can use the <emphasis>all</emphasis> argument.
1940                        </para>
1942                        <para>
1943                                A perl-compatible regular expression can be supplied as <emphasis>pattern</emphasis> to filter the results (case-insensitive).
1944                        </para>
1945                </description>
1947        </bitlbee-command>
1949        <bitlbee-command name="group">
1950                <short-description>Contact group management</short-description>
1951                <syntax>group [ list | info &lt;group&gt; ]</syntax>
1953                <description>
1954                        <para>
1955                                The <emphasis>group list</emphasis> command shows a list of all groups defined so far.
1956                        </para>
1958                        <para>
1959                                The <emphasis>group info</emphasis> command shows a list of all members of a the group &lt;group&gt;.
1960                        </para>
1962                        <para>
1963                                If you want to move contacts between groups, you can use the IRC <emphasis>/invite</emphasis> command. Also, if you use the <emphasis>add</emphasis> command in a control channel configured to show just one group, the new contact will automatically be added to that group.
1964                        </para>
1965                </description>
1966        </bitlbee-command>
1968        <bitlbee-command name="transfer">
1969                <short-description>Monitor, cancel, or reject file transfers</short-description>
1970                <syntax>transfer [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
1972                <description>
1973                        <para>
1974                                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 transfer &lt;action&gt;</emphasis> for more information.
1975                        </para>
1977                        <ircexample>
1978                                <ircline nick="ulim">transfer</ircline>
1979                        </ircexample>
1980                </description>
1982                <bitlbee-command name="cancel">
1983                        <short-description>Cancels the file transfer with the given id</short-description>
1984                        <syntax>transfer &lt;cancel&gt; id</syntax>
1986                        <description>
1987                                <para>Cancels the file transfer with the given id</para>
1988                        </description>
1990                        <ircexample>
1991                                <ircline nick="ulim">transfer cancel 1</ircline>
1992                                <ircline nick="root">Canceling file transfer for test</ircline>
1993                        </ircexample>
1994                </bitlbee-command>
1996                <bitlbee-command name="reject">
1997                        <short-description>Rejects all incoming transfers</short-description>
1998                        <syntax>transfer &lt;reject&gt;</syntax>
2000                        <description>
2001                                <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is necessary. Or is it?</para>
2002                        </description>
2004                        <ircexample>
2005                                <ircline nick="ulim">transfer reject</ircline>
2006                        </ircexample>
2007                </bitlbee-command>
2008        </bitlbee-command>
Note: See TracBrowser for help on using the repository browser.