Context Navigation

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

Last change on this file since fc34fb5 was 673a54c, checked in by Sven Moritz Hallberg <pesco@…>, at 2009-03-12T19:33:28Z
pretty blind try at merging in the latest trunk
Property mode set to `100644`
File size: 43.3 KB

Rev	Line
[b7d3cc34]	1	<chapter id="commands">
	2	<title>Bitlbee commands</title>
	3
	4	<command-list/>
	5
	6	<bitlbee-command name="account">
	7	<short-description>IM-account list maintenance</short-description>
	8	<syntax>account <action> [<arguments>]</syntax>
	9
	10	<description>
	11
	12	<para>
[75a4b85]	13	Available actions: add, del, list, on, off and set. See <emphasis>help account <action></emphasis> for more information.
[b7d3cc34]	14	</para>
	15
	16	</description>
	17
	18	<bitlbee-command name="add">
[30ce1ce]	19	<syntax>account add <protocol> <username> <password></syntax>
[b7d3cc34]	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">
[30ce1ce]	28	<syntax>account add jabber <handle@server.tld> <password></syntax>
[b7d3cc34]	29
	30	<description>
	31	<para>
[ee5c355]	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.
[b7d3cc34]	33	</para>
	34
	35	<para>
[ee5c355]	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>).
[b7d3cc34]	37	</para>
	38	</description>
	39	</bitlbee-command>
	40
	41	<bitlbee-command name="msn">
[75a4b85]	42	<syntax>account add msn <handle@server.tld> <password></syntax>
[b7d3cc34]	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">
[30ce1ce]	52	<syntax>account add oscar <handle> <password></syntax>
[b7d3cc34]	53
	54	<description>
	55	<para>
[30ce1ce]	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.
[b7d3cc34]	57	</para>
	58	</description>
	59
	60	<ircexample>
[30ce1ce]	61	<ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
[b7d3cc34]	62	<ircline nick="root">Account successfully added</ircline>
	63	</ircexample>
	64	</bitlbee-command>
	65
	66	<bitlbee-command name="yahoo">
	67	<syntax>account add yahoo <handle> <password></syntax>
	68
	69	<description>
	70	<para>
	71	For Yahoo! connections there are no special arguments.
	72	</para>
	73	</description>
	74	</bitlbee-command>
	75
	76	</bitlbee-command>
	77
	78	<bitlbee-command name="del">
	79	<syntax>account del <account id></syntax>
	80
	81	<description>
	82	<para>
	83	This commands deletes an account from your account list. You should signoff the account before deleting it.
	84	</para>
	85
	86
	87	<para>
	88	The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
	89	</para>
	90	</description>
	91	</bitlbee-command>
	92
	93	<bitlbee-command name="on">
	94	<syntax>account on [<account id>]</syntax>
	95
	96	<description>
	97	<para>
[75a4b85]	98	This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts that have the auto_connect flag set.
[b7d3cc34]	99	</para>
	100
	101	<para>
	102	The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
	103	</para>
	104	</description>
	105
	106	</bitlbee-command>
	107
	108	<bitlbee-command name="off">
	109	<syntax>account off [<account id>]</syntax>
	110
	111	<description>
	112	<para>
[75a4b85]	113	This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts and cancel all pending reconnects.
[b7d3cc34]	114	</para>
	115
	116	<para>
	117	The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
	118	</para>
	119	</description>
	120	</bitlbee-command>
	121
	122	<bitlbee-command name="list">
	123	<syntax>account list</syntax>
	124
	125	<description>
	126	<para>
[c1333754]	127	This command gives you a list of all the accounts known by BitlBee.
[b7d3cc34]	128	</para>
	129	</description>
	130	</bitlbee-command>
[75a4b85]	131
	132	<bitlbee-command name="set">
	133	<syntax>account set <account id></syntax>
	134	<syntax>account set <account id>/<setting></syntax>
	135	<syntax>account set <account id>/<setting> <value></syntax>
[cd428e4]	136	<syntax>account set -del <account id>/<setting></syntax>
[75a4b85]	137
	138	<description>
	139	<para>
[c1333754]	140	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 <account id></emphasis>.
[75a4b85]	141	</para>
	142
	143	<para>
[c1333754]	144	For more infomation about a setting, see <emphasis>help set <setting></emphasis>.
[75a4b85]	145	</para>
	146
	147	<para>
	148	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.
	149	</para>
	150	</description>
	151	</bitlbee-command>
