source: doc/user-guide/commands.xml @ 6cc36ef

Last change on this file since 6cc36ef was 6cc36ef, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-04-18T14:04:50Z

show_ids documentation.

  • Property mode set to 100644
File size: 67.9 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">
[bedad20]71                                <syntax>account add twitter &lt;handle&gt; [&lt;password&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">
97                                <syntax>account add identica &lt;handle&gt; [&lt;password&gt;]</syntax>
98
99                                <description>
100                                        <para>
101                                                Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca, and with OAuth disabled.
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>
[6ce2240]395                                Available subcommands: connect, disconnect, 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>
415                       
416                        <description>
417                       
418                                <para>
419                                        Resets the connection with the specified user to cleartext.
420                                </para>
421                               
422                        </description>
423               
424                </bitlbee-command>
425               
426                <bitlbee-command name="smp">
427                        <syntax>otr smp &lt;nick&gt; &lt;secret&gt;</syntax>
428                       
429                        <description>
430                       
431                                <para>
432                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
433                                </para>
434                               
435                                <para>
[3ad8036]436                                        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.
437                                </para>
438                               
439                                <para>
440                                        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.
441                                </para>
442                               
443                                <para>
444                                        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]445                                </para>
446                               
447                        </description>
448               
449                </bitlbee-command>
450               
[2171044]451                <bitlbee-command name="smpq">
452                        <syntax>otr smpq &lt;nick&gt; &lt;question&gt; &lt;answer&gt;</syntax>
453                       
454                        <description>
455                       
456                                <para>
457                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol, Q&amp;A style.
458                                </para>
459
460                                <para>
[3ad8036]461                                        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!
462                                </para>
463                               
464                                <para>
465                                        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]466                                </para>
467                               
468                        </description>
469               
470                </bitlbee-command>
471               
[f5ac0fb]472                <bitlbee-command name="trust">
473                        <syntax>otr trust &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</syntax>
474                       
475                        <description>
476                       
477                                <para>
478                                        Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
479                                </para>
480                               
481                        </description>
482               
483                </bitlbee-command>
484               
485                <bitlbee-command name="info">
486                        <syntax>otr info</syntax>
487                        <syntax>otr info &lt;nick&gt;</syntax>
488                       
489                        <description>
490                       
491                                <para>
492                                        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.
493                                </para>
494                               
495                        </description>
496               
497                </bitlbee-command>
498               
499                <bitlbee-command name="keygen">
500                        <syntax>otr keygen &lt;account-no&gt;</syntax>
501                       
502                        <description>
503                       
504                                <para>
505                                        Generates a new OTR private key for the given account.
506                                </para>
507                               
508                        </description>
509               
510                </bitlbee-command>
511               
512                <bitlbee-command name="forget">
513                        <syntax>otr forget &lt;thing&gt; &lt;arguments&gt;</syntax>
514                       
515                        <description>
516                       
517                                <para>
[d0faf62]518                                        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]519                                </para>
520                       
521                        </description>
522                       
523                        <bitlbee-command name="fingerprint">
524                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</syntax>
525                               
526                                <description>
527                               
528                                        <para>
529                                                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.
530                                        </para>
531                                       
532                                </description>
533                               
534                        </bitlbee-command>
535                               
536                        <bitlbee-command name="context">
537                                <syntax>otr forget context &lt;nick&gt;</syntax>
538                               
539                                <description>
540                               
541                                        <para>
542                                                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.
543                                        </para>
544                                       
545                                </description>
546                               
547                        </bitlbee-command>
548
[d0faf62]549                        <bitlbee-command name="key">
550                                <syntax>otr forget key &lt;fingerprint&gt;</syntax>
551                               
552                                <description>
553                               
554                                        <para>
555                                                Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
556                                        </para>
557                                       
558                                </description>
559                               
560                        </bitlbee-command>
561               
[f5ac0fb]562                </bitlbee-command>
563               
564        </bitlbee-command>
[b7d3cc34]565
566        <bitlbee-command name="set">
567                <short-description>Miscellaneous settings</short-description>
[cd428e4]568                <syntax>set</syntax>
569                <syntax>set &lt;variable&gt;</syntax>
570                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
571                <syntax>set -del &lt;variable&gt;</syntax>
[b7d3cc34]572
573                <description>
574
575                        <para>
[cd428e4]576                                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]577                        </para>
578
579                        <para>
580                                To get more help information about a setting, try:
581                        </para>
582
583                </description>
584
585                <ircexample>
586                        <ircline nick="ctrlsoft">help set private</ircline>
587                </ircexample>
588
589        </bitlbee-command>
590
591        <bitlbee-command name="help">
592                <short-description>BitlBee help system</short-description>
593
594                <syntax>help [subject]</syntax>
595
596                <description>
597                        <para>
598                                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.
599                        </para>
600                </description>
601        </bitlbee-command>
602
603        <bitlbee-command name="save">
604                <short-description>Save your account data</short-description>
605                <syntax>save</syntax>
606
607                <description>
608                        <para>
609                                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... ;-)
610                        </para>
611                </description>
612        </bitlbee-command>
613
[f537044]614        <bitlbee-setting name="account" type="string" scope="channel">
615
616                <description>
617                        <para>
618                                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.
619                        </para>
620                </description>
621        </bitlbee-setting>
622
[af9f2ca]623        <bitlbee-setting name="allow_takeover" type="boolean" scope="global">
624                <default>true</default>
625
626                <description>
627                        <para>
628                                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.
629                        </para>
630                </description>
631        </bitlbee-setting>
632
[89a1809]633        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
634                <default>true</default>
[b7d3cc34]635
636                <description>
637                        <para>
[75a4b85]638                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
[b7d3cc34]639                        </para>
[75a4b85]640                       
[b7d3cc34]641                        <para>
[75a4b85]642                                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]643                        </para>
644                </description>
645        </bitlbee-setting>
646
[f537044]647        <bitlbee-setting name="auto_join" type="boolean" scope="channel">
[c1333754]648                <default>false</default>
649
650                <description>
651                        <para>
[f537044]652                                With this option enabled, BitlBee will automatically join this channel when you log in.
[c1333754]653                        </para>
654                </description>
655        </bitlbee-setting>
656
[89a1809]657        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
[7a90d02]658                <default>true</default>
[b7d3cc34]659
660                <description>
661                        <para>
[75a4b85]662                                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]663                        </para>
664
665                        <para>
[75a4b85]666                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
[b7d3cc34]667                        </para>
[75a4b85]668
[89a1809]669                        <para>
670                                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!)
671                        </para>
672                </description>
[b7d3cc34]673        </bitlbee-setting>
674
[4230221]675        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
676                <default>5*3&lt;900</default>
[b7d3cc34]677
678                <description>
679                        <para>
[4230221]680                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
681                        </para>
682
683                        <para>
684                                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]685                        </para>
686
687                        <para>
688                                See also the <emphasis>auto_reconnect</emphasis> setting.
[b7d3cc34]689                        </para>
690                </description>
691        </bitlbee-setting>
692
[b890626]693        <bitlbee-setting name="auto_reply_timeout" type="integer" scope="account">
694                <default>10800</default>
695
696                <description>
697                        <para>
698                                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").
699                        </para>
700
701                        <para>
702                                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.
703                        </para>
704
705                        <para>
706                                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).
707                        </para>
708                </description>
709        </bitlbee-setting>
710
[0e99548]711        <bitlbee-setting name="away" type="string" scope="both">
712                <description>
713                        <para>
714                                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.
715                        </para>
716
717                        <para>
718                                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.
719                        </para>
720
721                        <para>
722                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
723                        </para>
724                </description>
725        </bitlbee-setting>
726
[89a1809]727        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
728                <default>true</default>
[b7d3cc34]729
730                <description>
731                        <para>
[75a4b85]732                                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]733                        </para>
[6d8cc05]734                       
735                        <para>
736                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
737                        </para>
[b7d3cc34]738                </description>
739        </bitlbee-setting>
740
[1c8e5f7]741        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
742                <default>3600</default>
743
744                <description>
745                        <para>
746                                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.
747                        </para>
748
749                        <para>
750                                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.
751                        </para>
752                </description>
753        </bitlbee-setting>
754
[4346c3f4]755        <bitlbee-setting name="base_url" type="string" scope="account">
756                <default>http://twitter.com</default>
[b7d3cc34]757
758                <description>
759                        <para>
[4346c3f4]760                                There are more services that understand the Twitter API than just Twitter.com. BitlBee can connect to all Twitter API implementations.
[b7d3cc34]761                        </para>
762
763                        <para>
[4346c3f4]764                                For example, set this setting to <emphasis>http://identi.ca/api</emphasis> to use Identi.ca.
[b7d3cc34]765                        </para>
766
767                        <para>
[4346c3f4]768                                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]769                        </para>
770                </description>
771        </bitlbee-setting>
772
[89a1809]773        <bitlbee-setting name="charset" type="string" scope="global">
[b27557b]774                <default>utf-8</default>
[75a4b85]775                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
[b7d3cc34]776
777                <description>
778                        <para>
[b27557b]779                                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]780                        </para>
781
782                        <para>
[b27557b]783                                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]784                        </para>
785                </description>
[75a4b85]786
[b7d3cc34]787        </bitlbee-setting>
788
[1c18ce1]789        <bitlbee-setting name="color_encrypted" type="boolean" scope="global">
790                <default>true</default>
791
792                <description>
793                        <para>
794                                If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
795                        </para>
796                </description>
[814aa52]797        </bitlbee-setting>
[1c18ce1]798
[0baed0d]799        <bitlbee-setting name="control_channel" type="string" scope="global">
800                <default>&amp;bitlbee</default>
801
802                <description>
803                        <para>
804                                Normally the control channel where you can see all your contacts is called "&amp;bitlbee". 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.
805                        </para>
806                </description>
807        </bitlbee-setting>
808
[f537044]809        <bitlbee-setting name="chat_type" type="string" scope="channel">
810                <default>groupchat</default>
811                <possible-values>groupchat, room</possible-values>
812
813                <description>
814                        <para>
815                                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.
816                        </para>
817                       
818                        <para>
819                                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.
820                        </para>
821                       
822                        <para>
823                                For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command.
824                        </para>
825                </description>
826        </bitlbee-setting>
827
[b890626]828        <bitlbee-setting name="commands" type="boolean" scope="account">
829                <default>true</default>
830
831                <description>
832                        <para>
833                                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:
834                        </para>
835
836                        <variablelist>
837                                <varlistentry><term>undo [&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
838                                <varlistentry><term>rt &lt;screenname|id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
[6cc36ef]839                                <varlistentry><term>reply &lt;screenname|id&gt;</term><listitem><para>Reply to a Tweet (with a reply-to reference)</para></listitem></varlistentry>
[b890626]840                                <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
841                                <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
842                                <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
843                        </variablelist>
844
845                        <para>
846                                Anything that doesn't look like a command will be treated as a tweet. Watch out for typos! :-)
847                        </para>
848                </description>
849        </bitlbee-setting>
850
[89a1809]851        <bitlbee-setting name="debug" type="boolean" scope="global">
852                <default>false</default>
[b7d3cc34]853
854                <description>
855                        <para>
[75a4b85]856                                Some debugging messages can be sent to the control channel if you wish. They're probably not really useful for you, unless you're doing some development on BitlBee.
[b7d3cc34]857                        </para>
[75a4b85]858                </description>
859        </bitlbee-setting>
860
[89a1809]861        <bitlbee-setting name="default_target" type="string" scope="global">
[75a4b85]862                <default>root</default>
863                <possible-values>root, last</possible-values>
[b7d3cc34]864
[75a4b85]865                <description>
[b7d3cc34]866                        <para>
[75a4b85]867                                With this value set to <emphasis>root</emphasis>, lines written in the 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 the control channel, set this to <emphasis>last</emphasis>.
[b7d3cc34]868                        </para>
869                </description>
870        </bitlbee-setting>
871
[89a1809]872        <bitlbee-setting name="display_name" type="string" scope="account">
[b7d3cc34]873                <description>
874                        <para>
[75a4b85]875                                Currently only available for MSN connections. 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.
[b7d3cc34]876                        </para>
877                </description>
878        </bitlbee-setting>
879
[89a1809]880        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
881                <default>false</default>
[75a4b85]882
[2529faf]883                <description>
884                        <para>
885                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
886                        </para>
887                </description>
[75a4b85]888        </bitlbee-setting>
889
[5b9b2b6]890        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
891                <default>true</default>
892
893                <description>
894                        <para>
895                                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.
896                        </para>
897                </description>
898        </bitlbee-setting>
899
[f537044]900        <bitlbee-setting name="fill_by" type="string" scope="channel">
901                <default>all</default>
902                <possible-values>all, group, account, protocol</possible-values>
903
904                <description>
905                        <para>
906                                For control channels only: This setting determines which contacts the channel gets populated with.
907                        </para>
908
909                        <para>
910                                By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol.
911                        </para>
912                       
913                        <para>
914                                Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection.
915                        </para>
916                       
917                        <para>
918                                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>.
919                        </para>
920                </description>
921        </bitlbee-setting>
922
923        <bitlbee-setting name="group" type="string" scope="channel">
924
925                <description>
926                        <para>
927                                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.
928                        </para>
929                </description>
930        </bitlbee-setting>
931
[89a1809]932        <bitlbee-setting name="handle_unknown" type="string" scope="global">
[16834a5]933                <default>add_channel</default>
[b7d3cc34]934                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
935
936                <description>
937                        <para>
938                                Messages from unknown users are echoed like this by default:
939                        </para>
940
941                        <ircexample>
942                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
943                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
944                        </ircexample>
945
946                        <para>
947                                If you want this lame user to be added automatically, you can set this setting to "add". 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.
948                        </para>
949
950                        <note>
951                                <para>
952                                        Auto-added users aren't added to your real contact list. This is because you don't want the user to get authorization requests. So when you restart BitlBee, the auto-added user will be gone. If you want to keep the person in your buddy-list, you have to fixate the add using the <emphasis>add</emphasis> command.
953                                </para>
954                        </note>
955                </description>
956
957        </bitlbee-setting>
958
[545d7c0]959        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
[f9110b4]960                <default>false</default>
[545d7c0]961
962                <description>
963                        <para>
964                                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.
965                        </para>
966                </description>
967
968        </bitlbee-setting>
969
[89a1809]970        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
971                <default>true</default>
[b7d3cc34]972
973                <description>
974                        <para>
[75a4b85]975                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
[b7d3cc34]976                        </para>
977                </description>
[75a4b85]978
[b7d3cc34]979        </bitlbee-setting>
980
[e3413cc]981        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
982                <default>false</default>
983
984                <description>
985                        <para>
986                                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.
987                        </para>
988                </description>
989
990        </bitlbee-setting>
991
[1febf5c]992        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
993                <default>false</default>
994
995                <description>
996                        <para>
997                                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.
998                        </para>
999                </description>
1000
1001        </bitlbee-setting>
1002
[9997691]1003        <bitlbee-setting name="message_length" type="integer" scope="account">
1004                <default>140</default>
1005
1006                <description>
1007                        <para>
1008                                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.
1009                        </para>
1010
1011                        <para>
1012                                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.
1013                        </para>
1014                </description>
1015
1016        </bitlbee-setting>
1017
[e88fbe27]1018        <bitlbee-setting name="mode" type="string" scope="account">
1019                <possible-values>one, many, chat</possible-values>
[c55701e]1020                <default>chat</default>
[e88fbe27]1021
1022                <description>
1023                        <para>
[c55701e]1024                                By default, BitlBee will create a separate channel (called #twitter_yourusername) for all your Twitter contacts/messages.
1025                        </para>
1026
1027                        <para>
1028                                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]1029                        </para>
1030                       
1031                        <para>
[c55701e]1032                                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]1033                        </para>
1034                       
1035                        <para>
[c55701e]1036                                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]1037                        </para>
1038                </description>
1039
1040        </bitlbee-setting>
1041
[0ebf919]1042        <bitlbee-setting name="mobile_is_away" type="boolean" scope="global">
1043                <default>false</default>
1044
1045                <description>
1046                        <para>
1047                                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.
1048                        </para>
1049                </description>
1050
1051        </bitlbee-setting>
1052
[c1333754]1053        <bitlbee-setting name="nick" type="string" scope="chat">
1054                <description>
1055                        <para>
1056                                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.
1057                        </para>
1058                </description>
1059        </bitlbee-setting>
1060
[db2cef1]1061        <bitlbee-setting name="nick_format" type="string" scope="both">
1062                <default>%-@nick</default>
1063
1064                <description>
1065                        <para>
1066                                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.
1067                        </para>
1068
1069                        <para>
1070                                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.
1071                        </para>
1072
1073                        <para>
1074                                It's easier to describe this setting using a few examples:
1075                        </para>
1076
1077                        <para>
1078                                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.
1079                        </para>
1080
1081                        <para>
1082                                [%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.
1083                        </para>
1084
1085                        <para>
1086                                See <emphasis>help nick_format</emphasis> for more information.
1087                        </para>
1088                </description>
1089        </bitlbee-setting>
1090
[286b28e]1091        <bitlbee-setting name="nick_source" type="string" scope="account">
1092                <default>handle</default>
1093                <possible-values>handle, full_name, first_name</possible-values>
1094
1095                <description>
1096                        <para>
1097                                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.
1098                        </para>
1099
1100                        <para>
1101                                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.
1102                        </para>
1103                </description>
1104        </bitlbee-setting>
1105
[3f668e47]1106        <bitlbee-setting name="oauth" type="boolean" scope="account">
1107                <default>true</default>
1108
1109                <description>
1110                        <para>
1111                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
1112                        </para>
1113
1114                        <para>
1115                                With OAuth enabled, you shouldn't tell BitlBee your Twitter 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 Twitter. If this succeeds, Twitter will return a PIN code which you can give back to BitlBee to finish the process.
1116                        </para>
1117
1118                        <para>
1119                                The resulting access token will be saved permanently, so you have to do this only once.
1120                        </para>
1121                </description>
1122
1123        </bitlbee-setting>
1124
[89a1809]1125        <bitlbee-setting name="ops" type="string" scope="global">
[75a4b85]1126                <default>both</default>
1127                <possible-values>both, root, user, none</possible-values>
[b7d3cc34]1128
1129                <description>
1130                        <para>
[75a4b85]1131                                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]1132                        </para>
1133
1134                        <para>
[75a4b85]1135                                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]1136                        </para>
1137                </description>
1138        </bitlbee-setting>
1139
[be999a5]1140        <bitlbee-setting name="otr_policy" type="string" scope="global">
1141                <default>opportunistic</default>
1142                <possible-values>never, opportunistic, manual, always</possible-values>
1143
1144                <description>
1145                        <para>
1146                                This setting controls the policy for establishing Off-the-Record connections.
1147                        </para>
1148                        <para>
1149                                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.
1150                        </para>
1151                </description>
1152        </bitlbee-setting>
1153
[89a1809]1154        <bitlbee-setting name="password" type="string" scope="both">
[b7d3cc34]1155                <description>
1156                        <para>
[75a4b85]1157                                Use this global setting to change your "NickServ" password.
[b7d3cc34]1158                        </para>
[75a4b85]1159                       
[b7d3cc34]1160                        <para>
[75a4b85]1161                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
1162                        </para>
1163                       
1164                        <para>
1165                                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]1166                        </para>
1167                </description>
1168        </bitlbee-setting>
[e5b521d]1169
1170        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
1171                <default>false</default>
1172
1173                <description>
1174                        <para>
1175                                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.
1176                        </para>
1177
1178                        <para>
1179                                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.
1180                        </para>
1181
1182                        <para>
1183                                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.
1184                        </para>
1185                </description>
1186        </bitlbee-setting>
1187
1188        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
1189                <default>200</default>
1190
1191                <description>
1192
1193                        <para>
1194                                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.
1195                        </para>
1196
1197                        <para>
1198                                See also the <emphasis>paste_buffer</emphasis> setting.
1199                        </para>
1200                </description>
1201        </bitlbee-setting>
[75a4b85]1202       
[89a1809]1203        <bitlbee-setting name="port" type="integer" scope="account">
[b7d3cc34]1204                <description>
1205                        <para>
[75a4b85]1206                                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]1207                        </para>
[75a4b85]1208                </description>
1209        </bitlbee-setting>
1210
[ee5c355]1211        <bitlbee-setting name="priority" type="integer" scope="account">
1212                <default>0</default>
1213
1214                <description>
1215                        <para>
1216                                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).
1217                        </para>
1218
1219                        <para>
1220                                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).
1221                        </para>
1222                </description>
1223        </bitlbee-setting>
1224
[89a1809]1225        <bitlbee-setting name="private" type="boolean" scope="global">
1226                <default>true</default>
[b7d3cc34]1227
[75a4b85]1228                <description>
[b7d3cc34]1229                        <para>
[75a4b85]1230                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
[b7d3cc34]1231                        </para>
1232
1233                        <para>
[75a4b85]1234                                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]1235                        </para>
1236                </description>
1237        </bitlbee-setting>
1238
[f537044]1239        <bitlbee-setting name="protocol" type="string" scope="channel">
1240
1241                <description>
1242                        <para>
1243                                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.
1244                        </para>
1245                </description>
1246        </bitlbee-setting>
1247
[89a1809]1248        <bitlbee-setting name="query_order" type="string" scope="global">
[75a4b85]1249                <default>lifo</default>
1250                <possible-values>lifo, fifo</possible-values>
[834ff44]1251
[b7d3cc34]1252                <description>
1253                        <para>
[75a4b85]1254                                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]1255                        </para>
1256
1257                        <para>
[75a4b85]1258                                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]1259                        </para>
1260                </description>
[75a4b85]1261        </bitlbee-setting>
[b7d3cc34]1262
[89a1809]1263        <bitlbee-setting name="resource" type="string" scope="account">
[75a4b85]1264                <default>BitlBee</default>
1265
1266                <description>
1267                        <para>
1268                                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.
1269                        </para>
1270                </description>
[b7d3cc34]1271        </bitlbee-setting>
1272
[ee5c355]1273        <bitlbee-setting name="resource_select" type="string" scope="account">
[f9928cb]1274                <default>activity</default>
[9e768da]1275                <possible-values>priority, activity</possible-values>
[ee5c355]1276
1277                <description>
1278                        <para>
1279                                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.
1280                        </para>
1281
1282                        <para>
[9e768da]1283                                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]1284                        </para>
1285                </description>
1286        </bitlbee-setting>
1287
[1195cec]1288        <bitlbee-setting name="root_nick" type="string" scope="global">
1289                <default>root</default>
1290
1291                <description>
1292                        <para>
1293                                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.
1294                        </para>
1295                </description>
1296        </bitlbee-setting>
1297
[89a1809]1298        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1299                <default>true</default>
[b7d3cc34]1300
1301                <description>
1302                        <para>
[75a4b85]1303                                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]1304                        </para>
1305                </description>
[75a4b85]1306        </bitlbee-setting>
[b7d3cc34]1307
[89a1809]1308        <bitlbee-setting name="server" type="string" scope="account">
[75a4b85]1309                <description>
1310                        <para>
[30ce1ce]1311                                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]1312                        </para>
1313                </description>
[b7d3cc34]1314        </bitlbee-setting>
[1186382]1315
[6cc36ef]1316        <bitlbee-setting name="show_ids" type="boolean" scope="account">
1317                <default>false</default>
1318
1319                <description>
1320                        <para>
1321                                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.
1322                        </para>
1323                </description>
1324        </bitlbee-setting>
1325
[839189b]1326        <bitlbee-setting name="show_offline" type="boolean" scope="global">
[6824fb3]1327                <default>false</default>
[839189b]1328
1329                <description>
1330                        <para>
1331                                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.
1332                        </para>
[6d8cc05]1333                       
1334                        <para>
1335                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
1336                        </para>
1337                </description>
1338        </bitlbee-setting>
1339
1340        <bitlbee-setting name="show_users" type="string" scope="channel">
1341                <default>online+,away</default>
1342
1343                <description>
1344                        <para>
1345                                Comma-separated list of statuses of users you want in the channel,
1346                                and any modes they should have. The following statuses are currently
1347                                recognised: <emphasis>online</emphasis> (i.e. available, not
1348                                away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
1349                        </para>
1350                       
1351                        <para>
1352                                If a status is followed by a valid channel mode character
1353                                (@, % or +), it will be given to users with that status.
1354                                For example, <emphasis>online@,away+,offline</emphasis> will
1355                                show all users in the channel. Online people will
1356                                have +o, people who are online but away will have +v,
1357                                and others will have no special modes.
1358                        </para>
[839189b]1359                </description>
1360        </bitlbee-setting>
1361
[1186382]1362        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1363                <default>true</default>
1364
1365                <description>
1366                        <para>
1367                                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 channel window clean. If you don't like this (or if your IRC client doesn't support this) you can disable this setting.
1368                        </para>
1369                </description>
1370        </bitlbee-setting>
[b7d3cc34]1371
[89a1809]1372        <bitlbee-setting name="ssl" type="boolean" scope="account">
1373                <default>false</default>
[b7d3cc34]1374
[75a4b85]1375                <description>
1376                        <para>
1377                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
1378                        </para>
1379                </description>
[b7d3cc34]1380        </bitlbee-setting>
1381
[0e99548]1382        <bitlbee-setting name="status" type="string" scope="both">
1383                <description>
1384                        <para>
1385                                Certain protocols (like Jabber/XMPP) 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.
1386                        </para>
1387
1388                        <para>
1389                                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).
1390                        </para>
1391
1392                        <para>
1393                                Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To un-set the setting, use <emphasis>set -del status</emphasis>.
1394                        </para>
1395                </description>
1396        </bitlbee-setting>
1397
[89a1809]1398        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1399                <default>true</default>
[75a4b85]1400
[b7d3cc34]1401                <description>
1402                        <para>
[75a4b85]1403                                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.
1404                        </para>
1405                        <para>
1406                                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]1407                        </para>
1408                </description>
1409        </bitlbee-setting>
1410
[0f84234]1411        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1412                <default>false</default>
1413
1414                <description>
1415                        <para>
1416                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1417                        </para>
1418                       
1419                        <para>
1420                                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.
1421                        </para>
1422                       
1423                        <para>
1424                                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.
1425                        </para>
1426                </description>
1427        </bitlbee-setting>
1428
[0f28785]1429        <bitlbee-setting name="tag" type="string" scope="account">
1430                <description>
1431                        <para>
1432                                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.
1433                        </para>
1434
1435                        <para>
1436                                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.
1437                        </para>
1438                </description>
1439        </bitlbee-setting>
1440
[3e57660]1441        <bitlbee-setting name="timezone" type="string" scope="global">
1442                <default>local</default>
1443                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1444
1445                <description>
1446                        <para>
1447                                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.
1448                        </para>
1449
1450                        <para>
1451                                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.
1452                        </para>
1453                </description>
1454        </bitlbee-setting>
1455
[ee5c355]1456        <bitlbee-setting name="tls" type="boolean" scope="account">
1457                <default>try</default>
1458
1459                <description>
1460                        <para>
1461                                Newer Jabber servers allow clients to convert a plain-text session to a TLS/SSL-encrypted session. Normally (with this setting set to <emphasis>try</emphasis>) BitlBee will do this, if possible.
1462                        </para>
1463
1464                        <para>
1465                                If you want to force BitlBee to use TLS sessions only (and to give up if that doesn't seem to be possible) you can set this setting to <emphasis>true</emphasis>. Set it to <emphasis>false</emphasis> if you want the session to remain plain-text.
1466                        </para>
1467                </description>
1468        </bitlbee-setting>
1469
[89a1809]1470        <bitlbee-setting name="to_char" type="string" scope="global">
[75a4b85]1471                <default>": "</default>
[b7d3cc34]1472
1473                <description>
1474                        <para>
[75a4b85]1475                                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]1476                        </para>
1477
1478                        <para>
[75a4b85]1479                                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]1480                        </para>
1481                </description>
1482        </bitlbee-setting>
1483
[69b896b]1484        <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel">
1485                <default>true</default>
1486
1487                <description>
1488                        <para>
1489                                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.
1490                        </para>
1491
1492                        <para>
1493                                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.
1494                        </para>
1495                </description>
1496        </bitlbee-setting>
1497
[f537044]1498        <bitlbee-setting name="type" type="string" scope="channel">
1499                <default>control</default>
1500                <possible-values>control, chat</possible-values>
1501
1502                <description>
1503                        <para>
1504                                BitlBee supports two kinds of channels: control channels (usually with a name starting with a &amp;) and chatroom channels (name usually starts with a #).
1505                        </para>
1506
1507                        <para>
1508                                See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee.
1509                        </para>
1510                </description>
1511        </bitlbee-setting>
1512
[89a1809]1513        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1514                <default>false</default>
[b7d3cc34]1515
1516                <description>
1517                        <para>
[b27557b]1518                                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]1519                        </para>
1520                </description>
1521        </bitlbee-setting>
1522
[4eef271]1523        <bitlbee-setting name="user_agent" type="string" scope="account">
1524                <default>BitlBee</default>
1525
1526                <description>
1527                        <para>
1528                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
1529                        </para>
1530                       
1531                        <para>
1532                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
1533                        </para>
1534                </description>
1535        </bitlbee-setting>
1536
[846cec61]1537        <bitlbee-setting name="web_aware" type="string" scope="account">
1538                <default>false</default>
1539
1540                <description>
1541                        <para>
1542                                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.
1543                        </para>
1544
1545                        <para>
1546                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1547                        </para>
1548                </description>
1549        </bitlbee-setting>
1550
[a6df0b5]1551        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1552                <default>false</default>
1553
1554                <description>
1555                        <para>
1556                                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.
1557                        </para>
1558                        <para>
1559                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1560                        </para>
1561                </description>
1562        </bitlbee-setting>
1563
[b7d3cc34]1564        <bitlbee-command name="rename">
1565                <short-description>Rename (renick) a buddy</short-description>
1566                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
[a429907]1567                <syntax>rename -del &lt;oldnick&gt;</syntax>
[b7d3cc34]1568
1569                <description>
1570                        <para>
1571                                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).
1572                        </para>
[a429907]1573                       
1574                        <para>
1575                                <emphasis>rename -del</emphasis> can be used to erase your manually set nickname for a contact and reset it to what was automatically generated.
1576                        </para>
[b7d3cc34]1577                </description>
1578
1579                <ircexample>
1580                        <ircline nick="itsme">rename itsme_ you</ircline>
1581                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1582                </ircexample>
1583
1584        </bitlbee-command>
1585
1586        <bitlbee-command name="yes">
1587                <short-description>Accept a request</short-description>
1588                <syntax>yes [&lt;number&gt;]</syntax>
1589
1590                <description>
1591                        <para>
1592                                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.
1593                        </para>
1594
1595                        <para>
1596                                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.
1597                        </para>
1598                </description>
1599
1600        </bitlbee-command>
1601
1602        <bitlbee-command name="no">
1603                <short-description>Deny a request</short-description>
1604                <syntax>no [&lt;number&gt;]</syntax>
1605
1606                <description>
1607                        <para>
1608                                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.
1609                        </para>
1610
1611                        <para>
1612                                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.
1613                        </para>
1614                </description>
1615        </bitlbee-command>
1616
1617        <bitlbee-command name="qlist">
1618                <short-description>List all the unanswered questions root asked</short-description>
1619                <syntax>qlist</syntax>
1620
1621                <description>
1622                        <para>
1623                                This gives you a list of all the unanswered questions from root.
1624                        </para>
1625                </description>
1626
1627        </bitlbee-command>
1628
1629        <bitlbee-command name="register">
1630                <short-description>Register yourself</short-description>
[060d066]1631                <syntax>register [&lt;password&gt;]</syntax>
[b7d3cc34]1632
1633                <description>
1634                        <para>
1635                                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.
1636                        </para>
1637
1638                        <para>
1639                                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.. ;-)
1640                        </para>
1641
1642                        <para>
[1be54a9]1643                                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]1644                        </para>
[060d066]1645
1646                        <para>
1647                                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.
1648                        </para>
[b7d3cc34]1649                </description>
1650
1651        </bitlbee-command>
1652
1653        <bitlbee-command name="identify">
[060d066]1654                <syntax>identify [-noload|-force] [&lt;password&gt;]</syntax>
[b7d3cc34]1655                <short-description>Identify yourself with your password</short-description>
1656
1657                <description>
1658                        <para>
1659                                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.
1660                        </para>
1661
1662                        <para>
1663                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1664                        </para>
[92cb8c4]1665
1666                        <para>
1667                                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).
1668                        </para>
1669                       
1670                        <para>
1671                                <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).
1672                        </para>
[060d066]1673
1674                        <para>
1675                                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.
1676                        </para>
[b7d3cc34]1677                </description>
1678        </bitlbee-command>
1679
1680        <bitlbee-command name="drop">
1681                <syntax>drop &lt;password&gt;</syntax>
1682                <short-description>Drop your account</short-description>
1683
1684                <description>
1685                        <para>
1686                                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.
1687                        </para>
1688                </description>
1689        </bitlbee-command>
1690
1691        <bitlbee-command name="blist">
1692                <syntax>blist [all|online|offline|away]</syntax>
[ac2717b]1693                <short-description>List all the buddies in the current channel</short-description>
[b7d3cc34]1694
1695                <description>
1696                        <para>
[ac2717b]1697                                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]1698                        </para>
1699                </description>
1700
1701        </bitlbee-command>
1702
[2efb69b]1703        <bitlbee-command name="group">
1704                <short-description>Contact group management</short-description>
1705                <syntax>group list</syntax>
[b7d3cc34]1706
1707                <description>
1708                        <para>
[2efb69b]1709                                Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far.
[0aaca60]1710                        </para>
[52d63dc]1711                       
1712                        <para>
1713                                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.
1714                        </para>
[b7d3cc34]1715                </description>
1716        </bitlbee-command>
[2ff2076]1717       
[3f10fad]1718        <bitlbee-command name="transfer">
[2ff2076]1719                <short-description>Monitor, cancel, or reject file transfers</short-description>
[3f10fad]1720                <syntax>transfer [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
[2ff2076]1721               
1722                <description>
1723                        <para>
[3f10fad]1724                                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]1725                        </para>
1726
1727                        <ircexample>
[3f10fad]1728                                <ircline nick="ulim">transfer</ircline>
[2ff2076]1729                        </ircexample>
1730                </description>
1731               
1732                <bitlbee-command name="cancel">
1733                        <short-description>Cancels the file transfer with the given id</short-description>
[3f10fad]1734                        <syntax>transfer &lt;cancel&gt; id</syntax>
[2ff2076]1735
1736                        <description>
1737                                <para>Cancels the file transfer with the given id</para>
1738                        </description>
1739
1740                        <ircexample>
[3f10fad]1741                                <ircline nick="ulim">transfer cancel 1</ircline>
[2ff2076]1742                                <ircline nick="root">Canceling file transfer for test</ircline>
1743                        </ircexample>
1744                </bitlbee-command>
1745
1746                <bitlbee-command name="reject">
1747                        <short-description>Rejects all incoming transfers</short-description>
[3f10fad]1748                        <syntax>transfer &lt;reject&gt;</syntax>
[2ff2076]1749
1750                        <description>
1751                                <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>
1752                        </description>
1753
1754                        <ircexample>
[3f10fad]1755                                <ircline nick="ulim">transfer reject</ircline>
[2ff2076]1756                        </ircexample>
1757                </bitlbee-command>
1758        </bitlbee-command>
1759       
[b7d3cc34]1760</chapter>
Note: See TracBrowser for help on using the repository browser.