source: doc/user-guide/commands.xml @ ab6006c

Last change on this file since ab6006c was e907683, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-06-26T23:39:31Z

Changed account set (and other account commands) syntax. Instead of
"account set acc/key value" you now do "account acc set key value". So just
the regular set syntax with a "account acc" prefix. The slash has been a
source of confusion for long enough now.

For consistency, commands like "account on acc" should now also be
"account acc on" instead. Same for the new "channel" comand, of course.
  • Property mode set to 100644
File size: 46.8 KB
Line 
1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
9
10                <description>
11
12                        <para>
13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
14                        </para>
15
16                </description>
17
18                <bitlbee-command name="add">
19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>
20
21                        <description>
22                                <para>
23                                        Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ), Yahoo and Twitter. For more information about adding an account, see <emphasis>help account add &lt;protocol&gt;</emphasis>.
24                                </para>
25                        </description>
26                       
27                        <bitlbee-command name="jabber">
28                                <syntax>account add jabber &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
29
30                                <description>
31                                        <para>
32                                                The handle should be a full handle, including the domain name. You can specify a servername if necessary. Normally BitlBee doesn't need this though, since it's able to find out the server by doing DNS SRV lookups.
33                                        </para>
34
35                                        <para>
36                                                In previous versions it was also possible to specify port numbers and/or SSL in the server tag. This is deprecated and should now be done using the <emphasis>account set</emphasis> command. This also applies to specifying a resource in the handle (like <emphasis>wilmer@bitlbee.org/work</emphasis>).
37                                        </para>
38                                </description>
39                        </bitlbee-command>
40
41                        <bitlbee-command name="msn">
42                                <syntax>account add msn &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
43
44                                <description>
45                                        <para>
46                                                For MSN connections there are no special arguments.
47                                        </para>
48                                </description>
49                        </bitlbee-command>
50                       
51                        <bitlbee-command name="oscar">
52                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt;</syntax>
53
54                                <description>
55                                        <para>
56                                                OSCAR is the protocol used to connect to AIM and/or ICQ. The servers will automatically detect if you're using a numeric or non-numeric username so there's no need to tell which network you want to connect to.
57                                        </para>
58                                </description>
59
60                                <ircexample>
61                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
62                                        <ircline nick="root">Account successfully added</ircline>
63                                </ircexample>
64                        </bitlbee-command>
65                       
66                        <bitlbee-command name="twitter">
67                                <syntax>account add twitter &lt;handle&gt; &lt;password&gt;</syntax>
68
69                                <description>
70                                        <para>
71                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
72                                        </para>
73                                       
74                                        <para>
75                                                By default all your Twitter contacts will come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
76                                        </para>
77                                       
78                                        <para>
79                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
80                                        </para>
81
82                                        <para>
83                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
84                                        </para>
85                                </description>
86                        </bitlbee-command>
87
88                        <bitlbee-command name="yahoo">
89                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
90
91                                <description>
92                                        <para>
93                                                For Yahoo! connections there are no special arguments.
94                                        </para>
95                                </description>
96                        </bitlbee-command>
97
98                </bitlbee-command>
99
100                <bitlbee-command name="del">
101                        <syntax>account &lt;account id&gt; del</syntax>
102
103                        <description>
104                                <para>
105                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
106                                </para>
107
108
109                                <para>
110                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
111                                </para>
112                        </description>
113                </bitlbee-command>
114
115                <bitlbee-command name="on">
116                        <syntax>account [&lt;account id&gt;] on</syntax>
117
118                        <description>
119                                <para>
120                                        This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts that have the auto_connect flag set.
121                                </para>
122
123                                <para>
124                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
125                                </para>
126                        </description>
127
128                </bitlbee-command>
129
130                <bitlbee-command name="off">
131                        <syntax>account [&lt;account id&gt;] off</syntax>
132
133                        <description>
134                                <para>
135                                        This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts and cancel all pending reconnects.
136                                </para>
137
138                                <para>
139                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
140                                </para>
141                        </description>
142                </bitlbee-command>
143
144                <bitlbee-command name="list">
145                        <syntax>account list</syntax>
146
147                        <description>
148                                <para>
149                                        This command gives you a list of all the accounts known by BitlBee.
150                                </para>
151                        </description>
152                </bitlbee-command>
153
154                <bitlbee-command name="set">
155                        <syntax>account &lt;account id&gt; set</syntax>
156                        <syntax>account &lt;account id&gt; set &lt;setting&gt;</syntax>
157                        <syntax>account &lt;account id&gt; set &lt;setting&gt; &lt;value&gt;</syntax>
158                        <syntax>account &lt;account id&gt; set -del &lt;setting&gt;</syntax>
159
160                        <description>
161                                <para>
162                                        This command can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account set &lt;account id&gt;</emphasis>.
163                                </para>
164                               
165                                <para>
166                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
167                                </para>
168                               
169                                <para>
170                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
171                                </para>
172                        </description>
173                </bitlbee-command>
174        </bitlbee-command>
175
176        <bitlbee-command name="chat">
177                <short-description>Chatroom list maintenance</short-description>
178                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
179
180                <description>
181
182                        <para>
183                                Available actions: add, with. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
184                        </para>
185
186                </description>
187
188                <bitlbee-command name="add">
189                        <syntax>chat add &lt;account&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
190
191                        <description>
192                                <para>
193                                        Add a chatroom to the list of chatrooms you're interested in. BitlBee needs this list to map room names to a proper IRC channel name.
194                                </para>
195
196                                <para>
197                                        After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See <emphasis>chat set</emphasis>)
198                                </para>
199
200                                <para>
201                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
202                                </para>
203                        </description>
204
205                </bitlbee-command>
206
207                <bitlbee-command name="with">
208                        <syntax>chat with &lt;nickname&gt;</syntax>
209
210                        <description>
211                                <para>
212                                        While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions.
213                                </para>
214                        </description>
215                </bitlbee-command>
216        </bitlbee-command>
217
218        <bitlbee-command name="add">
219                <short-description>Add a buddy to your contact list</short-description>
220                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
221                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
222
223                <description>
224                        <para>
225                                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.
226                        </para>
227
228                        <para>
229                                If you want, you can also tell BitlBee what nick to give the new contact. The -tmp option adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications.
230                        </para>
231                </description>
232
233                <ircexample>
234                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
235                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
236                </ircexample>
237        </bitlbee-command>
238
239        <bitlbee-command name="info">
240                <short-description>Request user information</short-description>
241                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
242                <syntax>info &lt;nick&gt;</syntax>
243
244                <description>
245                        <para>
246                                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.
247                        </para>
248                </description>
249
250                <ircexample>
251                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
252                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
253                </ircexample>
254
255        </bitlbee-command>
256
257        <bitlbee-command name="remove">
258                <short-description>Remove a buddy from your contact list</short-description>
259                <syntax>remove &lt;nick&gt;</syntax>
260
261                <description>
262                        <para>
263                                Removes the specified nick from your buddy list.
264                        </para>
265                </description>
266
267                <ircexample>
268                        <ircline nick="ctrlsoft">remove gryp</ircline>
269                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
270                </ircexample>
271
272        </bitlbee-command>
273
274        <bitlbee-command name="block">
275                <short-description>Block someone</short-description>
276                <syntax>block &lt;nick&gt;</syntax>
277                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
278                <syntax>block &lt;connection&gt;</syntax>
279
280                <description>
281                        <para>
282                                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.
283                        </para>
284                       
285                        <para>
286                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
287                        </para>
288                </description>
289        </bitlbee-command>
290
291        <bitlbee-command name="allow">
292                <short-description>Unblock someone</short-description>
293                <syntax>allow &lt;nick&gt;</syntax>
294                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
295
296                <description>
297                        <para>
298                                Reverse of block. Unignores the specified user or user handle on specified connection.
299                        </para>
300                       
301                        <para>
302                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
303                        </para>
304                </description>
305        </bitlbee-command>
306
307        <bitlbee-command name="set">
308                <short-description>Miscellaneous settings</short-description>
309                <syntax>set</syntax>
310                <syntax>set &lt;variable&gt;</syntax>
311                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
312                <syntax>set -del &lt;variable&gt;</syntax>
313
314                <description>
315
316                        <para>
317                                Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. With <emphasis>-del</emphasis> you can reset a setting to its default value.
318                        </para>
319
320                        <para>
321                                To get more help information about a setting, try:
322                        </para>
323
324                </description>
325
326                <ircexample>
327                        <ircline nick="ctrlsoft">help set private</ircline>
328                </ircexample>
329
330        </bitlbee-command>
331
332        <bitlbee-command name="help">
333                <short-description>BitlBee help system</short-description>
334
335                <syntax>help [subject]</syntax>
336
337                <description>
338                        <para>
339                                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.
340                        </para>
341                </description>
342        </bitlbee-command>
343
344        <bitlbee-command name="save">
345                <short-description>Save your account data</short-description>
346                <syntax>save</syntax>
347
348                <description>
349                        <para>
350                                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... ;-)
351                        </para>
352                </description>
353        </bitlbee-command>
354
355        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
356                <default>true</default>
357
358                <description>
359                        <para>
360                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
361                        </para>
362                       
363                        <para>
364                                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!)
365                        </para>
366                </description>
367        </bitlbee-setting>
368
369        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
370                <default>false</default>
371
372                <description>
373                        <para>
374                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
375                        </para>
376                </description>
377        </bitlbee-setting>
378
379        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
380                <default>true</default>
381
382                <description>
383                        <para>
384                                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.
385                        </para>
386
387                        <para>
388                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
389                        </para>
390
391                        <para>
392                                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!)
393                        </para>
394                </description>
395        </bitlbee-setting>
396
397        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
398                <default>5*3&lt;900</default>
399
400                <description>
401                        <para>
402                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
403                        </para>
404
405                        <para>
406                                This can be one integer, for a constant delay. One can also set it to something like &quot;10*10&quot;, which means wait for ten seconds on the first reconnect, multiply it by ten on every failure. Once successfully connected, this delay is re-set to the initial value. With &lt; you can give a maximum delay.
407                        </para>
408
409                        <para>
410                                See also the <emphasis>auto_reconnect</emphasis> setting.
411                        </para>
412                </description>
413        </bitlbee-setting>
414
415        <bitlbee-setting name="away" type="string" scope="both">
416                <description>
417                        <para>
418                                To mark yourself as away, it is recommended to just use <emphasis>/away</emphasis>, like on normal IRC networks. If you want to mark yourself as away on only one IM network, you can use this per-account setting.
419                        </para>
420
421                        <para>
422                                You can set it to any value and BitlBee will try to map it to the most appropriate away state for every open IM connection, or set it as a free-form away message where possible.
423                        </para>
424
425                        <para>
426                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
427                        </para>
428                </description>
429        </bitlbee-setting>
430
431        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
432                <default>true</default>
433
434                <description>
435                        <para>
436                                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.
437                        </para>
438                </description>
439        </bitlbee-setting>
440
441        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
442                <default>3600</default>
443
444                <description>
445                        <para>
446                                Most IRC servers send a user's away message every time s/he gets a private message, to inform the sender that they may not get a response immediately. With this setting set to 0, BitlBee will also behave like this.
447                        </para>
448
449                        <para>
450                                Since not all IRC clients do an excellent job at suppressing these messages, this setting lets BitlBee do it instead. BitlBee will wait this many seconds (or until the away state/message changes) before re-informing you that the person's away.
451                        </para>
452                </description>
453        </bitlbee-setting>
454
455        <bitlbee-setting name="charset" type="string" scope="global">
456                <default>utf-8</default>
457                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
458
459                <description>
460                        <para>
461                                This setting tells BitlBee what your IRC client sends and expects. It should be equal to the charset setting of your IRC client if you want to be able to send and receive non-ASCII text properly.
462                        </para>
463
464                        <para>
465                                Most systems use UTF-8 these days. On older systems, an iso8859 charset may work better. For example, iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://www.unicodecharacter.com/charsets/iso8859.html
466                        </para>
467                </description>
468
469        </bitlbee-setting>
470
471        <bitlbee-setting name="control_channel" type="string" scope="global">
472                <default>&amp;bitlbee</default>
473
474                <description>
475                        <para>
476                                Normally the control channel where you can see all your contacts is called "&amp;bitlbee". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
477                        </para>
478                </description>
479        </bitlbee-setting>
480
481        <bitlbee-setting name="debug" type="boolean" scope="global">
482                <default>false</default>
483
484                <description>
485                        <para>
486                                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.
487                        </para>
488                </description>
489        </bitlbee-setting>
490
491        <bitlbee-setting name="default_target" type="string" scope="global">
492                <default>root</default>
493                <possible-values>root, last</possible-values>
494
495                <description>
496                        <para>
497                                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>.
498                        </para>
499                </description>
500        </bitlbee-setting>
501
502        <bitlbee-setting name="display_name" type="string" scope="account">
503                <description>
504                        <para>
505                                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.
506                        </para>
507                </description>
508        </bitlbee-setting>
509
510        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
511                <default>false</default>
512
513                <description>
514                        <para>
515                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
516                        </para>
517                </description>
518        </bitlbee-setting>
519
520        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
521                <default>true</default>
522
523                <description>
524                        <para>
525                                When incoming messages are old (i.e. offline messages and channel backlogs), BitlBee will prepend them with a timestamp. If you find them ugly or useless, you can use this setting to hide them.
526                        </para>
527                </description>
528        </bitlbee-setting>
529
530        <bitlbee-setting name="handle_unknown" type="string" scope="global">
531                <default>add_channel</default>
532                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
533
534                <description>
535                        <para>
536                                Messages from unknown users are echoed like this by default:
537                        </para>
538
539                        <ircexample>
540                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
541                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
542                        </ircexample>
543
544                        <para>
545                                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.
546                        </para>
547
548                        <note>
549                                <para>
550                                        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.
551                                </para>
552                        </note>
553                </description>
554
555        </bitlbee-setting>
556
557        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
558                <default>false</default>
559
560                <description>
561                        <para>
562                                Only supported by OSCAR so far, you can use this setting to ignore ICQ authorization requests, which are hardly used for legitimate (i.e. non-spam) reasons anymore.
563                        </para>
564                </description>
565
566        </bitlbee-setting>
567
568        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
569                <default>true</default>
570
571                <description>
572                        <para>
573                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
574                        </para>
575                </description>
576
577        </bitlbee-setting>
578
579        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
580                <default>false</default>
581
582                <description>
583                        <para>
584                                Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting.
585                        </para>
586                </description>
587
588        </bitlbee-setting>
589
590        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
591                <default>false</default>
592
593                <description>
594                        <para>
595                                Some protocols (MSN, Yahoo!) can notify via IM about new e-mail. Since most people use their Hotmail/Yahoo! addresses as a spam-box, this is disabled default. If you want these notifications, you can enable this setting.
596                        </para>
597                </description>
598
599        </bitlbee-setting>
600
601        <bitlbee-setting name="message_length" type="integer" scope="account">
602                <default>140</default>
603
604                <description>
605                        <para>
606                                Since Twitter rejects messages longer than 140 characters, BitlBee can count message length and emit a warning instead of waiting for Twitter to reject it.
607                        </para>
608
609                        <para>
610                                You can change this limit here but this won't disable length checks on Twitter's side. You can also set it to 0 to disable the check in case you believe BitlBee doesn't count the characters correctly.
611                        </para>
612                </description>
613
614        </bitlbee-setting>
615
616        <bitlbee-setting name="mode" type="string" scope="account">
617                <possible-values>one, many, chat</possible-values>
618                <default>one</default>
619
620                <description>
621                        <para>
622                                By default, everything from the Twitter module will come from one nick, twitter_(yourusername). If you prefer to have individual nicks for everyone, you can set this setting to "many" instead.
623                        </para>
624                       
625                        <para>
626                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
627                        </para>
628                       
629                        <para>
630                                In the last two modes, you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
631                        </para>
632                </description>
633
634        </bitlbee-setting>
635
636        <bitlbee-setting name="nick" type="string" scope="chat">
637
638                <description>
639                        <para>
640                                You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname.
641                        </para>
642                </description>
643        </bitlbee-setting>
644
645        <bitlbee-setting name="nick_source" type="string" scope="account">
646                <default>handle</default>
647                <possible-values>handle, full_name, first_name</possible-values>
648
649                <description>
650                        <para>
651                                By default, BitlBee generates a nickname for every contact by taking its handle and chopping off everything after the @. In some cases, this gives very inconvenient nicknames. The Facebook XMPP server is a good example, as all Facebook XMPP handles are numeric.
652                        </para>
653
654                        <para>
655                                With this setting set to <emphasis>full_name</emphasis>, the person's full name is used to generate a nickname. Or if you don't like long nicknames, set this setting to <emphasis>first_name</emphasis> instead and only the first word will be used. Note that the full name can be full of non-ASCII characters which will be stripped off.
656                        </para>
657                </description>
658        </bitlbee-setting>
659
660        <bitlbee-setting name="oauth" type="boolean" scope="account">
661                <default>true</default>
662
663                <description>
664                        <para>
665                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
666                        </para>
667
668                        <para>
669                                With OAuth enabled, you shouldn't tell BitlBee your Twitter password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with Twitter. If this succeeds, Twitter will return a PIN code which you can give back to BitlBee to finish the process.
670                        </para>
671
672                        <para>
673                                The resulting access token will be saved permanently, so you have to do this only once.
674                        </para>
675                </description>
676
677        </bitlbee-setting>
678
679        <bitlbee-setting name="ops" type="string" scope="global">
680                <default>both</default>
681                <possible-values>both, root, user, none</possible-values>
682
683                <description>
684                        <para>
685                                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.
686                        </para>
687
688                        <para>
689                                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.
690                        </para>
691                </description>
692        </bitlbee-setting>
693
694        <bitlbee-setting name="password" type="string" scope="both">
695                <description>
696                        <para>
697                                Use this global setting to change your "NickServ" password.
698                        </para>
699                       
700                        <para>
701                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
702                        </para>
703                       
704                        <para>
705                                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.
706                        </para>
707                </description>
708        </bitlbee-setting>
709
710        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
711                <default>false</default>
712
713                <description>
714                        <para>
715                                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.
716                        </para>
717
718                        <para>
719                                Using the <emphasis>paste_buffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
720                        </para>
721
722                        <para>
723                                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.
724                        </para>
725                </description>
726        </bitlbee-setting>
727
728        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
729                <default>200</default>
730
731                <description>
732
733                        <para>
734                                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.
735                        </para>
736
737                        <para>
738                                See also the <emphasis>paste_buffer</emphasis> setting.
739                        </para>
740                </description>
741        </bitlbee-setting>
742       
743        <bitlbee-setting name="port" type="integer" scope="account">
744                <description>
745                        <para>
746                                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.
747                        </para>
748                </description>
749        </bitlbee-setting>
750
751        <bitlbee-setting name="priority" type="integer" scope="account">
752                <default>0</default>
753
754                <description>
755                        <para>
756                                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).
757                        </para>
758
759                        <para>
760                                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).
761                        </para>
762                </description>
763        </bitlbee-setting>
764
765        <bitlbee-setting name="private" type="boolean" scope="global">
766                <default>true</default>
767
768                <description>
769                        <para>
770                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
771                        </para>
772
773                        <para>
774                                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.
775                        </para>
776                </description>
777        </bitlbee-setting>
778
779        <bitlbee-setting name="query_order" type="string" scope="global">
780                <default>lifo</default>
781                <possible-values>lifo, fifo</possible-values>
782
783                <description>
784                        <para>
785                                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.
786                        </para>
787
788                        <para>
789                                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).
790                        </para>
791                </description>
792        </bitlbee-setting>
793
794        <bitlbee-setting name="resource" type="string" scope="account">
795                <default>BitlBee</default>
796
797                <description>
798                        <para>
799                                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.
800                        </para>
801                </description>
802        </bitlbee-setting>
803
804        <bitlbee-setting name="resource_select" type="string" scope="account">
805                <default>activity</default>
806                <possible-values>priority, activity</possible-values>
807
808                <description>
809                        <para>
810                                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.
811                        </para>
812
813                        <para>
814                                Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>activity</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected).
815                        </para>
816                </description>
817        </bitlbee-setting>
818
819        <bitlbee-setting name="root_nick" type="string" scope="global">
820                <default>root</default>
821
822                <description>
823                        <para>
824                                Normally the "bot" that takes all your BitlBee commands is called "root". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
825                        </para>
826                </description>
827        </bitlbee-setting>
828
829        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
830                <default>true</default>
831
832                <description>
833                        <para>
834                                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.
835                        </para>
836                </description>
837        </bitlbee-setting>
838
839        <bitlbee-setting name="server" type="string" scope="account">
840                <description>
841                        <para>
842                                Can be set for Jabber- and OSCAR-connections. For Jabber, you might have to set this if the servername isn't equal to the part after the @ in the Jabber handle. For OSCAR this shouldn't be necessary anymore in recent BitlBee versions.
843                        </para>
844                </description>
845        </bitlbee-setting>
846
847        <bitlbee-setting name="show_offline" type="boolean" scope="global">
848                <default>false</default>
849
850                <description>
851                        <para>
852                                If enabled causes BitlBee to also show offline users in Channel. Online-users will get op, away-users voice and offline users none of both. This option takes effect as soon as you reconnect.
853                        </para>
854                </description>
855        </bitlbee-setting>
856
857        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
858                <default>true</default>
859
860                <description>
861                        <para>
862                                Some IRC clients parse quit messages sent by the IRC server to see if someone really left or just disappeared because of a netsplit. By default, BitlBee tries to simulate netsplit-like quit messages to keep the control channel window clean. If you don't like this (or if your IRC client doesn't support this) you can disable this setting.
863                        </para>
864                </description>
865        </bitlbee-setting>
866
867        <bitlbee-setting name="ssl" type="boolean" scope="account">
868                <default>false</default>
869
870                <description>
871                        <para>
872                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
873                        </para>
874                </description>
875        </bitlbee-setting>
876
877        <bitlbee-setting name="status" type="string" scope="both">
878                <description>
879                        <para>
880                                Certain protocols (like Jabber/XMPP) support status messages, similar to away messages. They can be used to indicate things like your location or activity, without showing up as away/busy.
881                        </para>
882
883                        <para>
884                                This setting can be used to set such a message. It will be available as a per-account setting for protocols that support it, and also as a global setting (which will then automatically be used for all protocols that support it).
885                        </para>
886
887                        <para>
888                                Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To un-set the setting, use <emphasis>set -del status</emphasis>.
889                        </para>
890                </description>
891        </bitlbee-setting>
892
893        <bitlbee-setting name="strip_html" type="boolean" scope="global">
894                <default>true</default>
895
896                <description>
897                        <para>
898                                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.
899                        </para>
900                        <para>
901                                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.
902                        </para>
903                </description>
904        </bitlbee-setting>
905
906        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
907                <default>false</default>
908
909                <description>
910                        <para>
911                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
912                        </para>
913                       
914                        <para>
915                                With this setting enabled, BitlBee will send keepalives to MSN switchboards with offline/invisible contacts every twenty seconds. This should keep the server and client on the other side from shutting it down.
916                        </para>
917                       
918                        <para>
919                                This is useful because BitlBee doesn't support MSN offline messages yet and the MSN servers won't let the user reopen switchboards to offline users. Once offline messaging is supported, this flag might be removed.
920                        </para>
921                </description>
922        </bitlbee-setting>
923
924        <bitlbee-setting name="timezone" type="string" scope="global">
925                <default>local</default>
926                <possible-values>local, utc, gmt, timezone-spec</possible-values>
927
928                <description>
929                        <para>
930                                If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting.
931                        </para>
932
933                        <para>
934                                Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time.
935                        </para>
936                </description>
937        </bitlbee-setting>
938
939        <bitlbee-setting name="tls" type="boolean" scope="account">
940                <default>try</default>
941
942                <description>
943                        <para>
944                                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.
945                        </para>
946
947                        <para>
948                                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.
949                        </para>
950                </description>
951        </bitlbee-setting>
952
953        <bitlbee-setting name="to_char" type="string" scope="global">
954                <default>": "</default>
955
956                <description>
957                        <para>
958                                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>.
959                        </para>
960
961                        <para>
962                                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.
963                        </para>
964                </description>
965        </bitlbee-setting>
966
967        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
968                <default>false</default>
969
970                <description>
971                        <para>
972                                Sends you a /notice when a user starts typing a message (if supported by the IM protocol and the user's client). To use this, you most likely want to use a script in your IRC client to show this information in a more sensible way.
973                        </para>
974                </description>
975        </bitlbee-setting>
976
977        <bitlbee-setting name="user_agent" type="string" scope="account">
978                <default>BitlBee</default>
979
980                <description>
981                        <para>
982                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
983                        </para>
984                       
985                        <para>
986                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
987                        </para>
988                </description>
989        </bitlbee-setting>
990
991        <bitlbee-setting name="web_aware" type="string" scope="account">
992                <default>false</default>
993
994                <description>
995                        <para>
996                                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.
997                        </para>
998
999                        <para>
1000                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1001                        </para>
1002                </description>
1003        </bitlbee-setting>
1004
1005        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1006                <default>false</default>
1007
1008                <description>
1009                        <para>
1010                                The Jabber module allows you to add a buddy <emphasis>xmlconsole</emphasis> to your contact list, which will then show you the raw XMPP stream between you and the server. You can also send XMPP packets to this buddy, which will then be sent to the server.
1011                        </para>
1012                        <para>
1013                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1014                        </para>
1015                </description>
1016        </bitlbee-setting>
1017
1018        <bitlbee-command name="rename">
1019                <short-description>Rename (renick) a buddy</short-description>
1020                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1021
1022                <description>
1023                        <para>
1024                                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).
1025                        </para>
1026                </description>
1027
1028                <ircexample>
1029                        <ircline nick="itsme">rename itsme_ you</ircline>
1030                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1031                </ircexample>
1032
1033        </bitlbee-command>
1034
1035        <bitlbee-command name="yes">
1036                <short-description>Accept a request</short-description>
1037                <syntax>yes [&lt;number&gt;]</syntax>
1038
1039                <description>
1040                        <para>
1041                                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.
1042                        </para>
1043
1044                        <para>
1045                                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.
1046                        </para>
1047                </description>
1048
1049        </bitlbee-command>
1050
1051        <bitlbee-command name="no">
1052                <short-description>Deny a request</short-description>
1053                <syntax>no [&lt;number&gt;]</syntax>
1054
1055                <description>
1056                        <para>
1057                                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.
1058                        </para>
1059
1060                        <para>
1061                                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.
1062                        </para>
1063                </description>
1064        </bitlbee-command>
1065
1066        <bitlbee-command name="qlist">
1067                <short-description>List all the unanswered questions root asked</short-description>
1068                <syntax>qlist</syntax>
1069
1070                <description>
1071                        <para>
1072                                This gives you a list of all the unanswered questions from root.
1073                        </para>
1074                </description>
1075
1076        </bitlbee-command>
1077
1078        <bitlbee-command name="register">
1079                <short-description>Register yourself</short-description>
1080                <syntax>register &lt;password&gt;</syntax>
1081
1082                <description>
1083                        <para>
1084                                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.
1085                        </para>
1086
1087                        <para>
1088                                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.. ;-)
1089                        </para>
1090
1091                        <para>
1092                                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.
1093                        </para>
1094                </description>
1095
1096        </bitlbee-command>
1097
1098        <bitlbee-command name="identify">
1099                <syntax>identify [-noload|-force] &lt;password&gt;</syntax>
1100                <short-description>Identify yourself with your password</short-description>
1101
1102                <description>
1103                        <para>
1104                                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.
1105                        </para>
1106
1107                        <para>
1108                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1109                        </para>
1110
1111                        <para>
1112                                The <emphasis>-noload</emphasis> and <emphasis>-force</emphasis> flags can be used to identify when you're logged into some IM accounts already. <emphasis>-force</emphasis> will let you identify yourself and load all saved accounts (and keep the accounts you're logged into already).
1113                        </para>
1114                       
1115                        <para>
1116                                <emphasis>-noload</emphasis> will log you in but not load any accounts and settings saved under your current nickname. These will be overwritten once you save your settings (i.e. when you disconnect).
1117                        </para>
1118                </description>
1119        </bitlbee-command>
1120
1121        <bitlbee-command name="drop">
1122                <syntax>drop &lt;password&gt;</syntax>
1123                <short-description>Drop your account</short-description>
1124
1125                <description>
1126                        <para>
1127                                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.
1128                        </para>
1129                </description>
1130        </bitlbee-command>
1131
1132        <bitlbee-command name="blist">
1133                <syntax>blist [all|online|offline|away]</syntax>
1134                <short-description>List all the buddies in your contact list</short-description>
1135
1136                <description>
1137                        <para>
1138                                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.
1139                        </para>
1140                </description>
1141
1142        </bitlbee-command>
1143
1144        <bitlbee-command name="nick">
1145                <short-description>Change friendly name, nick</short-description>
1146                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
1147                <syntax>nick &lt;connection&gt;</syntax>
1148
1149                <description>
1150                        <para>
1151                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
1152                        </para>
1153                </description>
1154
1155                <ircexample>
1156                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
1157                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
1158                </ircexample>
1159
1160        </bitlbee-command>
1161       
1162        <bitlbee-command name="transfers">
1163                <short-description>Monitor, cancel, or reject file transfers</short-description>
1164                <syntax>transfers [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
1165               
1166                <description>
1167                        <para>
1168                                Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfers &lt;action&gt;</emphasis> for more information.
1169                        </para>
1170
1171                        <ircexample>
1172                                <ircline nick="ulim">transfers</ircline>
1173                        </ircexample>
1174                </description>
1175               
1176                <bitlbee-command name="cancel">
1177                        <short-description>Cancels the file transfer with the given id</short-description>
1178                        <syntax>transfers &lt;cancel&gt; id</syntax>
1179
1180                        <description>
1181                                <para>Cancels the file transfer with the given id</para>
1182                        </description>
1183
1184                        <ircexample>
1185                                <ircline nick="ulim">transfers cancel 1</ircline>
1186                                <ircline nick="root">Canceling file transfer for test</ircline>
1187                        </ircexample>
1188                </bitlbee-command>
1189
1190                <bitlbee-command name="reject">
1191                        <short-description>Rejects all incoming transfers</short-description>
1192                        <syntax>transfers &lt;reject&gt;</syntax>
1193
1194                        <description>
1195                                <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is neccessary. Or is it?</para>
1196                        </description>
1197
1198                        <ircexample>
1199                                <ircline nick="ulim">transfers reject</ircline>
1200                        </ircexample>
1201                </bitlbee-command>
1202        </bitlbee-command>
1203       
1204</chapter>
Note: See TracBrowser for help on using the repository browser.