[b7d3cc34]	152	</bitlbee-command>
	153
[c1333754]	154	<bitlbee-command name="chat">
	155	<short-description>Chatroom list maintenance</short-description>
	156	<syntax>chat <action> [<arguments>]</syntax>
	157
	158	<description>
	159
	160	<para>
	161	Available actions: add, del, list, with and set. See <emphasis>help chat <action></emphasis> for more information.
	162	</para>
	163
	164	</description>
	165
	166	<bitlbee-command name="add">
	167	<syntax>chat add <account> <room> [<channel>]</syntax>
	168
	169	<description>
	170	<para>
	171	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.
	172	</para>
	173
	174	<para>
	175	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>)
	176	</para>
	177	</description>
	178
	179	</bitlbee-command>
	180
	181	<bitlbee-command name="del">
	182	<syntax>chat del <chat id></syntax>
	183
	184	<description>
	185	<para>
	186	This commands deletes an chatroom from your list.
	187	</para>
	188
	189	<para>
	190	The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
	191	</para>
	192	</description>
	193	</bitlbee-command>
	194
	195	<bitlbee-command name="list">
	196	<syntax>chat list</syntax>
	197
	198	<description>
	199	<para>
	200	This command gives you a list of all the chatrooms known by BitlBee.
	201	</para>
	202	</description>
	203	</bitlbee-command>
	204
	205	<bitlbee-command name="with">
	206	<syntax>chat with <nickname></syntax>
	207
	208	<description>
	209	<para>
	210	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.
	211	</para>
	212	</description>
	213	</bitlbee-command>
	214
	215	<bitlbee-command name="set">
	216	<syntax>chat set <chat id></syntax>
	217	<syntax>chat set <chat id>/<setting></syntax>
	218	<syntax>chat set <chat id>/<setting> <value></syntax>
	219	<syntax>chat set -del <chat id>/<setting></syntax>
	220
	221	<description>
	222	<para>
	223	This command can be used to change various settings for chatrooms.
	224	</para>
	225
	226	<para>
	227	For more infomation about a setting, see <emphasis>help set <setting></emphasis>.
	228	</para>
	229
	230	<para>
	231	The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
	232	</para>
	233	</description>
	234	</bitlbee-command>
	235	</bitlbee-command>
	236
[b7d3cc34]	237	<bitlbee-command name="add">
	238	<short-description>Add a buddy to your contact list</short-description>
	239	<syntax>add <connection> <handle> [<nick>]</syntax>
[ea3a26d]	240	<syntax>add -tmp <connection> <handle> [<nick>]</syntax>
[b7d3cc34]	241
	242	<description>
	243	<para>
	244	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.
	245	</para>
	246
	247	<para>
[b27557b]	248	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.
[ea3a26d]	249	</para>
[b7d3cc34]	250	</description>
	251
	252	<ircexample>
	253	<ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
[689a6e0]	254	<ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&bitlbee</emphasis></ircaction>
[b7d3cc34]	255	</ircexample>
	256	</bitlbee-command>
	257
	258	<bitlbee-command name="info">
	259	<short-description>Request user information</short-description>
	260	<syntax>info <connection> <handle></syntax>
	261	<syntax>info <nick></syntax>
	262
	263	<description>
	264	<para>
	265	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.
	266	</para>
	267	</description>
	268
	269	<ircexample>
	270	<ircline nick="ctrlsoft">info 0 72696705</ircline>
	271	<ircline nick="root">User info - UIN: 72696705 Nick: Lintux First/Last name: Wilmer van der Gaast E-mail: lintux@lintux.cx</ircline>
	272	</ircexample>
	273
	274	</bitlbee-command>
	275
	276	<bitlbee-command name="remove">
	277	<short-description>Remove a buddy from your contact list</short-description>
	278	<syntax>remove <nick></syntax>
	279
	280	<description>
	281	<para>
	282	Removes the specified nick from your buddy list.
	283	</para>
	284	</description>
	285
	286	<ircexample>
	287	<ircline nick="ctrlsoft">remove gryp</ircline>
	288	<ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
	289	</ircexample>
	290
	291	</bitlbee-command>
	292
	293	<bitlbee-command name="block">
	294	<short-description>Block someone</short-description>
	295	<syntax>block <nick></syntax>
	296	<syntax>block <connection> <handle></syntax>
