source: doc/user-guide/commands.xml @ 4f22a68

Last change on this file since 4f22a68 was 4f22a68, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-18T20:12:55Z

Automatically operate on the current channel if just using "channel set".

  • Property mode set to 100644
File size: 55.1 KB
Line 
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>
8                <syntax>account [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
9
10                <description>
11
12                        <para>
13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
14                        </para>
15
16                </description>
17
18                <bitlbee-command name="add">
19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>
20
21                        <description>
22                                <para>
23                                        Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ), Yahoo and Twitter. For more information about adding an account, see <emphasis>help account add &lt;protocol&gt;</emphasis>.
24                                </para>
25                        </description>
26                       
27                        <bitlbee-command name="jabber">
28                                <syntax>account add jabber &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
29
30                                <description>
31                                        <para>
32                                                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.
33                                        </para>
34
35                                        <para>
36                                                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>).
37                                        </para>
38                                </description>
39                        </bitlbee-command>
40
41                        <bitlbee-command name="msn">
42                                <syntax>account add msn &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
43
44                                <description>
45                                        <para>
46                                                For MSN connections there are no special arguments.
47                                        </para>
48                                </description>
49                        </bitlbee-command>
50                       
51                        <bitlbee-command name="oscar">
52                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt;</syntax>
53
54                                <description>
55                                        <para>
56                                                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.
57                                        </para>
58                                </description>
59
60                                <ircexample>
61                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
62                                        <ircline nick="root">Account successfully added</ircline>
63                                </ircexample>
64                        </bitlbee-command>
65                       
66                        <bitlbee-command name="twitter">
67                                <syntax>account add twitter &lt;handle&gt; &lt;password&gt;</syntax>
68
69                                <description>
70                                        <para>
71                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
72                                        </para>
73                                       
74                                        <para>
75                                                By default all your Twitter contacts will come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
76                                        </para>
77                                       
78                                        <para>
79                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
80                                        </para>
81
82                                        <para>
83                                                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>.)
84                                        </para>
85                                </description>
86                        </bitlbee-command>
87
88                        <bitlbee-command name="yahoo">
89                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
90
91                                <description>
92                                        <para>
93                                                For Yahoo! connections there are no special arguments.
94                                        </para>
95                                </description>
96                        </bitlbee-command>
97
98                </bitlbee-command>
99
100                <bitlbee-command name="del">
101                        <syntax>account &lt;account id&gt; del</syntax>
102
103                        <description>
104                                <para>
105                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
106                                </para>
107
108
109                                <para>
110                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
111                                </para>
112                        </description>
113                </bitlbee-command>
114
115                <bitlbee-command name="on">
116                        <syntax>account [&lt;account id&gt;] on</syntax>
117
118                        <description>
119                                <para>
120                                        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.
121                                </para>
122
123                                <para>
124                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
125                                </para>
126                        </description>
127
128                </bitlbee-command>
129
130                <bitlbee-command name="off">
131                        <syntax>account [&lt;account id&gt;] off</syntax>
132
133                        <description>
134                                <para>
135                                        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.
136                                </para>
137
138                                <para>
139                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
140                                </para>
141                        </description>
142                </bitlbee-command>
143
144                <bitlbee-command name="list">
145                        <syntax>account list</syntax>
146
147                        <description>
148                                <para>
149                                        This command gives you a list of all the accounts known by BitlBee.
150                                </para>
151                        </description>
152                </bitlbee-command>
153
154                <bitlbee-command name="set">
155                        <syntax>account &lt;account id&gt; set</syntax>
156                        <syntax>account &lt;account id&gt; set &lt;setting&gt;</syntax>
157                        <syntax>account &lt;account id&gt; set &lt;setting&gt; &lt;value&gt;</syntax>
158                        <syntax>account &lt;account id&gt; set -del &lt;setting&gt;</syntax>
159
160                        <description>
161                                <para>
162                                        This command can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account &lt;account id&gt; set</emphasis>.
163                                </para>
164                               
165                                <para>
166                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
167                                </para>
168                               
169                                <para>
170                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
171                                </para>
172                        </description>
173                </bitlbee-command>
174        </bitlbee-command>
175
176        <bitlbee-command name="channel">
177                <short-description>Channel list maintenance</short-description>
178                <syntax>channel [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
179
180                <description>
181                        <para>
182                                Available actions: del, list, set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
183                        </para>
184                       
185                        <para>
186                                There is no <emphasis>channel add</emphasis> command. To create a new channel, just use the IRC <emphasis>/join</emphasis> command. See also <emphasis>help channels</emphasis> and <emphasis>help groupchats</emphasis>.
187                        </para>
188                </description>
189
190                <bitlbee-command name="del">
191                        <syntax>channel &lt;channel id&gt; del</syntax>
192
193                        <description>
194                                <para>
195                                        Remove a channel and forget all its settings. You can only remove channels you're not currently in, and can't remove the main control channel. (You can, however, leave it.)
196                                </para>
197                        </description>
198
199                </bitlbee-command>
200
201                <bitlbee-command name="list">
202                        <syntax>channel list</syntax>
203
204                        <description>
205                                <para>
206                                        This command gives you a list of all the channels you configured.
207                                </para>
208                        </description>
209
210                </bitlbee-command>
211
212                <bitlbee-command name="set">
213                        <syntax>channel [&lt;channel id&gt;] set</syntax>
214                        <syntax>channel [&lt;channel id&gt;] set &lt;setting&gt;</syntax>
215                        <syntax>channel [&lt;channel id&gt;] set &lt;setting&gt; &lt;value&gt;</syntax>
216                        <syntax>channel [&lt;channel id&gt;] set -del &lt;setting&gt;</syntax>
217
218                        <description>
219                                <para>
220                                        This command can be used to change various settings for channels. Different channel types support different settings. You can see the settings available for a channel by typing <emphasis>channel &lt;channel id&gt; set</emphasis>.
221                                </para>
222                               
223                                <para>
224                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
225                                </para>
226                               
227                                <para>
228                                        The channel ID can be a number (see <emphasis>channel list</emphasis>), or (part of) its name, as long as it matches only one channel. If you want to change settings of the current channel, you can omit the channel ID.
229                                </para>
230                        </description>
231                </bitlbee-command>
232
233        </bitlbee-command>
234
235        <bitlbee-command name="chat">
236                <short-description>Chatroom list maintenance</short-description>
237                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
238
239                <description>
240
241                        <para>
242                                Available actions: add, with. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
243                        </para>
244
245                </description>
246
247                <bitlbee-command name="add">
248                        <syntax>chat add &lt;account id&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
249
250                        <description>
251                                <para>
252                                        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.
253                                </para>
254
255                                <para>
256                                        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>)
257                                </para>
258
259                                <para>
260                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
261                                </para>
262                        </description>
263
264                </bitlbee-command>
265
266                <bitlbee-command name="with">
267                        <syntax>chat with &lt;nickname&gt;</syntax>
268
269                        <description>
270                                <para>
271                                        While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions.
272                                </para>
273                        </description>
274                </bitlbee-command>
275        </bitlbee-command>
276
277        <bitlbee-command name="add">
278                <short-description>Add a buddy to your contact list</short-description>
279                <syntax>add &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
280                <syntax>add -tmp &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
281
282                <description>
283                        <para>
284                                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.
285                        </para>
286
287                        <para>
288                                If you want, you can also tell BitlBee what nick to give the new contact. The -tmp option adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications.
289                        </para>
290
291                        <para>
292                                If you use this command in a control channel containing people from only one group, the new contact will be added to that group automatically.
293                        </para>
294                </description>
295
296                <ircexample>
297                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
298                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
299                </ircexample>
300        </bitlbee-command>
301
302        <bitlbee-command name="info">
303                <short-description>Request user information</short-description>
304                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
305                <syntax>info &lt;nick&gt;</syntax>
306
307                <description>
308                        <para>
309                                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.
310                        </para>
311                </description>
312
313                <ircexample>
314                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
315                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
316                </ircexample>
317
318        </bitlbee-command>
319
320        <bitlbee-command name="remove">
321                <short-description>Remove a buddy from your contact list</short-description>
322                <syntax>remove &lt;nick&gt;</syntax>
323
324                <description>
325                        <para>
326                                Removes the specified nick from your buddy list.
327                        </para>
328                </description>
329
330                <ircexample>
331                        <ircline nick="ctrlsoft">remove gryp</ircline>
332                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
333                </ircexample>
334
335        </bitlbee-command>
336
337        <bitlbee-command name="block">
338                <short-description>Block someone</short-description>
339                <syntax>block &lt;nick&gt;</syntax>
340                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
341                <syntax>block &lt;connection&gt;</syntax>
342
343                <description>
344                        <para>
345                                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.
346                        </para>
347                       
348                        <para>
349                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
350                        </para>
351                </description>
352        </bitlbee-command>
353
354        <bitlbee-command name="allow">
355                <short-description>Unblock someone</short-description>
356                <syntax>allow &lt;nick&gt;</syntax>
357                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
358
359                <description>
360                        <para>
361                                Reverse of block. Unignores the specified user or user handle on specified connection.
362                        </para>
363                       
364                        <para>
365                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
366                        </para>
367                </description>
368        </bitlbee-command>
369
370        <bitlbee-command name="set">
371                <short-description>Miscellaneous settings</short-description>
372                <syntax>set</syntax>
373                <syntax>set &lt;variable&gt;</syntax>
374                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
375                <syntax>set -del &lt;variable&gt;</syntax>
376
377                <description>
378
379                        <para>
380                                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.
381                        </para>
382
383                        <para>
384                                To get more help information about a setting, try:
385                        </para>
386
387                </description>
388
389                <ircexample>
390                        <ircline nick="ctrlsoft">help set private</ircline>
391                </ircexample>
392
393        </bitlbee-command>
394
395        <bitlbee-command name="help">
396                <short-description>BitlBee help system</short-description>
397
398                <syntax>help [subject]</syntax>
399
400                <description>
401                        <para>
402                                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.
403                        </para>
404                </description>
405        </bitlbee-command>
406
407        <bitlbee-command name="save">
408                <short-description>Save your account data</short-description>
409                <syntax>save</syntax>
410
411                <description>
412                        <para>
413                                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... ;-)
414                        </para>
415                </description>
416        </bitlbee-command>
417
418        <bitlbee-setting name="account" type="string" scope="channel">
419
420                <description>
421                        <para>
422                                For control channels with <emphasis>fill_by</emphasis> set to <emphasis>account</emphasis>: Set this setting to the account id (numeric, or part of the username) of the account containing the contacts you want to see in this channel.
423                        </para>
424                </description>
425        </bitlbee-setting>
426
427        <bitlbee-setting name="allow_takeover" type="boolean" scope="global">
428                <default>true</default>
429
430                <description>
431                        <para>
432                                When you're already connected to a BitlBee server and you connect (and identify) again, BitlBee will offer to migrate your existing session to the new connection. If for whatever reason you don't want this, you can disable this setting.
433                        </para>
434                </description>
435        </bitlbee-setting>
436
437        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
438                <default>true</default>
439
440                <description>
441                        <para>
442                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
443                        </para>
444                       
445                        <para>
446                                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!)
447                        </para>
448                </description>
449        </bitlbee-setting>
450
451        <bitlbee-setting name="auto_join" type="boolean" scope="channel">
452                <default>false</default>
453
454                <description>
455                        <para>
456                                With this option enabled, BitlBee will automatically join this channel when you log in.
457                        </para>
458                </description>
459        </bitlbee-setting>
460
461        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
462                <default>true</default>
463
464                <description>
465                        <para>
466                                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.
467                        </para>
468
469                        <para>
470                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
471                        </para>
472
473                        <para>
474                                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!)
475                        </para>
476                </description>
477        </bitlbee-setting>
478
479        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
480                <default>5*3&lt;900</default>
481
482                <description>
483                        <para>
484                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
485                        </para>
486
487                        <para>
488                                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.
489                        </para>
490
491                        <para>
492                                See also the <emphasis>auto_reconnect</emphasis> setting.
493                        </para>
494                </description>
495        </bitlbee-setting>
496
497        <bitlbee-setting name="away" type="string" scope="both">
498                <description>
499                        <para>
500                                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.
501                        </para>
502
503                        <para>
504                                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.
505                        </para>
506
507                        <para>
508                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
509                        </para>
510                </description>
511        </bitlbee-setting>
512
513        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
514                <default>true</default>
515
516                <description>
517                        <para>
518                                With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled.
519                        </para>
520                </description>
521        </bitlbee-setting>
522
523        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
524                <default>3600</default>
525
526                <description>
527                        <para>
528                                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.
529                        </para>
530
531                        <para>
532                                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.
533                        </para>
534                </description>
535        </bitlbee-setting>
536
537        <bitlbee-setting name="base_url" type="string" scope="account">
538                <default>http://twitter.com</default>
539
540                <description>
541                        <para>
542                                There are more services that understand the Twitter API than just Twitter.com. BitlBee can connect to all Twitter API implementations.
543                        </para>
544
545                        <para>
546                                For example, set this setting to <emphasis>http://identi.ca/api</emphasis> to use Identi.ca.
547                        </para>
548
549                        <para>
550                                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.
551                        </para>
552                </description>
553        </bitlbee-setting>
554
555        <bitlbee-setting name="charset" type="string" scope="global">
556                <default>utf-8</default>
557                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
558
559                <description>
560                        <para>
561                                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.
562                        </para>
563
564                        <para>
565                                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
566                        </para>
567                </description>
568
569        </bitlbee-setting>
570
571        <bitlbee-setting name="control_channel" type="string" scope="global">
572                <default>&amp;bitlbee</default>
573
574                <description>
575                        <para>
576                                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.
577                        </para>
578                </description>
579        </bitlbee-setting>
580
581        <bitlbee-setting name="chat_type" type="string" scope="channel">
582                <default>groupchat</default>
583                <possible-values>groupchat, room</possible-values>
584
585                <description>
586                        <para>
587                                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.
588                        </para>
589                       
590                        <para>
591                                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.
592                        </para>
593                       
594                        <para>
595                                For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command.
596                        </para>
597                </description>
598        </bitlbee-setting>
599
600        <bitlbee-setting name="debug" type="boolean" scope="global">
601                <default>false</default>
602
603                <description>
604                        <para>
605                                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.
606                        </para>
607                </description>
608        </bitlbee-setting>
609
610        <bitlbee-setting name="default_target" type="string" scope="global">
611                <default>root</default>
612                <possible-values>root, last</possible-values>
613
614                <description>
615                        <para>
616                                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>.
617                        </para>
618                </description>
619        </bitlbee-setting>
620
621        <bitlbee-setting name="display_name" type="string" scope="account">
622                <description>
623                        <para>
624                                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.
625                        </para>
626                </description>
627        </bitlbee-setting>
628
629        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
630                <default>false</default>
631
632                <description>
633                        <para>
634                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
635                        </para>
636                </description>
637        </bitlbee-setting>
638
639        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
640                <default>true</default>
641
642                <description>
643                        <para>
644                                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.
645                        </para>
646                </description>
647        </bitlbee-setting>
648
649        <bitlbee-setting name="fill_by" type="string" scope="channel">
650                <default>all</default>
651                <possible-values>all, group, account, protocol</possible-values>
652
653                <description>
654                        <para>
655                                For control channels only: This setting determines which contacts the channel gets populated with.
656                        </para>
657
658                        <para>
659                                By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol.
660                        </para>
661                       
662                        <para>
663                                Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection.
664                        </para>
665                       
666                        <para>
667                                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>.
668                        </para>
669                </description>
670        </bitlbee-setting>
671
672        <bitlbee-setting name="group" type="string" scope="channel">
673
674                <description>
675                        <para>
676                                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.
677                        </para>
678                </description>
679        </bitlbee-setting>
680
681        <bitlbee-setting name="handle_unknown" type="string" scope="global">
682                <default>add_channel</default>
683                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
684
685                <description>
686                        <para>
687                                Messages from unknown users are echoed like this by default:
688                        </para>
689
690                        <ircexample>
691                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
692                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
693                        </ircexample>
694
695                        <para>
696                                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.
697                        </para>
698
699                        <note>
700                                <para>
701                                        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.
702                                </para>
703                        </note>
704                </description>
705
706        </bitlbee-setting>
707
708        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
709                <default>false</default>
710
711                <description>
712                        <para>
713                                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.
714                        </para>
715                </description>
716
717        </bitlbee-setting>
718
719        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
720                <default>true</default>
721
722                <description>
723                        <para>
724                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
725                        </para>
726                </description>
727
728        </bitlbee-setting>
729
730        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
731                <default>false</default>
732
733                <description>
734                        <para>
735                                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.
736                        </para>
737                </description>
738
739        </bitlbee-setting>
740
741        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
742                <default>false</default>
743
744                <description>
745                        <para>
746                                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.
747                        </para>
748                </description>
749
750        </bitlbee-setting>
751
752        <bitlbee-setting name="message_length" type="integer" scope="account">
753                <default>140</default>
754
755                <description>
756                        <para>
757                                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.
758                        </para>
759
760                        <para>
761                                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.
762                        </para>
763                </description>
764
765        </bitlbee-setting>
766
767        <bitlbee-setting name="mode" type="string" scope="account">
768                <possible-values>one, many, chat</possible-values>
769                <default>one</default>
770
771                <description>
772                        <para>
773                                By default, everything from the Twitter module will come from one nick, twitter_(yourusername). If you prefer to have individual nicks for everyone, you can set this setting to "many" instead.
774                        </para>
775                       
776                        <para>
777                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
778                        </para>
779                       
780                        <para>
781                                In the last two modes, you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
782                        </para>
783                </description>
784
785        </bitlbee-setting>
786
787        <bitlbee-setting name="nick" type="string" scope="chat">
788                <description>
789                        <para>
790                                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.
791                        </para>
792                </description>
793        </bitlbee-setting>
794
795        <bitlbee-setting name="nick_format" type="string" scope="both">
796                <default>%-@nick</default>
797
798                <description>
799                        <para>
800                                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.
801                        </para>
802
803                        <para>
804                                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.
805                        </para>
806
807                        <para>
808                                It's easier to describe this setting using a few examples:
809                        </para>
810
811                        <para>
812                                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.
813                        </para>
814
815                        <para>
816                                [%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.
817                        </para>
818
819                        <para>
820                                See <emphasis>help nick_format</emphasis> for more information.
821                        </para>
822                </description>
823        </bitlbee-setting>
824
825        <bitlbee-setting name="nick_source" type="string" scope="account">
826                <default>handle</default>
827                <possible-values>handle, full_name, first_name</possible-values>
828
829                <description>
830                        <para>
831                                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.
832                        </para>
833
834                        <para>
835                                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.
836                        </para>
837                </description>
838        </bitlbee-setting>
839
840        <bitlbee-setting name="oauth" type="boolean" scope="account">
841                <default>true</default>
842
843                <description>
844                        <para>
845                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
846                        </para>
847
848                        <para>
849                                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.
850                        </para>
851
852                        <para>
853                                The resulting access token will be saved permanently, so you have to do this only once.
854                        </para>
855                </description>
856
857        </bitlbee-setting>
858
859        <bitlbee-setting name="ops" type="string" scope="global">
860                <default>both</default>
861                <possible-values>both, root, user, none</possible-values>
862
863                <description>
864                        <para>
865                                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.
866                        </para>
867
868                        <para>
869                                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.
870                        </para>
871                </description>
872        </bitlbee-setting>
873
874        <bitlbee-setting name="password" type="string" scope="both">
875                <description>
876                        <para>
877                                Use this global setting to change your "NickServ" password.
878                        </para>
879                       
880                        <para>
881                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
882                        </para>
883                       
884                        <para>
885                                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.
886                        </para>
887                </description>
888        </bitlbee-setting>
889
890        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
891                <default>false</default>
892
893                <description>
894                        <para>
895                                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.
896                        </para>
897
898                        <para>
899                                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.
900                        </para>
901
902                        <para>
903                                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.
904                        </para>
905                </description>
906        </bitlbee-setting>
907
908        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
909                <default>200</default>
910
911                <description>
912
913                        <para>
914                                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.
915                        </para>
916
917                        <para>
918                                See also the <emphasis>paste_buffer</emphasis> setting.
919                        </para>
920                </description>
921        </bitlbee-setting>
922       
923        <bitlbee-setting name="port" type="integer" scope="account">
924                <description>
925                        <para>
926                                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.
927                        </para>
928                </description>
929        </bitlbee-setting>
930
931        <bitlbee-setting name="priority" type="integer" scope="account">
932                <default>0</default>
933
934                <description>
935                        <para>
936                                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).
937                        </para>
938
939                        <para>
940                                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).
941                        </para>
942                </description>
943        </bitlbee-setting>
944
945        <bitlbee-setting name="private" type="boolean" scope="global">
946                <default>true</default>
947
948                <description>
949                        <para>
950                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
951                        </para>
952
953                        <para>
954                                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.
955                        </para>
956                </description>
957        </bitlbee-setting>
958
959        <bitlbee-setting name="protocol" type="string" scope="channel">
960
961                <description>
962                        <para>
963                                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.
964                        </para>
965                </description>
966        </bitlbee-setting>
967
968        <bitlbee-setting name="query_order" type="string" scope="global">
969                <default>lifo</default>
970                <possible-values>lifo, fifo</possible-values>
971
972                <description>
973                        <para>
974                                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.
975                        </para>
976
977                        <para>
978                                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).
979                        </para>
980                </description>
981        </bitlbee-setting>
982
983        <bitlbee-setting name="resource" type="string" scope="account">
984                <default>BitlBee</default>
985
986                <description>
987                        <para>
988                                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.
989                        </para>
990                </description>
991        </bitlbee-setting>
992
993        <bitlbee-setting name="resource_select" type="string" scope="account">
994                <default>activity</default>
995                <possible-values>priority, activity</possible-values>
996
997                <description>
998                        <para>
999                                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.
1000                        </para>
1001
1002                        <para>
1003                                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).
1004                        </para>
1005                </description>
1006        </bitlbee-setting>
1007
1008        <bitlbee-setting name="root_nick" type="string" scope="global">
1009                <default>root</default>
1010
1011                <description>
1012                        <para>
1013                                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.
1014                        </para>
1015                </description>
1016        </bitlbee-setting>
1017
1018        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1019                <default>true</default>
1020
1021                <description>
1022                        <para>
1023                                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.
1024                        </para>
1025                </description>
1026        </bitlbee-setting>
1027
1028        <bitlbee-setting name="server" type="string" scope="account">
1029                <description>
1030                        <para>
1031                                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.
1032                        </para>
1033                </description>
1034        </bitlbee-setting>
1035
1036        <bitlbee-setting name="show_offline" type="boolean" scope="global">
1037                <default>false</default>
1038
1039                <description>
1040                        <para>
1041                                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.
1042                        </para>
1043                </description>
1044        </bitlbee-setting>
1045
1046        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1047                <default>true</default>
1048
1049                <description>
1050                        <para>
1051                                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.
1052                        </para>
1053                </description>
1054        </bitlbee-setting>
1055
1056        <bitlbee-setting name="ssl" type="boolean" scope="account">
1057                <default>false</default>
1058
1059                <description>
1060                        <para>
1061                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
1062                        </para>
1063                </description>
1064        </bitlbee-setting>
1065
1066        <bitlbee-setting name="status" type="string" scope="both">
1067                <description>
1068                        <para>
1069                                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.
1070                        </para>
1071
1072                        <para>
1073                                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).
1074                        </para>
1075
1076                        <para>
1077                                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>.
1078                        </para>
1079                </description>
1080        </bitlbee-setting>
1081
1082        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1083                <default>true</default>
1084
1085                <description>
1086                        <para>
1087                                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.
1088                        </para>
1089                        <para>
1090                                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.
1091                        </para>
1092                </description>
1093        </bitlbee-setting>
1094
1095        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1096                <default>false</default>
1097
1098                <description>
1099                        <para>
1100                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1101                        </para>
1102                       
1103                        <para>
1104                                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.
1105                        </para>
1106                       
1107                        <para>
1108                                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.
1109                        </para>
1110                </description>
1111        </bitlbee-setting>
1112
1113        <bitlbee-setting name="timezone" type="string" scope="global">
1114                <default>local</default>
1115                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1116
1117                <description>
1118                        <para>
1119                                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.
1120                        </para>
1121
1122                        <para>
1123                                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.
1124                        </para>
1125                </description>
1126        </bitlbee-setting>
1127
1128        <bitlbee-setting name="tls" type="boolean" scope="account">
1129                <default>try</default>
1130
1131                <description>
1132                        <para>
1133                                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.
1134                        </para>
1135
1136                        <para>
1137                                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.
1138                        </para>
1139                </description>
1140        </bitlbee-setting>
1141
1142        <bitlbee-setting name="to_char" type="string" scope="global">
1143                <default>": "</default>
1144
1145                <description>
1146                        <para>
1147                                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>.
1148                        </para>
1149
1150                        <para>
1151                                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.
1152                        </para>
1153                </description>
1154        </bitlbee-setting>
1155
1156        <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel">
1157                <default>true</default>
1158
1159                <description>
1160                        <para>
1161                                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.
1162                        </para>
1163
1164                        <para>
1165                                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.
1166                        </para>
1167                </description>
1168        </bitlbee-setting>
1169
1170        <bitlbee-setting name="type" type="string" scope="channel">
1171                <default>control</default>
1172                <possible-values>control, chat</possible-values>
1173
1174                <description>
1175                        <para>
1176                                BitlBee supports two kinds of channels: control channels (usually with a name starting with a &amp;) and chatroom channels (name usually starts with a #).
1177                        </para>
1178
1179                        <para>
1180                                See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee.
1181                        </para>
1182                </description>
1183        </bitlbee-setting>
1184
1185        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1186                <default>false</default>
1187
1188                <description>
1189                        <para>
1190                                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.
1191                        </para>
1192                </description>
1193        </bitlbee-setting>
1194
1195        <bitlbee-setting name="user_agent" type="string" scope="account">
1196                <default>BitlBee</default>
1197
1198                <description>
1199                        <para>
1200                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
1201                        </para>
1202                       
1203                        <para>
1204                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
1205                        </para>
1206                </description>
1207        </bitlbee-setting>
1208
1209        <bitlbee-setting name="web_aware" type="string" scope="account">
1210                <default>false</default>
1211
1212                <description>
1213                        <para>
1214                                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.
1215                        </para>
1216
1217                        <para>
1218                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1219                        </para>
1220                </description>
1221        </bitlbee-setting>
1222
1223        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1224                <default>false</default>
1225
1226                <description>
1227                        <para>
1228                                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.
1229                        </para>
1230                        <para>
1231                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1232                        </para>
1233                </description>
1234        </bitlbee-setting>
1235
1236        <bitlbee-command name="rename">
1237                <short-description>Rename (renick) a buddy</short-description>
1238                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1239
1240                <description>
1241                        <para>
1242                                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).
1243                        </para>
1244                </description>
1245
1246                <ircexample>
1247                        <ircline nick="itsme">rename itsme_ you</ircline>
1248                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1249                </ircexample>
1250
1251        </bitlbee-command>
1252
1253        <bitlbee-command name="yes">
1254                <short-description>Accept a request</short-description>
1255                <syntax>yes [&lt;number&gt;]</syntax>
1256
1257                <description>
1258                        <para>
1259                                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.
1260                        </para>
1261
1262                        <para>
1263                                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.
1264                        </para>
1265                </description>
1266
1267        </bitlbee-command>
1268
1269        <bitlbee-command name="no">
1270                <short-description>Deny a request</short-description>
1271                <syntax>no [&lt;number&gt;]</syntax>
1272
1273                <description>
1274                        <para>
1275                                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.
1276                        </para>
1277
1278                        <para>
1279                                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.
1280                        </para>
1281                </description>
1282        </bitlbee-command>
1283
1284        <bitlbee-command name="qlist">
1285                <short-description>List all the unanswered questions root asked</short-description>
1286                <syntax>qlist</syntax>
1287
1288                <description>
1289                        <para>
1290                                This gives you a list of all the unanswered questions from root.
1291                        </para>
1292                </description>
1293
1294        </bitlbee-command>
1295
1296        <bitlbee-command name="register">
1297                <short-description>Register yourself</short-description>
1298                <syntax>register &lt;password&gt;</syntax>
1299
1300                <description>
1301                        <para>
1302                                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.
1303                        </para>
1304
1305                        <para>
1306                                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.. ;-)
1307                        </para>
1308
1309                        <para>
1310                                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.
1311                        </para>
1312                </description>
1313
1314        </bitlbee-command>
1315
1316        <bitlbee-command name="identify">
1317                <syntax>identify [-noload|-force] &lt;password&gt;</syntax>
1318                <short-description>Identify yourself with your password</short-description>
1319
1320                <description>
1321                        <para>
1322                                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.
1323                        </para>
1324
1325                        <para>
1326                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1327                        </para>
1328
1329                        <para>
1330                                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).
1331                        </para>
1332                       
1333                        <para>
1334                                <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).
1335                        </para>
1336                </description>
1337        </bitlbee-command>
1338
1339        <bitlbee-command name="drop">
1340                <syntax>drop &lt;password&gt;</syntax>
1341                <short-description>Drop your account</short-description>
1342
1343                <description>
1344                        <para>
1345                                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.
1346                        </para>
1347                </description>
1348        </bitlbee-command>
1349
1350        <bitlbee-command name="blist">
1351                <syntax>blist [all|online|offline|away]</syntax>
1352                <short-description>List all the buddies in your contact list</short-description>
1353
1354                <description>
1355                        <para>
1356                                You can get a better 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.
1357                        </para>
1358                </description>
1359
1360        </bitlbee-command>
1361
1362        <bitlbee-command name="group">
1363                <short-description>Contact group management</short-description>
1364                <syntax>group list</syntax>
1365
1366                <description>
1367                        <para>
1368                                Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far.
1369                        </para>
1370                </description>
1371        </bitlbee-command>
1372       
1373        <bitlbee-command name="transfers">
1374                <short-description>Monitor, cancel, or reject file transfers</short-description>
1375                <syntax>transfers [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
1376               
1377                <description>
1378                        <para>
1379                                Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfers &lt;action&gt;</emphasis> for more information.
1380                        </para>
1381
1382                        <ircexample>
1383                                <ircline nick="ulim">transfers</ircline>
1384                        </ircexample>
1385                </description>
1386               
1387                <bitlbee-command name="cancel">
1388                        <short-description>Cancels the file transfer with the given id</short-description>
1389                        <syntax>transfers &lt;cancel&gt; id</syntax>
1390
1391                        <description>
1392                                <para>Cancels the file transfer with the given id</para>
1393                        </description>
1394
1395                        <ircexample>
1396                                <ircline nick="ulim">transfers cancel 1</ircline>
1397                                <ircline nick="root">Canceling file transfer for test</ircline>
1398                        </ircexample>
1399                </bitlbee-command>
1400
1401                <bitlbee-command name="reject">
1402                        <short-description>Rejects all incoming transfers</short-description>
1403                        <syntax>transfers &lt;reject&gt;</syntax>
1404
1405                        <description>
1406                                <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>
1407                        </description>
1408
1409                        <ircexample>
1410                                <ircline nick="ulim">transfers reject</ircline>
1411                        </ircexample>
1412                </bitlbee-command>
1413        </bitlbee-command>
1414       
1415</chapter>
Note: See TracBrowser for help on using the repository browser.