source: doc/user-guide/commands.xml @ 1e52e1f

Last change on this file since 1e52e1f was 69b896b, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-05T12:01:28Z

When addressing people in a chatroom, try to translate the nickname to the
original unstripped version (without ugly underscores, also).

  • Property mode set to 100644
File size: 52.7 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.
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&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;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
280                <syntax>add -tmp &lt;connection&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                </description>
291
292                <ircexample>
293                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
294                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
295                </ircexample>
296        </bitlbee-command>
297
298        <bitlbee-command name="info">
299                <short-description>Request user information</short-description>
300                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
301                <syntax>info &lt;nick&gt;</syntax>
302
303                <description>
304                        <para>
305                                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.
306                        </para>
307                </description>
308
309                <ircexample>
310                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
311                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
312                </ircexample>
313
314        </bitlbee-command>
315
316        <bitlbee-command name="remove">
317                <short-description>Remove a buddy from your contact list</short-description>
318                <syntax>remove &lt;nick&gt;</syntax>
319
320                <description>
321                        <para>
322                                Removes the specified nick from your buddy list.
323                        </para>
324                </description>
325
326                <ircexample>
327                        <ircline nick="ctrlsoft">remove gryp</ircline>
328                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
329                </ircexample>
330
331        </bitlbee-command>
332
333        <bitlbee-command name="block">
334                <short-description>Block someone</short-description>
335                <syntax>block &lt;nick&gt;</syntax>
336                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
337                <syntax>block &lt;connection&gt;</syntax>
338
339                <description>
340                        <para>
341                                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.
342                        </para>
343                       
344                        <para>
345                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
346                        </para>
347                </description>
348        </bitlbee-command>
349
350        <bitlbee-command name="allow">
351                <short-description>Unblock someone</short-description>
352                <syntax>allow &lt;nick&gt;</syntax>
353                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
354
355                <description>
356                        <para>
357                                Reverse of block. Unignores the specified user or user handle on specified connection.
358                        </para>
359                       
360                        <para>
361                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
362                        </para>
363                </description>
364        </bitlbee-command>
365
366        <bitlbee-command name="set">
367                <short-description>Miscellaneous settings</short-description>
368                <syntax>set</syntax>
369                <syntax>set &lt;variable&gt;</syntax>
370                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
371                <syntax>set -del &lt;variable&gt;</syntax>
372
373                <description>
374
375                        <para>
376                                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.
377                        </para>
378
379                        <para>
380                                To get more help information about a setting, try:
381                        </para>
382
383                </description>
384
385                <ircexample>
386                        <ircline nick="ctrlsoft">help set private</ircline>
387                </ircexample>
388
389        </bitlbee-command>
390
391        <bitlbee-command name="help">
392                <short-description>BitlBee help system</short-description>
393
394                <syntax>help [subject]</syntax>
395
396                <description>
397                        <para>
398                                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.
399                        </para>
400                </description>
401        </bitlbee-command>
402
403        <bitlbee-command name="save">
404                <short-description>Save your account data</short-description>
405                <syntax>save</syntax>
406
407                <description>
408                        <para>
409                                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... ;-)
410                        </para>
411                </description>
412        </bitlbee-command>
413
414        <bitlbee-setting name="account" type="string" scope="channel">
415
416                <description>
417                        <para>
418                                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.
419                        </para>
420                </description>
421        </bitlbee-setting>
422
423        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
424                <default>true</default>
425
426                <description>
427                        <para>
428                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
429                        </para>
430                       
431                        <para>
432                                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!)
433                        </para>
434                </description>
435        </bitlbee-setting>
436
437        <bitlbee-setting name="auto_join" type="boolean" scope="channel">
438                <default>false</default>
439
440                <description>
441                        <para>
442                                With this option enabled, BitlBee will automatically join this channel when you log in.
443                        </para>
444                </description>
445        </bitlbee-setting>
446
447        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
448                <default>true</default>
449
450                <description>
451                        <para>
452                                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.
453                        </para>
454
455                        <para>
456                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
457                        </para>
458
459                        <para>
460                                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!)
461                        </para>
462                </description>
463        </bitlbee-setting>
464
465        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
466                <default>5*3&lt;900</default>
467
468                <description>
469                        <para>
470                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
471                        </para>
472
473                        <para>
474                                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.
475                        </para>
476
477                        <para>
478                                See also the <emphasis>auto_reconnect</emphasis> setting.
479                        </para>
480                </description>
481        </bitlbee-setting>
482
483        <bitlbee-setting name="away" type="string" scope="both">
484                <description>
485                        <para>
486                                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.
487                        </para>
488
489                        <para>
490                                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.
491                        </para>
492
493                        <para>
494                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
495                        </para>
496                </description>
497        </bitlbee-setting>
498
499        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
500                <default>true</default>
501
502                <description>
503                        <para>
504                                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.
505                        </para>
506                </description>
507        </bitlbee-setting>
508
509        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
510                <default>3600</default>
511
512                <description>
513                        <para>
514                                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.
515                        </para>
516
517                        <para>
518                                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.
519                        </para>
520                </description>
521        </bitlbee-setting>
522
523        <bitlbee-setting name="charset" type="string" scope="global">
524                <default>utf-8</default>
525                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
526
527                <description>
528                        <para>
529                                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.
530                        </para>
531
532                        <para>
533                                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
534                        </para>
535                </description>
536
537        </bitlbee-setting>
538
539        <bitlbee-setting name="control_channel" type="string" scope="global">
540                <default>&amp;bitlbee</default>
541
542                <description>
543                        <para>
544                                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.
545                        </para>
546                </description>
547        </bitlbee-setting>
548
549        <bitlbee-setting name="chat_type" type="string" scope="channel">
550                <default>groupchat</default>
551                <possible-values>groupchat, room</possible-values>
552
553                <description>
554                        <para>
555                                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.
556                        </para>
557                       
558                        <para>
559                                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.
560                        </para>
561                       
562                        <para>
563                                For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command.
564                        </para>
565                </description>
566        </bitlbee-setting>
567
568        <bitlbee-setting name="debug" type="boolean" scope="global">
569                <default>false</default>
570
571                <description>
572                        <para>
573                                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.
574                        </para>
575                </description>
576        </bitlbee-setting>
577
578        <bitlbee-setting name="default_target" type="string" scope="global">
579                <default>root</default>
580                <possible-values>root, last</possible-values>
581
582                <description>
583                        <para>
584                                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>.
585                        </para>
586                </description>
587        </bitlbee-setting>
588
589        <bitlbee-setting name="display_name" type="string" scope="account">
590                <description>
591                        <para>
592                                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.
593                        </para>
594                </description>
595        </bitlbee-setting>
596
597        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
598                <default>false</default>
599
600                <description>
601                        <para>
602                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
603                        </para>
604                </description>
605        </bitlbee-setting>
606
607        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
608                <default>true</default>
609
610                <description>
611                        <para>
612                                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.
613                        </para>
614                </description>
615        </bitlbee-setting>
616
617        <bitlbee-setting name="fill_by" type="string" scope="channel">
618                <default>all</default>
619                <possible-values>all, group, account, protocol</possible-values>
620
621                <description>
622                        <para>
623                                For control channels only: This setting determines which contacts the channel gets populated with.
624                        </para>
625
626                        <para>
627                                By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol.
628                        </para>
629                       
630                        <para>
631                                Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection.
632                        </para>
633                       
634                        <para>
635                                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>.
636                        </para>
637                </description>
638        </bitlbee-setting>
639
640        <bitlbee-setting name="group" type="string" scope="channel">
641
642                <description>
643                        <para>
644                                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.
645                        </para>
646                </description>
647        </bitlbee-setting>
648
649        <bitlbee-setting name="handle_unknown" type="string" scope="global">
650                <default>add_channel</default>
651                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
652
653                <description>
654                        <para>
655                                Messages from unknown users are echoed like this by default:
656                        </para>
657
658                        <ircexample>
659                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
660                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
661                        </ircexample>
662
663                        <para>
664                                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.
665                        </para>
666
667                        <note>
668                                <para>
669                                        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.
670                                </para>
671                        </note>
672                </description>
673
674        </bitlbee-setting>
675
676        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
677                <default>false</default>
678
679                <description>
680                        <para>
681                                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.
682                        </para>
683                </description>
684
685        </bitlbee-setting>
686
687        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
688                <default>true</default>
689
690                <description>
691                        <para>
692                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
693                        </para>
694                </description>
695
696        </bitlbee-setting>
697
698        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
699                <default>false</default>
700
701                <description>
702                        <para>
703                                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.
704                        </para>
705                </description>
706
707        </bitlbee-setting>
708
709        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
710                <default>false</default>
711
712                <description>
713                        <para>
714                                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.
715                        </para>
716                </description>
717
718        </bitlbee-setting>
719
720        <bitlbee-setting name="message_length" type="integer" scope="account">
721                <default>140</default>
722
723                <description>
724                        <para>
725                                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.
726                        </para>
727
728                        <para>
729                                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.
730                        </para>
731                </description>
732
733        </bitlbee-setting>
734
735        <bitlbee-setting name="mode" type="string" scope="account">
736                <possible-values>one, many, chat</possible-values>
737                <default>one</default>
738
739                <description>
740                        <para>
741                                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.
742                        </para>
743                       
744                        <para>
745                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
746                        </para>
747                       
748                        <para>
749                                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.
750                        </para>
751                </description>
752
753        </bitlbee-setting>
754
755        <bitlbee-setting name="nick" type="string" scope="chat">
756
757                <description>
758                        <para>
759                                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.
760                        </para>
761                </description>
762        </bitlbee-setting>
763
764        <bitlbee-setting name="nick_source" type="string" scope="account">
765                <default>handle</default>
766                <possible-values>handle, full_name, first_name</possible-values>
767
768                <description>
769                        <para>
770                                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.
771                        </para>
772
773                        <para>
774                                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.
775                        </para>
776                </description>
777        </bitlbee-setting>
778
779        <bitlbee-setting name="oauth" type="boolean" scope="account">
780                <default>true</default>
781
782                <description>
783                        <para>
784                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
785                        </para>
786
787                        <para>
788                                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.
789                        </para>
790
791                        <para>
792                                The resulting access token will be saved permanently, so you have to do this only once.
793                        </para>
794                </description>
795
796        </bitlbee-setting>
797
798        <bitlbee-setting name="ops" type="string" scope="global">
799                <default>both</default>
800                <possible-values>both, root, user, none</possible-values>
801
802                <description>
803                        <para>
804                                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.
805                        </para>
806
807                        <para>
808                                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.
809                        </para>
810                </description>
811        </bitlbee-setting>
812
813        <bitlbee-setting name="password" type="string" scope="both">
814                <description>
815                        <para>
816                                Use this global setting to change your "NickServ" password.
817                        </para>
818                       
819                        <para>
820                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
821                        </para>
822                       
823                        <para>
824                                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.
825                        </para>
826                </description>
827        </bitlbee-setting>
828
829        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
830                <default>false</default>
831
832                <description>
833                        <para>
834                                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.
835                        </para>
836
837                        <para>
838                                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.
839                        </para>
840
841                        <para>
842                                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.
843                        </para>
844                </description>
845        </bitlbee-setting>
846
847        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
848                <default>200</default>
849
850                <description>
851
852                        <para>
853                                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.
854                        </para>
855
856                        <para>
857                                See also the <emphasis>paste_buffer</emphasis> setting.
858                        </para>
859                </description>
860        </bitlbee-setting>
861       
862        <bitlbee-setting name="port" type="integer" scope="account">
863                <description>
864                        <para>
865                                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.
866                        </para>
867                </description>
868        </bitlbee-setting>
869
870        <bitlbee-setting name="priority" type="integer" scope="account">
871                <default>0</default>
872
873                <description>
874                        <para>
875                                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).
876                        </para>
877
878                        <para>
879                                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).
880                        </para>
881                </description>
882        </bitlbee-setting>
883
884        <bitlbee-setting name="private" type="boolean" scope="global">
885                <default>true</default>
886
887                <description>
888                        <para>
889                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
890                        </para>
891
892                        <para>
893                                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.
894                        </para>
895                </description>
896        </bitlbee-setting>
897
898        <bitlbee-setting name="protocol" type="string" scope="channel">
899
900                <description>
901                        <para>
902                                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.
903                        </para>
904                </description>
905        </bitlbee-setting>
906
907        <bitlbee-setting name="query_order" type="string" scope="global">
908                <default>lifo</default>
909                <possible-values>lifo, fifo</possible-values>
910
911                <description>
912                        <para>
913                                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.
914                        </para>
915
916                        <para>
917                                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).
918                        </para>
919                </description>
920        </bitlbee-setting>
921
922        <bitlbee-setting name="resource" type="string" scope="account">
923                <default>BitlBee</default>
924
925                <description>
926                        <para>
927                                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.
928                        </para>
929                </description>
930        </bitlbee-setting>
931
932        <bitlbee-setting name="resource_select" type="string" scope="account">
933                <default>activity</default>
934                <possible-values>priority, activity</possible-values>
935
936                <description>
937                        <para>
938                                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.
939                        </para>
940
941                        <para>
942                                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).
943                        </para>
944                </description>
945        </bitlbee-setting>
946
947        <bitlbee-setting name="root_nick" type="string" scope="global">
948                <default>root</default>
949
950                <description>
951                        <para>
952                                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.
953                        </para>
954                </description>
955        </bitlbee-setting>
956
957        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
958                <default>true</default>
959
960                <description>
961                        <para>
962                                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.
963                        </para>
964                </description>
965        </bitlbee-setting>
966
967        <bitlbee-setting name="server" type="string" scope="account">
968                <description>
969                        <para>
970                                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.
971                        </para>
972                </description>
973        </bitlbee-setting>
974
975        <bitlbee-setting name="show_offline" type="boolean" scope="global">
976                <default>false</default>
977
978                <description>
979                        <para>
980                                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.
981                        </para>
982                </description>
983        </bitlbee-setting>
984
985        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
986                <default>true</default>
987
988                <description>
989                        <para>
990                                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.
991                        </para>
992                </description>
993        </bitlbee-setting>
994
995        <bitlbee-setting name="ssl" type="boolean" scope="account">
996                <default>false</default>
997
998                <description>
999                        <para>
1000                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
1001                        </para>
1002                </description>
1003        </bitlbee-setting>
1004
1005        <bitlbee-setting name="status" type="string" scope="both">
1006                <description>
1007                        <para>
1008                                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.
1009                        </para>
1010
1011                        <para>
1012                                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).
1013                        </para>
1014
1015                        <para>
1016                                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>.
1017                        </para>
1018                </description>
1019        </bitlbee-setting>
1020
1021        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1022                <default>true</default>
1023
1024                <description>
1025                        <para>
1026                                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.
1027                        </para>
1028                        <para>
1029                                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.
1030                        </para>
1031                </description>
1032        </bitlbee-setting>
1033
1034        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1035                <default>false</default>
1036
1037                <description>
1038                        <para>
1039                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1040                        </para>
1041                       
1042                        <para>
1043                                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.
1044                        </para>
1045                       
1046                        <para>
1047                                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.
1048                        </para>
1049                </description>
1050        </bitlbee-setting>
1051
1052        <bitlbee-setting name="timezone" type="string" scope="global">
1053                <default>local</default>
1054                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1055
1056                <description>
1057                        <para>
1058                                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.
1059                        </para>
1060
1061                        <para>
1062                                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.
1063                        </para>
1064                </description>
1065        </bitlbee-setting>
1066
1067        <bitlbee-setting name="tls" type="boolean" scope="account">
1068                <default>try</default>
1069
1070                <description>
1071                        <para>
1072                                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.
1073                        </para>
1074
1075                        <para>
1076                                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.
1077                        </para>
1078                </description>
1079        </bitlbee-setting>
1080
1081        <bitlbee-setting name="to_char" type="string" scope="global">
1082                <default>": "</default>
1083
1084                <description>
1085                        <para>
1086                                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>.
1087                        </para>
1088
1089                        <para>
1090                                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.
1091                        </para>
1092                </description>
1093        </bitlbee-setting>
1094
1095        <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel">
1096                <default>true</default>
1097
1098                <description>
1099                        <para>
1100                                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.
1101                        </para>
1102
1103                        <para>
1104                                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.
1105                        </para>
1106                </description>
1107        </bitlbee-setting>
1108
1109        <bitlbee-setting name="type" type="string" scope="channel">
1110                <default>control</default>
1111                <possible-values>control, chat</possible-values>
1112
1113                <description>
1114                        <para>
1115                                BitlBee supports two kinds of channels: control channels (usually with a name starting with a &amp;) and chatroom channels (name usually starts with a #).
1116                        </para>
1117
1118                        <para>
1119                                See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee.
1120                        </para>
1121                </description>
1122        </bitlbee-setting>
1123
1124        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1125                <default>false</default>
1126
1127                <description>
1128                        <para>
1129                                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.
1130                        </para>
1131                </description>
1132        </bitlbee-setting>
1133
1134        <bitlbee-setting name="user_agent" type="string" scope="account">
1135                <default>BitlBee</default>
1136
1137                <description>
1138                        <para>
1139                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
1140                        </para>
1141                       
1142                        <para>
1143                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
1144                        </para>
1145                </description>
1146        </bitlbee-setting>
1147
1148        <bitlbee-setting name="web_aware" type="string" scope="account">
1149                <default>false</default>
1150
1151                <description>
1152                        <para>
1153                                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.
1154                        </para>
1155
1156                        <para>
1157                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1158                        </para>
1159                </description>
1160        </bitlbee-setting>
1161
1162        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1163                <default>false</default>
1164
1165                <description>
1166                        <para>
1167                                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.
1168                        </para>
1169                        <para>
1170                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1171                        </para>
1172                </description>
1173        </bitlbee-setting>
1174
1175        <bitlbee-command name="rename">
1176                <short-description>Rename (renick) a buddy</short-description>
1177                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1178
1179                <description>
1180                        <para>
1181                                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).
1182                        </para>
1183                </description>
1184
1185                <ircexample>
1186                        <ircline nick="itsme">rename itsme_ you</ircline>
1187                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1188                </ircexample>
1189
1190        </bitlbee-command>
1191
1192        <bitlbee-command name="yes">
1193                <short-description>Accept a request</short-description>
1194                <syntax>yes [&lt;number&gt;]</syntax>
1195
1196                <description>
1197                        <para>
1198                                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.
1199                        </para>
1200
1201                        <para>
1202                                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.
1203                        </para>
1204                </description>
1205
1206        </bitlbee-command>
1207
1208        <bitlbee-command name="no">
1209                <short-description>Deny a request</short-description>
1210                <syntax>no [&lt;number&gt;]</syntax>
1211
1212                <description>
1213                        <para>
1214                                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.
1215                        </para>
1216
1217                        <para>
1218                                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.
1219                        </para>
1220                </description>
1221        </bitlbee-command>
1222
1223        <bitlbee-command name="qlist">
1224                <short-description>List all the unanswered questions root asked</short-description>
1225                <syntax>qlist</syntax>
1226
1227                <description>
1228                        <para>
1229                                This gives you a list of all the unanswered questions from root.
1230                        </para>
1231                </description>
1232
1233        </bitlbee-command>
1234
1235        <bitlbee-command name="register">
1236                <short-description>Register yourself</short-description>
1237                <syntax>register &lt;password&gt;</syntax>
1238
1239                <description>
1240                        <para>
1241                                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.
1242                        </para>
1243
1244                        <para>
1245                                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.. ;-)
1246                        </para>
1247
1248                        <para>
1249                                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.
1250                        </para>
1251                </description>
1252
1253        </bitlbee-command>
1254
1255        <bitlbee-command name="identify">
1256                <syntax>identify [-noload|-force] &lt;password&gt;</syntax>
1257                <short-description>Identify yourself with your password</short-description>
1258
1259                <description>
1260                        <para>
1261                                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.
1262                        </para>
1263
1264                        <para>
1265                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1266                        </para>
1267
1268                        <para>
1269                                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).
1270                        </para>
1271                       
1272                        <para>
1273                                <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).
1274                        </para>
1275                </description>
1276        </bitlbee-command>
1277
1278        <bitlbee-command name="drop">
1279                <syntax>drop &lt;password&gt;</syntax>
1280                <short-description>Drop your account</short-description>
1281
1282                <description>
1283                        <para>
1284                                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.
1285                        </para>
1286                </description>
1287        </bitlbee-command>
1288
1289        <bitlbee-command name="blist">
1290                <syntax>blist [all|online|offline|away]</syntax>
1291                <short-description>List all the buddies in your contact list</short-description>
1292
1293                <description>
1294                        <para>
1295                                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.
1296                        </para>
1297                </description>
1298
1299        </bitlbee-command>
1300
1301        <bitlbee-command name="nick">
1302                <short-description>Change friendly name, nick</short-description>
1303                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
1304                <syntax>nick &lt;connection&gt;</syntax>
1305
1306                <description>
1307                        <para>
1308                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
1309                        </para>
1310                </description>
1311
1312                <ircexample>
1313                        <ircline nick="wouter">account 1 set display_name "The majestik møøse"</ircline>
1314                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
1315                </ircexample>
1316
1317        </bitlbee-command>
1318       
1319        <bitlbee-command name="transfers">
1320                <short-description>Monitor, cancel, or reject file transfers</short-description>
1321                <syntax>transfers [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
1322               
1323                <description>
1324                        <para>
1325                                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.
1326                        </para>
1327
1328                        <ircexample>
1329                                <ircline nick="ulim">transfers</ircline>
1330                        </ircexample>
1331                </description>
1332               
1333                <bitlbee-command name="cancel">
1334                        <short-description>Cancels the file transfer with the given id</short-description>
1335                        <syntax>transfers &lt;cancel&gt; id</syntax>
1336
1337                        <description>
1338                                <para>Cancels the file transfer with the given id</para>
1339                        </description>
1340
1341                        <ircexample>
1342                                <ircline nick="ulim">transfers cancel 1</ircline>
1343                                <ircline nick="root">Canceling file transfer for test</ircline>
1344                        </ircexample>
1345                </bitlbee-command>
1346
1347                <bitlbee-command name="reject">
1348                        <short-description>Rejects all incoming transfers</short-description>
1349                        <syntax>transfers &lt;reject&gt;</syntax>
1350
1351                        <description>
1352                                <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>
1353                        </description>
1354
1355                        <ircexample>
1356                                <ircline nick="ulim">transfers reject</ircline>
1357                        </ircexample>
1358                </bitlbee-command>
1359        </bitlbee-command>
1360       
1361</chapter>
Note: See TracBrowser for help on using the repository browser.