source: doc/user-guide/commands.xml @ 89a1809

Last change on this file since 89a1809 was 89a1809, checked in by Wilmer van der Gaast <wilmer@…>, at 2006-07-14T18:27:02Z

More documentation updates: Added a Scope: line for every setting (for
per-account and global settings) and leaving out the Default: line when
there is no default specified in XML (like with the display_name setting).

  • Property mode set to 100644
File size: 30.1 KB
Line 
1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account &lt;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; [&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@server.tld&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]].
33                                        </para>
34                                </description>
35
36                                <description>
37                                        <para>
38                                                Google Talk uses the Jabber protocol. Please note that Google talk is SSL-only, but officially reachable over both port 5222 and 5223. Usually BitlBee users have to connect via port 5223, for example like this:
39                                        </para>
40                                </description>
41
42                                <ircexample>
43                                        <ircline nick="wilmer">account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl</ircline>
44                                        <ircline nick="root">Account successfully added</ircline>
45                                </ircexample>
46                        </bitlbee-command>
47
48                        <bitlbee-command name="msn">
49                                <syntax>account add msn &lt;handle@server.tld&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 that have the auto_connect flag set.
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 and cancel all pending reconnects.
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
139                <bitlbee-command name="set">
140                        <syntax>account set &lt;account id&gt;</syntax>
141                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
142                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
143
144                        <description>
145                                <para>
146                                        This account 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>.
147                                </para>
148                               
149                                <para>
150                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
151                                </para>
152                               
153                                <para>
154                                        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.
155                                </para>
156                        </description>
157                </bitlbee-command>
158        </bitlbee-command>
159
160        <bitlbee-command name="add">
161                <short-description>Add a buddy to your contact list</short-description>
162                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
163                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
164
165                <description>
166                        <para>
167                                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.
168                        </para>
169
170                        <para>
171                                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.
172                        </para>
173                       
174                        <para>
175                                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.
176                        </para>
177                </description>
178
179                <ircexample>
180                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
181                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
182                </ircexample>
183        </bitlbee-command>
184
185        <bitlbee-command name="info">
186                <short-description>Request user information</short-description>
187                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
188                <syntax>info &lt;nick&gt;</syntax>
189
190                <description>
191                        <para>
192                                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.
193                        </para>
194                </description>
195
196                <ircexample>
197                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
198                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
199                </ircexample>
200
201        </bitlbee-command>
202
203        <bitlbee-command name="remove">
204                <short-description>Remove a buddy from your contact list</short-description>
205                <syntax>remove &lt;nick&gt;</syntax>
206
207                <description>
208                        <para>
209                                Removes the specified nick from your buddy list.
210                        </para>
211                </description>
212
213                <ircexample>
214                        <ircline nick="ctrlsoft">remove gryp</ircline>
215                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
216                </ircexample>
217
218        </bitlbee-command>
219
220        <bitlbee-command name="block">
221                <short-description>Block someone</short-description>
222                <syntax>block &lt;nick&gt;</syntax>
223                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
224                <syntax>block &lt;connection&gt;</syntax>
225
226                <description>
227                        <para>
228                                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.
229                        </para>
230                       
231                        <para>
232                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
233                        </para>
234                </description>
235        </bitlbee-command>
236
237        <bitlbee-command name="allow">
238                <short-description>Unblock someone</short-description>
239                <syntax>allow &lt;nick&gt;</syntax>
240                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
241
242                <description>
243                        <para>
244                                Reverse of block. Unignores the specified user or user handle on specified connection.
245                        </para>
246                       
247                        <para>
248                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
249                        </para>
250                </description>
251        </bitlbee-command>
252
253        <bitlbee-command name="set">
254                <short-description>Miscellaneous settings</short-description>
255                <syntax>set [&lt;variable&gt; [&lt;value&gt;]]</syntax>
256
257                <description>
258
259                        <para>
260                                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.
261                        </para>
262
263                        <para>
264                                To get more help information about a setting, try:
265                        </para>
266
267                </description>
268
269                <ircexample>
270                        <ircline nick="ctrlsoft">help set private</ircline>
271                </ircexample>
272
273        </bitlbee-command>
274
275        <bitlbee-command name="help">
276                <short-description>BitlBee help system</short-description>
277
278                <syntax>help [subject]</syntax>
279
280                <description>
281                        <para>
282                                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.
283                        </para>
284                </description>
285        </bitlbee-command>
286
287        <bitlbee-command name="save">
288                <short-description>Save your account data</short-description>
289                <syntax>save</syntax>
290
291                <description>
292                        <para>
293                                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... ;-)
294                        </para>
295                </description>
296        </bitlbee-command>
297
298        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
299                <default>true</default>
300
301                <description>
302                        <para>
303                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
304                        </para>
305                       
306                        <para>
307                                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!)
308                        </para>
309                </description>
310        </bitlbee-setting>
311
312        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
313                <default>false</default>
314
315                <description>
316                        <para>
317                                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.
318                        </para>
319
320                        <para>
321                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
322                        </para>
323
324                        <para>
325                                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!)
326                        </para>
327                </description>
328        </bitlbee-setting>
329
330        <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global">
331                <default>300</default>
332
333                <description>
334                        <para>
335                                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.
336                        </para>
337
338                        <para>
339                                See also the <emphasis>auto_reconnect</emphasis> setting.
340                        </para>
341                </description>
342        </bitlbee-setting>
343
344        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
345                <default>true</default>
346
347                <description>
348                        <para>
349                                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.
350                        </para>
351                </description>
352        </bitlbee-setting>
353
354        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
355                <default>false</default>
356
357                <description>
358                        <para>
359                                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.
360                        </para>
361
362                        <para>
363                                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.
364                        </para>
365
366                        <para>
367                                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.
368                        </para>
369                </description>
370        </bitlbee-setting>
371
372        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
373                <default>200</default>
374
375                <description>
376
377                        <para>
378                                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.
379                        </para>
380
381                        <para>
382                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
383                        </para>
384                </description>
385        </bitlbee-setting>
386
387        <bitlbee-setting name="charset" type="string" scope="global">
388                <default>iso8859-1</default>
389                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
390
391                <description>
392                        <para>
393                                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.
394                        </para>
395
396                        <para>
397                                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
398                        </para>
399                </description>
400
401        </bitlbee-setting>
402
403        <bitlbee-setting name="debug" type="boolean" scope="global">
404                <default>false</default>
405
406                <description>
407                        <para>
408                                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.
409                        </para>
410                </description>
411        </bitlbee-setting>
412
413        <bitlbee-setting name="default_target" type="string" scope="global">
414                <default>root</default>
415                <possible-values>root, last</possible-values>
416
417                <description>
418                        <para>
419                                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>.
420                        </para>
421                </description>
422        </bitlbee-setting>
423
424        <bitlbee-setting name="display_name" type="string" scope="account">
425                <description>
426                        <para>
427                                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.
428                        </para>
429                </description>
430        </bitlbee-setting>
431
432        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
433                <default>false</default>
434
435                <para>
436                        With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
437                </para>
438        </bitlbee-setting>
439
440        <bitlbee-setting name="handle_unknown" type="string" scope="global">
441                <default>root</default>
442                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
443
444                <description>
445                        <para>
446                                Messages from unknown users are echoed like this by default:
447                        </para>
448
449                        <ircexample>
450                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
451                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
452                        </ircexample>
453
454                        <para>
455                                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.
456                        </para>
457
458                        <note>
459                                <para>
460                                        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.
461                                </para>
462                        </note>
463                </description>
464
465        </bitlbee-setting>
466
467        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
468                <default>true</default>
469
470                <description>
471                        <para>
472                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
473                        </para>
474                </description>
475
476        </bitlbee-setting>
477
478        <bitlbee-setting name="ops" type="string" scope="global">
479                <default>both</default>
480                <possible-values>both, root, user, none</possible-values>
481
482                <description>
483                        <para>
484                                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.
485                        </para>
486
487                        <para>
488                                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.
489                        </para>
490                </description>
491        </bitlbee-setting>
492
493        <bitlbee-setting name="password" type="string" scope="both">
494                <description>
495                        <para>
496                                Use this global setting to change your "NickServ" password.
497                        </para>
498                       
499                        <para>
500                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
501                        </para>
502                       
503                        <para>
504                                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.
505                        </para>
506                </description>
507        </bitlbee-setting>
508       
509        <bitlbee-setting name="port" type="integer" scope="account">
510                <description>
511                        <para>
512                                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.
513                        </para>
514                </description>
515        </bitlbee-setting>
516
517        <bitlbee-setting name="private" type="boolean" scope="global">
518                <default>true</default>
519
520                <description>
521                        <para>
522                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
523                        </para>
524
525                        <para>
526                                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.
527                        </para>
528                </description>
529        </bitlbee-setting>
530
531        <bitlbee-setting name="query_order" type="string" scope="global">
532                <default>lifo</default>
533                <possible-values>lifo, fifo</possible-values>
534
535                <description>
536                        <para>
537                                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.
538                        </para>
539
540                        <para>
541                                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).
542                        </para>
543                </description>
544        </bitlbee-setting>
545
546        <bitlbee-setting name="resource" type="string" scope="account">
547                <default>BitlBee</default>
548
549                <description>
550                        <para>
551                                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.
552                        </para>
553                </description>
554        </bitlbee-setting>
555
556        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
557                <default>true</default>
558
559                <description>
560                        <para>
561                                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.
562                        </para>
563                </description>
564        </bitlbee-setting>
565
566        <bitlbee-setting name="server" type="string" scope="account">
567                <description>
568                        <para>
569                                Can be set for Jabber- and OSCAR-connections. For OSCAR, this must be set to <emphasis>login.icq.com</emphasis> if it's an ICQ connection, or <emphasis>login.oscar.aol.com</emphasis> if it's an AIM connection. For Jabber, you have to set this if the servername isn't equal to the part after the @ in the Jabber handle.
570                        </para>
571                </description>
572        </bitlbee-setting>
573
574        <bitlbee-setting name="ssl" type="boolean" scope="account">
575                <default>false</default>
576
577                <description>
578                        <para>
579                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
580                        </para>
581                </description>
582        </bitlbee-setting>
583
584        <bitlbee-setting name="strip_html" type="boolean" scope="global">
585                <default>true</default>
586
587                <description>
588                        <para>
589                                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.
590                        </para>
591                        <para>
592                                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.
593                        </para>
594                </description>
595        </bitlbee-setting>
596
597        <bitlbee-setting name="to_char" type="string" scope="global">
598                <default>": "</default>
599
600                <description>
601                        <para>
602                                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>.
603                        </para>
604
605                        <para>
606                                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.
607                        </para>
608                </description>
609        </bitlbee-setting>
610
611        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
612                <default>false</default>
613
614                <description>
615                        <para>
616                                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. ;-)
617                        </para>
618                </description>
619        </bitlbee-setting>
620
621        <bitlbee-command name="rename">
622                <short-description>Rename (renick) a buddy</short-description>
623                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
624
625                <description>
626                        <para>
627                                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).
628                        </para>
629                </description>
630
631                <ircexample>
632                        <ircline nick="itsme">rename itsme_ you</ircline>
633                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
634                </ircexample>
635
636        </bitlbee-command>
637
638        <bitlbee-command name="yes">
639                <short-description>Accept a request</short-description>
640                <syntax>yes [&lt;number&gt;]</syntax>
641
642                <description>
643                        <para>
644                                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.
645                        </para>
646
647                        <para>
648                                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.
649                        </para>
650                </description>
651
652        </bitlbee-command>
653
654        <bitlbee-command name="no">
655                <short-description>Deny a request</short-description>
656                <syntax>no [&lt;number&gt;]</syntax>
657
658                <description>
659                        <para>
660                                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.
661                        </para>
662
663                        <para>
664                                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.
665                        </para>
666                </description>
667        </bitlbee-command>
668
669        <bitlbee-command name="qlist">
670                <short-description>List all the unanswered questions root asked</short-description>
671                <syntax>qlist</syntax>
672
673                <description>
674                        <para>
675                                This gives you a list of all the unanswered questions from root.
676                        </para>
677                </description>
678
679        </bitlbee-command>
680
681        <bitlbee-command name="register">
682                <short-description>Register yourself</short-description>
683                <syntax>register &lt;password&gt;</syntax>
684
685                <description>
686                        <para>
687                                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.
688                        </para>
689
690                        <para>
691                                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.. ;-)
692                        </para>
693
694                        <para>
695                                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.
696                        </para>
697                </description>
698
699        </bitlbee-command>
700
701        <bitlbee-command name="identify">
702                <syntax>identify &lt;password&gt;</syntax>
703                <short-description>Identify yourself with your password</short-description>
704
705                <description>
706                        <para>
707                                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.
708                        </para>
709
710                        <para>
711                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
712                        </para>
713                </description>
714        </bitlbee-command>
715
716        <bitlbee-command name="drop">
717                <syntax>drop &lt;password&gt;</syntax>
718                <short-description>Drop your account</short-description>
719
720                <description>
721                        <para>
722                                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.
723                        </para>
724                </description>
725        </bitlbee-command>
726
727        <bitlbee-command name="blist">
728                <syntax>blist [all|online|offline|away]</syntax>
729                <short-description>List all the buddies in your contact list</short-description>
730
731                <description>
732                        <para>
733                                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.
734                        </para>
735                </description>
736
737        </bitlbee-command>
738
739        <bitlbee-command name="nick">
740                <short-description>Change friendly name, nick</short-description>
741                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
742                <syntax>nick</syntax>
743
744                <description>
745                        <para>
746                                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.
747                        </para>
748                </description>
749
750                <ircexample>
751                        <ircline nick="wouter">nick 1 "Wouter Paesen"</ircline>
752                        <ircline nick="root">Setting your name on connection 1 to `Wouter Paesen'</ircline>
753                </ircexample>
754
755        </bitlbee-command>
756
757        <bitlbee-command name="import_buddies">
758                <short-description>Copy local buddy list to server (normally only needed when upgrading)</short-description>
759                <syntax>import_buddies &lt;connection&gt; [clear]</syntax>
760
761                <description>
762                        <para>
763                                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.
764                        </para>
765
766                        <para>
767                                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.
768                        </para>
769
770                        <para>
771                                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.
772                        </para>
773
774                        <para>
775                                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.
776                        </para>
777                </description>
778
779        </bitlbee-command>
780</chapter>
Note: See TracBrowser for help on using the repository browser.