[9b8efab]	297	<syntax>block <connection></syntax>
[b7d3cc34]	298
	299	<description>
	300	<para>
	301	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.
	302	</para>
[9b8efab]	303
	304	<para>
	305	When called with only a connection specification as an argument, the command displays the current block list for that connection.
	306	</para>
[b7d3cc34]	307	</description>
	308	</bitlbee-command>
	309
	310	<bitlbee-command name="allow">
	311	<short-description>Unblock someone</short-description>
	312	<syntax>allow <nick></syntax>
	313	<syntax>allow <connection> <handle></syntax>
	314
	315	<description>
	316	<para>
	317	Reverse of block. Unignores the specified user or user handle on specified connection.
	318	</para>
[9b8efab]	319
	320	<para>
	321	When called with only a connection specification as an argument, the command displays the current allow list for that connection.
	322	</para>
[b7d3cc34]	323	</description>
	324	</bitlbee-command>
[f5ac0fb]	325
	326	<bitlbee-command name="otr">
	327	<short-description>Off-the-Record encryption control</short-description>
	328	<syntax>otr <subcommand> [<arguments>]</syntax>
	329
	330	<description>
	331
	332	<para>
	333	Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr <subcommand></emphasis> for more information.
	334	</para>
	335
	336	</description>
	337
	338	<bitlbee-command name="connect">
	339	<syntax>otr connect <nick></syntax>
	340
	341	<description>
	342
	343	<para>
	344	Attempts to establish an encrypted connection with the specified user by sending a magic string.
	345	</para>
	346
	347	</description>
	348
	349	</bitlbee-command>
	350
	351	<bitlbee-command name="disconnect">
	352	<syntax>otr disconnect <nick></syntax>
	353
	354	<description>
	355
	356	<para>
	357	Resets the connection with the specified user to cleartext.
	358	</para>
	359
	360	</description>
	361
	362	</bitlbee-command>
	363
	364	<bitlbee-command name="smp">
	365	<syntax>otr smp <nick> <secret></syntax>
	366
	367	<description>
	368
	369	<para>
	370	Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
	371	</para>
	372
	373	<para>
	374	If an SMP challenge has already been received from the given user, responds with the specified secret. Otherwise, a challenge for the secret will be sent. If the protocol succeeds (i.e. both parties gave the same secret), the fingerprint will be trusted.
	375	</para>
	376
	377	</description>
	378
	379	</bitlbee-command>
	380
	381	<bitlbee-command name="trust">
	382	<syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax>
	383
	384	<description>
	385
	386	<para>
	387	Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
	388	</para>
	389
	390	</description>
	391
	392	</bitlbee-command>
	393
	394	<bitlbee-command name="info">
	395	<syntax>otr info</syntax>
	396	<syntax>otr info <nick></syntax>
	397
	398	<description>
	399
	400	<para>
	401	Shows information about the OTR state. The first form lists our private keys and current OTR contexts. The second form displays information about the connection with a given user, including the list of their known fingerprints.
	402	</para>
	403
	404	</description>
	405
	406	</bitlbee-command>
	407
	408	<bitlbee-command name="keygen">
	409	<syntax>otr keygen <account-no></syntax>
	410
	411	<description>
	412
	413	<para>
	414	Generates a new OTR private key for the given account.
	415	</para>
	416
	417	</description>
	418
	419	</bitlbee-command>
	420
	421	<bitlbee-command name="forget">
	422	<syntax>otr forget <thing> <arguments></syntax>
	423
	424	<description>
	425
	426	<para>
[d0faf62]	427	Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information.
[f5ac0fb]	428	</para>
	429
	430	</description>
	431
	432	<bitlbee-command name="fingerprint">
	433	<syntax>otr forget fingerprint <nick> <fingerprint></syntax>
	434
	435	<description>
	436
	437	<para>
	438	Drops the specified fingerprint from the given user's OTR connection context. It is allowed to specify only a (unique) prefix of the desired fingerprint.
	439	</para>
	440
	441	</description>
	442
	443	</bitlbee-command>
	444
	445	<bitlbee-command name="context">
	446	<syntax>otr forget context <nick></syntax>
	447
	448	<description>
	449
	450	<para>
	451	Forgets the entire OTR context associated with the given user. This includes current message and protocol states, as well as any fingerprints for that user.
	452	</para>
	453
	454	</description>
	455
	456	</bitlbee-command>
	457
