From 2ff20765990c756533957e8da9c7c29dd3102e79 Mon Sep 17 00:00:00 2001 From: ulim Date: Mon, 3 Dec 2007 15:28:45 +0100 Subject: Intermediate commit. Sending seems to work. TODOs: * move from out_of_data to is_writable, eliminate buffers * implement "transfers reject [id]" * documentation in commands.xml * implement throughput and cummulative throughput boundaries * feature discovery before sending * implement sending over a proxy (proxy discovery, socks5 client handshake for sending, activate message) * integrate toxik-mek-ft --- doc/user-guide/commands.xml | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index ac9bdf11..8c874014 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -860,4 +860,47 @@ + + + Monitor, cancel, or reject file transfers + transfers [<cancel> id | <reject>] + + + + Without parameters the currently pending file transfers and their status will be listed. Available actions are cancel and reject. See help transfers <action> for more information. + + + + transfers + + + + + Cancels the file transfer with the given id + transfers <cancel> id + + + Cancels the file transfer with the given id + + + + transfers cancel 1 + Canceling file transfer for test + + + + + Rejects all incoming transfers + transfers <reject> + + + Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is neccessary. Or is it? + + + + transfers reject + + + + -- cgit v1.2.3 From eded1f703a8f5d2272b9d294d8e3dfb48fa302b4 Mon Sep 17 00:00:00 2001 From: kenobi Date: Wed, 19 Dec 2007 00:59:35 +0100 Subject: Merged in 280..288 from upstream (e.g. PING) --- doc/user-guide/commands.xml | 12 ++++++------ doc/user-guide/quickstart.xml | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 8c874014..090acff3 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -16,7 +16,7 @@ - account add <protocol> <username> <password> [<server>] + account add <protocol> <username> <password> @@ -25,7 +25,7 @@ - account add jabber <handle@server.tld> <password> [<servertag>] + account add jabber <handle@server.tld> <password> @@ -49,16 +49,16 @@ - account add oscar <handle> <password> [<servername>] + account add oscar <handle> <password> - Specifying a server is required for OSCAR, since OSCAR can be used for both ICQ- and AIM-connections. Although these days it's supposed to be possible to connect to ICQ via AIM-servers and vice versa, we like to stick with this separation for now. For ICQ connections, the servername is login.icq.com, for AIM connections it's login.oscar.aol.com. + 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. - account add oscar 72696705 hobbelmeeuw login.icq.com + account add oscar 72696705 hobbelmeeuw Account successfully added @@ -594,7 +594,7 @@ - Can be set for Jabber- and OSCAR-connections. For OSCAR, this must be set to login.icq.com if it's an ICQ connection, or login.oscar.aol.com if it's an AIM connection. For Jabber, you have to set this if the servername isn't equal to the part after the @ in the Jabber handle. + 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. diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml index 520f240f..fcb06c6b 100644 --- a/doc/user-guide/quickstart.xml +++ b/doc/user-guide/quickstart.xml @@ -37,12 +37,12 @@ For instance, suppose you have an ICQ account with UIN 72696705 - account add oscar 72696705 QuickStart login.icq.com + account add jabber bitlbee@jabber.org QuickStart Account successfully added -Other available IM protocols are jabber, msn, and yahoo. Oscar is the protocol used by ICQ and AOL. For oscar, you need to specify the IM-server as a fourth argument (for msn and yahoo there is no fourth argument). For AOL Instant Messenger, the server name is login.oscar.aol.com. For ICQ, the server name is login.icq.com. +Other available IM protocols are msn, oscar, and yahoo. Oscar is the protocol used by ICQ and AOL. -- cgit v1.2.3 From f60079b74053a53da3720b992c603fddf75ff1dd Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Tue, 25 May 2010 23:26:54 +0100 Subject: Allow one to run the configure script from a different directory and put all build files in there. I need this to properly make Debian package variants (i.e. libpurple and native). --- doc/user-guide/Makefile | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/Makefile b/doc/user-guide/Makefile index 9841de8d..eaf2a5ff 100644 --- a/doc/user-guide/Makefile +++ b/doc/user-guide/Makefile @@ -1,4 +1,8 @@ -include ../../Makefile.settings +ifdef SRCDIR +SRCDIR := $(SRCDIR)doc/user-guide/ +endif + EXTRAPARANEWLINE = 1 # EXTRAPARANEWLINE = 0 -- cgit v1.2.3 From 4af305032ba6913449cbd9160db1b6ab228f0a9a Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Tue, 25 May 2010 23:41:52 +0100 Subject: install-* targets should also work now. Let's see how this works out in a deb. --- doc/user-guide/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/Makefile b/doc/user-guide/Makefile index eaf2a5ff..2a80ea6c 100644 --- a/doc/user-guide/Makefile +++ b/doc/user-guide/Makefile @@ -41,7 +41,7 @@ install: mkdir -p $(DESTDIR)$(DATADIR) chmod 0755 $(DESTDIR)$(DATADIR) rm -f $(DESTDIR)$(DATADIR)/help.txt # Prevent help function from breaking in running sessions - install -m 0644 help.txt $(DESTDIR)$(DATADIR)/help.txt + install -m 0644 $(SRCDIR)help.txt $(DESTDIR)$(DATADIR)/help.txt uninstall: rm -f $(DESTDIR)$(DATADIR)/help.txt -- cgit v1.2.3 From 16834a53f85be092acc16dee70cb72451b2230f9 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 6 Jun 2010 02:30:45 +0100 Subject: Set handle_unknown to add_channel by default. --- doc/user-guide/commands.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 4746e2c3..97c54bae 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -592,7 +592,7 @@ - root + add_channel root, add, add_private, add_channel, ignore -- cgit v1.2.3 From 92cb8c4c251fb04a483b29e7108e7a52388f14dd Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 7 Jun 2010 00:47:46 +0100 Subject: Complete (hopefully) fix for nickname changes: Add flags to the identify command to allow identifying without loading any new settings. With some documentation hints. --- doc/user-guide/commands.xml | 10 +++++++++- doc/user-guide/misc.xml | 17 +++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 97c54bae..bba2df73 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -1113,7 +1113,7 @@ - identify <password> + identify [-noload|-force] <password> Identify yourself with your password @@ -1124,6 +1124,14 @@ Once you're registered, you can change your password using set password <password>. + + + The -noload and -force flags can be used to identify when you're logged into some IM accounts already. -force will let you identify yourself and load all saved accounts (and keep the accounts you're logged into already). + + + + -noload will log you in but not load any accounts and settings saved under your current nickname. These will be overwritten once you save your settings (i.e. when you disconnect). + diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index a926775a..2427ef69 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -116,4 +116,21 @@ If you want to set an away state for only one of your connections, you can use t + +Changing your nickname + + +BitlBee now allows you to change your nickname. So far this was not possible because it made managing saved accounts more complicated. + + + +The restriction no longer exists now though. When you change your nick (just using the /nick command), your logged-in status will be reset, which means any changes made to your settings/accounts will not be saved. + + + +To restore your logged-in status, you need to either use the register command to create an account under the new nickname, or use identify -noload to re-identify yourself under the new nickname. The -noload flag tells the command to verify your password and log you in, but not load any new settings. See help identify for more information. + + + + -- cgit v1.2.3 From 1c8e5f7fba87b6096a7fd86508ca1821876abb54 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Fri, 11 Jun 2010 17:12:27 +0200 Subject: Added away_reply_timeout setting so BitlBee will suppress away messages sent in response to PRIVMSG if one was sent recently - some IRC clients including irssi don't do this very well (when talking to >1 people who are away for example). --- doc/user-guide/commands.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index bba2df73..0989118e 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -483,6 +483,20 @@ + + 3600 + + + + Most IRC servers send a user's away message every time s/he gets a private message, to inform the sender that they may not get a response immediately. With this setting set to 0, BitlBee will also behave like this. + + + + Since not all IRC clients do an excellent job at suppressing these messages, this setting lets BitlBee do it instead. BitlBee will wait this many seconds (or until the away state/message changes) before re-informing you that the person's away. + + + + false -- cgit v1.2.3 From 12b29dbdce259ad7c65b4b890b5d9a1bd44b60b4 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 13 Jun 2010 00:40:12 +0200 Subject: Small doc update on multi-channel stuff. The "channel" command is not documented yet. --- doc/user-guide/help.xml | 1 + doc/user-guide/misc.xml | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml index 7487a841..0684512e 100644 --- a/doc/user-guide/help.xml +++ b/doc/user-guide/help.xml @@ -13,6 +13,7 @@ These are the available help subjects: quickstartA short introduction into BitlBee commandsAll available commands and settings + channelsAbout creating and customizing channels awayAbout setting away states smileysA summary of some non-standard smileys you might find and fail to understand groupchatsHow to work with groupchats on BitlBee diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index 2427ef69..9a0bb67f 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -133,4 +133,50 @@ To restore your logged-in status, you need to either use the register< + +Dealing with channels + + +You can have as many channels in BitlBee as you want. You maintain your channel list using the channel command. You can create new channels by just joining them, like on regular IRC networks. + + + +You can create two kinds of channels. Control channels, and groupchat channels. By default, BitlBee will set up new channels as control channels if their name starts with an &, and as chat channels if it starts with a #. + + + +Control channels are where you see your contacts. By default, you will have one control channel called &bitlbee, containing all your contacts. But you can create more, if you want, and divide your contact list accross several channels. + + + +For example, you can have one channel with all contacts from your MSN Messenger account in it. Or all contacts from the group called "Work". + + + +Type help channels2 to read more. + + + + + +Creating a channel + + +When you create a new channel, BitlBee will try to guess from its name which contacts to fill it with. For example, if the channel name (excluding the &) matches the name of a group in which you have one or more contacts, the channel will contain all those contacts. + + + +Any valid account ID (so a number, protocol name or part of screenname, as long as it's unique) can also be used as a channel name. So if you just join &msn, it will contain all your MSN contacts (as long as you have only one MSN account set up). And if you have a Facebook account set up, you can see its contacts by just joining &facebook. + + + +To start a simple group chat, you simply join a channel which a name starting with #, and invite people into it. All people you invite have to be on the same IM network and contact list. + + + +If you want to configure your own channels, you can use the channel set. + + + + -- cgit v1.2.3 From e5b521d07dbe197c2dd7552f0036bdcac2116cde Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 14 Jun 2010 10:28:32 +0200 Subject: s/buddy_sendbuffer/paste_buffer/ in the docs as well. --- doc/user-guide/commands.xml | 66 ++++++++++++++++++++++----------------------- 1 file changed, 33 insertions(+), 33 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 0989118e..ce60b6db 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -497,39 +497,6 @@ - - false - - - - 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. - - - - Using the buddy_sendbuffer_delay setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent. - - - - 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. - - - - - - 200 - - - - - 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. - - - - See also the buddy_sendbuffer setting. - - - - utf-8 you can get a list of all possible values by doing 'iconv -l' in a shell @@ -784,6 +751,39 @@ + + + false + + + + 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. + + + + Using the paste_buffer_delay setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent. + + + + 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. + + + + + + 200 + + + + + 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. + + + + See also the paste_buffer setting. + + + -- cgit v1.2.3 From e907683afea9e2789e0ac6a1eb55bda9c896c255 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 27 Jun 2010 00:39:31 +0100 Subject: Changed account set (and other account commands) syntax. Instead of "account set acc/key value" you now do "account acc set key value". So just the regular set syntax with a "account acc" prefix. The slash has been a source of confusion for long enough now. For consistency, commands like "account on acc" should now also be "account acc on" instead. Same for the new "channel" comand, of course. --- doc/user-guide/commands.xml | 63 +++++++-------------------------------------- 1 file changed, 9 insertions(+), 54 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 96d54530..edf89d46 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -5,7 +5,7 @@ IM-account list maintenance - account <action> [<arguments>] + account [<account id>] <action> [<arguments>] @@ -98,7 +98,7 @@ - account del <account id> + account <account id> del @@ -113,7 +113,7 @@ - account on [<account id>] + account [<account id>] on @@ -128,7 +128,7 @@ - account off [<account id>] + account [<account id>] off @@ -152,10 +152,10 @@ - account set <account id> - account set <account id>/<setting> - account set <account id>/<setting> <value> - account set -del <account id>/<setting> + account <account id> set + account <account id> set <setting> + account <account id> set <setting> <value> + account <account id> set -del <setting> @@ -180,7 +180,7 @@ - Available actions: add, del, list, with and set. See help chat <action> for more information. + Available actions: add, with. See help chat <action> for more information. @@ -204,30 +204,6 @@ - - chat del <chat id> - - - - This commands deletes an chatroom from your list. - - - - The room ID can be a number (see chat list), or (part of) the name of the room/channel. - - - - - - chat list - - - - This command gives you a list of all the chatrooms known by BitlBee. - - - - chat with <nickname> @@ -237,27 +213,6 @@ - - - chat set <chat id> - chat set <chat id>/<setting> - chat set <chat id>/<setting> <value> - chat set -del <chat id>/<setting> - - - - This command can be used to change various settings for chatrooms. - - - - For more infomation about a setting, see help set <setting>. - - - - The room ID can be a number (see chat list), or (part of) the name of the room/channel. - - - -- cgit v1.2.3 From f537044f96de6b6553f042e2274252cb834680b3 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 4 Jul 2010 15:31:50 +0100 Subject: Documentation update. I think this covers most of the channel-related ui-fix changes. --- doc/user-guide/commands.xml | 151 ++++++++++++++++++++++++++++++++++++++++++-- doc/user-guide/help.xml | 7 +- doc/user-guide/misc.xml | 2 +- 3 files changed, 153 insertions(+), 7 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index edf89d46..889b6165 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -159,7 +159,7 @@ - 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 account set <account id>. + 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 account <account id> set. @@ -173,6 +173,65 @@ + + Channel list maintenance + channel [<account id>] <action> [<arguments>] + + + + Available actions: del, list, set. See help chat <action> for more information. + + + + There is no channel add command. To create a new channel, just use the IRC /join command. See also help channels and help groupchats. + + + + + channel <channel id> del + + + + Remove a channel and forget all its settings. You can only remove channels you're not currently in, and can't remove the main control channel. (You can, however, leave it.) + + + + + + + channel list + + + + This command gives you a list of all the channels you configured. + + + + + + + channel <channel id> set + channel <channel id> set <setting> + channel <channel id> set <setting> <value> + channel <channel id> set -del <setting> + + + + This command can be used to change various settings for channels. Different channel types support different settings. You can see the settings available for a channel by typing channel <channel id> set. + + + + For more infomation about a setting, see help set <setting>. + + + + The channel ID can be a number (see channel list), or (part of) its name, as long as it matches only one channel. + + + + + + Chatroom list maintenance chat <action> [<arguments>] @@ -352,6 +411,15 @@ + + + + + For control channels with fill_by set to account: Set this setting to the account id (numeric, or part of the username) of the account containing the contacts you want to see in this channel. + + + + true @@ -366,12 +434,12 @@ - + false - With this option enabled, BitlBee will automatically join this chatroom when you log in. + With this option enabled, BitlBee will automatically join this channel when you log in. @@ -478,6 +546,25 @@ + + groupchat + groupchat, room + + + + There are two kinds of chat channels: simple groupchats (basically normal IM chats with more than two participants) and names chatrooms, more similar to IRC channels. + + + + BitlBee supports both types. With this setting set to groupchat (the default), you can just invite people into the room and start talking. + + + + For setting up named chatrooms, it's currently easier to just use the chat add command. + + + + false @@ -527,6 +614,38 @@ + + all + all, group, account, protocol + + + + For control channels only: This setting determines which contacts the channel gets populated with. + + + + By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol. + + + + Change this setting and the corresponding account/group/protocol setting to set up this selection. + + + + Note that, when creating a new channel, BitlBee will try to preconfigure the channel for you, based on the channel name. See help channels. + + + + + + + + + For control channels with fill_by set to group: Set this setting to the name of the group containing the contacts you want to see in this channel. + + + + add_channel root, add, add_private, add_channel, ignore @@ -776,6 +895,15 @@ + + + + + For control channels with fill_by set to protocol: Set this setting to the name of the IM protocol of all contacts you want to see in this channel. + + + + lifo lifo, fifo @@ -964,6 +1092,21 @@ + + control + control, chat + + + + BitlBee supports two kinds of channels: control channels (usually with a name starting with a &) and chatroom channels (name usually starts with a #). + + + + See help channels for a full description of channel types in BitlBee. + + + + false @@ -1153,7 +1296,7 @@ - account set 1/display_name "The majestik møøse" + account 1 set display_name "The majestik møøse" display_name = `The majestik møøse' diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml index 0684512e..48ed8a48 100644 --- a/doc/user-guide/help.xml +++ b/doc/user-guide/help.xml @@ -15,8 +15,9 @@ These are the available help subjects: commandsAll available commands and settings channelsAbout creating and customizing channels awayAbout setting away states - smileysA summary of some non-standard smileys you might find and fail to understand groupchatsHow to work with groupchats on BitlBee + nick_changesChanging your nickname without losing any settings + smileysA summary of some non-standard smileys you might find and fail to understand @@ -43,9 +44,11 @@ These are the available help subjects: quickstartA short introduction into BitlBee commandsAll available commands and settings + channelsAbout creating and customizing channels awayAbout setting away states - smileysA summary of some non-standard smileys you might find and fail to understand groupchatsHow to work with groupchats on BitlBee + nick_changesChanging your nickname without losing any settings + smileysA summary of some non-standard smileys you might find and fail to understand diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index 9a0bb67f..175f0cd4 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -166,7 +166,7 @@ When you create a new channel, BitlBee will try to guess from its name which con -Any valid account ID (so a number, protocol name or part of screenname, as long as it's unique) can also be used as a channel name. So if you just join &msn, it will contain all your MSN contacts (as long as you have only one MSN account set up). And if you have a Facebook account set up, you can see its contacts by just joining &facebook. +Any valid account ID (so a number, protocol name or part of screenname, as long as it's unique) can also be used as a channel name. So if you just join &msn, it will contain all your MSN contacts. And if you have a Facebook account set up, you can see its contacts by just joining &facebook. -- cgit v1.2.3 From 69b896b5967e5d13b1c60c68cb3bc7d4a0d5cd06 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 5 Jul 2010 13:01:28 +0100 Subject: When addressing people in a chatroom, try to translate the nickname to the original unstripped version (without ugly underscores, also). --- doc/user-guide/commands.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 889b6165..4154fb27 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -1092,6 +1092,20 @@ + + true + + + + IRC's nickname namespace is quite limited compared to most IM protocols. Not any non-ASCII characters are allowed, in fact nicknames have to be mostly alpha-numeric. Also, BitlBee has to add underscores sometimes to avoid nickname collisions. + + + + While normally the BitlBee user is the only one seeing these names, they may be exposed to other chatroom participants for example when addressing someone in the channel (with or without tab completion). By default BitlBee will translate these stripped nicknames back to the original nick. If you don't want this, disable this setting. + + + + control control, chat -- cgit v1.2.3 From af9f2ca883354a47635d130ff5e7bd693a200a29 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 11 Jul 2010 11:59:56 +0100 Subject: Added allow_takeover setting for people who don't like this new functionality. --- doc/user-guide/commands.xml | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 4154fb27..be61e4db 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -420,6 +420,16 @@ + + true + + + + When you're already connected to a BitlBee server and you connect (and identify) again, BitlBee will offer to migrate your existing session to the new connection. If for whatever reason you don't want this, you can disable this setting. + + + + true -- cgit v1.2.3 From db2cef1ab11cc58cc92c16fd9bccd0fe17e413e4 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Tue, 13 Jul 2010 01:09:40 +0100 Subject: Document this complex new beast. --- doc/user-guide/commands.xml | 31 ++++++++++++++++++++++++++++++- doc/user-guide/misc.xml | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+), 1 deletion(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index be61e4db..d0ce485e 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -763,7 +763,6 @@ - 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. @@ -771,6 +770,36 @@ + + %-@nick + + + + By default, BitlBee tries to derive sensible nicknames for all your contacts from their IM handles. In some cases, IM modules (ICQ for example) will provide a nickname suggestion, which will then be used instead. This setting lets you change this behaviour. + + + + Whenever this setting is set for an account, it will be used for all its contacts. If it's not set, the global value will be used. + + + + It's easier to describe this setting using a few examples: + + + + FB-%full_name will make all nicknames start with "FB-", followed by the person's full name. For example you can set this format for your Facebook account so all Facebook contacts are clearly marked. + + + + [%group]%-@nick will make all nicknames start with the group the contact is in between square brackets, followed by the nickname suggestions from the IM module if available, or otherwise the handle. Because of the "-@" part, everything from the first @ will be stripped. + + + + See help nick_format for more information. + + + + handle handle, full_name, first_name diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index 175f0cd4..825d80ee 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -179,4 +179,38 @@ If you want to configure your own channels, you can use the channel se + +Nickname formatting + + +The nick_format setting can be set globally using the +set command, or per account using account +set (so that you can set a per-account suffix/prefix or have +nicknames generated from full names for certain accounts). + + + +The setting is basically some kind of format string. It can contain normal +text that will be copied to the nick, combined with several variables: + + + + %nickNickname suggested for this contact by the IM protocol, or just the handle if no nickname was suggested. + %handleThe handle/screenname of the contact. + %full_nameThe full name of the contact. + %first_nameThe first name of the contact (the full name up to the first space). + %groupThe name of the group this contact is a member of + + + +One modifier is currently available: %-@variable will remove all characters from the first @ in the string. + + + +In all cases, invalid characters (like spaces) will be stripped. Depending +on your locale settings, characters with accents will be converted to ASCII. + + + + -- cgit v1.2.3 From 6f0ea5781ea4bd50324ee81758a9fd72ef780fcd Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 17 Jul 2010 15:37:33 +0100 Subject: Making nick_format a tiny bit more complicated: Allow truncating a variable to a certain length. --- doc/user-guide/misc.xml | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index 825d80ee..fcbdda0e 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -203,12 +203,31 @@ text that will be copied to the nick, combined with several variables: -One modifier is currently available: %-@variable will remove all characters from the first @ in the string. +Invalid characters (like spaces) will always be stripped. Depending on your +locale settings, characters with accents will be converted to ASCII. -In all cases, invalid characters (like spaces) will be stripped. Depending -on your locale settings, characters with accents will be converted to ASCII. +See set nick_format2 for some more information. + + + + + +Nickname formatting - modifiers + + +Two modifiers ares currently available: You can include only the first few +characters of a variable by putting a number right after the %. For example, +[%3group]%-@nick will include only the first three +characters of the group name in the nick. + + + +Also, you can truncate variables from a certain character using +the -modifier. For example, you may want to leave out +everything after the @. %-@handle will expand to +everything in the handle up to the first @. -- cgit v1.2.3 From 0d691eaca734902fb6c0f476ad2dbddb72e6ba66 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 17 Jul 2010 15:41:50 +0100 Subject: Although linebreaks are allowed in the .xml files, new lines should never start with XML tags, since they won't show up as whitespace in help.txt. --- doc/user-guide/misc.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index fcbdda0e..330e18bb 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -183,8 +183,8 @@ If you want to configure your own channels, you can use the channel se Nickname formatting -The nick_format setting can be set globally using the -set command, or per account using account +The nick_format setting can be set globally using +the set command, or per account using account set (so that you can set a per-account suffix/prefix or have nicknames generated from full names for certain accounts). @@ -218,14 +218,14 @@ See set nick_format2 for some more information. Two modifiers ares currently available: You can include only the first few -characters of a variable by putting a number right after the %. For example, -[%3group]%-@nick will include only the first three -characters of the group name in the nick. +characters of a variable by putting a number right after the %. For +example, [%3group]%-@nick will include only the first +three characters of the group name in the nick. Also, you can truncate variables from a certain character using -the -modifier. For example, you may want to leave out +the - modifier. For example, you may want to leave out everything after the @. %-@handle will expand to everything in the handle up to the first @. -- cgit v1.2.3 From 2efb69bed8c96842368c1d82263909c74582399e Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 18 Jul 2010 16:12:35 +0100 Subject: Doc update for the previous change. --- doc/user-guide/commands.xml | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 46d12a9c..2f5c961a 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -245,7 +245,7 @@ - chat add <account> <room> [<channel>] + chat add <account id> <room> [<channel>] @@ -276,8 +276,8 @@ Add a buddy to your contact list - add <connection> <handle> [<nick>] - add -tmp <connection> <handle> [<nick>] + add <account id> <handle> [<nick>] + add -tmp <account id> <handle> [<nick>] @@ -287,6 +287,10 @@ 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 set handle_unknown add). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications. + + + If you use this command in a control channel containing people from only one group, the new contact will be added to that group automatically. + @@ -1355,22 +1359,15 @@ - - Change friendly name, nick - nick <connection> [<new nick>] - nick <connection> + + Contact group management + group list - Deprecated: Use the per-account display_name setting to read and change this information. + Only the group list command is supported at the moment, which shows a list of all groups defined so far. - - - account 1 set display_name "The majestik møøse" - display_name = `The majestik møøse' - - -- cgit v1.2.3 From 4f22a68c5d1dfd0d1da8b44c3a9d60a7754633b7 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 18 Jul 2010 21:12:55 +0100 Subject: Automatically operate on the current channel if just using "channel set". --- doc/user-guide/commands.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 2f5c961a..ae2d76fb 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -210,10 +210,10 @@ - channel <channel id> set - channel <channel id> set <setting> - channel <channel id> set <setting> <value> - channel <channel id> set -del <setting> + channel [<channel id>] set + channel [<channel id>] set <setting> + channel [<channel id>] set <setting> <value> + channel [<channel id>] set -del <setting> @@ -225,7 +225,7 @@ - The channel ID can be a number (see channel list), or (part of) its name, as long as it matches only one channel. + The channel ID can be a number (see channel list), or (part of) its name, as long as it matches only one channel. If you want to change settings of the current channel, you can omit the channel ID. -- cgit v1.2.3 From 6d8cc053c4b247ad721a0760b13cd383d758c2c5 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 19 Jul 2010 00:50:27 +0100 Subject: Adding easy migration from old show_offline/away_devoice settings, and documentation. --- doc/user-guide/commands.xml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index ae2d76fb..4413ce49 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -517,6 +517,10 @@ 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. + + + Replaced with the show_users setting. See help show_users. + @@ -1040,6 +1044,32 @@ If enabled causes BitlBee to also show offline users in Channel. Online-users will get op, away-users voice and offline users none of both. This option takes effect as soon as you reconnect. + + + Replaced with the show_users setting. See help show_users. + + + + + + online+,away + + + + Comma-separated list of statuses of users you want in the channel, + and any modes they should have. The following statuses are currently + recognised: online (i.e. available, not + away), away, and offline. + + + + If a status is followed by a valid channel mode character + (@, % or +), it will be given to users with that status. + For example, online@,away+,offline will + show all users in the channel. Online people will + have +o, people who are online but away will have +v, + and others will have no special modes. + -- cgit v1.2.3 From 0f28785760c8e625874d35f79c27eaa19785b809 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 24 Jul 2010 18:10:27 +0200 Subject: Account tag documentation update. --- doc/user-guide/commands.xml | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 4413ce49..982e122e 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -107,7 +107,7 @@ - The account ID can be a number (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. + The account ID can be a number/tag (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. @@ -121,7 +121,7 @@ - The account ID can be a number (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. + The account ID can be a number/tag (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. @@ -136,7 +136,7 @@ - The account ID can be a number (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. + The account ID can be a number/tag (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. @@ -167,7 +167,7 @@ - The account ID can be a number (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. + The account ID can be a number/tag (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. @@ -1140,6 +1140,18 @@ + + + + For every account you have, you can set a tag you can use to uniquely identify that account. This tag can be used instead of the account number (or protocol name, or part of the screenname) when using commands like account, add, etc. You can't have two accounts with one and the same account tag. + + + + By default, it will be set to the name of the IM protocol. Once you add a second account on an IM network, a numeric suffix will be added, starting with 2. + + + + local local, utc, gmt, timezone-spec -- cgit v1.2.3