Context Navigation

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

Last change on this file since eb0714d was d0faf62, checked in by Sven Moritz Hallberg <sm@…>, at 2008-02-17T01:58:41Z
put 'otr forget key' back in, which now works
Property mode set to `100644`
File size: 41.6 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>
	127	This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands.
	128	</para>
	129	</description>
	130	</bitlbee-command>
[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>
	140	This account can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account set <account id></emphasis>.
	141	</para>
	142
	143	<para>
[cd428e4]	144	For more infomation about a setting, see <emphasis>help set <setting></emphasis>. For details about the syntax of this command, see <emphasis>help set</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
	154	<bitlbee-command name="add">
	155	<short-description>Add a buddy to your contact list</short-description>
	156	<syntax>add <connection> <handle> [<nick>]</syntax>
[ea3a26d]	157	<syntax>add -tmp <connection> <handle> [<nick>]</syntax>
[b7d3cc34]	158
	159	<description>
	160	<para>
	161	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.
	162	</para>
	163
	164	<para>
	165	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.
	166	</para>
[ea3a26d]	167
	168	<para>
[64d1f45]	169	Adding -tmp adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list.
[ea3a26d]	170	</para>
[b7d3cc34]	171	</description>
	172
	173	<ircexample>
	174	<ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
[689a6e0]	175	<ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&bitlbee</emphasis></ircaction>
[b7d3cc34]	176	</ircexample>
	177	</bitlbee-command>
	178
	179	<bitlbee-command name="info">
	180	<short-description>Request user information</short-description>
	181	<syntax>info <connection> <handle></syntax>
	182	<syntax>info <nick></syntax>
	183
	184	<description>
	185	<para>
	186	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.
	187	</para>
	188	</description>
	189
	190	<ircexample>
	191	<ircline nick="ctrlsoft">info 0 72696705</ircline>
	192	<ircline nick="root">User info - UIN: 72696705 Nick: Lintux First/Last name: Wilmer van der Gaast E-mail: lintux@lintux.cx</ircline>
	193	</ircexample>
	194
	195	</bitlbee-command>
	196
	197	<bitlbee-command name="remove">
	198	<short-description>Remove a buddy from your contact list</short-description>
	199	<syntax>remove <nick></syntax>
	200
	201	<description>
	202	<para>
	203	Removes the specified nick from your buddy list.
	204	</para>
	205	</description>
	206
	207	<ircexample>
	208	<ircline nick="ctrlsoft">remove gryp</ircline>
	209	<ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
	210	</ircexample>
	211
	212	</bitlbee-command>
	213
	214	<bitlbee-command name="block">
	215	<short-description>Block someone</short-description>
	216	<syntax>block <nick></syntax>
	217	<syntax>block <connection> <handle></syntax>
[9b8efab]	218	<syntax>block <connection></syntax>
[b7d3cc34]	219
	220	<description>
	221	<para>
	222	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.
	223	</para>
[9b8efab]	224
	225	<para>
	226	When called with only a connection specification as an argument, the command displays the current block list for that connection.
	227	</para>
[b7d3cc34]	228	</description>
	229	</bitlbee-command>
	230
	231	<bitlbee-command name="allow">
	232	<short-description>Unblock someone</short-description>
	233	<syntax>allow <nick></syntax>
	234	<syntax>allow <connection> <handle></syntax>
	235
	236	<description>
	237	<para>
	238	Reverse of block. Unignores the specified user or user handle on specified connection.
	239	</para>
[9b8efab]	240
	241	<para>
	242	When called with only a connection specification as an argument, the command displays the current allow list for that connection.
	243	</para>
[b7d3cc34]	244	</description>
	245	</bitlbee-command>
[f5ac0fb]	246
	247	<bitlbee-command name="otr">
	248	<short-description>Off-the-Record encryption control</short-description>
	249	<syntax>otr <subcommand> [<arguments>]</syntax>
	250
	251	<description>
	252
	253	<para>
	254	Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr <subcommand></emphasis> for more information.
	255	</para>
	256
	257	</description>
	258
	259	<bitlbee-command name="connect">
	260	<syntax>otr connect <nick></syntax>
	261
	262	<description>
	263
	264	<para>
	265	Attempts to establish an encrypted connection with the specified user by sending a magic string.
	266	</para>
	267
	268	</description>
	269
	270	</bitlbee-command>
	271
	272	<bitlbee-command name="disconnect">
	273	<syntax>otr disconnect <nick></syntax>
	274
	275	<description>
	276
	277	<para>
	278	Resets the connection with the specified user to cleartext.
	279	</para>
	280
	281	</description>
	282
	283	</bitlbee-command>
	284
	285	<bitlbee-command name="smp">
	286	<syntax>otr smp <nick> <secret></syntax>
	287
	288	<description>
	289
	290	<para>
	291	Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
	292	</para>
	293
	294	<para>
	295	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.
	296	</para>
	297
	298	</description>
	299
	300	</bitlbee-command>
	301
	302	<bitlbee-command name="trust">
	303	<syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax>
	304
	305	<description>
	306
	307	<para>
	308	Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
	309	</para>
	310
	311	</description>
	312
	313	</bitlbee-command>
	314
	315	<bitlbee-command name="info">
	316	<syntax>otr info</syntax>
	317	<syntax>otr info <nick></syntax>
	318
	319	<description>
	320
	321	<para>
	322	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.
	323	</para>
	324
	325	</description>
	326
	327	</bitlbee-command>
	328
	329	<bitlbee-command name="keygen">
	330	<syntax>otr keygen <account-no></syntax>
	331
	332	<description>
	333
	334	<para>
	335	Generates a new OTR private key for the given account.
	336	</para>
	337
	338	</description>
	339
	340	</bitlbee-command>
	341
	342	<bitlbee-command name="forget">
	343	<syntax>otr forget <thing> <arguments></syntax>
	344
	345	<description>
	346
	347	<para>
[d0faf62]	348	Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information.
[f5ac0fb]	349	</para>
	350
	351	</description>
	352
	353	<bitlbee-command name="fingerprint">
	354	<syntax>otr forget fingerprint <nick> <fingerprint></syntax>
	355
	356	<description>
	357
	358	<para>
	359	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.
	360	</para>
	361
	362	</description>
	363
	364	</bitlbee-command>
	365
	366	<bitlbee-command name="context">
	367	<syntax>otr forget context <nick></syntax>
	368
	369	<description>
	370
	371	<para>
	372	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.
	373	</para>
	374
	375	</description>
	376
	377	</bitlbee-command>
	378
[d0faf62]	379	<bitlbee-command name="key">
	380	<syntax>otr forget key <fingerprint></syntax>
	381
	382	<description>
	383
	384	<para>
	385	Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
	386	</para>
	387
	388	</description>
	389
	390	</bitlbee-command>
	391
[f5ac0fb]	392	</bitlbee-command>
	393
	394	</bitlbee-command>
[b7d3cc34]	395
	396	<bitlbee-command name="set">
	397	<short-description>Miscellaneous settings</short-description>
[cd428e4]	398	<syntax>set</syntax>
	399	<syntax>set <variable></syntax>
	400	<syntax>set <variable> <value></syntax>
	401	<syntax>set -del <variable></syntax>
[b7d3cc34]	402
	403	<description>
	404
	405	<para>
[cd428e4]	406	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]	407	</para>
	408
	409	<para>
	410	To get more help information about a setting, try:
	411	</para>
	412
	413	</description>
	414
	415	<ircexample>
	416	<ircline nick="ctrlsoft">help set private</ircline>
	417	</ircexample>
	418
	419	</bitlbee-command>
	420
	421	<bitlbee-command name="help">
	422	<short-description>BitlBee help system</short-description>
	423
	424	<syntax>help [subject]</syntax>
	425
	426	<description>
	427	<para>
	428	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.
	429	</para>
	430	</description>
	431	</bitlbee-command>
	432
	433	<bitlbee-command name="save">
	434	<short-description>Save your account data</short-description>
	435	<syntax>save</syntax>
	436
	437	<description>
	438	<para>
	439	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... ;-)
	440	</para>
	441	</description>
	442	</bitlbee-command>
	443