[d0faf62]	458	<bitlbee-command name="key">
	459	<syntax>otr forget key <fingerprint></syntax>
	460
	461	<description>
	462
	463	<para>
	464	Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
	465	</para>
	466
	467	</description>
	468
	469	</bitlbee-command>
	470
[f5ac0fb]	471	</bitlbee-command>
	472
	473	</bitlbee-command>
[b7d3cc34]	474
	475	<bitlbee-command name="set">
	476	<short-description>Miscellaneous settings</short-description>
[cd428e4]	477	<syntax>set</syntax>
	478	<syntax>set <variable></syntax>
	479	<syntax>set <variable> <value></syntax>
	480	<syntax>set -del <variable></syntax>
[b7d3cc34]	481
	482	<description>
	483
	484	<para>
[cd428e4]	485	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.
[b7d3cc34]	486	</para>
	487
	488	<para>
	489	To get more help information about a setting, try:
	490	</para>
	491
	492	</description>
	493
	494	<ircexample>
	495	<ircline nick="ctrlsoft">help set private</ircline>
	496	</ircexample>
	497
	498	</bitlbee-command>
	499
	500	<bitlbee-command name="help">
	501	<short-description>BitlBee help system</short-description>
	502
	503	<syntax>help [subject]</syntax>
	504
	505	<description>
	506	<para>
	507	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.
	508	</para>
	509	</description>
	510	</bitlbee-command>
	511
	512	<bitlbee-command name="save">
	513	<short-description>Save your account data</short-description>
	514	<syntax>save</syntax>
	515
	516	<description>
	517	<para>
	518	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... ;-)
	519	</para>
	520	</description>
	521	</bitlbee-command>
	522
[89a1809]	523	<bitlbee-setting name="auto_connect" type="boolean" scope="both">
	524	<default>true</default>
[b7d3cc34]	525
	526	<description>
	527	<para>
[75a4b85]	528	With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
[b7d3cc34]	529	</para>
[75a4b85]	530
[b7d3cc34]	531	<para>
[75a4b85]	532	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!)
[b7d3cc34]	533	</para>
	534	</description>
	535	</bitlbee-setting>
	536
[c1333754]	537	<bitlbee-setting name="auto_join" type="boolean" scope="chat">
	538	<default>false</default>
	539
	540	<description>
	541	<para>
	542	With this option enabled, BitlBee will automatically join this chatroom when you log in.
	543	</para>
	544	</description>
	545	</bitlbee-setting>
	546
[89a1809]	547	<bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
	548	<default>false</default>
[b7d3cc34]	549
	550	<description>
	551	<para>
[75a4b85]	552	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.
[b7d3cc34]	553	</para>
	554
	555	<para>
[75a4b85]	556	See also the <emphasis>auto_reconnect_delay</emphasis> setting.
[b7d3cc34]	557	</para>
[75a4b85]	558
[89a1809]	559	<para>
	560	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!)
	561	</para>
	562	</description>
[b7d3cc34]	563	</bitlbee-setting>
	564
[823de9d]	565	<bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
	566	<default>5*3<900</default>
[b7d3cc34]	567
	568	<description>
	569	<para>
[823de9d]	570	Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
	571	</para>
	572
	573	<para>
	574	This can be one integer, for a constant delay. One can also set it to something like "10*10", 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 < you can give a maximum delay.
[75a4b85]	575	</para>
	576
	577	<para>
	578	See also the <emphasis>auto_reconnect</emphasis> setting.
[b7d3cc34]	579	</para>
	580	</description>
	581	</bitlbee-setting>
	582
[89a1809]	583	<bitlbee-setting name="away_devoice" type="boolean" scope="global">
	584	<default>true</default>
[b7d3cc34]	585
	586	<description>
	587	<para>
[75a4b85]	588	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.
[b7d3cc34]	589	</para>
	590	</description>
	591	</bitlbee-setting>
	592
[89a1809]	593	<bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
	594	<default>false</default>
[b7d3cc34]	595
	596	<description>
	597	<para>
[75a4b85]	598	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.
	599	</para>
	600
	601	<para>
	602	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.
	603	</para>
	604
	605	<para>
	606	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.
[b7d3cc34]	607	</para>
	608	</description>
	609	</bitlbee-setting>
	610
[89a1809]	611	<bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
[75a4b85]	612	<default>200</default>
[b7d3cc34]	613
	614	<description>
	615
	616	<para>
[75a4b85]	617	Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds.
[b7d3cc34]	618	</para>
	619
	620	<para>
