source: doc/user-guide/commands.xml @ 34afea7

Last change on this file since 34afea7 was ce402b2, checked in by dequis <dx@…>, at 2015-01-26T07:50:54Z

Twitter format strings

Allow users to specify how tweets should be displayed

3 new settings are available to set how tweets are displayed:

  • twitter_format_string for normal tweets
  • retweet_format_string for retweets
  • reply_format_string for replies

For full documentation see the help files
  • Property mode set to 100644
File size: 76.0 KB
RevLine 
[b7d3cc34]1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
[e907683]8                <syntax>account [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
[b7d3cc34]9
10                <description>
11
12                        <para>
[75a4b85]13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
[b7d3cc34]14                        </para>
15
16                </description>
17
18                <bitlbee-command name="add">
[bedad20]19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; [&lt;password&gt;]</syntax>
[b7d3cc34]20
21                        <description>
22                                <para>
[e88fbe27]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>.
[b7d3cc34]24                                </para>
[bedad20]25
26                                <para>
[060d066]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.
[bedad20]28                                </para>
[b7d3cc34]29                        </description>
30                       
31                        <bitlbee-command name="jabber">
[bedad20]32                                <syntax>account add jabber &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
[b7d3cc34]33
34                                <description>
35                                        <para>
[ee5c355]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.
[b7d3cc34]37                                        </para>
38
39                                        <para>
[ee5c355]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>wilmer@bitlbee.org/work</emphasis>).
[b7d3cc34]41                                        </para>
42                                </description>
43                        </bitlbee-command>
44
45                        <bitlbee-command name="msn">
[bedad20]46                                <syntax>account add msn &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
[b7d3cc34]47
48                                <description>
49                                        <para>
50                                                For MSN connections there are no special arguments.
51                                        </para>
52                                </description>
53                        </bitlbee-command>
54                       
55                        <bitlbee-command name="oscar">
[bedad20]56                                <syntax>account add oscar &lt;handle&gt; [&lt;password&gt;]</syntax>
[b7d3cc34]57
58                                <description>
59                                        <para>
[30ce1ce]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.
[b7d3cc34]61                                        </para>
62                                </description>
63
64                                <ircexample>
[30ce1ce]65                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
[b7d3cc34]66                                        <ircline nick="root">Account successfully added</ircline>
67                                </ircexample>
68                        </bitlbee-command>
[7a90d02]69                       
70                        <bitlbee-command name="twitter">
[b3d99e3]71                                <syntax>account add twitter &lt;handle&gt;</syntax>
[7a90d02]72
73                                <description>
74                                        <para>
[79ec314]75                                                This module gives you simple access to Twitter and Twitter API compatible services.
[7a90d02]76                                        </para>
77                                       
78                                        <para>
[c55701e]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>).
[7a90d02]80                                        </para>
81                                       
82                                        <para>
[e88fbe27]83                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
[7a90d02]84                                        </para>
[3f668e47]85
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>.)
[7a90d02]88                                        </para>
[79ec314]89                                       
90                                        <para>
91                                                To use a non-Twitter service, change the <emphasis>base_url</emphasis> setting. For identi.ca, you can simply use <emphasis>account add identica</emphasis>.
92                                        </para>
93                                </description>
94                        </bitlbee-command>
95                       
96                        <bitlbee-command name="identica">
[b3d99e3]97                                <syntax>account add identica &lt;handle&gt;</syntax>
[79ec314]98
99                                <description>
100                                        <para>
[b3d99e3]101                                                Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca. It also works with OAuth (so don't specify your password).
[79ec314]102                                        </para>
[7a90d02]103                                </description>
104                        </bitlbee-command>
[b7d3cc34]105
106                        <bitlbee-command name="yahoo">
[bedad20]107                                <syntax>account add yahoo &lt;handle&gt; [&lt;password&gt;]</syntax>
[b7d3cc34]108
109                                <description>
110                                        <para>
111                                                For Yahoo! connections there are no special arguments.
112                                        </para>
113                                </description>
114                        </bitlbee-command>
115
116                </bitlbee-command>
117
118                <bitlbee-command name="del">
[e907683]119                        <syntax>account &lt;account id&gt; del</syntax>
[b7d3cc34]120
121                        <description>
122                                <para>
123                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
124                                </para>
125
126
127                                <para>
[0f28785]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.
[b7d3cc34]129                                </para>
130                        </description>
131                </bitlbee-command>
132
133                <bitlbee-command name="on">
[e907683]134                        <syntax>account [&lt;account id&gt;] on</syntax>
[b7d3cc34]135
136                        <description>
137                                <para>
[75a4b85]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.
[b7d3cc34]139                                </para>
140
141                                <para>
[0f28785]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.
[b7d3cc34]143                                </para>
144                        </description>
145
146                </bitlbee-command>
147
148                <bitlbee-command name="off">
[e907683]149                        <syntax>account [&lt;account id&gt;] off</syntax>
[b7d3cc34]150
151                        <description>
152                                <para>
[75a4b85]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.
[b7d3cc34]154                                </para>
155
156                                <para>
[0f28785]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.
[b7d3cc34]158                                </para>
159                        </description>
160                </bitlbee-command>
161
162                <bitlbee-command name="list">
163                        <syntax>account list</syntax>
164
165                        <description>
166                                <para>
[c1333754]167                                        This command gives you a list of all the accounts known by BitlBee.
[b7d3cc34]168                                </para>
169                        </description>
170                </bitlbee-command>
[75a4b85]171
172                <bitlbee-command name="set">
[e907683]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>
[75a4b85]177
178                        <description>
179                                <para>
[f537044]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>.
[75a4b85]181                                </para>
182                               
183                                <para>
[c1333754]184                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
[75a4b85]185                                </para>
186                               
187                                <para>
[0f28785]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.
[75a4b85]189                                </para>
190                        </description>
191                </bitlbee-command>
[b7d3cc34]192        </bitlbee-command>
193
[f537044]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>
197
198                <description>
199                        <para>
[10685d3]200                                Available actions: del, list, set. See <emphasis>help channel &lt;action&gt;</emphasis> for more information.
[f537044]201                        </para>
202                       
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>
207
208                <bitlbee-command name="del">
209                        <syntax>channel &lt;channel id&gt; del</syntax>
210
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>
216
217                </bitlbee-command>
218
219                <bitlbee-command name="list">
220                        <syntax>channel list</syntax>
221
222                        <description>
223                                <para>
224                                        This command gives you a list of all the channels you configured.
225                                </para>
226                        </description>
227
228                </bitlbee-command>
229
230                <bitlbee-command name="set">
[4f22a68c]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>
[f537044]235
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>
240                               
241                                <para>
242                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
243                                </para>
244                               
245                                <para>
[4f22a68c]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.
[f537044]247                                </para>
248                        </description>
249                </bitlbee-command>
250
251        </bitlbee-command>
252
[c1333754]253        <bitlbee-command name="chat">
254                <short-description>Chatroom list maintenance</short-description>
255                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
256
257                <description>
258
259                        <para>
[e907683]260                                Available actions: add, with. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
[c1333754]261                        </para>
262
263                </description>
264
265                <bitlbee-command name="add">
[2efb69b]266                        <syntax>chat add &lt;account id&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
[c1333754]267
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>
272
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>
[57d8421]276
277                                <para>
278                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
279                                </para>
[c1333754]280                        </description>
281
282                </bitlbee-command>
283
284                <bitlbee-command name="with">
285                        <syntax>chat with &lt;nickname&gt;</syntax>
286
287                        <description>
288                                <para>
289                                        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.
290                                </para>
291                        </description>
292                </bitlbee-command>
293        </bitlbee-command>
294
[b7d3cc34]295        <bitlbee-command name="add">
296                <short-description>Add a buddy to your contact list</short-description>
[2efb69b]297                <syntax>add &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
298                <syntax>add -tmp &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
[b7d3cc34]299
300                <description>
301                        <para>
302                                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.
303                        </para>
304
305                        <para>
[b27557b]306                                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.
[ea3a26d]307                        </para>
[2efb69b]308
309                        <para>
310                                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.
311                        </para>
[b7d3cc34]312                </description>
313
314                <ircexample>
315                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
[689a6e0]316                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
[b7d3cc34]317                </ircexample>
318        </bitlbee-command>
319
320        <bitlbee-command name="info">
321                <short-description>Request user information</short-description>
322                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
323                <syntax>info &lt;nick&gt;</syntax>
324
325                <description>
326                        <para>
327                                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.
328                        </para>
329                </description>
330
331                <ircexample>
332                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
333                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
334                </ircexample>
335
336        </bitlbee-command>
337
338        <bitlbee-command name="remove">
339                <short-description>Remove a buddy from your contact list</short-description>
340                <syntax>remove &lt;nick&gt;</syntax>
341
342                <description>
343                        <para>
344                                Removes the specified nick from your buddy list.
345                        </para>
346                </description>
347
348                <ircexample>
349                        <ircline nick="ctrlsoft">remove gryp</ircline>
350                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
351                </ircexample>
352
353        </bitlbee-command>
354
355        <bitlbee-command name="block">
356                <short-description>Block someone</short-description>
357                <syntax>block &lt;nick&gt;</syntax>
358                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
[9b8efab]359                <syntax>block &lt;connection&gt;</syntax>
[b7d3cc34]360
361                <description>
362                        <para>
363                                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.
364                        </para>
[9b8efab]365                       
366                        <para>
367                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
368                        </para>
[b7d3cc34]369                </description>
370        </bitlbee-command>
371
372        <bitlbee-command name="allow">
373                <short-description>Unblock someone</short-description>
374                <syntax>allow &lt;nick&gt;</syntax>
375                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
376
377                <description>
378                        <para>
379                                Reverse of block. Unignores the specified user or user handle on specified connection.
380                        </para>
[9b8efab]381                       
382                        <para>
383                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
384                        </para>
[b7d3cc34]385                </description>
386        </bitlbee-command>
[f5ac0fb]387       
388        <bitlbee-command name="otr">
389                <short-description>Off-the-Record encryption control</short-description>
390                <syntax>otr &lt;subcommand&gt; [&lt;arguments&gt;]</syntax>
391
392                <description>
393
394                        <para>
[69ef042]395                                Available subcommands: connect, disconnect, reconnect, smp, smpq, trust, info, keygen, and forget. See <emphasis>help otr &lt;subcommand&gt;</emphasis> for more information.
[f5ac0fb]396                        </para>
397
398                </description>
399               
400                <bitlbee-command name="connect">
401                        <syntax>otr connect &lt;nick&gt;</syntax>
402                       
403                        <description>
404                       
405                                <para>
406                                        Attempts to establish an encrypted connection with the specified user by sending a magic string.
407                                </para>
408                               
409                        </description>
410               
411                </bitlbee-command>
412               
413                <bitlbee-command name="disconnect">
414                        <syntax>otr disconnect &lt;nick&gt;</syntax>
[c239fff]415                        <syntax>otr disconnect *</syntax>
[f5ac0fb]416                       
417                        <description>
418                       
419                                <para>
[c239fff]420                                        Resets the connection with the specified user/all users to cleartext.
[f5ac0fb]421                                </para>
422                               
423                        </description>
424               
425                </bitlbee-command>
426               
[69ef042]427                <bitlbee-command name="reconnect">
428                        <syntax>otr reconnect &lt;nick&gt;</syntax>
429                       
430                        <description>
431                       
432                                <para>
433                                        Breaks and re-establishes the encrypted connection with the specified user. Useful if something got desynced.
434                                </para>
435                               
436                                <para>
437                                        Equivalent to <emphasis>otr disconnect</emphasis> followed by <emphasis>otr connect</emphasis>.
438                                </para>
439                               
440                        </description>
441               
442                </bitlbee-command>
443               
[f5ac0fb]444                <bitlbee-command name="smp">
445                        <syntax>otr smp &lt;nick&gt; &lt;secret&gt;</syntax>
446                       
447                        <description>
448                       
449                                <para>
450                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
451                                </para>
452                               
453                                <para>
[3ad8036]454                                        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.
455                                </para>
456                               
457                                <para>
458                                        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.
459                                </para>
460                               
461                                <para>
462                                        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.
[f5ac0fb]463                                </para>
464                               
465                        </description>
466               
467                </bitlbee-command>
468               
[2171044]469                <bitlbee-command name="smpq">
470                        <syntax>otr smpq &lt;nick&gt; &lt;question&gt; &lt;answer&gt;</syntax>
471                       
472                        <description>
473                       
474                                <para>
475                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol, Q&amp;A style.
476                                </para>
477
478                                <para>
[3ad8036]479                                        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!
480                                </para>
481                               
482                                <para>
483                                        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.
[2171044]484                                </para>
485                               
486                        </description>
487               
488                </bitlbee-command>
489               
[f5ac0fb]490                <bitlbee-command name="trust">
491                        <syntax>otr trust &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</syntax>
492                       
493                        <description>
494                       
495                                <para>
496                                        Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
497                                </para>
498                               
499                        </description>
500               
501                </bitlbee-command>
502               
503                <bitlbee-command name="info">
504                        <syntax>otr info</syntax>
505                        <syntax>otr info &lt;nick&gt;</syntax>
506                       
507                        <description>
508                       
509                                <para>
510                                        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.
511                                </para>
512                               
513                        </description>
514               
515                </bitlbee-command>
516               
517                <bitlbee-command name="keygen">
518                        <syntax>otr keygen &lt;account-no&gt;</syntax>
519                       
520                        <description>
521                       
522                                <para>
523                                        Generates a new OTR private key for the given account.
524                                </para>
525                               
526                        </description>
527               
528                </bitlbee-command>
529               
530                <bitlbee-command name="forget">
531                        <syntax>otr forget &lt;thing&gt; &lt;arguments&gt;</syntax>
532                       
533                        <description>
534                       
535                                <para>
[d0faf62]536                                        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.
[f5ac0fb]537                                </para>
538                       
539                        </description>
540                       
541                        <bitlbee-command name="fingerprint">
542                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</syntax>
543                               
544                                <description>
545                               
546                                        <para>
547                                                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.
548                                        </para>
549                                       
550                                </description>
551                               
552                        </bitlbee-command>
553                               
554                        <bitlbee-command name="context">
555                                <syntax>otr forget context &lt;nick&gt;</syntax>
556                               
557                                <description>
558                               
559                                        <para>
560                                                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.
561                                        </para>
562                                       
563                                </description>
564                               
565                        </bitlbee-command>
566
[d0faf62]567                        <bitlbee-command name="key">
568                                <syntax>otr forget key &lt;fingerprint&gt;</syntax>
569                               
570                                <description>
571                               
572                                        <para>
573                                                Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
574                                        </para>
575                                       
576                                </description>
577                               
578                        </bitlbee-command>
579               
[f5ac0fb]580                </bitlbee-command>
581               
582        </bitlbee-command>
[b7d3cc34]583
584        <bitlbee-command name="set">
585                <short-description>Miscellaneous settings</short-description>
[cd428e4]586                <syntax>set</syntax>
587                <syntax>set &lt;variable&gt;</syntax>
588                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
589                <syntax>set -del &lt;variable&gt;</syntax>
[b7d3cc34]590
591                <description>
592
593                        <para>
[cd428e4]594                                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.
[b7d3cc34]595                        </para>
596
597                        <para>
598                                To get more help information about a setting, try:
599                        </para>
600
601                </description>
602
603                <ircexample>
604                        <ircline nick="ctrlsoft">help set private</ircline>
605                </ircexample>
606
607        </bitlbee-command>
608
609        <bitlbee-command name="help">
610                <short-description>BitlBee help system</short-description>
611
612                <syntax>help [subject]</syntax>
613
614                <description>
615                        <para>
616                                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.
617                        </para>
618                </description>
619        </bitlbee-command>
620
621        <bitlbee-command name="save">
622                <short-description>Save your account data</short-description>
623                <syntax>save</syntax>
624
625                <description>
626                        <para>
627                                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... ;-)
628                        </para>
629                </description>
630        </bitlbee-command>
631
[f537044]632        <bitlbee-setting name="account" type="string" scope="channel">
633
634                <description>
635                        <para>
636                                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.
637                        </para>
638                </description>
639        </bitlbee-setting>
640
[af9f2ca]641        <bitlbee-setting name="allow_takeover" type="boolean" scope="global">
642                <default>true</default>
643
644                <description>
645                        <para>
646                                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.
647                        </para>
648                </description>
649        </bitlbee-setting>
650
[5a48afd]651        <bitlbee-setting name="auto_connect" type="boolean" scope="account,global">
[89a1809]652                <default>true</default>
[b7d3cc34]653
654                <description>
655                        <para>
[75a4b85]656                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
[b7d3cc34]657                        </para>
[75a4b85]658                       
[b7d3cc34]659                        <para>
[75a4b85]660                                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!)
[b7d3cc34]661                        </para>
662                </description>
663        </bitlbee-setting>
664
[f537044]665        <bitlbee-setting name="auto_join" type="boolean" scope="channel">
[c1333754]666                <default>false</default>
667
668                <description>
669                        <para>
[f537044]670                                With this option enabled, BitlBee will automatically join this channel when you log in.
[c1333754]671                        </para>
672                </description>
673        </bitlbee-setting>
674
[5a48afd]675        <bitlbee-setting name="auto_reconnect" type="boolean" scope="account,global">
[7a90d02]676                <default>true</default>
[b7d3cc34]677
678                <description>
679                        <para>
[75a4b85]680                                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.
[b7d3cc34]681                        </para>
682
683                        <para>
[75a4b85]684                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
[b7d3cc34]685                        </para>
[75a4b85]686
[89a1809]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_reconnect</emphasis> setting is disabled!)
689                        </para>
690                </description>
[b7d3cc34]691        </bitlbee-setting>
692
[4230221]693        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
694                <default>5*3&lt;900</default>
[b7d3cc34]695
696                <description>
697                        <para>
[4230221]698                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
699                        </para>
700
701                        <para>
702                                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.
[75a4b85]703                        </para>
704
705                        <para>
706                                See also the <emphasis>auto_reconnect</emphasis> setting.
[b7d3cc34]707                        </para>
708                </description>
709        </bitlbee-setting>
710
[b890626]711        <bitlbee-setting name="auto_reply_timeout" type="integer" scope="account">
712                <default>10800</default>
713
714                <description>
715                        <para>
716                                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").
717                        </para>
718
719                        <para>
720                                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.
721                        </para>
722
723                        <para>
724                                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).
725                        </para>
726                </description>
727        </bitlbee-setting>
728
[5a48afd]729        <bitlbee-setting name="away" type="string" scope="account,global">
[0e99548]730                <description>
731                        <para>
732                                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.
733                        </para>
734
735                        <para>
736                                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.
737                        </para>
738
739                        <para>
740                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
741                        </para>
742                </description>
743        </bitlbee-setting>
744
[89a1809]745        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
746                <default>true</default>
[b7d3cc34]747
748                <description>
749                        <para>
[75a4b85]750                                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.
[b7d3cc34]751                        </para>
[6d8cc05]752                       
753                        <para>
754                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
755                        </para>
[b7d3cc34]756                </description>
757        </bitlbee-setting>
758
[1c8e5f7]759        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
760                <default>3600</default>
761
762                <description>
763                        <para>
764                                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.
765                        </para>
766
767                        <para>
768                                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.
769                        </para>
770                </description>
771        </bitlbee-setting>
772
[4346c3f4]773        <bitlbee-setting name="base_url" type="string" scope="account">
[c0f33f1]774                <default>http://api.twitter.com/1</default>
[b7d3cc34]775
776                <description>
777                        <para>
[4346c3f4]778                                There are more services that understand the Twitter API than just Twitter.com. BitlBee can connect to all Twitter API implementations.
[b7d3cc34]779                        </para>
780
781                        <para>
[4346c3f4]782                                For example, set this setting to <emphasis>http://identi.ca/api</emphasis> to use Identi.ca.
[b7d3cc34]783                        </para>
784
785                        <para>
[4346c3f4]786                                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.
[b7d3cc34]787                        </para>
788                </description>
789        </bitlbee-setting>
790
[89a1809]791        <bitlbee-setting name="charset" type="string" scope="global">
[b27557b]792                <default>utf-8</default>
[75a4b85]793                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
[b7d3cc34]794
795                <description>
796                        <para>
[b27557b]797                                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.
[75a4b85]798                        </para>
799
800                        <para>
[b27557b]801                                Most systems use UTF-8 these days. On older systems, an iso8859 charset may work better. For example, iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://www.unicodecharacter.com/charsets/iso8859.html
[b7d3cc34]802                        </para>
803                </description>
[75a4b85]804
[b7d3cc34]805        </bitlbee-setting>
806
[1c18ce1]807        <bitlbee-setting name="color_encrypted" type="boolean" scope="global">
808                <default>true</default>
809
810                <description>
811                        <para>
812                                If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
813                        </para>
814                </description>
[814aa52]815        </bitlbee-setting>
[1c18ce1]816
[f537044]817        <bitlbee-setting name="chat_type" type="string" scope="channel">
818                <default>groupchat</default>
819                <possible-values>groupchat, room</possible-values>
820
821                <description>
822                        <para>
823                                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.
824                        </para>
825                       
826                        <para>
827                                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.
828                        </para>
829                       
830                        <para>
831                                For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command.
832                        </para>
833                </description>
834        </bitlbee-setting>
835
[b890626]836        <bitlbee-setting name="commands" type="boolean" scope="account">
837                <default>true</default>
[3592b95]838                <possible-values>true, false, strict</possible-values>
[b890626]839
840                <description>
841                        <para>
842                                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:
843                        </para>
844
845                        <variablelist>
[fd1ca44]846                                <varlistentry><term>undo #[&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
847                                <varlistentry><term>rt &lt;screenname|#id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
848                                <varlistentry><term>reply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with a reply-to reference)</para></listitem></varlistentry>
[dfaa46d]849                                <varlistentry><term>rawreply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with no reply-to reference)</para></listitem></varlistentry>
[d18dee42]850                                <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>
[b890626]851                                <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
852                                <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
[b61c74c]853                                <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>
[b890626]854                                <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
855                        </variablelist>
856
857                        <para>
[3592b95]858                                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.
[b890626]859                        </para>
860                </description>
861        </bitlbee-setting>
862
[89a1809]863        <bitlbee-setting name="debug" type="boolean" scope="global">
864                <default>false</default>
[b7d3cc34]865
866                <description>
867                        <para>
[23445b6]868                                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.
869                        </para>
870                       
871                        <para>
872                                This feature is not currently used for anything so don't expect this to generate any output.
[b7d3cc34]873                        </para>
[75a4b85]874                </description>
875        </bitlbee-setting>
876
[89a1809]877        <bitlbee-setting name="default_target" type="string" scope="global">
[75a4b85]878                <default>root</default>
879                <possible-values>root, last</possible-values>
[b7d3cc34]880
[75a4b85]881                <description>
[b7d3cc34]882                        <para>
[23445b6]883                                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>.
[b7d3cc34]884                        </para>
885                </description>
886        </bitlbee-setting>
887
[89a1809]888        <bitlbee-setting name="display_name" type="string" scope="account">
[b7d3cc34]889                <description>
890                        <para>
[fcb2c2e]891                                Currently only available for MSN connections, and for jabber groupchats.
892                        </para>
893                        <para>
894                                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.
895                        </para>
896                        <para>
897                                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.
[b7d3cc34]898                        </para>
899                </description>
900        </bitlbee-setting>
901
[89a1809]902        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
903                <default>false</default>
[75a4b85]904
[2529faf]905                <description>
906                        <para>
907                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
908                        </para>
909                </description>
[75a4b85]910        </bitlbee-setting>
911
[5b9b2b6]912        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
913                <default>true</default>
914
915                <description>
916                        <para>
917                                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.
918                        </para>
919                </description>
920        </bitlbee-setting>
921
[f537044]922        <bitlbee-setting name="fill_by" type="string" scope="channel">
923                <default>all</default>
924                <possible-values>all, group, account, protocol</possible-values>
925
926                <description>
927                        <para>
928                                For control channels only: This setting determines which contacts the channel gets populated with.
929                        </para>
930
931                        <para>
932                                By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol.
933                        </para>
934                       
935                        <para>
936                                Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection.
937                        </para>
938                       
[a5c6ebd]939                        <para>
940                                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.
941                        </para>
942                       
[f537044]943                        <para>
944                                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>.
945                        </para>
946                </description>
947        </bitlbee-setting>
948
949        <bitlbee-setting name="group" type="string" scope="channel">
950
951                <description>
952                        <para>
953                                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.
954                        </para>
955                </description>
956        </bitlbee-setting>
957
[89a1809]958        <bitlbee-setting name="handle_unknown" type="string" scope="global">
[16834a5]959                <default>add_channel</default>
[b7d3cc34]960                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
961
962                <description>
963                        <para>
[4c73ba62]964                                By default, messages from people who aren't in your contact list are shown in a control channel instead of as a private message.
[b7d3cc34]965                        </para>
966
967                        <para>
[4c73ba62]968                                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.
[b7d3cc34]969                        </para>
970
971                        <note>
972                                <para>
[4c73ba62]973                                        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.
[b7d3cc34]974                                </para>
975                        </note>
976                </description>
977
978        </bitlbee-setting>
979
[545d7c0]980        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
[f9110b4]981                <default>false</default>
[545d7c0]982
983                <description>
984                        <para>
985                                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.
986                        </para>
987                </description>
988
989        </bitlbee-setting>
990
[89a1809]991        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
992                <default>true</default>
[b7d3cc34]993
994                <description>
995                        <para>
[75a4b85]996                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
[b7d3cc34]997                        </para>
998                </description>
[75a4b85]999
[b7d3cc34]1000        </bitlbee-setting>
1001
[e3413cc]1002        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
1003                <default>false</default>
1004
1005                <description>
1006                        <para>
1007                                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.
1008                        </para>
1009                </description>
1010
1011        </bitlbee-setting>
1012
[1febf5c]1013        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
1014                <default>false</default>
1015
1016                <description>
1017                        <para>
1018                                Some protocols (MSN, Yahoo!) 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.
1019                        </para>
1020                </description>
1021
1022        </bitlbee-setting>
1023
[9997691]1024        <bitlbee-setting name="message_length" type="integer" scope="account">
1025                <default>140</default>
1026
1027                <description>
1028                        <para>
1029                                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.
1030                        </para>
1031
1032                        <para>
1033                                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.
1034                        </para>
1035                </description>
1036
1037        </bitlbee-setting>
[f26d9a3e]1038
1039        <bitlbee-setting name="stream" type="boolean" scope="account">
1040                <default>true</default>
1041
1042                <description>
1043                        <para>
1044                                For Twitter accounts, this setting enables use of the Streaming API. This automatically gives you incoming DMs as well.
1045                        </para>
1046                       
1047                        <para>
1048                                For other Twitter-like services, this setting is not supported.
1049                        </para>
1050                </description>
1051
1052        </bitlbee-setting>
[7d27962]1053       
1054        <bitlbee-setting name="target_url_length" type="integer" scope="account">
1055                <default>20</default>
1056
1057                <description>
1058                        <para>
1059                                Twitter replaces every URL with fixed-length t.co URLs. BitlBee is able to take t.co 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.
1060                        </para>
1061
1062                        <para>
1063                                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 t.co links, even if that makes them longer).
1064                        </para>
1065                </description>
1066
1067        </bitlbee-setting>
[9997691]1068
[e88fbe27]1069        <bitlbee-setting name="mode" type="string" scope="account">
1070                <possible-values>one, many, chat</possible-values>
[c55701e]1071                <default>chat</default>
[e88fbe27]1072
1073                <description>
1074                        <para>
[c55701e]1075                                By default, BitlBee will create a separate channel (called #twitter_yourusername) for all your Twitter contacts/messages.
1076                        </para>
1077
1078                        <para>
1079                                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).
[e88fbe27]1080                        </para>
1081                       
1082                        <para>
[c55701e]1083                                With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
[e88fbe27]1084                        </para>
1085                       
1086                        <para>
[c55701e]1087                                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.
[e88fbe27]1088                        </para>
1089                </description>
1090
1091        </bitlbee-setting>
1092
[ce402b2]1093        <bitlbee-setting name="format_string" type="string" scope="account">
1094                <default>^B[^B%i^B]^B %c</default>
1095
1096                <description>
1097                        <para>
1098                                This setting controls how tweets are displayed. Below are listed the two replacement attributes you may use in the string. If you wish to use a percent symbol in your string, ensure you escape it with a second percent symbol (i.e. "%%").
1099                        </para>
1100
1101                        <para>
1102                                The default setting contains ^B as a control code for toggling of the bold property. Other similar properties (including color codes) are also functional in this setting. See the documentation for your IRC client for details on such control codes.
1103                        </para>
1104
1105                        <variablelist>
1106                                <varlistentry><term>%i</term><listitem><para>The ID of the tweet</para></listitem></varlistentry>
1107                                <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
1108                        </variablelist>
1109                </description>
1110
1111        </bitlbee-setting>
1112
1113        <bitlbee-setting name="reply_format_string" type="string" scope="account">
1114                <default>^B[^B%i->%t^B]^B %c</default>
1115
1116                <description>
1117                        <para>
1118                                This setting controls how replies to tweets are displayed. Below are listed the three replacement attributes you may use in the string. If you wish to use a percent symbol in your string, ensure you escape it with a second percent symbol (i.e. "%%").
1119                        </para>
1120
1121                        <para>
1122                                The default setting contains ^B as a control code for toggling of the bold property. Other similar properties (including color codes) are also functional in this setting. See the documentation for your IRC client for details on such control codes.
1123                        </para>
1124
1125                        <variablelist>
1126                                <varlistentry><term>%i</term><listitem><para>The ID of this tweet</para></listitem></varlistentry>
1127                                <varlistentry><term>%r</term><listitem><para>The ID of the tweet being replied to</para></listitem></varlistentry>
1128                                <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
1129                        </variablelist>
1130                </description>
1131
1132        </bitlbee-setting>
1133
1134        <bitlbee-setting name="retweet_format_string" type="string" scope="account">
1135                <default>^B[^B%i^B]^B RT @%a: %c</default>
1136
1137                <description>
1138                        <para>
1139                                This setting controls how retweets are displayed. Below are listed the three replacement attributes you may use in the string. If you wish to use a percent symbol in your string, ensure you escape it with a second percent symbol (i.e. "%%").
1140                        </para>
1141
1142                        <para>
1143                                The default setting contains ^B as a control code for toggling of the bold property. Other similar properties (including color codes) are also functional in this setting. See the documentation for your IRC client for details on such control codes.
1144                        </para>
1145
1146                        <variablelist>
1147                                <varlistentry><term>%i</term><listitem><para>The ID of the tweet</para></listitem></varlistentry>
1148                                <varlistentry><term>%a</term><listitem><para>The author of the original tweet</para></listitem></varlistentry>
1149                                <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
1150                        </variablelist>
1151                </description>
1152
1153        </bitlbee-setting>
1154
[0ebf919]1155        <bitlbee-setting name="mobile_is_away" type="boolean" scope="global">
1156                <default>false</default>
1157
1158                <description>
1159                        <para>
1160                                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.
1161                        </para>
1162                </description>
1163
1164        </bitlbee-setting>
1165
[c1333754]1166        <bitlbee-setting name="nick" type="string" scope="chat">
1167                <description>
1168                        <para>
1169                                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.
1170                        </para>
1171                </description>
1172        </bitlbee-setting>
1173
[5a48afd]1174        <bitlbee-setting name="nick_format" type="string" scope="account,global">
[db2cef1]1175                <default>%-@nick</default>
1176
1177                <description>
1178                        <para>
1179                                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.
1180                        </para>
1181
1182                        <para>
1183                                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.
1184                        </para>
1185
1186                        <para>
1187                                It's easier to describe this setting using a few examples:
1188                        </para>
1189
1190                        <para>
1191                                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.
1192                        </para>
1193
1194                        <para>
1195                                [%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.
1196                        </para>
1197
1198                        <para>
1199                                See <emphasis>help nick_format</emphasis> for more information.
1200                        </para>
1201                </description>
1202        </bitlbee-setting>
1203
[286b28e]1204        <bitlbee-setting name="nick_source" type="string" scope="account">
1205                <default>handle</default>
1206                <possible-values>handle, full_name, first_name</possible-values>
1207
1208                <description>
1209                        <para>
1210                                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. The Facebook XMPP server is a good example, as all Facebook XMPP handles are numeric.
1211                        </para>
1212
1213                        <para>
1214                                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.
1215                        </para>
1216                </description>
1217        </bitlbee-setting>
1218
[3f668e47]1219        <bitlbee-setting name="oauth" type="boolean" scope="account">
1220                <default>true</default>
1221
1222                <description>
1223                        <para>
[4b53c65]1224                                This enables OAuth authentication for an IM account; right now the Twitter (working for Twitter only) and Jabber (for Google Talk, Facebook and MSN Messenger) module support it.
[3f668e47]1225                        </para>
1226
1227                        <para>
[4b53c65]1228                                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.
[3f668e47]1229                        </para>
1230
1231                        <para>
[87dddee]1232                                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.
[3f668e47]1233                        </para>
1234                </description>
1235
1236        </bitlbee-setting>
1237
[89a1809]1238        <bitlbee-setting name="ops" type="string" scope="global">
[75a4b85]1239                <default>both</default>
1240                <possible-values>both, root, user, none</possible-values>
[b7d3cc34]1241
1242                <description>
1243                        <para>
[75a4b85]1244                                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.
[b7d3cc34]1245                        </para>
1246
1247                        <para>
[75a4b85]1248                                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.
[b7d3cc34]1249                        </para>
1250                </description>
1251        </bitlbee-setting>
1252
[be999a5]1253        <bitlbee-setting name="otr_policy" type="string" scope="global">
1254                <default>opportunistic</default>
1255                <possible-values>never, opportunistic, manual, always</possible-values>
1256
1257                <description>
1258                        <para>
1259                                This setting controls the policy for establishing Off-the-Record connections.
1260                        </para>
1261                        <para>
1262                                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.
1263                        </para>
1264                </description>
1265        </bitlbee-setting>
1266
[5a48afd]1267        <bitlbee-setting name="password" type="string" scope="account,global">
[b7d3cc34]1268                <description>
1269                        <para>
[75a4b85]1270                                Use this global setting to change your "NickServ" password.
[b7d3cc34]1271                        </para>
[75a4b85]1272                       
[b7d3cc34]1273                        <para>
[75a4b85]1274                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
1275                        </para>
1276                       
1277                        <para>
1278                                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.
[b7d3cc34]1279                        </para>
1280                </description>
1281        </bitlbee-setting>
[e5b521d]1282
1283        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
1284                <default>false</default>
1285
1286                <description>
1287                        <para>
1288                                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.
1289                        </para>
1290
1291                        <para>
1292                                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.
1293                        </para>
1294
1295                        <para>
1296                                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.
1297                        </para>
1298                </description>
1299        </bitlbee-setting>
1300
1301        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
1302                <default>200</default>
1303
1304                <description>
1305
1306                        <para>
1307                                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.
1308                        </para>
1309
1310                        <para>
1311                                See also the <emphasis>paste_buffer</emphasis> setting.
1312                        </para>
1313                </description>
1314        </bitlbee-setting>
[75a4b85]1315       
[89a1809]1316        <bitlbee-setting name="port" type="integer" scope="account">
[b7d3cc34]1317                <description>
1318                        <para>
[75a4b85]1319                                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.
[b7d3cc34]1320                        </para>
[75a4b85]1321                </description>
1322        </bitlbee-setting>
1323
[ee5c355]1324        <bitlbee-setting name="priority" type="integer" scope="account">
1325                <default>0</default>
1326
1327                <description>
1328                        <para>
1329                                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).
1330                        </para>
1331
1332                        <para>
1333                                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).
1334                        </para>
1335                </description>
1336        </bitlbee-setting>
1337
[89a1809]1338        <bitlbee-setting name="private" type="boolean" scope="global">
1339                <default>true</default>
[b7d3cc34]1340
[75a4b85]1341                <description>
[b7d3cc34]1342                        <para>
[23445b6]1343                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in a control channel.
[b7d3cc34]1344                        </para>
1345
1346                        <para>
[75a4b85]1347                                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.
[b7d3cc34]1348                        </para>
1349                </description>
1350        </bitlbee-setting>
1351
[f537044]1352        <bitlbee-setting name="protocol" type="string" scope="channel">
1353
1354                <description>
1355                        <para>
1356                                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.
1357                        </para>
1358                </description>
1359        </bitlbee-setting>
1360
[89a1809]1361        <bitlbee-setting name="query_order" type="string" scope="global">
[75a4b85]1362                <default>lifo</default>
1363                <possible-values>lifo, fifo</possible-values>
[834ff44]1364
[b7d3cc34]1365                <description>
1366                        <para>
[75a4b85]1367                                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.
[b7d3cc34]1368                        </para>
1369
1370                        <para>
[75a4b85]1371                                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).
[b7d3cc34]1372                        </para>
1373                </description>
[75a4b85]1374        </bitlbee-setting>
[b7d3cc34]1375
[89a1809]1376        <bitlbee-setting name="resource" type="string" scope="account">
[75a4b85]1377                <default>BitlBee</default>
1378
1379                <description>
1380                        <para>
1381                                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.
1382                        </para>
1383                </description>
[b7d3cc34]1384        </bitlbee-setting>
1385
[ee5c355]1386        <bitlbee-setting name="resource_select" type="string" scope="account">
[f9928cb]1387                <default>activity</default>
[9e768da]1388                <possible-values>priority, activity</possible-values>
[ee5c355]1389
1390                <description>
1391                        <para>
1392                                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.
1393                        </para>
1394
1395                        <para>
[9e768da]1396                                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).
[ee5c355]1397                        </para>
1398                </description>
1399        </bitlbee-setting>
1400
[1195cec]1401        <bitlbee-setting name="root_nick" type="string" scope="global">
1402                <default>root</default>
1403
1404                <description>
1405                        <para>
1406                                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.
1407                        </para>
1408                </description>
1409        </bitlbee-setting>
1410
[89a1809]1411        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1412                <default>true</default>
[b7d3cc34]1413
1414                <description>
1415                        <para>
[75a4b85]1416                                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.
[b7d3cc34]1417                        </para>
1418                </description>
[75a4b85]1419        </bitlbee-setting>
[b7d3cc34]1420
[89a1809]1421        <bitlbee-setting name="server" type="string" scope="account">
[75a4b85]1422                <description>
1423                        <para>
[30ce1ce]1424                                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.
[75a4b85]1425                        </para>
1426                </description>
[b7d3cc34]1427        </bitlbee-setting>
[1186382]1428
[6cc36ef]1429        <bitlbee-setting name="show_ids" type="boolean" scope="account">
[e9bdfbc]1430                <default>true</default>
[6cc36ef]1431
1432                <description>
1433                        <para>
1434                                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.
1435                        </para>
1436                </description>
1437        </bitlbee-setting>
1438
[839189b]1439        <bitlbee-setting name="show_offline" type="boolean" scope="global">
[6824fb3]1440                <default>false</default>
[839189b]1441
1442                <description>
1443                        <para>
1444                                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.
1445                        </para>
[6d8cc05]1446                       
1447                        <para>
1448                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
1449                        </para>
1450                </description>
1451        </bitlbee-setting>
1452
1453        <bitlbee-setting name="show_users" type="string" scope="channel">
1454                <default>online+,away</default>
1455
1456                <description>
1457                        <para>
1458                                Comma-separated list of statuses of users you want in the channel,
1459                                and any modes they should have. The following statuses are currently
1460                                recognised: <emphasis>online</emphasis> (i.e. available, not
1461                                away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
1462                        </para>
1463                       
1464                        <para>
1465                                If a status is followed by a valid channel mode character
1466                                (@, % or +), it will be given to users with that status.
1467                                For example, <emphasis>online@,away+,offline</emphasis> will
1468                                show all users in the channel. Online people will
1469                                have +o, people who are online but away will have +v,
1470                                and others will have no special modes.
1471                        </para>
[839189b]1472                </description>
1473        </bitlbee-setting>
1474
[1186382]1475        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1476                <default>true</default>
1477
1478                <description>
1479                        <para>
[23445b6]1480                                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.
[1186382]1481                        </para>
1482                </description>
1483        </bitlbee-setting>
[b7d3cc34]1484
[89a1809]1485        <bitlbee-setting name="ssl" type="boolean" scope="account">
1486                <default>false</default>
[b7d3cc34]1487
[75a4b85]1488                <description>
1489                        <para>
[25b05b7]1490                                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).
1491                        </para>
1492
1493                        <para>
1494                                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.
[75a4b85]1495                        </para>
1496                </description>
[b7d3cc34]1497        </bitlbee-setting>
1498
[5a48afd]1499        <bitlbee-setting name="status" type="string" scope="account,global">
[0e99548]1500                <description>
1501                        <para>
[5a48afd]1502                                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.
[0e99548]1503                        </para>
1504
1505                        <para>
1506                                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).
1507                        </para>
1508
1509                        <para>
[5a48afd]1510                                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>.
[0e99548]1511                        </para>
1512                </description>
1513        </bitlbee-setting>
1514
[89a1809]1515        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1516                <default>true</default>
[75a4b85]1517
[b7d3cc34]1518                <description>
1519                        <para>
[75a4b85]1520                                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.
1521                        </para>
1522                        <para>
1523                                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.
[b7d3cc34]1524                        </para>
1525                </description>
1526        </bitlbee-setting>
1527
[d2abcae]1528        <bitlbee-setting name="strip_newlines" type="boolean" scope="account">
1529                <default>false</default>
1530
1531                <description>
1532                        <para>
1533                                Turn on this flag to prevent tweets from spanning over multiple lines.
1534                        </para>
1535                </description>
1536        </bitlbee-setting>
1537
[b5fe39b]1538        <bitlbee-setting name="show_old_mentions" type="integer" scope="account">
1539                <default>20</default>
1540
1541                <description>
1542                        <para>
1543                                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.
1544                        </para>
1545                </description>
1546        </bitlbee-setting>
1547
[0f84234]1548        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1549                <default>false</default>
1550
1551                <description>
1552                        <para>
1553                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1554                        </para>
1555                       
1556                        <para>
1557                                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.
1558                        </para>
1559                       
1560                        <para>
1561                                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.
1562                        </para>
1563                </description>
1564        </bitlbee-setting>
1565
[0f28785]1566        <bitlbee-setting name="tag" type="string" scope="account">
1567                <description>
1568                        <para>
1569                                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.
1570                        </para>
1571
1572                        <para>
1573                                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.
1574                        </para>
1575                </description>
1576        </bitlbee-setting>
1577
[3e57660]1578        <bitlbee-setting name="timezone" type="string" scope="global">
1579                <default>local</default>
1580                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1581
1582                <description>
1583                        <para>
1584                                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.
1585                        </para>
1586
1587                        <para>
1588                                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.
1589                        </para>
1590                </description>
1591        </bitlbee-setting>
1592
[ee5c355]1593        <bitlbee-setting name="tls" type="boolean" scope="account">
[955aad8]1594                <default>true</default>
[ee5c355]1595
1596                <description>
1597                        <para>
[955aad8]1598                                By default (with this setting enabled), BitlBee will require Jabber servers to offer encryption via StartTLS and refuse to connect if they don't.
[ee5c355]1599                        </para>
1600
1601                        <para>
[955aad8]1602                                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.
[ee5c355]1603                        </para>
1604                </description>
1605        </bitlbee-setting>
1606
[25b05b7]1607        <bitlbee-setting name="tls_verify" type="boolean" scope="account">
1608                <default>true</default>
1609
1610                <description>
1611                        <para>
1612                                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.
1613                        </para>
1614
1615                        <para>
1616                                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 gmail.com or googlemail.com domain, please try to empty the <emphasis>server</emphasis> setting.
1617                        </para>
1618
1619                        <para>
[792a93b]1620                                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.
[25b05b7]1621                        </para>
1622                </description>
1623        </bitlbee-setting>
1624
[89a1809]1625        <bitlbee-setting name="to_char" type="string" scope="global">
[75a4b85]1626                <default>": "</default>
[b7d3cc34]1627
1628                <description>
1629                        <para>
[75a4b85]1630                                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>.
[b7d3cc34]1631                        </para>
1632
1633                        <para>
[75a4b85]1634                                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.
[b7d3cc34]1635                        </para>
1636                </description>
1637        </bitlbee-setting>
1638
[69b896b]1639        <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel">
1640                <default>true</default>
1641
1642                <description>
1643                        <para>
1644                                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.
1645                        </para>
1646
1647                        <para>
1648                                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.
1649                        </para>
1650                </description>
1651        </bitlbee-setting>
1652
[f537044]1653        <bitlbee-setting name="type" type="string" scope="channel">
1654                <default>control</default>
1655                <possible-values>control, chat</possible-values>
1656
1657                <description>
1658                        <para>
1659                                BitlBee supports two kinds of channels: control channels (usually with a name starting with a &amp;) and chatroom channels (name usually starts with a #).
1660                        </para>
1661
1662                        <para>
1663                                See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee.
1664                        </para>
1665                </description>
1666        </bitlbee-setting>
1667
[89a1809]1668        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1669                <default>false</default>
[b7d3cc34]1670
1671                <description>
1672                        <para>
[b27557b]1673                                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.
[b7d3cc34]1674                        </para>
1675                </description>
1676        </bitlbee-setting>
1677
[4eef271]1678        <bitlbee-setting name="user_agent" type="string" scope="account">
1679                <default>BitlBee</default>
1680
1681                <description>
1682                        <para>
1683                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
1684                        </para>
1685                       
1686                        <para>
1687                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
1688                        </para>
[5cb9461]1689                </description>
1690        </bitlbee-setting>
1691
1692        <bitlbee-setting name="utf8_nicks" type="boolean" scope="global">
1693                <default>false</default>
1694
1695                <description>
1696                        <para>
1697                                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.
1698                        </para>
1699                       
1700                        <para>
1701                                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.
1702                        </para>
[4eef271]1703                </description>
1704        </bitlbee-setting>
1705
[846cec61]1706        <bitlbee-setting name="web_aware" type="string" scope="account">
1707                <default>false</default>
1708
1709                <description>
1710                        <para>
1711                                ICQ allows people to see if you're on-line via a CGI-script. (http://status.icq.com/online.gif?icq=UIN) 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.
1712                        </para>
1713
1714                        <para>
1715                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1716                        </para>
1717                </description>
1718        </bitlbee-setting>
1719
[a6df0b5]1720        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1721                <default>false</default>
1722
1723                <description>
1724                        <para>
1725                                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.
1726                        </para>
1727                        <para>
1728                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1729                        </para>
1730                </description>
1731        </bitlbee-setting>
1732
[b7d3cc34]1733        <bitlbee-command name="rename">
1734                <short-description>Rename (renick) a buddy</short-description>
1735                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
[a429907]1736                <syntax>rename -del &lt;oldnick&gt;</syntax>
[b7d3cc34]1737
1738                <description>
1739                        <para>
1740                                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).
1741                        </para>
[a429907]1742                       
1743                        <para>
1744                                <emphasis>rename -del</emphasis> can be used to erase your manually set nickname for a contact and reset it to what was automatically generated.
1745                        </para>
[b7d3cc34]1746                </description>
1747
1748                <ircexample>
1749                        <ircline nick="itsme">rename itsme_ you</ircline>
1750                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1751                </ircexample>
1752
1753        </bitlbee-command>
1754
1755        <bitlbee-command name="yes">
1756                <short-description>Accept a request</short-description>
1757                <syntax>yes [&lt;number&gt;]</syntax>
1758
1759                <description>
1760                        <para>
1761                                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.
1762                        </para>
1763
1764                        <para>
1765                                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.
1766                        </para>
1767                </description>
1768
1769        </bitlbee-command>
1770
1771        <bitlbee-command name="no">
1772                <short-description>Deny a request</short-description>
1773                <syntax>no [&lt;number&gt;]</syntax>
1774
1775                <description>
1776                        <para>
1777                                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.
1778                        </para>
1779
1780                        <para>
1781                                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.
1782                        </para>
1783                </description>
1784        </bitlbee-command>
1785
1786        <bitlbee-command name="qlist">
1787                <short-description>List all the unanswered questions root asked</short-description>
1788                <syntax>qlist</syntax>
1789
1790                <description>
1791                        <para>
1792                                This gives you a list of all the unanswered questions from root.
1793                        </para>
1794                </description>
1795
1796        </bitlbee-command>
1797
1798        <bitlbee-command name="register">
1799                <short-description>Register yourself</short-description>
[060d066]1800                <syntax>register [&lt;password&gt;]</syntax>
[b7d3cc34]1801
1802                <description>
1803                        <para>
1804                                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.
1805                        </para>
1806
1807                        <para>
1808                                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.. ;-)
1809                        </para>
1810
1811                        <para>
[1be54a9]1812                                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.
[b7d3cc34]1813                        </para>
[060d066]1814
1815                        <para>
1816                                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.
1817                        </para>
[b7d3cc34]1818                </description>
1819
1820        </bitlbee-command>
1821
1822        <bitlbee-command name="identify">
[060d066]1823                <syntax>identify [-noload|-force] [&lt;password&gt;]</syntax>
[b7d3cc34]1824                <short-description>Identify yourself with your password</short-description>
1825
1826                <description>
1827                        <para>
1828                                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.
1829                        </para>
1830
1831                        <para>
1832                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1833                        </para>
[92cb8c4]1834
1835                        <para>
1836                                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).
1837                        </para>
1838                       
1839                        <para>
1840                                <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).
1841                        </para>
[060d066]1842
1843                        <para>
1844                                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.
1845                        </para>
[b7d3cc34]1846                </description>
1847        </bitlbee-command>
1848
1849        <bitlbee-command name="drop">
1850                <syntax>drop &lt;password&gt;</syntax>
1851                <short-description>Drop your account</short-description>
1852
1853                <description>
1854                        <para>
1855                                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.
1856                        </para>
1857                </description>
1858        </bitlbee-command>
1859
1860        <bitlbee-command name="blist">
[f93fd2d]1861                <syntax>blist [all|online|offline|away] [&lt;pattern&gt;]</syntax>
[ac2717b]1862                <short-description>List all the buddies in the current channel</short-description>
[b7d3cc34]1863
1864                <description>
1865                        <para>
[ac2717b]1866                                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.
[b7d3cc34]1867                        </para>
[f93fd2d]1868
1869                        <para>
1870                                A perl-compatible regular expression can be supplied as <emphasis>pattern</emphasis> to filter the results (case-insensitive).
1871                        </para>
[b7d3cc34]1872                </description>
1873
1874        </bitlbee-command>
1875
[2efb69b]1876        <bitlbee-command name="group">
1877                <short-description>Contact group management</short-description>
[c2cc24c]1878                <syntax>group [ list | info &lt;group&gt; ]</syntax>
[b7d3cc34]1879
1880                <description>
1881                        <para>
[c2cc24c]1882                                The <emphasis>group list</emphasis> command shows a list of all groups defined so far.
1883                        </para>
1884                       
1885                        <para>
1886                                The <emphasis>group info</emphasis> command shows a list of all members of a the group &lt;group&gt;.
[0aaca60]1887                        </para>
[52d63dc]1888                       
1889                        <para>
1890                                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.
1891                        </para>
[b7d3cc34]1892                </description>
1893        </bitlbee-command>
[2ff2076]1894       
[3f10fad]1895        <bitlbee-command name="transfer">
[2ff2076]1896                <short-description>Monitor, cancel, or reject file transfers</short-description>
[3f10fad]1897                <syntax>transfer [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
[2ff2076]1898               
1899                <description>
1900                        <para>
[3f10fad]1901                                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.
[2ff2076]1902                        </para>
1903
1904                        <ircexample>
[3f10fad]1905                                <ircline nick="ulim">transfer</ircline>
[2ff2076]1906                        </ircexample>
1907                </description>
1908               
1909                <bitlbee-command name="cancel">
1910                        <short-description>Cancels the file transfer with the given id</short-description>
[3f10fad]1911                        <syntax>transfer &lt;cancel&gt; id</syntax>
[2ff2076]1912
1913                        <description>
1914                                <para>Cancels the file transfer with the given id</para>
1915                        </description>
1916
1917                        <ircexample>
[3f10fad]1918                                <ircline nick="ulim">transfer cancel 1</ircline>
[2ff2076]1919                                <ircline nick="root">Canceling file transfer for test</ircline>
1920                        </ircexample>
1921                </bitlbee-command>
1922
1923                <bitlbee-command name="reject">
1924                        <short-description>Rejects all incoming transfers</short-description>
[3f10fad]1925                        <syntax>transfer &lt;reject&gt;</syntax>
[2ff2076]1926
1927                        <description>
1928                                <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is neccessary. Or is it?</para>
1929                        </description>
1930
1931                        <ircexample>
[3f10fad]1932                                <ircline nick="ulim">transfer reject</ircline>
[2ff2076]1933                        </ircexample>
1934                </bitlbee-command>
1935        </bitlbee-command>
1936       
[b7d3cc34]1937</chapter>
Note: See TracBrowser for help on using the repository browser.