Changes in doc/user-guide/commands.xml [286b28e:1195cec]
- File:
-
- 1 edited
-
doc/user-guide/commands.xml (modified) (9 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/commands.xml
r286b28e r1195cec 125 125 <description> 126 126 <para> 127 This command gives you a list of all the accounts known by BitlBee .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 128 </para> 129 129 </description> … … 138 138 <description> 139 139 <para> 140 This commandcan 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>.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 141 </para> 142 142 143 143 <para> 144 For more infomation about a setting, see <emphasis>help set <setting></emphasis>. 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>. 145 145 </para> 146 146 147 147 <para> 148 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>152 </bitlbee-command>153 154 <bitlbee-command name="chat">155 <short-description>Chatroom list maintenance</short-description>156 <syntax>chat <action> [<arguments>]</syntax>157 158 <description>159 160 <para>161 Available actions: add, del, list, with and set. See <emphasis>help chat <action></emphasis> for more information.162 </para>163 164 </description>165 166 <bitlbee-command name="add">167 <syntax>chat add <account> <room> [<channel>]</syntax>168 169 <description>170 <para>171 Add a chatroom to the list of chatrooms you're interested in. BitlBee needs this list to map room names to a proper IRC channel name.172 </para>173 174 <para>175 After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See <emphasis>chat set</emphasis>)176 </para>177 178 <para>179 Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.180 </para>181 </description>182 183 </bitlbee-command>184 185 <bitlbee-command name="del">186 <syntax>chat del <chat id></syntax>187 188 <description>189 <para>190 This commands deletes an chatroom from your list.191 </para>192 193 <para>194 The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.195 </para>196 </description>197 </bitlbee-command>198 199 <bitlbee-command name="list">200 <syntax>chat list</syntax>201 202 <description>203 <para>204 This command gives you a list of all the chatrooms known by BitlBee.205 </para>206 </description>207 </bitlbee-command>208 209 <bitlbee-command name="with">210 <syntax>chat with <nickname></syntax>211 212 <description>213 <para>214 While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions.215 </para>216 </description>217 </bitlbee-command>218 219 <bitlbee-command name="set">220 <syntax>chat set <chat id></syntax>221 <syntax>chat set <chat id>/<setting></syntax>222 <syntax>chat set <chat id>/<setting> <value></syntax>223 <syntax>chat set -del <chat id>/<setting></syntax>224 225 <description>226 <para>227 This command can be used to change various settings for chatrooms.228 </para>229 230 <para>231 For more infomation about a setting, see <emphasis>help set <setting></emphasis>.232 </para>233 234 <para>235 The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.236 149 </para> 237 150 </description> … … 390 303 </bitlbee-setting> 391 304 392 <bitlbee-setting name="auto_join" type="boolean" scope="chat">393 <default>false</default>394 395 <description>396 <para>397 With this option enabled, BitlBee will automatically join this chatroom when you log in.398 </para>399 </description>400 </bitlbee-setting>401 402 305 <bitlbee-setting name="auto_reconnect" type="boolean" scope="both"> 403 306 <default>false</default> … … 418 321 </bitlbee-setting> 419 322 420 <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global"> 421 <default>5*3<900</default> 422 423 <description> 424 <para> 425 Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up. 426 </para> 427 428 <para> 429 This can be one integer, for a constant delay. One can also set it to something like "10*10", which means wait for ten seconds on the first reconnect, multiply it by ten on every failure. Once successfully connected, this delay is re-set to the initial value. With < you can give a maximum delay. 323 <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global"> 324 <default>300</default> 325 326 <description> 327 <para> 328 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. 430 329 </para> 431 330 432 331 <para> 433 332 See also the <emphasis>auto_reconnect</emphasis> setting. 434 </para>435 </description>436 </bitlbee-setting>437 438 <bitlbee-setting name="away" type="string" scope="both">439 <description>440 <para>441 To mark yourself as away, it is recommended to just use <emphasis>/away</emphasis>, like on normal IRC networks. If you want to mark yourself as away on only one IM network, you can use this per-account setting.442 </para>443 444 <para>445 You can set it to any value and BitlBee will try to map it to the most appropriate away state for every open IM connection, or set it as a free-form away message where possible.446 </para>447 448 <para>449 Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.450 333 </para> 451 334 </description> … … 599 482 </bitlbee-setting> 600 483 601 <bitlbee-setting name="nick" type="string" scope="chat">602 603 <description>604 <para>605 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.606 </para>607 </description>608 </bitlbee-setting>609 610 <bitlbee-setting name="nick_source" type="string" scope="account">611 <default>handle</default>612 <possible-values>handle, full_name, first_name</possible-values>613 614 <description>615 <para>616 By default, BitlBee generates a nickname for every contact by taking its handle and chopping off everything after the @. In some cases, this gives very inconvenient nicknames. The Facebook XMPP server is a good example, as all Facebook XMPP handles are numeric.617 </para>618 619 <para>620 With this setting set to <emphasis>full_name</emphasis>, the person's full name is used to generate a nickname. Or if you don't like long nicknames, set this setting to <emphasis>first_name</emphasis> instead and only the first word will be used. Note that the full name can be full of non-ASCII characters which will be stripped off.621 </para>622 </description>623 </bitlbee-setting>624 625 484 <bitlbee-setting name="ops" type="string" scope="global"> 626 485 <default>both</default> … … 717 576 <bitlbee-setting name="resource_select" type="string" scope="account"> 718 577 <default>priority</default> 719 <possible-values>priority, activity</possible-values>578 <possible-values>priority, time</possible-values> 720 579 721 580 <description> … … 725 584 726 585 <para> 727 Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis> activity</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected).586 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). 728 587 </para> 729 588 </description> … … 774 633 <para> 775 634 Currently only available for Jabber connections. Set this to true if the server accepts SSL connections. 776 </para>777 </description>778 </bitlbee-setting>779 780 <bitlbee-setting name="status" type="string" scope="both">781 <description>782 <para>783 Certain protocols (like Jabber/XMPP) support status messages, similar to away messages. They can be used to indicate things like your location or activity, without showing up as away/busy.784 </para>785 786 <para>787 This setting can be used to set such a message. It will be available as a per-account setting for protocols that support it, and also as a global setting (which will then automatically be used for all protocols that support it).788 </para>789 790 <para>791 Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To un-set the setting, use <emphasis>set -del status</emphasis>.792 635 </para> 793 636 </description> … … 1007 850 1008 851 </bitlbee-command> 852 853 <bitlbee-command name="join_chat"> 854 <short-description>Join a named groupchat/conference room</short-description> 855 <syntax>join_chat <connection> <room name> [<channel name>] [<room nickname>] [<password>]</syntax> 856 857 <description> 858 <para> 859 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. 860 </para> 861 862 <para> 863 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. 864 </para> 865 866 <para> 867 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>. 868 </para> 869 </description> 870 871 <ircexample> 872 <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me</ircline> 873 </ircexample> 874 875 </bitlbee-command> 1009 876 </chapter>
Note: See TracChangeset
for help on using the changeset viewer.