[89a1809]	444	<bitlbee-setting name="auto_connect" type="boolean" scope="both">
	445	<default>true</default>
[b7d3cc34]	446
	447	<description>
	448	<para>
[75a4b85]	449	With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
[b7d3cc34]	450	</para>
[75a4b85]	451
[b7d3cc34]	452	<para>
[75a4b85]	453	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]	454	</para>
	455	</description>
	456	</bitlbee-setting>
	457
[89a1809]	458	<bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
	459	<default>false</default>
[b7d3cc34]	460
	461	<description>
	462	<para>
[75a4b85]	463	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]	464	</para>
	465
	466	<para>
[75a4b85]	467	See also the <emphasis>auto_reconnect_delay</emphasis> setting.
[b7d3cc34]	468	</para>
[75a4b85]	469
[89a1809]	470	<para>
	471	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!)
	472	</para>
	473	</description>
[b7d3cc34]	474	</bitlbee-setting>
	475
[89a1809]	476	<bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global">
[75a4b85]	477	<default>300</default>
[b7d3cc34]	478
	479	<description>
	480	<para>
[75a4b85]	481	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.
	482	</para>
	483
	484	<para>
	485	See also the <emphasis>auto_reconnect</emphasis> setting.
[b7d3cc34]	486	</para>
	487	</description>
	488	</bitlbee-setting>
	489
[89a1809]	490	<bitlbee-setting name="away_devoice" type="boolean" scope="global">
	491	<default>true</default>
[b7d3cc34]	492
	493	<description>
	494	<para>
[75a4b85]	495	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]	496	</para>
	497	</description>
	498	</bitlbee-setting>
	499
[89a1809]	500	<bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
	501	<default>false</default>
[b7d3cc34]	502
	503	<description>
	504	<para>
[75a4b85]	505	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.
	506	</para>
	507
	508	<para>
	509	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.
	510	</para>
	511
	512	<para>
	513	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]	514	</para>
	515	</description>
	516	</bitlbee-setting>
	517
[89a1809]	518	<bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
[75a4b85]	519	<default>200</default>
[b7d3cc34]	520
	521	<description>
	522
	523	<para>
[75a4b85]	524	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]	525	</para>
	526
	527	<para>
[75a4b85]	528	See also the <emphasis>buddy_sendbuffer</emphasis> setting.
[b7d3cc34]	529	</para>
	530	</description>
	531	</bitlbee-setting>
	532
[89a1809]	533	<bitlbee-setting name="charset" type="string" scope="global">
[75a4b85]	534	<default>iso8859-1</default>
	535	<possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
[b7d3cc34]	536
	537	<description>
	538	<para>
[75a4b85]	539	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.
	540	</para>
	541
	542	<para>
	543	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
[b7d3cc34]	544	</para>
	545	</description>
[75a4b85]	546
[b7d3cc34]	547	</bitlbee-setting>
	548
[1c18ce1]	549	<bitlbee-setting name="color_encrypted" type="boolean" scope="global">
	550	<default>true</default>
	551
	552	<description>
	553	<para>
	554	If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
	555	</para>
	556	</description>
	557
	558	</bitlbee-setting>
	559
[89a1809]	560	<bitlbee-setting name="debug" type="boolean" scope="global">
	561	<default>false</default>
[b7d3cc34]	562
	563	<description>
	564	<para>
[75a4b85]	565	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]	566	</para>
[75a4b85]	567	</description>
	568	</bitlbee-setting>
	569
[89a1809]	570	<bitlbee-setting name="default_target" type="string" scope="global">
[75a4b85]	571	<default>root</default>
	572	<possible-values>root, last</possible-values>
[b7d3cc34]	573
[75a4b85]	574	<description>
[b7d3cc34]	575	<para>
[75a4b85]	576	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]	577	</para>
	578	</description>
	579	</bitlbee-setting>
	580
[89a1809]	581	<bitlbee-setting name="display_name" type="string" scope="account">
[b7d3cc34]	582	<description>
	583	<para>
[75a4b85]	584	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]	585	</para>
	586	</description>
	587	</bitlbee-setting>
	588
[89a1809]	589	<bitlbee-setting name="display_namechanges" type="boolean" scope="global">
	590	<default>false</default>
[75a4b85]	591
[2529faf]	592	<description>
	593	<para>
	594	With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
	595	</para>
	596	</description>
[75a4b85]	597	</bitlbee-setting>
	598
[89a1809]	599	<bitlbee-setting name="handle_unknown" type="string" scope="global">
[b7d3cc34]	600	<default>root</default>
	601	<possible-values>root, add, add_private, add_channel, ignore</possible-values>
	602
	603	<description>
	604	<para>
	605	Messages from unknown users are echoed like this by default:
	606	</para>
	607
	608	<ircexample>
	609	<ircline nick="root">Unknown message from handle 3137137:</ircline>
	610	<ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
	611	</ircexample>
	612
	613	<para>
	614	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.
	615	</para>
	616
	617	<note>
	618	<para>
	619	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.
	620	</para>
	621	</note>
	622	</description>
	623
	624	</bitlbee-setting>
	625
[1c18ce1]	626	<bitlbee-setting name="halfop_buddies" type="string" scope="global">
	627	<default>encrypted</default>
	628	<possible-values>encrypted, trusted, notaway, false</possible-values>
	629
	630	<description>
	631	<para>
	632	Specifies under which circumstances BitlBee should give the "halfop" mode flag (+h) to buddies.
	633	</para>
	634
	635	<para>
	636	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.
	637	</para>
	638	</description>
	639
	640	</bitlbee-setting>
	641
[89a1809]	642	<bitlbee-setting name="lcnicks" type="boolean" scope="global">
	643	<default>true</default>
[b7d3cc34]	644
	645	<description>
	646	<para>
[75a4b85]	647	Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
[b7d3cc34]	648	</para>
	649	</description>
[75a4b85]	650
[b7d3cc34]	651	</bitlbee-setting>
	652
[1febf5c]	653	<bitlbee-setting name="mail_notifications" type="boolean" scope="account">
	654	<default>false</default>
	655
	656	<description>
	657	<para>
	658	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.
	659	</para>
	660	</description>
	661
	662	</bitlbee-setting>
	663
[1c18ce1]	664	<bitlbee-setting name="op_buddies" type="string" scope="global">
	665	<default>trusted</default>
	666	<possible-values>encrypted, trusted, notaway, false</possible-values>
[b7d3cc34]	667
	668	<description>
	669	<para>
[1c18ce1]	670	Specifies under which circumstances BitlBee should give the "op" mode flag (+o) to buddies.
	671	</para>
	672
	673	<para>
	674	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]	675	</para>
[1c18ce1]	676	</description>
	677
	678	</bitlbee-setting>
[b7d3cc34]	679
[1c18ce1]	680	<bitlbee-setting name="op_root" type="bool" scope="global">
	681	<default>true</default>
	682
	683	<description>
[b7d3cc34]	684	<para>
[1c18ce1]	685	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.
	686	</para>
	687	</description>
	688	</bitlbee-setting>
	689
	690	<bitlbee-setting name="op_user" type="bool" scope="global">
	691	<default>true</default>
	692
	693	<description>
	694	<para>
	695	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.
	696	</para>
	697	</description>
	698	</bitlbee-setting>
	699
	700	<bitlbee-setting name="otr_policy" type="string" scope="global">
	701	<default>opportunistic</default>
	702	<possible-values>never, opportunistic, manual, always</possible-values>
	703
	704	<description>
	705	<para>
	706	This setting controls the policy for establishing Off-the-Record connections.
	707	</para>
	708	<para>
	709	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]	710	</para>
	711	</description>
	712	</bitlbee-setting>
	713
[89a1809]	714	<bitlbee-setting name="password" type="string" scope="both">
[b7d3cc34]	715	<description>
	716	<para>
[75a4b85]	717	Use this global setting to change your "NickServ" password.
[b7d3cc34]	718	</para>
[75a4b85]	719
[b7d3cc34]	720	<para>
[75a4b85]	721	This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
	722	</para>
	723
	724	<para>
	725	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]	726	</para>
	727	</description>
	728	</bitlbee-setting>
[75a4b85]	729
[89a1809]	730	<bitlbee-setting name="port" type="integer" scope="account">
[b7d3cc34]	731	<description>
	732	<para>
[75a4b85]	733	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]	734	</para>
[75a4b85]	735	</description>
	736	</bitlbee-setting>
	737
[ee5c355]	738	<bitlbee-setting name="priority" type="integer" scope="account">
	739	<default>0</default>
	740
	741	<description>
	742	<para>
	743	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).
	744	</para>
	745
	746	<para>
	747	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).
	748	</para>
	749	</description>
	750	</bitlbee-setting>
	751
[89a1809]	752	<bitlbee-setting name="private" type="boolean" scope="global">
	753	<default>true</default>
[b7d3cc34]	754
[75a4b85]	755	<description>
[b7d3cc34]	756	<para>
[75a4b85]	757	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]	758	</para>
	759
	760	<para>
[75a4b85]	761	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]	762	</para>
	763	</description>
	764	</bitlbee-setting>
	765
[89a1809]	766	<bitlbee-setting name="query_order" type="string" scope="global">
[75a4b85]	767	<default>lifo</default>
	768	<possible-values>lifo, fifo</possible-values>
[834ff44]	769
[b7d3cc34]	770	<description>
	771	<para>
[75a4b85]	772	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]	773	</para>
	774
	775	<para>
[75a4b85]	776	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]	777	</para>
	778	</description>
[75a4b85]	779	</bitlbee-setting>
[b7d3cc34]	780
[89a1809]	781	<bitlbee-setting name="resource" type="string" scope="account">
[75a4b85]	782	<default>BitlBee</default>
	783
	784	<description>
	785	<para>
	786	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.
	787	</para>
	788	</description>
[b7d3cc34]	789	</bitlbee-setting>
	790
[ee5c355]	791	<bitlbee-setting name="resource_select" type="string" scope="account">
	792	<default>priority</default>
	793	<possible-values>priority, time</possible-values>
	794
	795	<description>
	796	<para>
	797	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.
	798	</para>
	799
	800	<para>
	801	Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>time</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected).
	802	</para>
	803	</description>
	804	</bitlbee-setting>
	805
[89a1809]	806	<bitlbee-setting name="save_on_quit" type="boolean" scope="global">
	807	<default>true</default>
[b7d3cc34]	808
	809	<description>
	810	<para>
[75a4b85]	811	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]	812	</para>
	813	</description>
[75a4b85]	814	</bitlbee-setting>
[b7d3cc34]	815
[89a1809]	816	<bitlbee-setting name="server" type="string" scope="account">
[75a4b85]	817	<description>
	818	<para>
[30ce1ce]	819	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]	820	</para>
	821	</description>
[b7d3cc34]	822	</bitlbee-setting>
[1186382]	823
	824	<bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
	825	<default>true</default>
	826
	827	<description>
	828	<para>
	829	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.
	830	</para>
	831	</description>
	832	</bitlbee-setting>
[b7d3cc34]	833
[89a1809]	834	<bitlbee-setting name="ssl" type="boolean" scope="account">
	835	<default>false</default>
[b7d3cc34]	836
[75a4b85]	837	<description>
	838	<para>
	839	Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
	840	</para>
	841	</description>
[b7d3cc34]	842	</bitlbee-setting>
	843
[89a1809]	844	<bitlbee-setting name="strip_html" type="boolean" scope="global">
	845	<default>true</default>
[75a4b85]	846
[b7d3cc34]	847	<description>
	848	<para>
[75a4b85]	849	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.
	850	</para>
	851	<para>
	852	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]	853	</para>
	854	</description>
	855	</bitlbee-setting>
	856
[ee5c355]	857	<bitlbee-setting name="tls" type="boolean" scope="account">
	858	<default>try</default>
	859
	860	<description>
	861	<para>
	862	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.
	863	</para>
	864
	865	<para>
	866	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.
	867	</para>
	868	</description>
	869	</bitlbee-setting>
	870
[89a1809]	871	<bitlbee-setting name="to_char" type="string" scope="global">
[75a4b85]	872	<default>": "</default>
[b7d3cc34]	873
	874	<description>
	875	<para>
[75a4b85]	876	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]	877	</para>
	878
	879	<para>
[75a4b85]	880	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]	881	</para>
	882	</description>
	883	</bitlbee-setting>
	884
[89a1809]	885	<bitlbee-setting name="typing_notice" type="boolean" scope="global">
	886	<default>false</default>
[b7d3cc34]	887
	888	<description>
	889	<para>
[75a4b85]	890	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. ;-)
[b7d3cc34]	891	</para>
	892	</description>
	893	</bitlbee-setting>
	894
[1c18ce1]	895	<bitlbee-setting name="voice_buddies" type="string" scope="global">
	896	<default>trusted</default>
	897	<possible-values>encrypted, trusted, notaway, false</possible-values>
	898
	899	<description>
	900	<para>
	901	Specifies under which circumstances BitlBee should give the "voice" mode flag (+v) to buddies.
	902	</para>
	903
	904	<para>
	905	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.
	906	</para>
	907	</description>
	908
	909	</bitlbee-setting>
	910
[846cec61]	911	<bitlbee-setting name="web_aware" type="string" scope="account">
	912	<default>false</default>
	913
	914	<description>
	915	<para>
	916	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.
	917	</para>
	918
	919	<para>
	920	Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
	921	</para>
	922	</description>
	923	</bitlbee-setting>
	924
[a6df0b5]	925	<bitlbee-setting name="xmlconsole" type="boolean" scope="account">
	926	<default>false</default>
	927
	928	<description>
	929	<para>
	930	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.
	931	</para>
	932	<para>
	933	If you want to enable this XML console permanently (and at login time already), you can set this setting.
	934	</para>
	935	</description>
	936	</bitlbee-setting>
	937
[b7d3cc34]	938	<bitlbee-command name="rename">
	939	<short-description>Rename (renick) a buddy</short-description>
	940	<syntax>rename <oldnick> <newnick></syntax>
	941
	942	<description>
	943	<para>
	944	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).
	945	</para>
	946	</description>
	947
	948	<ircexample>
	949	<ircline nick="itsme">rename itsme_ you</ircline>
	950	<ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
	951	</ircexample>
	952
	953	</bitlbee-command>
	954
	955	<bitlbee-command name="yes">
	956	<short-description>Accept a request</short-description>
	957	<syntax>yes [<number>]</syntax>
	958
	959	<description>
	960	<para>
	961	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.
	962	</para>
	963
	964	<para>
	965	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.
	966	</para>
	967	</description>
	968
	969	</bitlbee-command>
	970
	971	<bitlbee-command name="no">
	972	<short-description>Deny a request</short-description>
	973	<syntax>no [<number>]</syntax>
	974
	975	<description>
	976	<para>
	977	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.
	978	</para>
	979
	980	<para>
	981	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.
	982	</para>
	983	</description>
	984	</bitlbee-command>
	985
	986	<bitlbee-command name="qlist">
	987	<short-description>List all the unanswered questions root asked</short-description>
	988	<syntax>qlist</syntax>
	989
	990	<description>
	991	<para>
	992	This gives you a list of all the unanswered questions from root.
	993	</para>
	994	</description>
	995
	996	</bitlbee-command>
	997
	998	<bitlbee-command name="register">
	999	<short-description>Register yourself</short-description>
	1000	<syntax>register <password></syntax>
	1001
	1002	<description>
	1003	<para>
	1004	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.
	1005	</para>
	1006
	1007	<para>
	1008	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.. ;-)
	1009	</para>
	1010
	1011	<para>
[1be54a9]	1012	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]	1013	</para>
	1014	</description>
	1015
	1016	</bitlbee-command>
	1017
	1018	<bitlbee-command name="identify">
	1019	<syntax>identify <password></syntax>
	1020	<short-description>Identify yourself with your password</short-description>
	1021
	1022	<description>
	1023	<para>
	1024	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.
	1025	</para>
	1026
	1027	<para>
	1028	Once you're registered, you can change your password using <emphasis>set password <password></emphasis>.
	1029	</para>
	1030	</description>
	1031	</bitlbee-command>
	1032
	1033	<bitlbee-command name="drop">
	1034	<syntax>drop <password></syntax>
	1035	<short-description>Drop your account</short-description>
	1036
	1037	<description>
	1038	<para>
	1039	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.
	1040	</para>
	1041	</description>
	1042	</bitlbee-command>
	1043
	1044	<bitlbee-command name="blist">
	1045	<syntax>blist [all\|online\|offline\|away]</syntax>
	1046	<short-description>List all the buddies in your contact list</short-description>
	1047
	1048	<description>
	1049	<para>
	1050	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.
	1051	</para>
	1052	</description>
	1053
	1054	</bitlbee-command>
	1055
	1056	<bitlbee-command name="nick">
	1057	<short-description>Change friendly name, nick</short-description>
	1058	<syntax>nick <connection> [<new nick>]</syntax>
	1059	<syntax>nick</syntax>
	1060
	1061	<description>
	1062	<para>
	1063	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.
	1064	</para>
[0aaca60]	1065
	1066	<para>
	1067	It is recommended to use the per-account <emphasis>display_name</emphasis> setting to read and change this information. The <emphasis>nick</emphasis> command is deprecated.
	1068	</para>
[b7d3cc34]	1069	</description>
	1070
	1071	<ircexample>
	1072	<ircline nick="wouter">nick 1 "Wouter Paesen"</ircline>
	1073	<ircline nick="root">Setting your name on connection 1 to `Wouter Paesen'</ircline>
	1074	</ircexample>
	1075
	1076	</bitlbee-command>
	1077
[f7b44f2]	1078	<bitlbee-command name="join_chat">
	1079	<short-description>Join a named groupchat/conference room</short-description>
[3933853]	1080	<syntax>join_chat <connection> <room name> [<channel name>] [<room nickname>] [<password>]</syntax>
[b7d3cc34]	1081
	1082	<description>
	1083	<para>
[f7b44f2]	1084	On most IM-networks groupchats can be started using the /join command. (<emphasis>/join #foo</emphasis> to start a chatroom with you and <emphasis>foo</emphasis>) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command.
[b7d3cc34]	1085	</para>
	1086
	1087	<para>
[f7b44f2]	1088	The first two arguments are required. <emphasis>room name</emphasis> is the name of the chatroom on the IM-network. <emphasis>channel name</emphasis> is the IRC channel name BitlBee should map this to. <emphasis>room nickname</emphasis> is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses.
[b7d3cc34]	1089	</para>
	1090
	1091	<para>
[f7b44f2]	1092	The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&bitlbee-help</emphasis> because <emphasis>&bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>.
[b7d3cc34]	1093	</para>
	1094	</description>
	1095
[f7b44f2]	1096	<ircexample>
	1097	<ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me</ircline>
	1098	</ircexample>
	1099
[b7d3cc34]	1100	</bitlbee-command>
	1101	</chapter>

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

Download in other formats: