source: doc/user-guide/commands.xml @ 814aa52

Last change on this file since 814aa52 was 814aa52, checked in by Sven Moritz Hallberg <pesco@…>, at 2010-06-03T11:00:45Z

merge in bitlbee 1.2.6
  • Property mode set to 100644
File size: 50.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;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                                </description>
82                        </bitlbee-command>
83
84                        <bitlbee-command name="yahoo">
85                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
86
87                                <description>
88                                        <para>
89                                                For Yahoo! connections there are no special arguments.
90                                        </para>
91                                </description>
92                        </bitlbee-command>
93
94                </bitlbee-command>
95
96                <bitlbee-command name="del">
97                        <syntax>account del &lt;account id&gt;</syntax>
98
99                        <description>
100                                <para>
101                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
102                                </para>
103
104
105                                <para>
106                                        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.
107                                </para>
108                        </description>
109                </bitlbee-command>
110
111                <bitlbee-command name="on">
112                        <syntax>account on [&lt;account id&gt;]</syntax>
113
114                        <description>
115                                <para>
116                                        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.
117                                </para>
118
119                                <para>
120                                        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.
121                                </para>
122                        </description>
123
124                </bitlbee-command>
125
126                <bitlbee-command name="off">
127                        <syntax>account off [&lt;account id&gt;]</syntax>
128
129                        <description>
130                                <para>
131                                        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.
132                                </para>
133
134                                <para>
135                                        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.
136                                </para>
137                        </description>
138                </bitlbee-command>
139
140                <bitlbee-command name="list">
141                        <syntax>account list</syntax>
142
143                        <description>
144                                <para>
145                                        This command gives you a list of all the accounts known by BitlBee.
146                                </para>
147                        </description>
148                </bitlbee-command>
149
150                <bitlbee-command name="set">
151                        <syntax>account set &lt;account id&gt;</syntax>
152                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
153                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
154                        <syntax>account set -del &lt;account id&gt;/&lt;setting&gt;</syntax>
155
156                        <description>
157                                <para>
158                                        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 set &lt;account id&gt;</emphasis>.
159                                </para>
160                               
161                                <para>
162                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
163                                </para>
164                               
165                                <para>
166                                        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.
167                                </para>
168                        </description>
169                </bitlbee-command>
170        </bitlbee-command>
171
172        <bitlbee-command name="chat">
173                <short-description>Chatroom list maintenance</short-description>
174                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
175
176                <description>
177
178                        <para>
179                                Available actions: add, del, list, with and set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
180                        </para>
181
182                </description>
183
184                <bitlbee-command name="add">
185                        <syntax>chat add &lt;account&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
186
187                        <description>
188                                <para>
189                                        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.
190                                </para>
191
192                                <para>
193                                        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>)
194                                </para>
195
196                                <para>
197                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
198                                </para>
199                        </description>
200
201                </bitlbee-command>
202
203                <bitlbee-command name="del">
204                        <syntax>chat del &lt;chat id&gt;</syntax>
205
206                        <description>
207                                <para>
208                                        This commands deletes an chatroom from your list.
209                                </para>
210
211                                <para>
212                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
213                                </para>
214                        </description>
215                </bitlbee-command>
216
217                <bitlbee-command name="list">
218                        <syntax>chat list</syntax>
219
220                        <description>
221                                <para>
222                                        This command gives you a list of all the chatrooms known by BitlBee.
223                                </para>
224                        </description>
225                </bitlbee-command>
226
227                <bitlbee-command name="with">
228                        <syntax>chat with &lt;nickname&gt;</syntax>
229
230                        <description>
231                                <para>
232                                        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.
233                                </para>
234                        </description>
235                </bitlbee-command>
236
237                <bitlbee-command name="set">
238                        <syntax>chat set &lt;chat id&gt;</syntax>
239                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
240                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
241                        <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</syntax>
242
243                        <description>
244                                <para>
245                                        This command can be used to change various settings for chatrooms.
246                                </para>
247                               
248                                <para>
249                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
250                                </para>
251                               
252                                <para>
253                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
254                                </para>
255                        </description>
256                </bitlbee-command>
257        </bitlbee-command>
258
259        <bitlbee-command name="add">
260                <short-description>Add a buddy to your contact list</short-description>
261                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
262                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
263
264                <description>
265                        <para>
266                                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.
267                        </para>
268
269                        <para>
270                                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.
271                        </para>
272                </description>
273
274                <ircexample>
275                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
276                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
277                </ircexample>
278        </bitlbee-command>
279
280        <bitlbee-command name="info">
281                <short-description>Request user information</short-description>
282                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
283                <syntax>info &lt;nick&gt;</syntax>
284
285                <description>
286                        <para>
287                                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.
288                        </para>
289                </description>
290
291                <ircexample>
292                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
293                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
294                </ircexample>
295
296        </bitlbee-command>
297
298        <bitlbee-command name="remove">
299                <short-description>Remove a buddy from your contact list</short-description>
300                <syntax>remove &lt;nick&gt;</syntax>
301
302                <description>
303                        <para>
304                                Removes the specified nick from your buddy list.
305                        </para>
306                </description>
307
308                <ircexample>
309                        <ircline nick="ctrlsoft">remove gryp</ircline>
310                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
311                </ircexample>
312
313        </bitlbee-command>
314
315        <bitlbee-command name="block">
316                <short-description>Block someone</short-description>
317                <syntax>block &lt;nick&gt;</syntax>
318                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
319                <syntax>block &lt;connection&gt;</syntax>
320
321                <description>
322                        <para>
323                                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.
324                        </para>
325                       
326                        <para>
327                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
328                        </para>
329                </description>
330        </bitlbee-command>
331
332        <bitlbee-command name="allow">
333                <short-description>Unblock someone</short-description>
334                <syntax>allow &lt;nick&gt;</syntax>
335                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
336
337                <description>
338                        <para>
339                                Reverse of block. Unignores the specified user or user handle on specified connection.
340                        </para>
341                       
342                        <para>
343                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
344                        </para>
345                </description>
346        </bitlbee-command>
347       
348        <bitlbee-command name="otr">
349                <short-description>Off-the-Record encryption control</short-description>
350                <syntax>otr &lt;subcommand&gt; [&lt;arguments&gt;]</syntax>
351
352                <description>
353
354                        <para>
355                                Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr &lt;subcommand&gt;</emphasis> for more information.
356                        </para>
357
358                </description>
359               
360                <bitlbee-command name="connect">
361                        <syntax>otr connect &lt;nick&gt;</syntax>
362                       
363                        <description>
364                       
365                                <para>
366                                        Attempts to establish an encrypted connection with the specified user by sending a magic string.
367                                </para>
368                               
369                        </description>
370               
371                </bitlbee-command>
372               
373                <bitlbee-command name="disconnect">
374                        <syntax>otr disconnect &lt;nick&gt;</syntax>
375                       
376                        <description>
377                       
378                                <para>
379                                        Resets the connection with the specified user to cleartext.
380                                </para>
381                               
382                        </description>
383               
384                </bitlbee-command>
385               
386                <bitlbee-command name="smp">
387                        <syntax>otr smp &lt;nick&gt; &lt;secret&gt;</syntax>
388                       
389                        <description>
390                       
391                                <para>
392                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
393                                </para>
394                               
395                                <para>
396                                        If an SMP challenge has already been received from the given user, responds with the specified secret. Otherwise, a challenge for the secret will be sent. If the protocol succeeds (i.e. both parties gave the same secret), the fingerprint will be trusted.
397                                </para>
398                               
399                        </description>
400               
401                </bitlbee-command>
402               
403                <bitlbee-command name="trust">
404                        <syntax>otr trust &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</syntax>
405                       
406                        <description>
407                       
408                                <para>
409                                        Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
410                                </para>
411                               
412                        </description>
413               
414                </bitlbee-command>
415               
416                <bitlbee-command name="info">
417                        <syntax>otr info</syntax>
418                        <syntax>otr info &lt;nick&gt;</syntax>
419                       
420                        <description>
421                       
422                                <para>
423                                        Shows information about the OTR state. The first form lists our private keys and current OTR contexts. The second form displays information about the connection with a given user, including the list of their known fingerprints.
424                                </para>
425                               
426                        </description>
427               
428                </bitlbee-command>
429               
430                <bitlbee-command name="keygen">
431                        <syntax>otr keygen &lt;account-no&gt;</syntax>
432                       
433                        <description>
434                       
435                                <para>
436                                        Generates a new OTR private key for the given account.
437                                </para>
438                               
439                        </description>
440               
441                </bitlbee-command>
442               
443                <bitlbee-command name="forget">
444                        <syntax>otr forget &lt;thing&gt; &lt;arguments&gt;</syntax>
445                       
446                        <description>
447                       
448                                <para>
449                                        Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget &lt;thing&gt;</emphasis> for more information.
450                                </para>
451                       
452                        </description>
453                       
454                        <bitlbee-command name="fingerprint">
455                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</syntax>
456                               
457                                <description>
458                               
459                                        <para>
460                                                Drops the specified fingerprint from the given user's OTR connection context. It is allowed to specify only a (unique) prefix of the desired fingerprint.
461                                        </para>
462                                       
463                                </description>
464                               
465                        </bitlbee-command>
466                               
467                        <bitlbee-command name="context">
468                                <syntax>otr forget context &lt;nick&gt;</syntax>
469                               
470                                <description>
471                               
472                                        <para>
473                                                Forgets the entire OTR context associated with the given user. This includes current message and protocol states, as well as any fingerprints for that user.
474                                        </para>
475                                       
476                                </description>
477                               
478                        </bitlbee-command>
479
480                        <bitlbee-command name="key">
481                                <syntax>otr forget key &lt;fingerprint&gt;</syntax>
482                               
483                                <description>
484                               
485                                        <para>
486                                                Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
487                                        </para>
488                                       
489                                </description>
490                               
491                        </bitlbee-command>
492               
493                </bitlbee-command>
494               
495        </bitlbee-command>
496
497        <bitlbee-command name="set">
498                <short-description>Miscellaneous settings</short-description>
499                <syntax>set</syntax>
500                <syntax>set &lt;variable&gt;</syntax>
501                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
502                <syntax>set -del &lt;variable&gt;</syntax>
503
504                <description>
505
506                        <para>
507                                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.
508                        </para>
509
510                        <para>
511                                To get more help information about a setting, try:
512                        </para>
513
514                </description>
515
516                <ircexample>
517                        <ircline nick="ctrlsoft">help set private</ircline>
518                </ircexample>
519
520        </bitlbee-command>
521
522        <bitlbee-command name="help">
523                <short-description>BitlBee help system</short-description>
524
525                <syntax>help [subject]</syntax>
526
527                <description>
528                        <para>
529                                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.
530                        </para>
531                </description>
532        </bitlbee-command>
533
534        <bitlbee-command name="save">
535                <short-description>Save your account data</short-description>
536                <syntax>save</syntax>
537
538                <description>
539                        <para>
540                                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... ;-)
541                        </para>
542                </description>
543        </bitlbee-command>
544
545        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
546                <default>true</default>
547
548                <description>
549                        <para>
550                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
551                        </para>
552                       
553                        <para>
554                                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!)
555                        </para>
556                </description>
557        </bitlbee-setting>
558
559        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
560                <default>false</default>
561
562                <description>
563                        <para>
564                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
565                        </para>
566                </description>
567        </bitlbee-setting>
568
569        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
570                <default>true</default>
571
572                <description>
573                        <para>
574                                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.
575                        </para>
576
577                        <para>
578                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
579                        </para>
580
581                        <para>
582                                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!)
583                        </para>
584                </description>
585        </bitlbee-setting>
586
587        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
588                <default>5*3&lt;900</default>
589
590                <description>
591                        <para>
592                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
593                        </para>
594
595                        <para>
596                                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.
597                        </para>
598
599                        <para>
600                                See also the <emphasis>auto_reconnect</emphasis> setting.
601                        </para>
602                </description>
603        </bitlbee-setting>
604
605        <bitlbee-setting name="away" type="string" scope="both">
606                <description>
607                        <para>
608                                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.
609                        </para>
610
611                        <para>
612                                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.
613                        </para>
614
615                        <para>
616                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
617                        </para>
618                </description>
619        </bitlbee-setting>
620
621        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
622                <default>true</default>
623
624                <description>
625                        <para>
626                                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.
627                        </para>
628                </description>
629        </bitlbee-setting>
630
631        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
632                <default>false</default>
633
634                <description>
635                        <para>
636                                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.
637                        </para>
638
639                        <para>
640                                Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
641                        </para>
642
643                        <para>
644                                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.
645                        </para>
646                </description>
647        </bitlbee-setting>
648
649        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
650                <default>200</default>
651
652                <description>
653
654                        <para>
655                                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.
656                        </para>
657
658                        <para>
659                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
660                        </para>
661                </description>
662        </bitlbee-setting>
663
664        <bitlbee-setting name="charset" type="string" scope="global">
665                <default>utf-8</default>
666                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
667
668                <description>
669                        <para>
670                                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.
671                        </para>
672
673                        <para>
674                                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
675                        </para>
676                </description>
677
678        </bitlbee-setting>
679
680        <bitlbee-setting name="color_encrypted" type="boolean" scope="global">
681                <default>true</default>
682
683                <description>
684                        <para>
685                                If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
686                        </para>
687                </description>
688        </bitlbee-setting>
689
690        <bitlbee-setting name="control_channel" type="string" scope="global">
691                <default>&amp;bitlbee</default>
692
693                <description>
694                        <para>
695                                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.
696                        </para>
697                </description>
698        </bitlbee-setting>
699
700        <bitlbee-setting name="debug" type="boolean" scope="global">
701                <default>false</default>
702
703                <description>
704                        <para>
705                                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.
706                        </para>
707                </description>
708        </bitlbee-setting>
709
710        <bitlbee-setting name="default_target" type="string" scope="global">
711                <default>root</default>
712                <possible-values>root, last</possible-values>
713
714                <description>
715                        <para>
716                                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>.
717                        </para>
718                </description>
719        </bitlbee-setting>
720
721        <bitlbee-setting name="display_name" type="string" scope="account">
722                <description>
723                        <para>
724                                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.
725                        </para>
726                </description>
727        </bitlbee-setting>
728
729        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
730                <default>false</default>
731
732                <description>
733                        <para>
734                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
735                        </para>
736                </description>
737        </bitlbee-setting>
738
739        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
740                <default>true</default>
741
742                <description>
743                        <para>
744                                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.
745                        </para>
746                </description>
747        </bitlbee-setting>
748
749        <bitlbee-setting name="handle_unknown" type="string" scope="global">
750                <default>root</default>
751                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
752
753                <description>
754                        <para>
755                                Messages from unknown users are echoed like this by default:
756                        </para>
757
758                        <ircexample>
759                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
760                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
761                        </ircexample>
762
763                        <para>
764                                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.
765                        </para>
766
767                        <note>
768                                <para>
769                                        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.
770                                </para>
771                        </note>
772                </description>
773
774        </bitlbee-setting>
775
776        <bitlbee-setting name="halfop_buddies" type="string" scope="global">
777                <default>encrypted</default>
778                <possible-values>encrypted, trusted, notaway, false</possible-values>
779
780                <description>
781                        <para>
782                                Specifies under which circumstances BitlBee should give the "halfop" mode flag (+h) to buddies.
783                        </para>
784                       
785                        <para>
786                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
787                        </para>
788                </description>
789        </bitlbee-setting>
790
791        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
792                <default>true</default>
793
794                <description>
795                        <para>
796                                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.
797                        </para>
798                </description>
799        </bitlbee-setting>
800
801        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
802                <default>true</default>
803
804                <description>
805                        <para>
806                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
807                        </para>
808                </description>
809
810        </bitlbee-setting>
811
812        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
813                <default>false</default>
814
815                <description>
816                        <para>
817                                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.
818                        </para>
819                </description>
820
821        </bitlbee-setting>
822
823        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
824                <default>false</default>
825
826                <description>
827                        <para>
828                                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.
829                        </para>
830                </description>
831
832        </bitlbee-setting>
833
834        <bitlbee-setting name="op_buddies" type="string" scope="global">
835                <default>trusted</default>
836                <possible-values>encrypted, trusted, notaway, false</possible-values>
837
838                <description>
839                        <para>
840                                Specifies under which circumstances BitlBee should give the "op" mode flag (+o) to buddies.
841                        </para>
842                       
843                        <para>
844                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
845                        </para>
846                </description>
847
848        </bitlbee-setting>
849
850        <bitlbee-setting name="op_root" type="bool" scope="global">
851                <default>true</default>
852
853                <description>
854                        <para>
855                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can set the desired state for root using this setting.
856                        </para>
857                </description>
858        </bitlbee-setting>
859
860        <bitlbee-setting name="op_user" type="bool" scope="global">
861                <default>true</default>
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 set the desired state for yourself using this setting.
866                        </para>
867                </description>
868        </bitlbee-setting>
869
870        <bitlbee-setting name="otr_policy" type="string" scope="global">
871                <default>opportunistic</default>
872                <possible-values>never, opportunistic, manual, always</possible-values>
873
874                <description>
875                        <para>
876                                This setting controls the policy for establishing Off-the-Record connections.
877                        </para>
878                        <para>
879                                A value of "never" effectively disables the OTR subsystem. In "opportunistic" mode, a magic whitespace pattern will be appended to the first message sent to any user. If the peer is also running opportunistic OTR, an encrypted connection will be set up automatically. On "manual", on the other hand, OTR connections must be established explicitly using <emphasis>otr connect</emphasis>. Finally, the setting "always" enforces encrypted communication by causing BitlBee to refuse to send any cleartext messages at all.
880                        </para>
881                </description>
882        </bitlbee-setting>
883
884        <bitlbee-setting name="mode" type="string" scope="account">
885                <possible-values>one, many, chat</possible-values>
886                <default>one</default>
887
888                <description>
889                        <para>
890                                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.
891                        </para>
892                       
893                        <para>
894                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
895                        </para>
896                       
897                        <para>
898                                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.
899                        </para>
900                </description>
901        </bitlbee-setting>
902
903        <bitlbee-setting name="nick" type="string" scope="chat">
904
905                <description>
906                        <para>
907                                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.
908                        </para>
909                </description>
910        </bitlbee-setting>
911
912        <bitlbee-setting name="nick_source" type="string" scope="account">
913                <default>handle</default>
914                <possible-values>handle, full_name, first_name</possible-values>
915
916                <description>
917                        <para>
918                                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.
919                        </para>
920
921                        <para>
922                                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.
923                        </para>
924                </description>
925        </bitlbee-setting>
926
927        <bitlbee-setting name="ops" type="string" scope="global">
928                <default>both</default>
929                <possible-values>both, root, user, none</possible-values>
930
931                <description>
932                        <para>
933                                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.
934                        </para>
935
936                        <para>
937                                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.
938                        </para>
939                </description>
940        </bitlbee-setting>
941
942        <bitlbee-setting name="password" type="string" scope="both">
943                <description>
944                        <para>
945                                Use this global setting to change your "NickServ" password.
946                        </para>
947                       
948                        <para>
949                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
950                        </para>
951                       
952                        <para>
953                                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.
954                        </para>
955                </description>
956        </bitlbee-setting>
957       
958        <bitlbee-setting name="port" type="integer" scope="account">
959                <description>
960                        <para>
961                                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.
962                        </para>
963                </description>
964        </bitlbee-setting>
965
966        <bitlbee-setting name="priority" type="integer" scope="account">
967                <default>0</default>
968
969                <description>
970                        <para>
971                                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).
972                        </para>
973
974                        <para>
975                                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).
976                        </para>
977                </description>
978        </bitlbee-setting>
979
980        <bitlbee-setting name="private" type="boolean" scope="global">
981                <default>true</default>
982
983                <description>
984                        <para>
985                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
986                        </para>
987
988                        <para>
989                                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.
990                        </para>
991                </description>
992        </bitlbee-setting>
993
994        <bitlbee-setting name="query_order" type="string" scope="global">
995                <default>lifo</default>
996                <possible-values>lifo, fifo</possible-values>
997
998                <description>
999                        <para>
1000                                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.
1001                        </para>
1002
1003                        <para>
1004                                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).
1005                        </para>
1006                </description>
1007        </bitlbee-setting>
1008
1009        <bitlbee-setting name="resource" type="string" scope="account">
1010                <default>BitlBee</default>
1011
1012                <description>
1013                        <para>
1014                                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.
1015                        </para>
1016                </description>
1017        </bitlbee-setting>
1018
1019        <bitlbee-setting name="resource_select" type="string" scope="account">
1020                <default>activity</default>
1021                <possible-values>priority, activity</possible-values>
1022
1023                <description>
1024                        <para>
1025                                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.
1026                        </para>
1027
1028                        <para>
1029                                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).
1030                        </para>
1031                </description>
1032        </bitlbee-setting>
1033
1034        <bitlbee-setting name="root_nick" type="string" scope="global">
1035                <default>root</default>
1036
1037                <description>
1038                        <para>
1039                                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.
1040                        </para>
1041                </description>
1042        </bitlbee-setting>
1043
1044        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1045                <default>true</default>
1046
1047                <description>
1048                        <para>
1049                                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.
1050                        </para>
1051                </description>
1052        </bitlbee-setting>
1053
1054        <bitlbee-setting name="server" type="string" scope="account">
1055                <description>
1056                        <para>
1057                                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.
1058                        </para>
1059                </description>
1060        </bitlbee-setting>
1061
1062        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1063                <default>true</default>
1064
1065                <description>
1066                        <para>
1067                                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.
1068                        </para>
1069                </description>
1070        </bitlbee-setting>
1071
1072        <bitlbee-setting name="ssl" type="boolean" scope="account">
1073                <default>false</default>
1074
1075                <description>
1076                        <para>
1077                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
1078                        </para>
1079                </description>
1080        </bitlbee-setting>
1081
1082        <bitlbee-setting name="status" type="string" scope="both">
1083                <description>
1084                        <para>
1085                                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.
1086                        </para>
1087
1088                        <para>
1089                                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).
1090                        </para>
1091
1092                        <para>
1093                                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>.
1094                        </para>
1095                </description>
1096        </bitlbee-setting>
1097
1098        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1099                <default>true</default>
1100
1101                <description>
1102                        <para>
1103                                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.
1104                        </para>
1105                        <para>
1106                                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.
1107                        </para>
1108                </description>
1109        </bitlbee-setting>
1110
1111        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1112                <default>false</default>
1113
1114                <description>
1115                        <para>
1116                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1117                        </para>
1118                       
1119                        <para>
1120                                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.
1121                        </para>
1122                       
1123                        <para>
1124                                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.
1125                        </para>
1126                </description>
1127        </bitlbee-setting>
1128
1129        <bitlbee-setting name="timezone" type="string" scope="global">
1130                <default>local</default>
1131                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1132
1133                <description>
1134                        <para>
1135                                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.
1136                        </para>
1137
1138                        <para>
1139                                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.
1140                        </para>
1141                </description>
1142        </bitlbee-setting>
1143
1144        <bitlbee-setting name="tls" type="boolean" scope="account">
1145                <default>try</default>
1146
1147                <description>
1148                        <para>
1149                                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.
1150                        </para>
1151
1152                        <para>
1153                                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.
1154                        </para>
1155                </description>
1156        </bitlbee-setting>
1157
1158        <bitlbee-setting name="to_char" type="string" scope="global">
1159                <default>": "</default>
1160
1161                <description>
1162                        <para>
1163                                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>.
1164                        </para>
1165
1166                        <para>
1167                                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.
1168                        </para>
1169                </description>
1170        </bitlbee-setting>
1171
1172        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1173                <default>false</default>
1174
1175                <description>
1176                        <para>
1177                                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.
1178                        </para>
1179                </description>
1180        </bitlbee-setting>
1181
1182        <bitlbee-setting name="voice_buddies" type="string" scope="global">
1183                <default>trusted</default>
1184                <possible-values>encrypted, trusted, notaway, false</possible-values>
1185
1186                <description>
1187                        <para>
1188                                Specifies under which circumstances BitlBee should give the "voice" mode flag (+v) to buddies.
1189                        </para>
1190                       
1191                        <para>
1192                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
1193                        </para>
1194                </description>
1195
1196        </bitlbee-setting>
1197
1198        <bitlbee-setting name="web_aware" type="string" scope="account">
1199                <default>false</default>
1200
1201                <description>
1202                        <para>
1203                                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.
1204                        </para>
1205
1206                        <para>
1207                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1208                        </para>
1209                </description>
1210        </bitlbee-setting>
1211
1212        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1213                <default>false</default>
1214
1215                <description>
1216                        <para>
1217                                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.
1218                        </para>
1219                        <para>
1220                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1221                        </para>
1222                </description>
1223        </bitlbee-setting>
1224
1225        <bitlbee-command name="rename">
1226                <short-description>Rename (renick) a buddy</short-description>
1227                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1228
1229                <description>
1230                        <para>
1231                                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).
1232                        </para>
1233                </description>
1234
1235                <ircexample>
1236                        <ircline nick="itsme">rename itsme_ you</ircline>
1237                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1238                </ircexample>
1239
1240        </bitlbee-command>
1241
1242        <bitlbee-command name="yes">
1243                <short-description>Accept a request</short-description>
1244                <syntax>yes [&lt;number&gt;]</syntax>
1245
1246                <description>
1247                        <para>
1248                                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.
1249                        </para>
1250
1251                        <para>
1252                                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.
1253                        </para>
1254                </description>
1255
1256        </bitlbee-command>
1257
1258        <bitlbee-command name="no">
1259                <short-description>Deny a request</short-description>
1260                <syntax>no [&lt;number&gt;]</syntax>
1261
1262                <description>
1263                        <para>
1264                                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.
1265                        </para>
1266
1267                        <para>
1268                                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.
1269                        </para>
1270                </description>
1271        </bitlbee-command>
1272
1273        <bitlbee-command name="qlist">
1274                <short-description>List all the unanswered questions root asked</short-description>
1275                <syntax>qlist</syntax>
1276
1277                <description>
1278                        <para>
1279                                This gives you a list of all the unanswered questions from root.
1280                        </para>
1281                </description>
1282
1283        </bitlbee-command>
1284
1285        <bitlbee-command name="register">
1286                <short-description>Register yourself</short-description>
1287                <syntax>register &lt;password&gt;</syntax>
1288
1289                <description>
1290                        <para>
1291                                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.
1292                        </para>
1293
1294                        <para>
1295                                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.. ;-)
1296                        </para>
1297
1298                        <para>
1299                                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.
1300                        </para>
1301                </description>
1302
1303        </bitlbee-command>
1304
1305        <bitlbee-command name="identify">
1306                <syntax>identify &lt;password&gt;</syntax>
1307                <short-description>Identify yourself with your password</short-description>
1308
1309                <description>
1310                        <para>
1311                                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.
1312                        </para>
1313
1314                        <para>
1315                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1316                        </para>
1317                </description>
1318        </bitlbee-command>
1319
1320        <bitlbee-command name="drop">
1321                <syntax>drop &lt;password&gt;</syntax>
1322                <short-description>Drop your account</short-description>
1323
1324                <description>
1325                        <para>
1326                                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.
1327                        </para>
1328                </description>
1329        </bitlbee-command>
1330
1331        <bitlbee-command name="blist">
1332                <syntax>blist [all|online|offline|away]</syntax>
1333                <short-description>List all the buddies in your contact list</short-description>
1334
1335                <description>
1336                        <para>
1337                                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.
1338                        </para>
1339                </description>
1340
1341        </bitlbee-command>
1342
1343        <bitlbee-command name="nick">
1344                <short-description>Change friendly name, nick</short-description>
1345                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
1346                <syntax>nick &lt;connection&gt;</syntax>
1347
1348                <description>
1349                        <para>
1350                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
1351                        </para>
1352                </description>
1353
1354                <ircexample>
1355                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
1356                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
1357                </ircexample>
1358
1359        </bitlbee-command>
1360</chapter>
Note: See TracBrowser for help on using the repository browser.