Context Navigation

source: doc/user-guide/commands.xml @ 7b23afd

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: