source: doc/user-guide/commands.xml @ 266fe2f

Last change on this file since 266fe2f was 64d1f45, checked in by Wilmer van der Gaast <wilmer@…>, at 2006-05-07T11:22:46Z

Slightly different wording for add -tmp.
  • Property mode set to 100644
File size: 26.3 KB
RevLine 
[b7d3cc34]1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account &lt;action&gt; [&lt;arguments&gt;]</syntax>
9
10                <description>
11
12                        <para>
13                                Available actions: add, del, list, on, off. 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; [&lt;server&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) and Yahoo. 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&gt; &lt;password&gt; [&lt;servertag&gt;]</syntax>
29
30                                <description>
31                                        <para>
32                                                Note that the servertag argument is optional. You only have to use it if the part after the @ in your handle isn't the hostname of your Jabber server, or if you want to use SSL/connect to a non-standard port number. The format is simple: [&lt;servername&gt;[:&lt;portnumber&gt;][:ssl]]. For example, this is how you can connect to Google Talk:
33                                        </para>
34                                </description>
35
36                                <ircexample>
37                                        <ircline nick="wilmer">account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl</ircline>
38                                        <ircline nick="root">Account successfully added</ircline>
39                                </ircexample>
40
41                                <description>
42                                        <para>
43                                                Note that Google talk is SSL-only, but officially reachable over both port 5222 and 5223. However, for some people only port 5222 works, for some people only 5223. This is something you'll have to try out.
44                                        </para>
45                                </description>
46                        </bitlbee-command>
47
48                        <bitlbee-command name="msn">
49                                <syntax>account add msn &lt;handle&gt; &lt;password&gt;</syntax>
50
51                                <description>
52                                        <para>
53                                                For MSN connections there are no special arguments.
54                                        </para>
55                                </description>
56                        </bitlbee-command>
57                       
58                        <bitlbee-command name="oscar">
59                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt; [&lt;servername&gt;]</syntax>
60
61                                <description>
62                                        <para>
63                                                Specifying a server is required for OSCAR, since OSCAR can be used for both ICQ- and AIM-connections. Although these days it's supposed to be possible to connect to ICQ via AIM-servers and vice versa, we like to stick with this separation for now. For ICQ connections, the servername is <emphasis>login.icq.com</emphasis>, for AIM connections it's <emphasis>login.oscar.aol.com</emphasis>.
64                                        </para>
65                                </description>
66
67                                <ircexample>
68                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw login.icq.com</ircline>
69                                        <ircline nick="root">Account successfully added</ircline>
70                                </ircexample>
71                        </bitlbee-command>
72
73                        <bitlbee-command name="yahoo">
74                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
75
76                                <description>
77                                        <para>
78                                                For Yahoo! connections there are no special arguments.
79                                        </para>
80                                </description>
81                        </bitlbee-command>
82
83                </bitlbee-command>
84
85                <bitlbee-command name="del">
86                        <syntax>account del &lt;account id&gt;</syntax>
87
88                        <description>
89                                <para>
90                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
91                                </para>
92
93
94                                <para>
95                                        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.
96                                </para>
97                        </description>
98                </bitlbee-command>
99
100                <bitlbee-command name="on">
101                        <syntax>account on [&lt;account id&gt;]</syntax>
102
103                        <description>
104                                <para>
105                                        This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts. (Including accounts awaiting a reconnection)
106                                </para>
107
108                                <para>
109                                        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.
110                                </para>
111                        </description>
112
113                </bitlbee-command>
114
115                <bitlbee-command name="off">
116                        <syntax>account off [&lt;account id&gt;]</syntax>
117
118                        <description>
119                                <para>
120                                        This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts. (Including accounts awaiting a reconnection)
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                </bitlbee-command>
128
129                <bitlbee-command name="list">
130                        <syntax>account list</syntax>
131
132                        <description>
133                                <para>
134                                        This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands.
135                                </para>
136                        </description>
137                </bitlbee-command>
138        </bitlbee-command>
139
140        <bitlbee-command name="add">
141                <short-description>Add a buddy to your contact list</short-description>
142                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
[ea3a26d]143                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
[b7d3cc34]144
145                <description>
146                        <para>
147                                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.
148                        </para>
149
150                        <para>
151                                If you want, you can also tell BitlBee what nick to give the new contact. Of course you can also use the <emphasis>rename</emphasis> command for that, but sometimes this might be more convenient.
152                        </para>
[ea3a26d]153                       
154                        <para>
[64d1f45]155                                Adding -tmp 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.
[ea3a26d]156                        </para>
[b7d3cc34]157                </description>
158
159                <ircexample>
160                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
[689a6e0]161                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
[b7d3cc34]162                </ircexample>
163        </bitlbee-command>
164
165        <bitlbee-command name="info">
166                <short-description>Request user information</short-description>
167                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
168                <syntax>info &lt;nick&gt;</syntax>
169
170                <description>
171                        <para>
172                                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.
173                        </para>
174                </description>
175
176                <ircexample>
177                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
178                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
179                </ircexample>
180
181        </bitlbee-command>
182
183        <bitlbee-command name="remove">
184                <short-description>Remove a buddy from your contact list</short-description>
185                <syntax>remove &lt;nick&gt;</syntax>
186
187                <description>
188                        <para>
189                                Removes the specified nick from your buddy list.
190                        </para>
191                </description>
192
193                <ircexample>
194                        <ircline nick="ctrlsoft">remove gryp</ircline>
195                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
196                </ircexample>
197
198        </bitlbee-command>
199
200        <bitlbee-command name="block">
201                <short-description>Block someone</short-description>
202                <syntax>block &lt;nick&gt;</syntax>
203                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
[9b8efab]204                <syntax>block &lt;connection&gt;</syntax>
[b7d3cc34]205
206                <description>
207                        <para>
208                                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.
209                        </para>
[9b8efab]210                       
211                        <para>
212                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
213                        </para>
[b7d3cc34]214                </description>
215        </bitlbee-command>
216
217        <bitlbee-command name="allow">
218                <short-description>Unblock someone</short-description>
219                <syntax>allow &lt;nick&gt;</syntax>
220                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
221
222                <description>
223                        <para>
224                                Reverse of block. Unignores the specified user or user handle on specified connection.
225                        </para>
[9b8efab]226                       
227                        <para>
228                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
229                        </para>
[b7d3cc34]230                </description>
231        </bitlbee-command>
232
233        <bitlbee-command name="set">
234                <short-description>Miscellaneous settings</short-description>
235                <syntax>set [&lt;variable&gt; [&lt;value&gt;]]</syntax>
236
237                <description>
238
239                        <para>
240                                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.
241                        </para>
242
243                        <para>
244                                To get more help information about a setting, try:
245                        </para>
246
247                </description>
248
249                <ircexample>
250                        <ircline nick="ctrlsoft">help set private</ircline>
251                </ircexample>
252
253        </bitlbee-command>
254
255        <bitlbee-command name="help">
256                <short-description>BitlBee help system</short-description>
257
258                <syntax>help [subject]</syntax>
259
260                <description>
261                        <para>
262                                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.
263                        </para>
264                </description>
265        </bitlbee-command>
266
267        <bitlbee-command name="save">
268                <short-description>Save your account data</short-description>
269                <syntax>save</syntax>
270
271                <description>
272                        <para>
273                                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... ;-)
274                        </para>
275                </description>
276        </bitlbee-command>
277
278        <bitlbee-setting name="charset" type="string">
279                <default>iso8859-1</default>
280                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
281
282                <description>
283                        <para>
284                                The charset setting enables you to use different character sets in BitlBee. These get converted to UTF-8 before sending and from UTF-8 when receiving.
285                        </para>
286
287                        <para>
288                                If you don't know what's the best value for this, at least iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://czyborra.com/charsets/iso8859.html
289                        </para>
290                </description>
291
292        </bitlbee-setting>
293
294        <bitlbee-setting name="private" type="boolean">
295                <default>True</default>
296
297                <description>
298
299                        <para>
300                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
301                        </para>
302
303                        <para>
304                                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.
305                        </para>
306                </description>
307        </bitlbee-setting>
308
309        <bitlbee-setting name="save_on_quit" type="boolean">
310                <default>True</default>
311
312                <description>
313                        <para>
314                                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.
315                        </para>
316                </description>
317        </bitlbee-setting>
318
[c572dd6]319        <bitlbee-setting name="strip_html" type="boolean">
320                <default>True</default>
[b7d3cc34]321
322                <description>
323                        <para>
[c572dd6]324                                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.
325                        </para>
326                        <para>
327                                If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too.
[b7d3cc34]328                        </para>
329                </description>
330        </bitlbee-setting>
331
332        <bitlbee-setting name="debug" type="boolean">
333                <default>False</default>
334
335                <description>
336                        <para>
337                                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.
338                        </para>
339                </description>
340        </bitlbee-setting>
341
342        <bitlbee-setting name="to_char" type="string">
343                <default>": "</default>
344
345                <description>
346
347                        <para>
348                                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>.
349                        </para>
350
351                        <para>
352                                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.
353                        </para>
354                </description>
355        </bitlbee-setting>
356
357        <bitlbee-setting name="typing_notice" type="boolean">
358                <default>False</default>
359
360                <description>
361                        <para>
362                                Sends you a /notice when a user starts typing a message (if the protocol supports it, MSN for example). This is a bug, not a feature. (But please don't report it.. ;-) You don't want to use it. Really. In fact the typing-notification is just one of the least useful 'innovations' ever. It's just there because some guy will probably ask me about it anyway. ;-)
363                        </para>
364                </description>
365        </bitlbee-setting>
366
367        <bitlbee-setting name="ops" type="string">
368                <default>both</default>
369                <possible-values>both, root, user, none</possible-values>
370
371                <description>
372                        <para>
[689a6e0]373                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can change these states using this setting.
[b7d3cc34]374                        </para>
375
376                        <para>
377                                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.
378                        </para>
379                </description>
380        </bitlbee-setting>
381
382        <bitlbee-setting name="away_devoice" type="boolean">
383                <default>True</default>
384
385                <description>
386                        <para>
387                                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.
388                        </para>
389                </description>
390        </bitlbee-setting>
391
392        <bitlbee-setting name="handle_unknown" type="string">
393                <default>root</default>
394                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
395
396                <description>
397                        <para>
398                                Messages from unknown users are echoed like this by default:
399                        </para>
400
401                        <ircexample>
402                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
403                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
404                        </ircexample>
405
406                        <para>
407                                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.
408                        </para>
409
410                        <note>
411                                <para>
412                                        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.
413                                </para>
414                        </note>
415                </description>
416
417        </bitlbee-setting>
418
419        <bitlbee-setting name="auto_connect" type="boolean">
420                <default>True</default>
421
422                <description>
423                        <para>
424                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
425                        </para>
426                </description>
427        </bitlbee-setting>
428
429        <bitlbee-setting name="auto_reconnect" type="boolean">
430                <default>False</default>
431
432                <description>
433                        <para>
434                                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.
435                        </para>
436
437                        <para>
438                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
439                        </para>
440                </description>
441
442        </bitlbee-setting>
443
444        <bitlbee-setting name="auto_reconnect_delay" type="integer">
445                <default>300</default>
446
447                <description>
448
449                        <para>
450                                Tell BitlBee after how many seconds it should attempt to bring an IM-connection back up after a crash. It's not a good idea to set this value very low, it will cause too much useless traffic when an IM-server is down for a few hours.
451                        </para>
452
453                        <para>
454                                See also the <emphasis>auto_reconnect</emphasis> setting.
455                        </para>
456                </description>
457        </bitlbee-setting>
458
459        <bitlbee-setting name="buddy_sendbuffer" type="boolean">
460                <default>False</default>
461
462                <description>
463
464                        <para>
465                                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.
466                        </para>
467
468                        <para>
469                                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.
470                        </para>
471
472                        <para>
473                                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.
474                        </para>
475                </description>
476
477        </bitlbee-setting>
478
479        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer">
[834ff44]480                <default>200</default>
481
[b7d3cc34]482                <description>
483
484                        <para>
[834ff44]485                                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.
[b7d3cc34]486                        </para>
487
488                        <para>
489                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
490                        </para>
491                </description>
492
493        </bitlbee-setting>
494
495        <bitlbee-setting name="default_target" type="string">
496                <default>root</default>
497                <possible-values>root, last</possible-values>
498
499                <description>
500                        <para>
501                                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>.
502                        </para>
503                </description>
504
505        </bitlbee-setting>
506
507        <bitlbee-setting name="display_namechanges" type="boolean">
508                <default>False</default>
509
510                <para>
511                        With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
512                </para>
513        </bitlbee-setting>
514
515        <bitlbee-setting name="password" type="string">
516                <description>
517                        <para>
518                                Use this setting to change your "NickServ" password.
519                        </para>
520                </description>
521        </bitlbee-setting>
522
523        <bitlbee-setting name="query_order" type="string">
524                <default>lifo</default>
525                <possible-values>lifo, fifo</possible-values>
526
527                <description>
528                        <para>
529                                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.
530                        </para>
531
532                        <para>
533                                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).
534                        </para>
535                </description>
536        </bitlbee-setting>
537
538        <bitlbee-setting name="lcnicks" type="boolean">
539                <default>True</default>
540
541                <description>
542                        <para>
543                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
544                        </para>
545                </description>
546
547        </bitlbee-setting>
548
549        <bitlbee-command name="rename">
550                <short-description>Rename (renick) a buddy</short-description>
551                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
552
553                <description>
554                        <para>
555                                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).
556                        </para>
557                </description>
558
559                <ircexample>
560                        <ircline nick="itsme">rename itsme_ you</ircline>
561                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
562                </ircexample>
563
564        </bitlbee-command>
565
566        <bitlbee-command name="yes">
567                <short-description>Accept a request</short-description>
568                <syntax>yes [&lt;number&gt;]</syntax>
569
570                <description>
571                        <para>
572                                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.
573                        </para>
574
575                        <para>
576                                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.
577                        </para>
578                </description>
579
580        </bitlbee-command>
581
582        <bitlbee-command name="no">
583                <short-description>Deny a request</short-description>
584                <syntax>no [&lt;number&gt;]</syntax>
585
586                <description>
587                        <para>
588                                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.
589                        </para>
590
591                        <para>
592                                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.
593                        </para>
594                </description>
595        </bitlbee-command>
596
597        <bitlbee-command name="qlist">
598                <short-description>List all the unanswered questions root asked</short-description>
599                <syntax>qlist</syntax>
600
601                <description>
602                        <para>
603                                This gives you a list of all the unanswered questions from root.
604                        </para>
605                </description>
606
607        </bitlbee-command>
608
609        <bitlbee-command name="register">
610                <short-description>Register yourself</short-description>
611                <syntax>register &lt;password&gt;</syntax>
612
613                <description>
614                        <para>
615                                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.
616                        </para>
617
618                        <para>
619                                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.. ;-)
620                        </para>
621
622                        <para>
[1be54a9]623                                To identify yourself in later sessions, you can use the <emphasis>identify</emphasis> command. To change your password later, you can use the <emphasis>set password</emphasis> command.
[b7d3cc34]624                        </para>
625                </description>
626
627        </bitlbee-command>
628
629        <bitlbee-command name="identify">
630                <syntax>identify &lt;password&gt;</syntax>
631                <short-description>Identify yourself with your password</short-description>
632
633                <description>
634                        <para>
635                                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.
636                        </para>
637
638                        <para>
639                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
640                        </para>
641                </description>
642        </bitlbee-command>
643
644        <bitlbee-command name="drop">
645                <syntax>drop &lt;password&gt;</syntax>
646                <short-description>Drop your account</short-description>
647
648                <description>
649                        <para>
650                                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.
651                        </para>
652                </description>
653        </bitlbee-command>
654
655        <bitlbee-command name="blist">
656                <syntax>blist [all|online|offline|away]</syntax>
657                <short-description>List all the buddies in your contact list</short-description>
658
659                <description>
660                        <para>
661                                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.
662                        </para>
663                </description>
664
665        </bitlbee-command>
666
667        <bitlbee-command name="nick">
668                <short-description>Change friendly name, nick</short-description>
669                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
670                <syntax>nick</syntax>
671
672                <description>
673                        <para>
674                                This command allows to set the friendly name of an im account. If no new name is specified the command will report the current name. When the name contains spaces, don't forget to quote the whole nick in double quotes. Currently this command is only supported by the MSN protocol.
675                        </para>
676                </description>
677
678                <ircexample>
679                        <ircline nick="wouter">nick 1 "Wouter Paesen"</ircline>
680                        <ircline nick="root">Setting your name on connection 1 to `Wouter Paesen'</ircline>
681                </ircexample>
682
683        </bitlbee-command>
684
685        <bitlbee-command name="import_buddies">
686                <short-description>Copy local buddy list to server (normally only needed when upgrading)</short-description>
687                <syntax>import_buddies &lt;connection&gt; [clear]</syntax>
688
689                <description>
690                        <para>
691                                This command copies the locally stored buddy list to the server. This command exists for upgrading purposes. Previous versions of BitlBee didn't support server-side buddy lists for ICQ, so the list was stored locally.
692                        </para>
693
694                        <para>
695                                Since version 0.91 however, server-side contact lists are supported for all protocols, so the local list is now ignored. When upgrading from an older BitlBee to version 0.91, you might need this command to get your buddy list back.
696                        </para>
697
698                        <para>
699                                The only argument this command needs is your ICQ account identification. If your serverside buddy list contains some old buddies you don't want anymore, you can pass <emphasis>clear</emphasis> as a second argument.
700                        </para>
701
702                        <para>
703                                After giving this command, you have to wait for a while before all the adds are handled, because of ICQ's rate limiting. If your buddy list is very large and the ICQ server starts complaining, you might have to reconnect and enter this command again.
704                        </para>
705                </description>
706
707        </bitlbee-command>
708</chapter>
Note: See TracBrowser for help on using the repository browser.