[75a4b85]	621	See also the <emphasis>buddy_sendbuffer</emphasis> setting.
[b7d3cc34]	622	</para>
	623	</description>
	624	</bitlbee-setting>
	625
[89a1809]	626	<bitlbee-setting name="charset" type="string" scope="global">
[b27557b]	627	<default>utf-8</default>
[75a4b85]	628	<possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
[b7d3cc34]	629
	630	<description>
	631	<para>
[b27557b]	632	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.
[75a4b85]	633	</para>
	634
	635	<para>
[b27557b]	636	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
[b7d3cc34]	637	</para>
	638	</description>
[75a4b85]	639
[b7d3cc34]	640	</bitlbee-setting>
	641
[1c18ce1]	642	<bitlbee-setting name="color_encrypted" type="boolean" scope="global">
	643	<default>true</default>
	644
	645	<description>
	646	<para>
	647	If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
	648	</para>
	649	</description>
	650
	651	</bitlbee-setting>
	652
[89a1809]	653	<bitlbee-setting name="debug" type="boolean" scope="global">
	654	<default>false</default>
[b7d3cc34]	655
	656	<description>
	657	<para>
[75a4b85]	658	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.
[b7d3cc34]	659	</para>
[75a4b85]	660	</description>
	661	</bitlbee-setting>
	662
[89a1809]	663	<bitlbee-setting name="default_target" type="string" scope="global">
[75a4b85]	664	<default>root</default>
	665	<possible-values>root, last</possible-values>
[b7d3cc34]	666
[75a4b85]	667	<description>
[b7d3cc34]	668	<para>
[75a4b85]	669	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>.
[b7d3cc34]	670	</para>
	671	</description>
	672	</bitlbee-setting>
	673
[89a1809]	674	<bitlbee-setting name="display_name" type="string" scope="account">
[b7d3cc34]	675	<description>
	676	<para>
[75a4b85]	677	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.
[b7d3cc34]	678	</para>
	679	</description>
	680	</bitlbee-setting>
	681
[89a1809]	682	<bitlbee-setting name="display_namechanges" type="boolean" scope="global">
	683	<default>false</default>
[75a4b85]	684
[2529faf]	685	<description>
	686	<para>
	687	With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
	688	</para>
	689	</description>
[75a4b85]	690	</bitlbee-setting>
	691
[89a1809]	692	<bitlbee-setting name="handle_unknown" type="string" scope="global">
[b7d3cc34]	693	<default>root</default>
	694	<possible-values>root, add, add_private, add_channel, ignore</possible-values>
	695
	696	<description>
	697	<para>
	698	Messages from unknown users are echoed like this by default:
	699	</para>
	700
	701	<ircexample>
	702	<ircline nick="root">Unknown message from handle 3137137:</ircline>
	703	<ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
	704	</ircexample>
	705
	706	<para>
	707	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.
	708	</para>
	709
	710	<note>
	711	<para>
	712	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.
	713	</para>
	714	</note>
	715	</description>
	716
	717	</bitlbee-setting>
	718
[1c18ce1]	719	<bitlbee-setting name="halfop_buddies" type="string" scope="global">
	720	<default>encrypted</default>
	721	<possible-values>encrypted, trusted, notaway, false</possible-values>
	722
	723	<description>
	724	<para>
	725	Specifies under which circumstances BitlBee should give the "halfop" mode flag (+h) to buddies.
	726	</para>
	727
	728	<para>
	729	If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
	730	</para>
	731	</description>
	732
	733	</bitlbee-setting>
	734
[89a1809]	735	<bitlbee-setting name="lcnicks" type="boolean" scope="global">
	736	<default>true</default>
[b7d3cc34]	737
	738	<description>
	739	<para>
[75a4b85]	740	Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
[b7d3cc34]	741	</para>
	742	</description>
[75a4b85]	743
[b7d3cc34]	744	</bitlbee-setting>
	745
[1febf5c]	746	<bitlbee-setting name="mail_notifications" type="boolean" scope="account">
	747	<default>false</default>
	748
	749	<description>
	750	<para>
	751	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.
	752	</para>
	753	</description>
	754
	755	</bitlbee-setting>
	756
[1c18ce1]	757	<bitlbee-setting name="op_buddies" type="string" scope="global">
	758	<default>trusted</default>
	759	<possible-values>encrypted, trusted, notaway, false</possible-values>
