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