From c1333754810c20ff77324c9463ec3efba3c493d2 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 1 Sep 2008 00:19:32 +0100 Subject: Added documentation on the "chat" command. --- doc/user-guide/commands.xml | 108 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 105 insertions(+), 3 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index cd16808e..60b24113 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -124,7 +124,7 @@ - This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands. + This command gives you a list of all the accounts known by BitlBee. @@ -137,11 +137,11 @@ - 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 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 set <account id>. - For more infomation about a setting, see help set <setting>. For details about the syntax of this command, see help set. + For more infomation about a setting, see help set <setting>. @@ -151,6 +151,89 @@ + + Chatroom list maintenance + chat <action> [<arguments>] + + + + + Available actions: add, del, list, with and set. See help chat <action> for more information. + + + + + + chat add <account> <room> [<channel>] + + + + Add a chatroom to the list of chatrooms you're interested in. BitlBee needs this list to map room names to a proper IRC channel name. + + + + After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See chat set) + + + + + + + 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> + + + + While most chat subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what /join #nickname used to do in older BitlBee versions. + + + + + + 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. + + + + + Add a buddy to your contact list add <connection> <handle> [<nick>] @@ -302,6 +385,16 @@ + + false + + + + With this option enabled, BitlBee will automatically join this chatroom when you log in. + + + + false @@ -485,6 +578,15 @@ + + + + + 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. + + + + both both, root, user, none -- cgit v1.2.3 From 35529ae92ca468d7be6be60663c1f8d6a07b8373 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 1 Sep 2008 00:37:56 +0100 Subject: Updated "help groupchats" and removed help information on the join_chat command. --- doc/user-guide/commands.xml | 24 ------------------------ doc/user-guide/misc.xml | 6 +++--- 2 files changed, 3 insertions(+), 27 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 60b24113..e50aed19 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -955,28 +955,4 @@ - - - Join a named groupchat/conference room - join_chat <connection> <room name> [<channel name>] [<room nickname>] [<password>] - - - - On most IM-networks groupchats can be started using the /join command. (/join #foo to start a chatroom with you and foo) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command. - - - - The first two arguments are required. room name is the name of the chatroom on the IM-network. channel name is the IRC channel name BitlBee should map this to. room nickname is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses. - - - - The following command will join you to the chatroom called bitlbee@conference.bitlbee.org. The channel will be called &bitlbee-help because &bitlbee will already be in use. Your nickname will be help-me. - - - - - join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me - - - diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index b55a8915..3102b8b0 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -68,15 +68,15 @@ Of course you can also create your own groupchats. Type help groupchat Creating groupchats -If you want to start a groupchat with the person lisa_msn in it, just join the channel #lisa_msn. BitlBee will refuse to join you to the channel with that name, but it will create a new virtual channel with root, you and lisa_msn in it. +To open a groupchat, use the chat with command. For example, to start a groupchat with the person lisa_msn in it, just type chat with lisa_msn. BitlBee will create a new virtual channel with root, you and lisa_msn in it. -Of course a channel with only two people isn't really exciting yet. So the next step is to invite some other people to the channel. For this, you can use the /invite command of your IRC client. Please do keep in mind that all the people have to be on the same network and contact list! You can't invite Yahoo! buddies into an MSN groupchat. +Then, just use the ordinary IRC /invite command to invite more people. Please do keep in mind that all the people have to be on the same network and contact list! You can't invite Yahoo! buddies into an MSN groupchat. -Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the join_chat command to join them. See help join_chat for more information. +Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the chat add command to join them. See help chat_add for more information. -- cgit v1.2.3 From 76b652192e8f1a247bd3152cf62b17966efeb72e Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 7 Sep 2008 14:03:51 +0100 Subject: =?UTF-8?q?Switched=20docs=20to=20UTF-8,=20using=20XHTML=20DocBook?= =?UTF-8?q?=20template=20instead=20of=20old=20HTML=20one,=20to=20get=20tha?= =?UTF-8?q?t=20doc=20over=20to=20UTF-8=20as=20well=20(all=20for=20the=20ma?= =?UTF-8?q?jestik=20m=C3=B8=C3=B8se!)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/user-guide/Makefile | 2 +- doc/user-guide/help.xml | 2 +- doc/user-guide/user-guide.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/Makefile b/doc/user-guide/Makefile index eb31fc0f..9841de8d 100644 --- a/doc/user-guide/Makefile +++ b/doc/user-guide/Makefile @@ -12,7 +12,7 @@ all: user-guide.txt user-guide.html help.txt # user-guide.pdf user-guide.ps user mv $*.db.txt $@ %.html: %.db.xml - xsltproc --output $@ http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< + xsltproc --output $@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl $< %.pdf: %.db.xml xmlto --skip-validation pdf $< diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml index 34fdb9e2..7487a841 100644 --- a/doc/user-guide/help.xml +++ b/doc/user-guide/help.xml @@ -1,4 +1,4 @@ - + diff --git a/doc/user-guide/user-guide.xml b/doc/user-guide/user-guide.xml index 5b881fb2..5e1c8fe0 100644 --- a/doc/user-guide/user-guide.xml +++ b/doc/user-guide/user-guide.xml @@ -1,4 +1,4 @@ - + -- cgit v1.2.3 From 9e768da723b4a770967efa0d4dcaf58ccef8917f Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Tue, 13 Jan 2009 18:59:28 +0000 Subject: Fixed an embarassing typo that even fooled me into believing BitlBee is broken. :-( --- doc/user-guide/commands.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index e50aed19..fcb1c8be 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -681,7 +681,7 @@ priority - priority, time + priority, activity @@ -689,7 +689,7 @@ - Normally it's set to priority which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to time, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). + Normally it's set to priority which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to activity, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). -- cgit v1.2.3 From 57d842193767ddbb87531ce9865b23fbdb72eadb Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 17 Oct 2009 16:04:30 +0100 Subject: Document password-protected rooms. --- doc/user-guide/commands.xml | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index fcb1c8be..af566de4 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -174,6 +174,10 @@ After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See chat set) + + + Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join. + -- cgit v1.2.3 From fb51d85751b36098ad4271bc4553ade4dc53f20b Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 24 Oct 2009 00:57:41 +0100 Subject: "chat add", not chat_add --- doc/user-guide/misc.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index 3102b8b0..68b44e95 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -76,7 +76,7 @@ Then, just use the ordinary IRC /invite command to invite m -Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the chat add command to join them. See help chat_add for more information. +Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the chat add command to join them. See help chat add for more information. -- cgit v1.2.3