[b7d3cc34]	760
	761	<description>
	762	<para>
[1c18ce1]	763	Specifies under which circumstances BitlBee should give the "op" mode flag (+o) to buddies.
	764	</para>
	765
	766	<para>
	767	If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
[b7d3cc34]	768	</para>
[1c18ce1]	769	</description>
	770
	771	</bitlbee-setting>
[b7d3cc34]	772
[1c18ce1]	773	<bitlbee-setting name="op_root" type="bool" scope="global">
	774	<default>true</default>
	775
	776	<description>
[b7d3cc34]	777	<para>
[1c18ce1]	778	Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can set the desired state for root using this setting.
	779	</para>
	780	</description>
	781	</bitlbee-setting>
	782
	783	<bitlbee-setting name="op_user" type="bool" scope="global">
	784	<default>true</default>
	785
	786	<description>
	787	<para>
	788	Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can set the desired state for yourself using this setting.
	789	</para>
	790	</description>
	791	</bitlbee-setting>
	792
	793	<bitlbee-setting name="otr_policy" type="string" scope="global">
	794	<default>opportunistic</default>
	795	<possible-values>never, opportunistic, manual, always</possible-values>
	796
	797	<description>
	798	<para>
	799	This setting controls the policy for establishing Off-the-Record connections.
	800	</para>
	801	<para>
	802	A value of "never" effectively disables the OTR subsystem. In "opportunistic" mode, a magic whitespace pattern will be appended to the first message sent to any user. If the peer is also running opportunistic OTR, an encrypted connection will be set up automatically. On "manual", on the other hand, OTR connections must be established explicitly using <emphasis>otr connect</emphasis>. Finally, the setting "always" enforces encrypted communication by causing BitlBee to refuse to send any cleartext messages at all.
[b7d3cc34]	803	</para>
	804	</description>
	805	</bitlbee-setting>
	806
[673a54c]	807	<bitlbee-setting name="nick" type="string" scope="chat">
	808
	809	<description>
	810	<para>
	811	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.
[b7d3cc34]	812	</para>
	813	</description>
	814	</bitlbee-setting>
	815
[89a1809]	816	<bitlbee-setting name="password" type="string" scope="both">
[b7d3cc34]	817	<description>
	818	<para>
[75a4b85]	819	Use this global setting to change your "NickServ" password.
[b7d3cc34]	820	</para>
[75a4b85]	821
[b7d3cc34]	822	<para>
[75a4b85]	823	This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
	824	</para>
	825
	826	<para>
	827	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.
[b7d3cc34]	828	</para>
	829	</description>
	830	</bitlbee-setting>
[75a4b85]	831
[89a1809]	832	<bitlbee-setting name="port" type="integer" scope="account">
[b7d3cc34]	833	<description>
	834	<para>
[75a4b85]	835	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.
[b7d3cc34]	836	</para>
[75a4b85]	837	</description>
	838	</bitlbee-setting>
	839
[ee5c355]	840	<bitlbee-setting name="priority" type="integer" scope="account">
	841	<default>0</default>
	842
	843	<description>
	844	<para>
	845	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).
	846	</para>
	847
	848	<para>
	849	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).
	850	</para>
	851	</description>
	852	</bitlbee-setting>
	853
[89a1809]	854	<bitlbee-setting name="private" type="boolean" scope="global">
	855	<default>true</default>
[b7d3cc34]	856
[75a4b85]	857	<description>
[b7d3cc34]	858	<para>
[75a4b85]	859	If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
[b7d3cc34]	860	</para>
	861
	862	<para>
[75a4b85]	863	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.
[b7d3cc34]	864	</para>
	865	</description>
	866	</bitlbee-setting>
	867
[89a1809]	868	<bitlbee-setting name="query_order" type="string" scope="global">
[75a4b85]	869	<default>lifo</default>
	870	<possible-values>lifo, fifo</possible-values>
[834ff44]	871
[b7d3cc34]	872	<description>
	873	<para>
[75a4b85]	874	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.
[b7d3cc34]	875	</para>
	876
	877	<para>
[75a4b85]	878	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).
[b7d3cc34]	879	</para>
	880	</description>
[75a4b85]	881	</bitlbee-setting>
[b7d3cc34]	882
[89a1809]	883	<bitlbee-setting name="resource" type="string" scope="account">
[75a4b85]	884	<default>BitlBee</default>
	885
	886	<description>
	887	<para>
	888	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.
	889	</para>
	890	</description>
