source: doc/user-guide/commands.xml @ 85023c6

Last change on this file since 85023c6 was f7b44f2, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-06-30T21:52:44Z

Added help information for the join_chat command and its five arguments,
which were completely undocumented so far. Also removed the import_buddies
information because that command doesn't exist anymore anyway.
  • Property mode set to 100644
File size: 33.0 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                                                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; [&lt;servername&gt;]</syntax>
53
54                                <description>
55                                        <para>
56                                                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>.
57                                        </para>
58                                </description>
59
60                                <ircexample>
61                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw login.icq.com</ircline>
62                                        <ircline nick="root">Account successfully added</ircline>
63                                </ircexample>
64                        </bitlbee-command>
65
66                        <bitlbee-command name="yahoo">
67                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
68
69                                <description>
70                                        <para>
71                                                For Yahoo! connections there are no special arguments.
72                                        </para>
73                                </description>
74                        </bitlbee-command>
75
76                </bitlbee-command>
77
78                <bitlbee-command name="del">
79                        <syntax>account del &lt;account id&gt;</syntax>
80
81                        <description>
82                                <para>
83                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
84                                </para>
85
86
87                                <para>
88                                        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.
89                                </para>
90                        </description>
91                </bitlbee-command>
92
93                <bitlbee-command name="on">
94                        <syntax>account on [&lt;account id&gt;]</syntax>
95
96                        <description>
97                                <para>
98                                        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.
99                                </para>
100
101                                <para>
102                                        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.
103                                </para>
104                        </description>
105
106                </bitlbee-command>
107
108                <bitlbee-command name="off">
109                        <syntax>account off [&lt;account id&gt;]</syntax>
110
111                        <description>
112                                <para>
113                                        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.
114                                </para>
115
116                                <para>
117                                        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.
118                                </para>
119                        </description>
120                </bitlbee-command>
121
122                <bitlbee-command name="list">
123                        <syntax>account list</syntax>
124
125                        <description>
126                                <para>
127                                        This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands.
128                                </para>
129                        </description>
130                </bitlbee-command>
131
132                <bitlbee-command name="set">
133                        <syntax>account set &lt;account id&gt;</syntax>
134                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
135                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
136
137                        <description>
138                                <para>
139                                        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>.
140                                </para>
141                               
142                                <para>
143                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
144                                </para>
145                               
146                                <para>
147                                        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                        </description>
150                </bitlbee-command>
151        </bitlbee-command>
152
153        <bitlbee-command name="add">
154                <short-description>Add a buddy to your contact list</short-description>
155                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
156                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
157
158                <description>
159                        <para>
160                                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.
161                        </para>
162
163                        <para>
164                                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.
165                        </para>
166                       
167                        <para>
168                                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.
169                        </para>
170                </description>
171
172                <ircexample>
173                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
174                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
175                </ircexample>
176        </bitlbee-command>
177
178        <bitlbee-command name="info">
179                <short-description>Request user information</short-description>
180                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
181                <syntax>info &lt;nick&gt;</syntax>
182
183                <description>
184                        <para>
185                                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.
186                        </para>
187                </description>
188
189                <ircexample>
190                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
191                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
192                </ircexample>
193
194        </bitlbee-command>
195
196        <bitlbee-command name="remove">
197                <short-description>Remove a buddy from your contact list</short-description>
198                <syntax>remove &lt;nick&gt;</syntax>
199
200                <description>
201                        <para>
202                                Removes the specified nick from your buddy list.
203                        </para>
204                </description>
205
206                <ircexample>
207                        <ircline nick="ctrlsoft">remove gryp</ircline>
208                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
209                </ircexample>
210
211        </bitlbee-command>
212
213        <bitlbee-command name="block">
214                <short-description>Block someone</short-description>
215                <syntax>block &lt;nick&gt;</syntax>
216                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
217                <syntax>block &lt;connection&gt;</syntax>
218
219                <description>
220                        <para>
221                                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.
222                        </para>
223                       
224                        <para>
225                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
226                        </para>
227                </description>
228        </bitlbee-command>
229
230        <bitlbee-command name="allow">
231                <short-description>Unblock someone</short-description>
232                <syntax>allow &lt;nick&gt;</syntax>
233                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
234
235                <description>
236                        <para>
237                                Reverse of block. Unignores the specified user or user handle on specified connection.
238                        </para>
239                       
240                        <para>
241                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
242                        </para>
243                </description>
244        </bitlbee-command>
245
246        <bitlbee-command name="set">
247                <short-description>Miscellaneous settings</short-description>
248                <syntax>set [&lt;variable&gt; [&lt;value&gt;]]</syntax>
249
250                <description>
251
252                        <para>
253                                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.
254                        </para>
255
256                        <para>
257                                To get more help information about a setting, try:
258                        </para>
259
260                </description>
261
262                <ircexample>
263                        <ircline nick="ctrlsoft">help set private</ircline>
264                </ircexample>
265
266        </bitlbee-command>
267
268        <bitlbee-command name="help">
269                <short-description>BitlBee help system</short-description>
270
271                <syntax>help [subject]</syntax>
272
273                <description>
274                        <para>
275                                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.
276                        </para>
277                </description>
278        </bitlbee-command>
279
280        <bitlbee-command name="save">
281                <short-description>Save your account data</short-description>
282                <syntax>save</syntax>
283
284                <description>
285                        <para>
286                                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... ;-)
287                        </para>
288                </description>
289        </bitlbee-command>
290
291        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
292                <default>true</default>
293
294                <description>
295                        <para>
296                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
297                        </para>
298                       
299                        <para>
300                                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!)
301                        </para>
302                </description>
303        </bitlbee-setting>
304
305        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
306                <default>false</default>
307
308                <description>
309                        <para>
310                                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.
311                        </para>
312
313                        <para>
314                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
315                        </para>
316
317                        <para>
318                                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!)
319                        </para>
320                </description>
321        </bitlbee-setting>
322
323        <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global">
324                <default>300</default>
325
326                <description>
327                        <para>
328                                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.
329                        </para>
330
331                        <para>
332                                See also the <emphasis>auto_reconnect</emphasis> setting.
333                        </para>
334                </description>
335        </bitlbee-setting>
336
337        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
338                <default>true</default>
339
340                <description>
341                        <para>
342                                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.
343                        </para>
344                </description>
345        </bitlbee-setting>
346
347        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
348                <default>false</default>
349
350                <description>
351                        <para>
352                                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.
353                        </para>
354
355                        <para>
356                                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.
357                        </para>
358
359                        <para>
360                                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.
361                        </para>
362                </description>
363        </bitlbee-setting>
364
365        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
366                <default>200</default>
367
368                <description>
369
370                        <para>
371                                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.
372                        </para>
373
374                        <para>
375                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
376                        </para>
377                </description>
378        </bitlbee-setting>
379
380        <bitlbee-setting name="charset" type="string" scope="global">
381                <default>iso8859-1</default>
382                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
383
384                <description>
385                        <para>
386                                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.
387                        </para>
388
389                        <para>
390                                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
391                        </para>
392                </description>
393
394        </bitlbee-setting>
395
396        <bitlbee-setting name="debug" type="boolean" scope="global">
397                <default>false</default>
398
399                <description>
400                        <para>
401                                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.
402                        </para>
403                </description>
404        </bitlbee-setting>
405
406        <bitlbee-setting name="default_target" type="string" scope="global">
407                <default>root</default>
408                <possible-values>root, last</possible-values>
409
410                <description>
411                        <para>
412                                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>.
413                        </para>
414                </description>
415        </bitlbee-setting>
416
417        <bitlbee-setting name="display_name" type="string" scope="account">
418                <description>
419                        <para>
420                                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.
421                        </para>
422                </description>
423        </bitlbee-setting>
424
425        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
426                <default>false</default>
427
428                <description>
429                        <para>
430                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
431                        </para>
432                </description>
433        </bitlbee-setting>
434
435        <bitlbee-setting name="handle_unknown" type="string" scope="global">
436                <default>root</default>
437                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
438
439                <description>
440                        <para>
441                                Messages from unknown users are echoed like this by default:
442                        </para>
443
444                        <ircexample>
445                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
446                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
447                        </ircexample>
448
449                        <para>
450                                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.
451                        </para>
452
453                        <note>
454                                <para>
455                                        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.
456                                </para>
457                        </note>
458                </description>
459
460        </bitlbee-setting>
461
462        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
463                <default>true</default>
464
465                <description>
466                        <para>
467                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
468                        </para>
469                </description>
470
471        </bitlbee-setting>
472
473        <bitlbee-setting name="ops" type="string" scope="global">
474                <default>both</default>
475                <possible-values>both, root, user, none</possible-values>
476
477                <description>
478                        <para>
479                                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.
480                        </para>
481
482                        <para>
483                                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.
484                        </para>
485                </description>
486        </bitlbee-setting>
487
488        <bitlbee-setting name="password" type="string" scope="both">
489                <description>
490                        <para>
491                                Use this global setting to change your "NickServ" password.
492                        </para>
493                       
494                        <para>
495                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
496                        </para>
497                       
498                        <para>
499                                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.
500                        </para>
501                </description>
502        </bitlbee-setting>
503       
504        <bitlbee-setting name="port" type="integer" scope="account">
505                <description>
506                        <para>
507                                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.
508                        </para>
509                </description>
510        </bitlbee-setting>
511
512        <bitlbee-setting name="priority" type="integer" scope="account">
513                <default>0</default>
514
515                <description>
516                        <para>
517                                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).
518                        </para>
519
520                        <para>
521                                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).
522                        </para>
523                </description>
524        </bitlbee-setting>
525
526        <bitlbee-setting name="private" type="boolean" scope="global">
527                <default>true</default>
528
529                <description>
530                        <para>
531                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
532                        </para>
533
534                        <para>
535                                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.
536                        </para>
537                </description>
538        </bitlbee-setting>
539
540        <bitlbee-setting name="query_order" type="string" scope="global">
541                <default>lifo</default>
542                <possible-values>lifo, fifo</possible-values>
543
544                <description>
545                        <para>
546                                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.
547                        </para>
548
549                        <para>
550                                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).
551                        </para>
552                </description>
553        </bitlbee-setting>
554
555        <bitlbee-setting name="resource" type="string" scope="account">
556                <default>BitlBee</default>
557
558                <description>
559                        <para>
560                                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.
561                        </para>
562                </description>
563        </bitlbee-setting>
564
565        <bitlbee-setting name="resource_select" type="string" scope="account">
566                <default>priority</default>
567                <possible-values>priority, time</possible-values>
568
569                <description>
570                        <para>
571                                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.
572                        </para>
573
574                        <para>
575                                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>time</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected).
576                        </para>
577                </description>
578        </bitlbee-setting>
579
580        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
581                <default>true</default>
582
583                <description>
584                        <para>
585                                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.
586                        </para>
587                </description>
588        </bitlbee-setting>
589
590        <bitlbee-setting name="server" type="string" scope="account">
591                <description>
592                        <para>
593                                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.
594                        </para>
595                </description>
596        </bitlbee-setting>
597
598        <bitlbee-setting name="ssl" type="boolean" scope="account">
599                <default>false</default>
600
601                <description>
602                        <para>
603                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
604                        </para>
605                </description>
606        </bitlbee-setting>
607
608        <bitlbee-setting name="strip_html" type="boolean" scope="global">
609                <default>true</default>
610
611                <description>
612                        <para>
613                                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.
614                        </para>
615                        <para>
616                                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.
617                        </para>
618                </description>
619        </bitlbee-setting>
620
621        <bitlbee-setting name="tls" type="boolean" scope="account">
622                <default>try</default>
623
624                <description>
625                        <para>
626                                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.
627                        </para>
628
629                        <para>
630                                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.
631                        </para>
632                </description>
633        </bitlbee-setting>
634
635        <bitlbee-setting name="to_char" type="string" scope="global">
636                <default>": "</default>
637
638                <description>
639                        <para>
640                                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>.
641                        </para>
642
643                        <para>
644                                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.
645                        </para>
646                </description>
647        </bitlbee-setting>
648
649        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
650                <default>false</default>
651
652                <description>
653                        <para>
654                                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. ;-)
655                        </para>
656                </description>
657        </bitlbee-setting>
658
659        <bitlbee-setting name="web_aware" type="string" scope="account">
660                <default>false</default>
661
662                <description>
663                        <para>
664                                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.
665                        </para>
666
667                        <para>
668                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
669                        </para>
670                </description>
671        </bitlbee-setting>
672
673        <bitlbee-command name="rename">
674                <short-description>Rename (renick) a buddy</short-description>
675                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
676
677                <description>
678                        <para>
679                                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).
680                        </para>
681                </description>
682
683                <ircexample>
684                        <ircline nick="itsme">rename itsme_ you</ircline>
685                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
686                </ircexample>
687
688        </bitlbee-command>
689
690        <bitlbee-command name="yes">
691                <short-description>Accept a request</short-description>
692                <syntax>yes [&lt;number&gt;]</syntax>
693
694                <description>
695                        <para>
696                                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.
697                        </para>
698
699                        <para>
700                                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.
701                        </para>
702                </description>
703
704        </bitlbee-command>
705
706        <bitlbee-command name="no">
707                <short-description>Deny a request</short-description>
708                <syntax>no [&lt;number&gt;]</syntax>
709
710                <description>
711                        <para>
712                                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.
713                        </para>
714
715                        <para>
716                                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.
717                        </para>
718                </description>
719        </bitlbee-command>
720
721        <bitlbee-command name="qlist">
722                <short-description>List all the unanswered questions root asked</short-description>
723                <syntax>qlist</syntax>
724
725                <description>
726                        <para>
727                                This gives you a list of all the unanswered questions from root.
728                        </para>
729                </description>
730
731        </bitlbee-command>
732
733        <bitlbee-command name="register">
734                <short-description>Register yourself</short-description>
735                <syntax>register &lt;password&gt;</syntax>
736
737                <description>
738                        <para>
739                                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.
740                        </para>
741
742                        <para>
743                                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.. ;-)
744                        </para>
745
746                        <para>
747                                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.
748                        </para>
749                </description>
750
751        </bitlbee-command>
752
753        <bitlbee-command name="identify">
754                <syntax>identify &lt;password&gt;</syntax>
755                <short-description>Identify yourself with your password</short-description>
756
757                <description>
758                        <para>
759                                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.
760                        </para>
761
762                        <para>
763                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
764                        </para>
765                </description>
766        </bitlbee-command>
767
768        <bitlbee-command name="drop">
769                <syntax>drop &lt;password&gt;</syntax>
770                <short-description>Drop your account</short-description>
771
772                <description>
773                        <para>
774                                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.
775                        </para>
776                </description>
777        </bitlbee-command>
778
779        <bitlbee-command name="blist">
780                <syntax>blist [all|online|offline|away]</syntax>
781                <short-description>List all the buddies in your contact list</short-description>
782
783                <description>
784                        <para>
785                                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.
786                        </para>
787                </description>
788
789        </bitlbee-command>
790
791        <bitlbee-command name="nick">
792                <short-description>Change friendly name, nick</short-description>
793                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
794                <syntax>nick</syntax>
795
796                <description>
797                        <para>
798                                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.
799                        </para>
800
801                        <para>
802                                It is recommended to use the per-account <emphasis>display_name</emphasis> setting to read and change this information. The <emphasis>nick</emphasis> command is deprecated.
803                        </para>
804                </description>
805
806                <ircexample>
807                        <ircline nick="wouter">nick 1 "Wouter Paesen"</ircline>
808                        <ircline nick="root">Setting your name on connection 1 to `Wouter Paesen'</ircline>
809                </ircexample>
810
811        </bitlbee-command>
812
813        <bitlbee-command name="join_chat">
814                <short-description>Join a named groupchat/conference room</short-description>
815                <syntax>import_buddies &lt;connection&gt; &lt;room name&gt; [&lt;channel name&gt;] [&lt;room nickname&gt;] [&lt;password&gt;]</syntax>
816
817                <description>
818                        <para>
819                                On most IM-networks groupchats can be started using the /join command. (<emphasis>/join #foo</emphasis> to start a chatroom with you and <emphasis>foo</emphasis>) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command.
820                        </para>
821
822                        <para>
823                                The first two arguments are required. <emphasis>room name</emphasis> is the name of the chatroom on the IM-network. <emphasis>channel name</emphasis> is the IRC channel name BitlBee should map this to. <emphasis>room nickname</emphasis> is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses.
824                        </para>
825
826                        <para>
827                                The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&amp;bitlbee-help</emphasis> because <emphasis>&amp;bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>.
828                        </para>
829                </description>
830
831                <ircexample>
832                        <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &amp;bitlbee-help help-me</ircline>
833                </ircexample>
834
835        </bitlbee-command>
836</chapter>
Note: See TracBrowser for help on using the repository browser.