[b7d3cc34]	891	</bitlbee-setting>
	892
[ee5c355]	893	<bitlbee-setting name="resource_select" type="string" scope="account">
	894	<default>priority</default>
[9e768da]	895	<possible-values>priority, activity</possible-values>
[ee5c355]	896
	897	<description>
	898	<para>
	899	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.
	900	</para>
	901
	902	<para>
[9e768da]	903	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).
[ee5c355]	904	</para>
	905	</description>
	906	</bitlbee-setting>
	907
[1195cec]	908	<bitlbee-setting name="root_nick" type="string" scope="global">
	909	<default>root</default>
	910
	911	<description>
	912	<para>
	913	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.
	914	</para>
	915	</description>
	916	</bitlbee-setting>
	917
[89a1809]	918	<bitlbee-setting name="save_on_quit" type="boolean" scope="global">
	919	<default>true</default>
[b7d3cc34]	920
	921	<description>
	922	<para>
[75a4b85]	923	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.
[b7d3cc34]	924	</para>
	925	</description>
[75a4b85]	926	</bitlbee-setting>
[b7d3cc34]	927
[89a1809]	928	<bitlbee-setting name="server" type="string" scope="account">
[75a4b85]	929	<description>
	930	<para>
[30ce1ce]	931	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.
[75a4b85]	932	</para>
	933	</description>
[b7d3cc34]	934	</bitlbee-setting>
[1186382]	935
	936	<bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
	937	<default>true</default>
	938
	939	<description>
	940	<para>
	941	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.
	942	</para>
	943	</description>
	944	</bitlbee-setting>
[b7d3cc34]	945
[89a1809]	946	<bitlbee-setting name="ssl" type="boolean" scope="account">
	947	<default>false</default>
[b7d3cc34]	948
[75a4b85]	949	<description>
	950	<para>
	951	Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
	952	</para>
	953	</description>
[b7d3cc34]	954	</bitlbee-setting>
	955
[89a1809]	956	<bitlbee-setting name="strip_html" type="boolean" scope="global">
	957	<default>true</default>
[75a4b85]	958
[b7d3cc34]	959	<description>
	960	<para>
[75a4b85]	961	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.
	962	</para>
	963	<para>
	964	If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too.
[b7d3cc34]	965	</para>
	966	</description>
	967	</bitlbee-setting>
	968
[ee5c355]	969	<bitlbee-setting name="tls" type="boolean" scope="account">
	970	<default>try</default>
	971
	972	<description>
	973	<para>
	974	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.
	975	</para>
	976
	977	<para>
	978	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.
	979	</para>
	980	</description>
	981	</bitlbee-setting>
	982
[89a1809]	983	<bitlbee-setting name="to_char" type="string" scope="global">
[75a4b85]	984	<default>": "</default>
[b7d3cc34]	985
	986	<description>
	987	<para>
[75a4b85]	988	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>.
[b7d3cc34]	989	</para>
	990
	991	<para>
[75a4b85]	992	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.
[b7d3cc34]	993	</para>
	994	</description>
	995	</bitlbee-setting>
	996
[89a1809]	997	<bitlbee-setting name="typing_notice" type="boolean" scope="global">
	998	<default>false</default>
[b7d3cc34]	999
	1000	<description>
	1001	<para>
[b27557b]	1002	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.
[b7d3cc34]	1003	</para>
	1004	</description>
	1005	</bitlbee-setting>
	1006
[1c18ce1]	1007	<bitlbee-setting name="voice_buddies" type="string" scope="global">
	1008	<default>trusted</default>
	1009	<possible-values>encrypted, trusted, notaway, false</possible-values>
	1010
	1011	<description>
	1012	<para>
	1013	Specifies under which circumstances BitlBee should give the "voice" mode flag (+v) to buddies.
	1014	</para>
	1015
	1016	<para>
	1017	If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
	1018	</para>
	1019	</description>
	1020
	1021	</bitlbee-setting>
	1022
[846cec61]	1023	<bitlbee-setting name="web_aware" type="string" scope="account">
	1024	<default>false</default>
	1025
	1026	<description>
	1027	<para>
	1028	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.
	1029	</para>
	1030
	1031	<para>
	1032	Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
	1033	</para>
	1034	</description>
	1035	</bitlbee-setting>
	1036
[a6df0b5]	1037	<bitlbee-setting name="xmlconsole" type="boolean" scope="account">
	1038	<default>false</default>
	1039
	1040	<description>
	1041	<para>
	1042	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.
	1043	</para>
	1044	<para>
	1045	If you want to enable this XML console permanently (and at login time already), you can set this setting.
	1046	</para>
	1047	</description>
	1048	</bitlbee-setting>
	1049
[b7d3cc34]	1050	<bitlbee-command name="rename">
	1051	<short-description>Rename (renick) a buddy</short-description>
	1052	<syntax>rename <oldnick> <newnick></syntax>
	1053
	1054	<description>
	1055	<para>
	1056	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).
	1057	</para>
	1058	</description>
	1059
	1060	<ircexample>
	1061	<ircline nick="itsme">rename itsme_ you</ircline>
	1062	<ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
	1063	</ircexample>
	1064
	1065	</bitlbee-command>
	1066
	1067	<bitlbee-command name="yes">
	1068	<short-description>Accept a request</short-description>
	1069	<syntax>yes [<number>]</syntax>
	1070
	1071	<description>
	1072	<para>
	1073	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.
	1074	</para>
	1075
	1076	<para>
	1077	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.
	1078	</para>
	1079	</description>
	1080
	1081	</bitlbee-command>
	1082
	1083	<bitlbee-command name="no">
	1084	<short-description>Deny a request</short-description>
	1085	<syntax>no [<number>]</syntax>
	1086
	1087	<description>
	1088	<para>
	1089	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.
	1090	</para>
	1091
	1092	<para>
	1093	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.
	1094	</para>
	1095	</description>
	1096	</bitlbee-command>
	1097
	1098	<bitlbee-command name="qlist">
	1099	<short-description>List all the unanswered questions root asked</short-description>
	1100	<syntax>qlist</syntax>
	1101
	1102	<description>
	1103	<para>
	1104	This gives you a list of all the unanswered questions from root.
	1105	</para>
	1106	</description>
	1107
	1108	</bitlbee-command>
	1109
	1110	<bitlbee-command name="register">
	1111	<short-description>Register yourself</short-description>
	1112	<syntax>register <password></syntax>
	1113
	1114	<description>
	1115	<para>
	1116	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.
	1117	</para>
	1118
	1119	<para>
	1120	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.. ;-)
	1121	</para>
	1122
	1123	<para>
[1be54a9]	1124	To identify yourself in later sessions, you can use the <emphasis>identify</emphasis> command. To change your password later, you can use the <emphasis>set password</emphasis> command.
[b7d3cc34]	1125	</para>
	1126	</description>
	1127
	1128	</bitlbee-command>
	1129
	1130	<bitlbee-command name="identify">
	1131	<syntax>identify <password></syntax>
	1132	<short-description>Identify yourself with your password</short-description>
	1133
	1134	<description>
	1135	<para>
	1136	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.
	1137	</para>
	1138
	1139	<para>
	1140	Once you're registered, you can change your password using <emphasis>set password <password></emphasis>.
	1141	</para>
	1142	</description>
	1143	</bitlbee-command>
	1144
	1145	<bitlbee-command name="drop">
	1146	<syntax>drop <password></syntax>
	1147	<short-description>Drop your account</short-description>
	1148
	1149	<description>
	1150	<para>
	1151	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.
	1152	</para>
	1153	</description>
	1154	</bitlbee-command>
	1155
	1156	<bitlbee-command name="blist">
	1157	<syntax>blist [all\|online\|offline\|away]</syntax>
	1158	<short-description>List all the buddies in your contact list</short-description>
	1159
	1160	<description>
	1161	<para>
	1162	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.
	1163	</para>
	1164	</description>
	1165
	1166	</bitlbee-command>
	1167
	1168	<bitlbee-command name="nick">
	1169	<short-description>Change friendly name, nick</short-description>
	1170	<syntax>nick <connection> [<new nick>]</syntax>
[b27557b]	1171	<syntax>nick <connection></syntax>
[b7d3cc34]	1172
	1173	<description>
	1174	<para>
[b27557b]	1175	Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
[0aaca60]	1176	</para>
[b7d3cc34]	1177	</description>
	1178
	1179	<ircexample>
[d5bd9c0]	1180	<ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
	1181	<ircline nick="root">display_name = `The majestik møøse'</ircline>
[b7d3cc34]	1182	</ircexample>
	1183
	1184	</bitlbee-command>
	1185	</chapter>

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

Download in other formats: