diff options
Diffstat (limited to 'doc/user-guide')
| -rw-r--r-- | doc/user-guide/Installation.xml | 114 | ||||
| -rw-r--r-- | doc/user-guide/Makefile | 50 | ||||
| -rw-r--r-- | doc/user-guide/Support.xml | 49 | ||||
| -rw-r--r-- | doc/user-guide/Usage.xml | 58 | ||||
| -rw-r--r-- | doc/user-guide/commands.xml | 1749 | ||||
| -rw-r--r-- | doc/user-guide/docbook.xsl | 137 | ||||
| -rw-r--r-- | doc/user-guide/help.xml | 64 | ||||
| -rw-r--r-- | doc/user-guide/help.xsl | 161 | ||||
| -rw-r--r-- | doc/user-guide/misc.xml | 368 | ||||
| -rw-r--r-- | doc/user-guide/quickstart.xml | 167 | ||||
| -rw-r--r-- | doc/user-guide/user-guide.xml | 41 |
11 files changed, 2958 insertions, 0 deletions
diff --git a/doc/user-guide/Installation.xml b/doc/user-guide/Installation.xml new file mode 100644 index 00000000..6980ba3c --- /dev/null +++ b/doc/user-guide/Installation.xml @@ -0,0 +1,114 @@ +<chapter id="Installation"> + +<title>Installation</title> + +<sect1> +<title>Downloading the package</title> + +<para> +The latest BitlBee release is always available from <ulink +url="http://www.bitlbee.org/">http://www.bitlbee.org/</ulink>. +Download the package with your favorite program and unpack it: <command>tar +xvfz bitlbee-<version>.tar.gz</command> where <version> is to be +replaced by the version number of the BitlBee you downloaded (e.g. 0.91). +</para> + +</sect1> + +<sect1> +<title>Compiling</title> +<para> +BitlBee's build system has to be configured before compiling. The +<filename>configure</filename> script will do this for you. Just run +it, it'll set up with nice and hopefully well-working defaults. If you +want to change some settings, just try +<command>./configure --help</command> and see what you can do. +</para> + +<para>Some variables that might be of interest to the normal user:</para> + +<itemizedlist> +<listitem><para>prefix, bindir, etcdir, mandir, datadir - The place where +all the BitlBee program files will be put. There's usually no reason to +specify them all separately, just specifying prefix (or keeping the default +<filename>/usr/local/</filename>) should be okay.</para></listitem> +<listitem><para>config - The place where BitlBee will save all the per-user +settings and buddy information. <filename>/var/lib/bitlbee/</filename> +is the default value.</para></listitem> +<listitem><para>msn, jabber, oscar, yahoo - By default, support for all +these IM-protocols (OSCAR is the protocol used by both ICQ and AIM) will +be compiled in. To make the binary a bit smaller, you can use these options +to leave out support for protocols you're not planning to use.</para></listitem> +<listitem><para>debug - Generate an unoptimized binary with debugging symbols, +mainly useful if you want to do some debugging or help us to track down a +problem.</para></listitem> +<listitem><para>strip - By default, unnecessary parts of the generated binary +will be stripped out to make it as small as possible. If you don't want this +(because it might cause problems on some platforms), set this to 0. +</para></listitem> +<listitem><para>flood - To secure your BitlBee server against flooding attacks, +you can use this option. It's not compiled in by default because it needs +more testing first.</para></listitem> +<listitem><para>ssl - The MSN and Jabber modules require an SSL library for +some of their tasks. BitlBee can use three different SSL libraries: GnuTLS, +mozilla-nss and OpenSSL. (OpenSSL is, however, a bit troublesome because of +licensing issues, so don't forget to read the information configure will +give you when you try to use OpenSSL!) By default, configure will try to +detect GnuTLS or mozilla-nss. If none of them can be found, it'll give up. +If you want BitlBee to use OpenSSL, you have to explicitly specify that. +</para></listitem> +</itemizedlist> + +<para> +After running <filename>configure</filename>, you should run +<command>make</command>. After that, run <command>make install</command> as +root. +</para> + +</sect1> + +<sect1> +<title>Configuration</title> + +<para> +By default, BitlBee runs as the user nobody. You might want +to run it as a seperate user (some computers run named or apache as nobody). +</para> + +<para> +Since BitlBee uses inetd, you should add the following line to <filename>/etc/inetd.conf</filename>: +</para> + +<para> +<programlisting> +6667 stream tcp nowait nobody /usr/local/sbin/bitlbee bitlbee +</programlisting> +</para> + +<para> +Inetd has to be restarted after changing the configuration. Either +<command>killall -HUP inetd</command> or +<command>/etc/init.d/inetd restart</command> should do the job on most systems. +</para> + +<para> +You might be one of the.. ehr, lucky people running an xinetd-powered distro. +<command>xinetd</command> is quite different and they seem to be proud of that.. ;-) +Anyway, if you want BitlBee to work with <command>xinetd</command>, just copy the +bitlbee.xinetd file to your /etc/xinetd.d/ directory (and probably edit it to suit +your needs). +</para> + +<para> +You should create a directory where BitlBee can store it's data files. This +should be the directory named after the value 'CONFIG' in Makefile.settings. +The default is <filename>/var/lib/bitlbee</filename>, which can be created +with the command <command>mkdir -p /var/lib/bitlbee</command>. This +directory has to be owned by the user that runs bitlbee. To make +'nobody' owner of this directory, run <command>chown nobody /var/lib/bitlbee</command>. +Because things like passwords are saved in this directory, it's probably +a good idea to make this directory owner-read-/writable only. +</para> +</sect1> + +</chapter> diff --git a/doc/user-guide/Makefile b/doc/user-guide/Makefile new file mode 100644 index 00000000..2a80ea6c --- /dev/null +++ b/doc/user-guide/Makefile @@ -0,0 +1,50 @@ +-include ../../Makefile.settings +ifdef SRCDIR +SRCDIR := $(SRCDIR)doc/user-guide/ +endif + +EXTRAPARANEWLINE = 1 +# EXTRAPARANEWLINE = 0 + +all: user-guide.txt user-guide.html help.txt # user-guide.pdf user-guide.ps user-guide.rtf + +%.tex: %.db.xml + xsltproc --stringparam l10n.gentext.default.language "en" --stringparam latex.documentclass.common "" --stringparam latex.babel.language "" --output $@ http://db2latex.sourceforge.net/xsl/docbook.xsl $< + +%.txt: %.db.xml + xmlto --skip-validation txt $< + mv $*.db.txt $@ + +%.html: %.db.xml + xsltproc --output $@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl $< + +%.pdf: %.db.xml + xmlto --skip-validation pdf $< + mv $*.db.pdf $@ + +%.ps: %.db.xml + xmlto --skip-validation ps $< + mv $*.db.ps $@ + +help.xml: commands.xml + +%.db.xml: %.xml docbook.xsl + xsltproc --xinclude --output $@ docbook.xsl $< + +help.txt: help.xml help.xsl commands.xml misc.xml quickstart.xml + xsltproc --stringparam extraparanewline "$(EXTRAPARANEWLINE)" --xinclude help.xsl $< | perl -0077 -pe 's/\n\n%/\n%/s; s/_b_/\002/g;' > $@ + +clean: + rm -f *.html *.pdf *.ps *.rtf *.txt *.db.xml + +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 $(SRCDIR)help.txt $(DESTDIR)$(DATADIR)/help.txt + +uninstall: + rm -f $(DESTDIR)$(DATADIR)/help.txt + -rmdir $(DESTDIR)$(DATADIR) + +.PHONY: clean install uninstall diff --git a/doc/user-guide/Support.xml b/doc/user-guide/Support.xml new file mode 100644 index 00000000..c9f50a5f --- /dev/null +++ b/doc/user-guide/Support.xml @@ -0,0 +1,49 @@ +<chapter id="Support"> + +<title>Support</title> + +<sect1> +<title>Disclaimer</title> + +<para> +BitlBee doesn't come with a warranty and is still (and will probably always +be) under development. That means it can crash at any time, corrupt your +data or whatever. Don't use it in any production environment and don't rely +on it, or at least don't blame us if things blow up. :-) +</para> + +</sect1> + +<sect1> +<title>Support channels</title> + +<sect2> +<title>The World Wide Web</title> + +<para> +<ulink url="http://www.bitlbee.org/">http://www.bitlbee.org/</ulink> +is the homepage of bitlbee and contains the most recent news on bitlbee and +the latest releases. +</para> + +</sect2> + +<sect2> +<title>IRC</title> +<para> +BitlBee is discussed on #bitlbee on the OFTC IRC network (server: irc.oftc.net). +</para> + +</sect2> + +<sect2> +<title>Mailinglists</title> +<para> +BitlBee doesn't have any mailinglists. +</para> + +</sect2> + +</sect1> + +</chapter> diff --git a/doc/user-guide/Usage.xml b/doc/user-guide/Usage.xml new file mode 100644 index 00000000..167a74e0 --- /dev/null +++ b/doc/user-guide/Usage.xml @@ -0,0 +1,58 @@ +<chapter id="Usage"> + +<title>Usage</title> + +<sect1> +<title>Connecting to the server</title> +<para> +Since BitlBee acts just like any other irc daemon, you can connect to +it with your favorite irc client. Launch it and connect to localhost port 6667 +(or whatever host/port you are running bitlbee on). +</para> + +</sect1> + +<sect1> +<title>The &bitlbee control channel</title> + +<para> +Once you are connected to the BitlBee server, you are automatically joined +to &bitlbee on that server. This channel acts like the 'buddy list' you have +on the various other chat networks. +</para> + +<para> +The user 'root' always hangs around in &bitlbee and acts as your interface +to bitlbee. All commands you give on &bitlbee are 'answered' by root. +</para> + +<para> +You might be slightly confused by the & in the channel name. This is, +however, completely allowed by the IRC standards. Just try it on a regular +IRC server, it should work. The difference between the standard #channels +and &channels is that the #channels are distributed over all the servers +on the IRC network, while &channels are local to one server. Because +the BitlBee control channel is local to one server (and in fact, to one person), +this name seems more suitable. Also, with this name, it's harder to confuse +the control channel with the #bitlbee channel on OFTC. +</para> + +</sect1> + +<sect1> +<title>Talking to people</title> + +<para> +You can talk to by starting a query with them. In most irc clients, +this can be done with either <command>/msg <nick> <text></command> +or <command>/query <nick></command>. +</para> + +<para> +To keep the number of open query windows limited, you can also talk to people +in the control channel, like <command><nick>: <text></command>. +</para> + +</sect1> + +</chapter> diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml new file mode 100644 index 00000000..85003f24 --- /dev/null +++ b/doc/user-guide/commands.xml @@ -0,0 +1,1749 @@ +<chapter id="commands"> + <title>Bitlbee commands</title> + + <command-list/> + + <bitlbee-command name="account"> + <short-description>IM-account list maintenance</short-description> + <syntax>account [<account id>] <action> [<arguments>]</syntax> + + <description> + + <para> + Available actions: add, del, list, on, off and set. See <emphasis>help account <action></emphasis> for more information. + </para> + + </description> + + <bitlbee-command name="add"> + <syntax>account add <protocol> <username> [<password>]</syntax> + + <description> + <para> + 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), Yahoo and Twitter. For more information about adding an account, see <emphasis>help account add <protocol></emphasis>. + </para> + + <para> + You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs. + </para> + </description> + + <bitlbee-command name="jabber"> + <syntax>account add jabber <handle@server.tld> [<password>]</syntax> + + <description> + <para> + 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. + </para> + + <para> + 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>). + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="msn"> + <syntax>account add msn <handle@server.tld> [<password>]</syntax> + + <description> + <para> + For MSN connections there are no special arguments. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="oscar"> + <syntax>account add oscar <handle> [<password>]</syntax> + + <description> + <para> + 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. + </para> + </description> + + <ircexample> + <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline> + <ircline nick="root">Account successfully added</ircline> + </ircexample> + </bitlbee-command> + + <bitlbee-command name="twitter"> + <syntax>account add twitter <handle> [<password>]</syntax> + + <description> + <para> + This module gives you simple access to Twitter and Twitter API compatible services. + </para> + + <para> + By default all your Twitter contacts will appear in a new channel called #twitter_yourusername. You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>). + </para> + + <para> + To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option. + </para> + + <para> + Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.) + </para> + + <para> + To use a non-Twitter service, change the <emphasis>base_url</emphasis> setting. For identi.ca, you can simply use <emphasis>account add identica</emphasis>. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="identica"> + <syntax>account add identica <handle> [<password>]</syntax> + + <description> + <para> + Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca, and with OAuth disabled. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="yahoo"> + <syntax>account add yahoo <handle> [<password>]</syntax> + + <description> + <para> + For Yahoo! connections there are no special arguments. + </para> + </description> + </bitlbee-command> + + </bitlbee-command> + + <bitlbee-command name="del"> + <syntax>account <account id> del</syntax> + + <description> + <para> + This commands deletes an account from your account list. You should signoff the account before deleting it. + </para> + + + <para> + The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="on"> + <syntax>account [<account id>] on</syntax> + + <description> + <para> + 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. + </para> + + <para> + The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="off"> + <syntax>account [<account id>] off</syntax> + + <description> + <para> + 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. + </para> + + <para> + The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="list"> + <syntax>account list</syntax> + + <description> + <para> + This command gives you a list of all the accounts known by BitlBee. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="set"> + <syntax>account <account id> set</syntax> + <syntax>account <account id> set <setting></syntax> + <syntax>account <account id> set <setting> <value></syntax> + <syntax>account <account id> set -del <setting></syntax> + + <description> + <para> + 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 <emphasis>account <account id> set</emphasis>. + </para> + + <para> + For more infomation about a setting, see <emphasis>help set <setting></emphasis>. + </para> + + <para> + The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. + </para> + </description> + </bitlbee-command> + </bitlbee-command> + + <bitlbee-command name="channel"> + <short-description>Channel list maintenance</short-description> + <syntax>channel [<account id>] <action> [<arguments>]</syntax> + + <description> + <para> + Available actions: del, list, set. See <emphasis>help channel <action></emphasis> for more information. + </para> + + <para> + There is no <emphasis>channel add</emphasis> command. To create a new channel, just use the IRC <emphasis>/join</emphasis> command. See also <emphasis>help channels</emphasis> and <emphasis>help groupchats</emphasis>. + </para> + </description> + + <bitlbee-command name="del"> + <syntax>channel <channel id> del</syntax> + + <description> + <para> + 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.) + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="list"> + <syntax>channel list</syntax> + + <description> + <para> + This command gives you a list of all the channels you configured. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="set"> + <syntax>channel [<channel id>] set</syntax> + <syntax>channel [<channel id>] set <setting></syntax> + <syntax>channel [<channel id>] set <setting> <value></syntax> + <syntax>channel [<channel id>] set -del <setting></syntax> + + <description> + <para> + 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 <emphasis>channel <channel id> set</emphasis>. + </para> + + <para> + For more infomation about a setting, see <emphasis>help set <setting></emphasis>. + </para> + + <para> + The channel ID can be a number (see <emphasis>channel list</emphasis>), 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. + </para> + </description> + </bitlbee-command> + + </bitlbee-command> + + <bitlbee-command name="chat"> + <short-description>Chatroom list maintenance</short-description> + <syntax>chat <action> [<arguments>]</syntax> + + <description> + + <para> + Available actions: add, with. See <emphasis>help chat <action></emphasis> for more information. + </para> + + </description> + + <bitlbee-command name="add"> + <syntax>chat add <account id> <room> [<channel>]</syntax> + + <description> + <para> + 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. + </para> + + <para> + 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>) + </para> + + <para> + Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="with"> + <syntax>chat with <nickname></syntax> + + <description> + <para> + 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. + </para> + </description> + </bitlbee-command> + </bitlbee-command> + + <bitlbee-command name="add"> + <short-description>Add a buddy to your contact list</short-description> + <syntax>add <account id> <handle> [<nick>]</syntax> + <syntax>add -tmp <account id> <handle> [<nick>]</syntax> + + <description> + <para> + 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. + </para> + + <para> + 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 <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications. + </para> + + <para> + 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. + </para> + </description> + + <ircexample> + <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline> + <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&bitlbee</emphasis></ircaction> + </ircexample> + </bitlbee-command> + + <bitlbee-command name="info"> + <short-description>Request user information</short-description> + <syntax>info <connection> <handle></syntax> + <syntax>info <nick></syntax> + + <description> + <para> + 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. + </para> + </description> + + <ircexample> + <ircline nick="ctrlsoft">info 0 72696705</ircline> + <ircline nick="root">User info - UIN: 72696705 Nick: Lintux First/Last name: Wilmer van der Gaast E-mail: lintux@lintux.cx</ircline> + </ircexample> + + </bitlbee-command> + + <bitlbee-command name="remove"> + <short-description>Remove a buddy from your contact list</short-description> + <syntax>remove <nick></syntax> + + <description> + <para> + Removes the specified nick from your buddy list. + </para> + </description> + + <ircexample> + <ircline nick="ctrlsoft">remove gryp</ircline> + <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction> + </ircexample> + + </bitlbee-command> + + <bitlbee-command name="block"> + <short-description>Block someone</short-description> + <syntax>block <nick></syntax> + <syntax>block <connection> <handle></syntax> + <syntax>block <connection></syntax> + + <description> + <para> + 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. + </para> + + <para> + When called with only a connection specification as an argument, the command displays the current block list for that connection. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="allow"> + <short-description>Unblock someone</short-description> + <syntax>allow <nick></syntax> + <syntax>allow <connection> <handle></syntax> + + <description> + <para> + Reverse of block. Unignores the specified user or user handle on specified connection. + </para> + + <para> + When called with only a connection specification as an argument, the command displays the current allow list for that connection. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="otr"> + <short-description>Off-the-Record encryption control</short-description> + <syntax>otr <subcommand> [<arguments>]</syntax> + + <description> + + <para> + Available subcommands: connect, disconnect, smp, smpq, trust, info, keygen, and forget. See <emphasis>help otr <subcommand></emphasis> for more information. + </para> + + </description> + + <bitlbee-command name="connect"> + <syntax>otr connect <nick></syntax> + + <description> + + <para> + Attempts to establish an encrypted connection with the specified user by sending a magic string. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="disconnect"> + <syntax>otr disconnect <nick></syntax> + + <description> + + <para> + Resets the connection with the specified user to cleartext. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="smp"> + <syntax>otr smp <nick> <secret></syntax> + + <description> + + <para> + Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol. + </para> + + <para> + If an SMP challenge has been received from the given user, responds with the specified secret/answer. Otherwise, sends a challenge for the given secret. + </para> + + <para> + Note that there are two flavors of SMP challenges: "shared-secret" and "question & answer". This command is used to respond to both of them, or to initiate a shared-secret style exchange. Use the <emphasis>otr smpq</emphasis> command to initiate a "Q&A" session. + </para> + + <para> + When responding to a "Q&A" challenge, the local trust value is not altered. Only the <emphasis>asking party</emphasis> sets trust in the case of success. Use <emphasis>otr smpq</emphasis> to pose your challenge. In a shared-secret exchange, both parties set their trust according to the outcome. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="smpq"> + <syntax>otr smpq <nick> <question> <answer></syntax> + + <description> + + <para> + Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol, Q&A style. + </para> + + <para> + Initiates an SMP session in "question & answer" style. The question is transmitted with the initial SMP packet and used to prompt the other party. You must be confident that only they know the answer. If the protocol succeeds (i.e. they answer correctly), the fingerprint will be trusted. Note that the answer must be entered exactly, case and punctuation count! + </para> + + <para> + Note that this style of SMP only affects the trust setting on your side. Expect your opponent to send you their own challenge. Alternatively, if you and the other party have a shared secret, use the <emphasis>otr smp</emphasis> command. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="trust"> + <syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax> + + <description> + + <para> + Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="info"> + <syntax>otr info</syntax> + <syntax>otr info <nick></syntax> + + <description> + + <para> + 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. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="keygen"> + <syntax>otr keygen <account-no></syntax> + + <description> + + <para> + Generates a new OTR private key for the given account. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="forget"> + <syntax>otr forget <thing> <arguments></syntax> + + <description> + + <para> + Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information. + </para> + + </description> + + <bitlbee-command name="fingerprint"> + <syntax>otr forget fingerprint <nick> <fingerprint></syntax> + + <description> + + <para> + 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. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="context"> + <syntax>otr forget context <nick></syntax> + + <description> + + <para> + 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. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="key"> + <syntax>otr forget key <fingerprint></syntax> + + <description> + + <para> + Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint. + </para> + + </description> + + </bitlbee-command> + + </bitlbee-command> + + </bitlbee-command> + + <bitlbee-command name="set"> + <short-description>Miscellaneous settings</short-description> + <syntax>set</syntax> + <syntax>set <variable></syntax> + <syntax>set <variable> <value></syntax> + <syntax>set -del <variable></syntax> + + <description> + + <para> + 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. + </para> + + <para> + To get more help information about a setting, try: + </para> + + </description> + + <ircexample> + <ircline nick="ctrlsoft">help set private</ircline> + </ircexample> + + </bitlbee-command> + + <bitlbee-command name="help"> + <short-description>BitlBee help system</short-description> + + <syntax>help [subject]</syntax> + + <description> + <para> + 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. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="save"> + <short-description>Save your account data</short-description> + <syntax>save</syntax> + + <description> + <para> + 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... ;-) + </para> + </description> + </bitlbee-command> + + <bitlbee-setting name="account" type="string" scope="channel"> + + <description> + <para> + For control channels with <emphasis>fill_by</emphasis> set to <emphasis>account</emphasis>: 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="allow_takeover" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="auto_connect" type="boolean" scope="both"> + <default>true</default> + + <description> + <para> + With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this. + </para> + + <para> + 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!) + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="auto_join" type="boolean" scope="channel"> + <default>false</default> + + <description> + <para> + With this option enabled, BitlBee will automatically join this channel when you log in. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="auto_reconnect" type="boolean" scope="both"> + <default>true</default> + + <description> + <para> + 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. + </para> + + <para> + See also the <emphasis>auto_reconnect_delay</emphasis> setting. + </para> + + <para> + 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!) + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global"> + <default>5*3<900</default> + + <description> + <para> + Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up. + </para> + + <para> + 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. + </para> + + <para> + See also the <emphasis>auto_reconnect</emphasis> setting. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="auto_reply_timeout" type="integer" scope="account"> + <default>10800</default> + + <description> + <para> + For Twitter accounts: If you respond to Tweets IRC-style (like "nickname: reply"), this will automatically be converted to the usual Twitter format ("@screenname reply"). + </para> + + <para> + By default, BitlBee will then also add a reference to that person's most recent Tweet, unless that message is older than the value of this setting in seconds. + </para> + + <para> + If you want to disable this feature, just set this to 0. Alternatively, if you want to write a message once that is <emphasis>not</emphasis> a reply, use the Twitter reply syntax (@screenname). + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="away" type="string" scope="both"> + <description> + <para> + 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. + </para> + + <para> + 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. + </para> + + <para> + Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="away_devoice" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + 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. + </para> + + <para> + Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="away_reply_timeout" type="integer" scope="global"> + <default>3600</default> + + <description> + <para> + 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. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="base_url" type="string" scope="account"> + <default>http://twitter.com</default> + + <description> + <para> + There are more services that understand the Twitter API than just Twitter.com. BitlBee can connect to all Twitter API implementations. + </para> + + <para> + For example, set this setting to <emphasis>http://identi.ca/api</emphasis> to use Identi.ca. + </para> + + <para> + Keep two things in mind: When not using Twitter, you <emphasis>must</emphasis> also disable the <emphasis>oauth</emphasis> setting as it currently only works with Twitter. If you're still having issues, make sure there is <emphasis>no</emphasis> slash at the end of the URL you enter here. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="charset" type="string" scope="global"> + <default>utf-8</default> + <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values> + + <description> + <para> + This setting tells BitlBee what your IRC client sends and expects. It should be equal to the charset setting of your IRC client if you want to be able to send and receive non-ASCII text properly. + </para> + + <para> + Most systems use UTF-8 these days. On older systems, an iso8859 charset may work better. For example, iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://www.unicodecharacter.com/charsets/iso8859.html + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="color_encrypted" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="control_channel" type="string" scope="global"> + <default>&bitlbee</default> + + <description> + <para> + Normally the control channel where you can see all your contacts is called "&bitlbee". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="chat_type" type="string" scope="channel"> + <default>groupchat</default> + <possible-values>groupchat, room</possible-values> + + <description> + <para> + 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. + </para> + + <para> + BitlBee supports both types. With this setting set to <emphasis>groupchat</emphasis> (the default), you can just invite people into the room and start talking. + </para> + + <para> + For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="commands" type="boolean" scope="account"> + <default>true</default> + + <description> + <para> + With this setting enabled, you can use some commands in your Twitter channel/query. The commands are simple and not documented in too much detail: + </para> + + <variablelist> + <varlistentry><term>undo [<id>]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry> + <varlistentry><term>rt <screenname|id></term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry> + <varlistentry><term>follow <screenname></term><listitem><para>Start following a person</para></listitem></varlistentry> + <varlistentry><term>unfollow <screenname></term><listitem><para>Stop following a person</para></listitem></varlistentry> + <varlistentry><term>post <message></term><listitem><para>Post a tweet</para></listitem></varlistentry> + </variablelist> + + <para> + Anything that doesn't look like a command will be treated as a tweet. Watch out for typos! :-) + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="debug" type="boolean" scope="global"> + <default>false</default> + + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="default_target" type="string" scope="global"> + <default>root</default> + <possible-values>root, last</possible-values> + + <description> + <para> + 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>. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="display_name" type="string" scope="account"> + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="display_namechanges" type="boolean" scope="global"> + <default>false</default> + + <description> + <para> + With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="display_timestamps" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + When incoming messages are old (i.e. offline messages and channel backlogs), BitlBee will prepend them with a timestamp. If you find them ugly or useless, you can use this setting to hide them. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="fill_by" type="string" scope="channel"> + <default>all</default> + <possible-values>all, group, account, protocol</possible-values> + + <description> + <para> + For control channels only: This setting determines which contacts the channel gets populated with. + </para> + + <para> + By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol. + </para> + + <para> + Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection. + </para> + + <para> + Note that, when creating a new channel, BitlBee will try to preconfigure the channel for you, based on the channel name. See <emphasis>help channels</emphasis>. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="group" type="string" scope="channel"> + + <description> + <para> + For control channels with <emphasis>fill_by</emphasis> set to <emphasis>group</emphasis>: Set this setting to the name of the group containing the contacts you want to see in this channel. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="handle_unknown" type="string" scope="global"> + <default>add_channel</default> + <possible-values>root, add, add_private, add_channel, ignore</possible-values> + + <description> + <para> + Messages from unknown users are echoed like this by default: + </para> + + <ircexample> + <ircline nick="root">Unknown message from handle 3137137:</ircline> + <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline> + </ircexample> + + <para> + 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. + </para> + + <note> + <para> + 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. + </para> + </note> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account"> + <default>false</default> + + <description> + <para> + Only supported by OSCAR so far, you can use this setting to ignore ICQ authorization requests, which are hardly used for legitimate (i.e. non-spam) reasons anymore. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="lcnicks" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="local_display_name" type="boolean" scope="account"> + <default>false</default> + + <description> + <para> + Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="mail_notifications" type="boolean" scope="account"> + <default>false</default> + + <description> + <para> + 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. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="message_length" type="integer" scope="account"> + <default>140</default> + + <description> + <para> + Since Twitter rejects messages longer than 140 characters, BitlBee can count message length and emit a warning instead of waiting for Twitter to reject it. + </para> + + <para> + You can change this limit here but this won't disable length checks on Twitter's side. You can also set it to 0 to disable the check in case you believe BitlBee doesn't count the characters correctly. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="mode" type="string" scope="account"> + <possible-values>one, many, chat</possible-values> + <default>chat</default> + + <description> + <para> + By default, BitlBee will create a separate channel (called #twitter_yourusername) for all your Twitter contacts/messages. + </para> + + <para> + If you don't want an extra channel, you can set this setting to "one" (everything will come from one nick, twitter_yourusername), or to "many" (individual nicks for everyone). + </para> + + <para> + With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet. + </para> + + <para> + With modes "many" and "one", you can post tweets by /msg'ing the twitter_yourusername contact. In mode "chat", messages posted in the Twitter channel will also be posted as tweets. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="mobile_is_away" type="boolean" scope="global"> + <default>false</default> + + <description> + <para> + Most IM networks have a mobile version of their client. People who use these may not be paying that much attention to messages coming in. By enabling this setting, people using mobile clients will always be shown as away. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="nick" type="string" scope="chat"> + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="nick_format" type="string" scope="both"> + <default>%-@nick</default> + + <description> + <para> + 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. + </para> + + <para> + 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. + </para> + + <para> + It's easier to describe this setting using a few examples: + </para> + + <para> + 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. + </para> + + <para> + [%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. + </para> + + <para> + See <emphasis>help nick_format</emphasis> for more information. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="nick_source" type="string" scope="account"> + <default>handle</default> + <possible-values>handle, full_name, first_name</possible-values> + + <description> + <para> + 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. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="oauth" type="boolean" scope="account"> + <default>true</default> + + <description> + <para> + This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory. + </para> + + <para> + With OAuth enabled, you shouldn't tell BitlBee your Twitter password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with Twitter. If this succeeds, Twitter will return a PIN code which you can give back to BitlBee to finish the process. + </para> + + <para> + The resulting access token will be saved permanently, so you have to do this only once. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="ops" type="string" scope="global"> + <default>both</default> + <possible-values>both, root, user, none</possible-values> + + <description> + <para> + Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. + </para> + + <para> + The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="otr_policy" type="string" scope="global"> + <default>opportunistic</default> + <possible-values>never, opportunistic, manual, always</possible-values> + + <description> + <para> + This setting controls the policy for establishing Off-the-Record connections. + </para> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="password" type="string" scope="both"> + <description> + <para> + Use this global setting to change your "NickServ" password. + </para> + + <para> + This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="paste_buffer" type="boolean" scope="global"> + <default>false</default> + + <description> + <para> + 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. + </para> + + <para> + Using the <emphasis>paste_buffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global"> + <default>200</default> + + <description> + + <para> + 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. + </para> + + <para> + See also the <emphasis>paste_buffer</emphasis> setting. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="port" type="integer" scope="account"> + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="priority" type="integer" scope="account"> + <default>0</default> + + <description> + <para> + 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). + </para> + + <para> + 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). + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="private" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="protocol" type="string" scope="channel"> + + <description> + <para> + For control channels with <emphasis>fill_by</emphasis> set to <emphasis>protocol</emphasis>: Set this setting to the name of the IM protocol of all contacts you want to see in this channel. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="query_order" type="string" scope="global"> + <default>lifo</default> + <possible-values>lifo, fifo</possible-values> + + <description> + <para> + 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. + </para> + + <para> + 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). + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="resource" type="string" scope="account"> + <default>BitlBee</default> + + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="resource_select" type="string" scope="account"> + <default>activity</default> + <possible-values>priority, activity</possible-values> + + <description> + <para> + 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. + </para> + + <para> + 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). + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="root_nick" type="string" scope="global"> + <default>root</default> + + <description> + <para> + Normally the "bot" that takes all your BitlBee commands is called "root". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="save_on_quit" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="server" type="string" scope="account"> + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="show_offline" type="boolean" scope="global"> + <default>false</default> + + <description> + <para> + 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. + </para> + + <para> + Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="show_users" type="string" scope="channel"> + <default>online+,away</default> + + <description> + <para> + Comma-separated list of statuses of users you want in the channel, + and any modes they should have. The following statuses are currently + recognised: <emphasis>online</emphasis> (i.e. available, not + away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>. + </para> + + <para> + If a status is followed by a valid channel mode character + (@, % or +), it will be given to users with that status. + For example, <emphasis>online@,away+,offline</emphasis> 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="ssl" type="boolean" scope="account"> + <default>false</default> + + <description> + <para> + Currently only available for Jabber connections. Set this to true if the server accepts SSL connections. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="status" type="string" scope="both"> + <description> + <para> + 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. + </para> + + <para> + 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). + </para> + + <para> + 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>. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="strip_html" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + 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. + </para> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account"> + <default>false</default> + + <description> + <para> + Turn on this flag if you have difficulties talking to offline/invisible contacts. + </para> + + <para> + With this setting enabled, BitlBee will send keepalives to MSN switchboards with offline/invisible contacts every twenty seconds. This should keep the server and client on the other side from shutting it down. + </para> + + <para> + This is useful because BitlBee doesn't support MSN offline messages yet and the MSN servers won't let the user reopen switchboards to offline users. Once offline messaging is supported, this flag might be removed. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="tag" type="string" scope="account"> + <description> + <para> + 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 <emphasis>account</emphasis>, <emphasis>add</emphasis>, etc. You can't have two accounts with one and the same account tag. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="timezone" type="string" scope="global"> + <default>local</default> + <possible-values>local, utc, gmt, timezone-spec</possible-values> + + <description> + <para> + If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting. + </para> + + <para> + Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="tls" type="boolean" scope="account"> + <default>try</default> + + <description> + <para> + 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. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="to_char" type="string" scope="global"> + <default>": "</default> + + <description> + <para> + 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>. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel"> + <default>true</default> + + <description> + <para> + 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. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="type" type="string" scope="channel"> + <default>control</default> + <possible-values>control, chat</possible-values> + + <description> + <para> + BitlBee supports two kinds of channels: control channels (usually with a name starting with a &) and chatroom channels (name usually starts with a #). + </para> + + <para> + See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="typing_notice" type="boolean" scope="global"> + <default>false</default> + + <description> + <para> + Sends you a /notice when a user starts typing a message (if supported by the IM protocol and the user's client). To use this, you most likely want to use a script in your IRC client to show this information in a more sensible way. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="user_agent" type="string" scope="account"> + <default>BitlBee</default> + + <description> + <para> + Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them. + </para> + + <para> + You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="web_aware" type="string" scope="account"> + <default>false</default> + + <description> + <para> + 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. + </para> + + <para> + Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="xmlconsole" type="boolean" scope="account"> + <default>false</default> + + <description> + <para> + 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. + </para> + <para> + If you want to enable this XML console permanently (and at login time already), you can set this setting. + </para> + </description> + </bitlbee-setting> + + <bitlbee-command name="rename"> + <short-description>Rename (renick) a buddy</short-description> + <syntax>rename <oldnick> <newnick></syntax> + <syntax>rename -del <oldnick></syntax> + + <description> + <para> + 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). + </para> + + <para> + <emphasis>rename -del</emphasis> can be used to erase your manually set nickname for a contact and reset it to what was automatically generated. + </para> + </description> + + <ircexample> + <ircline nick="itsme">rename itsme_ you</ircline> + <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction> + </ircexample> + + </bitlbee-command> + + <bitlbee-command name="yes"> + <short-description>Accept a request</short-description> + <syntax>yes [<number>]</syntax> + + <description> + <para> + 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. + </para> + + <para> + 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. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="no"> + <short-description>Deny a request</short-description> + <syntax>no [<number>]</syntax> + + <description> + <para> + 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. + </para> + + <para> + 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. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="qlist"> + <short-description>List all the unanswered questions root asked</short-description> + <syntax>qlist</syntax> + + <description> + <para> + This gives you a list of all the unanswered questions from root. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="register"> + <short-description>Register yourself</short-description> + <syntax>register [<password>]</syntax> + + <description> + <para> + 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. + </para> + + <para> + 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.. ;-) + </para> + + <para> + 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. + </para> + + <para> + You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="identify"> + <syntax>identify [-noload|-force] [<password>]</syntax> + <short-description>Identify yourself with your password</short-description> + + <description> + <para> + 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. + </para> + + <para> + Once you're registered, you can change your password using <emphasis>set password <password></emphasis>. + </para> + + <para> + The <emphasis>-noload</emphasis> and <emphasis>-force</emphasis> flags can be used to identify when you're logged into some IM accounts already. <emphasis>-force</emphasis> will let you identify yourself and load all saved accounts (and keep the accounts you're logged into already). + </para> + + <para> + <emphasis>-noload</emphasis> 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). + </para> + + <para> + You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="drop"> + <syntax>drop <password></syntax> + <short-description>Drop your account</short-description> + + <description> + <para> + 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. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="blist"> + <syntax>blist [all|online|offline|away]</syntax> + <short-description>List all the buddies in the current channel</short-description> + + <description> + <para> + You can get a more 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. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="group"> + <short-description>Contact group management</short-description> + <syntax>group list</syntax> + + <description> + <para> + Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far. + </para> + + <para> + If you want to move contacts between groups, you can use the IRC <emphasis>/invite</emphasis> command. Also, if you use the <emphasis>add</emphasis> command in a control channel configured to show just one group, the new contact will automatically be added to that group. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="transfer"> + <short-description>Monitor, cancel, or reject file transfers</short-description> + <syntax>transfer [<cancel> id | <reject>]</syntax> + + <description> + <para> + Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfer <action></emphasis> for more information. + </para> + + <ircexample> + <ircline nick="ulim">transfer</ircline> + </ircexample> + </description> + + <bitlbee-command name="cancel"> + <short-description>Cancels the file transfer with the given id</short-description> + <syntax>transfer <cancel> id</syntax> + + <description> + <para>Cancels the file transfer with the given id</para> + </description> + + <ircexample> + <ircline nick="ulim">transfer cancel 1</ircline> + <ircline nick="root">Canceling file transfer for test</ircline> + </ircexample> + </bitlbee-command> + + <bitlbee-command name="reject"> + <short-description>Rejects all incoming transfers</short-description> + <syntax>transfer <reject></syntax> + + <description> + <para>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?</para> + </description> + + <ircexample> + <ircline nick="ulim">transfer reject</ircline> + </ircexample> + </bitlbee-command> + </bitlbee-command> + +</chapter> diff --git a/doc/user-guide/docbook.xsl b/doc/user-guide/docbook.xsl new file mode 100644 index 00000000..21d6b08e --- /dev/null +++ b/doc/user-guide/docbook.xsl @@ -0,0 +1,137 @@ +<?xml version='1.0'?> +<!-- + Convert BitlBee XML documentation to DocBook + (C) 2004 Jelmer Vernooij +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:exsl="http://exslt.org/common" + version="1.1" + extension-element-prefixes="exsl"> + + <xsl:output method="xml" encoding="UTF-8" doctype-public="-//OASIS//DTD DocBook XML V4.2//EN" indent="yes" doctype-system="http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"/> + + <xsl:strip-space elements="*"/> + + <xsl:template match="ircline"> + <xsl:element name="prompt"><xsl:text>< </xsl:text><xsl:value-of select="@nick"/><xsl:text>> </xsl:text></xsl:element> + <xsl:element name="userinput"><xsl:value-of select="normalize-space(.)"/></xsl:element><xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="ircaction"> + <xsl:text> * </xsl:text><xsl:value-of select="@nick"/><xsl:text> </xsl:text><xsl:value-of select="normalize-space(.)"/><xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="ircexample"> + <xsl:element name="screen"> + <xsl:for-each select="ircline|ircaction"> + <xsl:apply-templates select="."/> + </xsl:for-each> + </xsl:element> + </xsl:template> + + + <!-- This is needed to copy content unchanged --> + <xsl:template match="@*|node()"> + <xsl:copy> + <xsl:apply-templates select="@*|node()"/> + </xsl:copy> + </xsl:template> + + <xsl:template name="subcmd-list"> + <xsl:if test="bitlbee-command != ''"> + <xsl:element name="variablelist"> + <xsl:for-each select="bitlbee-command"> + <xsl:element name="varlistentry"> + <xsl:element name="term"> + <xsl:value-of select="@name"/> + </xsl:element> + <xsl:element name="listitem"> + <xsl:element name="para"> + <xsl:value-of select="short-description"/> + </xsl:element> + </xsl:element> + </xsl:element> + </xsl:for-each> + </xsl:element> + </xsl:if> + </xsl:template> + + <xsl:template match="command-list"> + <xsl:call-template name="subcmd-list"/> + </xsl:template> + + <xsl:template match="bitlbee-setting"> + <xsl:element name="sect1"> + <xsl:attribute name="id"> + <xsl:text>set_</xsl:text> + <xsl:value-of select="@name"/> + </xsl:attribute> + <xsl:element name="title"><xsl:value-of select="@name"/></xsl:element> + + <xsl:element name="simplelist"> + <xsl:element name="member"> + <xsl:text>Type: </xsl:text><xsl:value-of select="@type"/> + </xsl:element> + </xsl:element> + + <xsl:for-each select="description/para"> + <xsl:apply-templates select="."/> + </xsl:for-each> + + </xsl:element> + </xsl:template> + + <xsl:template name="cmd"> + <xsl:param name="prefix"/> + <xsl:variable name="thiscmd"><xsl:value-of select="$prefix"/><xsl:value-of select="@name"/></xsl:variable> + <xsl:attribute name="id"> + <xsl:text>cmd_</xsl:text> + <xsl:value-of select="translate($thiscmd,' ','_')"/> + </xsl:attribute> + <xsl:element name="title"><xsl:value-of select="$thiscmd"/> + <xsl:if test="short-description"> + <xsl:text> - </xsl:text> + <xsl:value-of select="short-description"/> + </xsl:if> + </xsl:element> + + <xsl:element name="formalpara"> + <xsl:element name="title"><xsl:text>Syntax:</xsl:text></xsl:element> + <xsl:element name="para"> + <xsl:element name="programlisting"> + <xsl:for-each select="syntax"> + <xsl:value-of select="normalize-space(.)"/><xsl:text> </xsl:text> + </xsl:for-each> + </xsl:element> + </xsl:element> + </xsl:element> + + <xsl:for-each select="description/para"> + <xsl:apply-templates select="."/> + </xsl:for-each> + + <xsl:for-each select="ircexample"> + <xsl:apply-templates select="."/> + </xsl:for-each> + + <!--<xsl:call-template name="subcmd-list"/>--> + + <xsl:for-each select="bitlbee-command"> + <xsl:element name="sect2"> + <xsl:call-template name="cmd"> + <xsl:with-param name="prefix"><xsl:value-of select="$thiscmd"/><xsl:text> </xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:element> + </xsl:for-each> + </xsl:template> + + <xsl:template match="bitlbee-command"> + <xsl:element name="sect1"> + <xsl:call-template name="cmd"> + <xsl:with-param name="prefix" select="''"/> + </xsl:call-template> + </xsl:element> + </xsl:template> + + </xsl:stylesheet> diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml new file mode 100644 index 00000000..48ed8a48 --- /dev/null +++ b/doc/user-guide/help.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + +<book id="BitlBee-Help" xmlns:xi="http://www.w3.org/2003/XInclude"> + +<preface id=""> +<title>BitlBee help system</title> + +<para> +These are the available help subjects: +</para> + +<variablelist> + <varlistentry><term>quickstart</term><listitem><para>A short introduction into BitlBee</para></listitem></varlistentry> + <varlistentry><term>commands</term><listitem><para>All available commands and settings</para></listitem></varlistentry> + <varlistentry><term>channels</term><listitem><para>About creating and customizing channels</para></listitem></varlistentry> + <varlistentry><term>away</term><listitem><para>About setting away states</para></listitem></varlistentry> + <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry> + <varlistentry><term>nick_changes</term><listitem><para>Changing your nickname without losing any settings</para></listitem></varlistentry> + <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry> +</variablelist> + +<para> +You can read more about them with <emphasis>help <subject></emphasis> +</para> + +<para> +BitlBee is written by Wilmer van der Gaast together with Jelmer Vernooij, Maurits Dijkstra and others. Bugs can be reported at <ulink link="http://bugs.bitlbee.org/">http://bugs.bitlbee.org/</ulink>. +</para> + +<para> +For other things than bug reports, you can join <emphasis>#BitlBee</emphasis> on OFTC (<emphasis>irc.oftc.net</emphasis>) (OFTC, *not* FreeNode!) and flame us right in the face. :-) +</para> + +</preface> + +<chapter id="index"> +<title>Index</title> + +<para> +These are the available help subjects: +</para> + +<variablelist> + <varlistentry><term>quickstart</term><listitem><para>A short introduction into BitlBee</para></listitem></varlistentry> + <varlistentry><term>commands</term><listitem><para>All available commands and settings</para></listitem></varlistentry> + <varlistentry><term>channels</term><listitem><para>About creating and customizing channels</para></listitem></varlistentry> + <varlistentry><term>away</term><listitem><para>About setting away states</para></listitem></varlistentry> + <varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry> + <varlistentry><term>nick_changes</term><listitem><para>Changing your nickname without losing any settings</para></listitem></varlistentry> + <varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry> +</variablelist> + +<para> +You can read more about them with <emphasis>help <subject></emphasis> +</para> + +</chapter> + +<xi:include href="quickstart.xml"/> +<xi:include href="commands.xml"/> +<xi:include href="misc.xml"/> + +</book> diff --git a/doc/user-guide/help.xsl b/doc/user-guide/help.xsl new file mode 100644 index 00000000..b7e3c371 --- /dev/null +++ b/doc/user-guide/help.xsl @@ -0,0 +1,161 @@ +<?xml version='1.0'?> +<!-- + Convert DocBook documentation to help.txt file used by bitlbee + (C) 2004 Jelmer Vernooij +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.1"> + + <xsl:output method="text" encoding="utf-8" standalone="yes"/> + <xsl:strip-space elements="*"/> + + <xsl:template match="text()"> + <xsl:if test="starts-with(.,' ') and preceding-sibling::* and + not(preceding-sibling::*[1]/node()[1][self::text() and contains(concat(.,'^$%'),' ^$%')])"> + <xsl:text> </xsl:text> + </xsl:if> + + <xsl:value-of select="normalize-space(.)"/> + <xsl:if test="contains(concat(.,'^$%'),' ^$%') and following-sibling::* and + not(following-sibling::*[1]/node()[1][self::text() and starts-with(.,' ')])"> + <xsl:text> </xsl:text> + </xsl:if> + </xsl:template> + + <xsl:template match="para"> + <xsl:apply-templates/><xsl:text> </xsl:text> + <xsl:if test="$extraparanewline = '1'"> + <xsl:text> </xsl:text> + </xsl:if> + </xsl:template> + + <xsl:template name="subject"> + <xsl:param name="id"/> + <xsl:message><xsl:text>Processing: </xsl:text><xsl:value-of select="$id"/></xsl:message> + <xsl:text>?</xsl:text><xsl:value-of select="$id"/><xsl:text> </xsl:text> + + <xsl:for-each select="para|variablelist|simplelist|command-list|ircexample"> + <xsl:if test="title != ''"> + <xsl:value-of select="title"/><xsl:text> </xsl:text> + </xsl:if> + <xsl:apply-templates select="."/> + </xsl:for-each> + <xsl:text>% </xsl:text> + + <xsl:for-each select="sect1|sect2"> + <xsl:call-template name="subject"> + <xsl:with-param name="id" select="@id"/> + </xsl:call-template> + </xsl:for-each> + + <xsl:for-each select="bitlbee-command"> + <xsl:call-template name="cmd"> + <xsl:with-param name="prefix" select="''"/> + </xsl:call-template> + </xsl:for-each> + + <xsl:for-each select="bitlbee-setting"> + <xsl:message><xsl:text>Processing setting '</xsl:text><xsl:value-of select="@name"/><xsl:text>'</xsl:text></xsl:message> + <xsl:text>?set </xsl:text><xsl:value-of select="@name"/><xsl:text> </xsl:text> + <xsl:text>_b_Type:_b_ </xsl:text><xsl:value-of select="@type"/><xsl:text> </xsl:text> + <xsl:text>_b_Scope:_b_ </xsl:text><xsl:value-of select="@scope"/><xsl:text> </xsl:text> + <xsl:if test="default"> + <xsl:text>_b_Default:_b_ </xsl:text><xsl:value-of select="default"/><xsl:text> </xsl:text> + </xsl:if> + <xsl:if test="possible-values"> + <xsl:text>_b_Possible Values:_b_ </xsl:text><xsl:value-of select="possible-values"/><xsl:text> </xsl:text> + </xsl:if> + <xsl:text> </xsl:text> + <xsl:apply-templates select="description"/> + <xsl:text>% </xsl:text> + </xsl:for-each> + </xsl:template> + + <xsl:template match="command-list"> + <xsl:for-each select="../bitlbee-command"> + <xsl:text> * _b_</xsl:text><xsl:value-of select="@name"/><xsl:text>_b_ - </xsl:text><xsl:value-of select="short-description"/><xsl:text> </xsl:text> + </xsl:for-each> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="preface|chapter|sect1|sect2"> + <xsl:call-template name="subject"> + <xsl:with-param name="id" select="@id"/> + </xsl:call-template> + </xsl:template> + + <xsl:template match="emphasis"> + <xsl:text>_b_</xsl:text> + <xsl:apply-templates/> + <xsl:text>_b_</xsl:text> + </xsl:template> + + <xsl:template match="book"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template match="variablelist"> + <xsl:for-each select="varlistentry"> + <xsl:text> _b_</xsl:text><xsl:value-of select="term"/><xsl:text>_b_ - </xsl:text><xsl:value-of select="listitem/para"/><xsl:text> </xsl:text> + </xsl:for-each> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="simplelist"> + <xsl:for-each select="member"> + <xsl:text> - </xsl:text><xsl:apply-templates/><xsl:text> </xsl:text> + </xsl:for-each> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="ircline"> + <xsl:text>_b_<</xsl:text><xsl:value-of select="@nick"/><xsl:text>>_b_ </xsl:text><xsl:value-of select="."/><xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="ircaction"> + <xsl:text>_b_* </xsl:text><xsl:value-of select="@nick"/><xsl:text>_b_ </xsl:text><xsl:value-of select="."/><xsl:text> </xsl:text> + </xsl:template> + + <xsl:template match="ircexample"> + <xsl:apply-templates/> + <xsl:text> </xsl:text> + </xsl:template> + + <xsl:template name="cmd"> + <xsl:param name="prefix"/> + <xsl:variable name="thiscmd"><xsl:value-of select="$prefix"/><xsl:value-of select="@name"/></xsl:variable> + <xsl:message><xsl:text>Processing command '</xsl:text><xsl:value-of select="$thiscmd"/><xsl:text>'</xsl:text></xsl:message> + <xsl:text>?</xsl:text><xsl:value-of select="$thiscmd"/><xsl:text> </xsl:text> + <xsl:for-each select="syntax"> + <xsl:text>_b_Syntax:_b_ </xsl:text><xsl:value-of select="."/><xsl:text> </xsl:text> + </xsl:for-each> + <xsl:text> </xsl:text> + + <xsl:apply-templates select="description"/> + + <xsl:for-each select="ircexample"> + <xsl:text>_b_Example:_b_ </xsl:text> + <xsl:apply-templates select="."/> + </xsl:for-each> + + <!-- + <xsl:if test="bitlbee-command != ''"> + <xsl:text>Subcommands: </xsl:text> + <xsl:for-each select="bitlbee-command"> + <xsl:value-of select="@name"/><xsl:text>, </xsl:text> + </xsl:for-each> + <xsl:text> </xsl:text> + </xsl:if> + --> + + <xsl:text>% </xsl:text> + + <xsl:for-each select="bitlbee-command"> + <xsl:call-template name="cmd"> + <xsl:with-param name="prefix"><xsl:value-of select="$thiscmd"/><xsl:text> </xsl:text></xsl:with-param> + </xsl:call-template> + </xsl:for-each> + + </xsl:template> + +</xsl:stylesheet> diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml new file mode 100644 index 00000000..1aceab56 --- /dev/null +++ b/doc/user-guide/misc.xml @@ -0,0 +1,368 @@ +<chapter id="misc"> +<title>Misc Stuff</title> + +<sect1 id="smileys"> +<title>Smileys</title> + +<para> +All MSN smileys (except one) are case insensitive and work without the nose too. +</para> + +<variablelist> + <varlistentry><term>(Y)</term><listitem><para>Thumbs up</para></listitem></varlistentry> + <varlistentry><term>(N)</term><listitem><para>Thumbs down</para></listitem></varlistentry> + <varlistentry><term>(B)</term><listitem><para>Beer mug</para></listitem></varlistentry> + <varlistentry><term>(D)</term><listitem><para>Martini glass</para></listitem></varlistentry> + <varlistentry><term>(X)</term><listitem><para>Girl</para></listitem></varlistentry> + <varlistentry><term>(Z)</term><listitem><para>Boy</para></listitem></varlistentry> + <varlistentry><term>(6)</term><listitem><para>Devil smiley</para></listitem></varlistentry> + <varlistentry><term>:-[</term><listitem><para>Vampire bat</para></listitem></varlistentry> + <varlistentry><term>(})</term><listitem><para>Right hug</para></listitem></varlistentry> + <varlistentry><term>({)</term><listitem><para>Left hug</para></listitem></varlistentry> + <varlistentry><term>(M)</term><listitem><para>MSN Messenger or Windows Messenger icon (think a BitlBee logo here ;)</para></listitem></varlistentry> + <varlistentry><term>:-S</term><listitem><para>Crooked smiley (Confused smiley)</para></listitem></varlistentry> + <varlistentry><term>:-$</term><listitem><para>Embarrassed smiley</para></listitem></varlistentry> + <varlistentry><term>(H)</term><listitem><para>Smiley with sunglasses</para></listitem></varlistentry> + <varlistentry><term>:-@</term><listitem><para>Angry smiley</para></listitem></varlistentry> + <varlistentry><term>(A)</term><listitem><para>Angel smiley</para></listitem></varlistentry> + <varlistentry><term>(L)</term><listitem><para>Red heart (Love)</para></listitem></varlistentry> + <varlistentry><term>(U)</term><listitem><para>Broken heart</para></listitem></varlistentry> + <varlistentry><term>(K)</term><listitem><para>Red lips (Kiss)</para></listitem></varlistentry> + <varlistentry><term>(G)</term><listitem><para>Gift with bow</para></listitem></varlistentry> + <varlistentry><term>(F)</term><listitem><para>Red rose</para></listitem></varlistentry> + <varlistentry><term>(W)</term><listitem><para>Wilted rose</para></listitem></varlistentry> + <varlistentry><term>(P)</term><listitem><para>Camera</para></listitem></varlistentry> + <varlistentry><term>(~)</term><listitem><para>Film strip</para></listitem></varlistentry> + <varlistentry><term>(T)</term><listitem><para>Telephone receiver</para></listitem></varlistentry> + <varlistentry><term>(@)</term><listitem><para>Cat face</para></listitem></varlistentry> + <varlistentry><term>(&)</term><listitem><para>Dog's head</para></listitem></varlistentry> + <varlistentry><term>(C)</term><listitem><para>Coffee cup</para></listitem></varlistentry> + <varlistentry><term>(I)</term><listitem><para>Light bulb</para></listitem></varlistentry> + <varlistentry><term>(S)</term><listitem><para>Half-moon (Case sensitive!)</para></listitem></varlistentry> + <varlistentry><term>(*)</term><listitem><para>Star</para></listitem></varlistentry> + <varlistentry><term>(8)</term><listitem><para>Musical eighth note</para></listitem></varlistentry> + <varlistentry><term>(E)</term><listitem><para>Envelope</para></listitem></varlistentry> + <varlistentry><term>(^)</term><listitem><para>Birthday cake</para></listitem></varlistentry> + <varlistentry><term>(O)</term><listitem><para>Clock</para></listitem></varlistentry> +</variablelist> + +</sect1> + +<sect1 id="groupchats"> +<title>Groupchats</title> +<para> +BitlBee now supports groupchats on all IM networks. This text will try to explain you how they work. +</para> + +<para> +As soon as someone invites you into a groupchat, you will be force-joined or invited (depending on the protocol) into a new virtual channel with all the people in there. You can leave the channel at any time, just like you would close the window in regular IM clients. Please note that root-commands don't work in groupchat channels, they only work in the control channel (or to root directly). +</para> + +<para> +Of course you can also create your own groupchats. Type <emphasis>help groupchats2</emphasis> to see how. +</para> + +</sect1> + +<sect1 id="groupchats2"> +<title>Creating groupchats</title> + +<para> +To open a groupchat, use the <emphasis>chat with</emphasis> command. For example, to start a groupchat with the person <emphasis>lisa_msn</emphasis> in it, just type <emphasis>chat with lisa_msn</emphasis>. BitlBee will create a new virtual channel with root, you and lisa_msn in it. +</para> + +<para> +Then, just use the ordinary IRC <emphasis>/invite</emphasis> 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. +</para> + +<para> +Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>chat add</emphasis> command to join them. See <emphasis>help chat add</emphasis> for more information. +</para> + +</sect1> + +<sect1 id="away"> +<title>Away states</title> + +<para> +To mark yourself as away, you can just use the <emphasis>/away</emphasis> command in your IRC client. BitlBee supports most away-states supported by the protocols. +</para> + +<para> +Away states have different names accross different protocols. BitlBee will try to pick the best available option for every connection: +</para> + +<simplelist> + <member>Away</member> + <member>NA</member> + <member>Busy, DND</member> + <member>BRB</member> + <member>Phone</member> + <member>Lunch, Food</member> + <member>Invisible, Hidden</member> +</simplelist> + +<para> +So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your MSN connection, and for most other connections the default, "Away" will be chosen. +</para> + +<para> +You can also add more information to your away message. Setting it to "Busy - Fixing BitlBee bugs" will set your IM-away-states to Busy, but your away message will be more descriptive for people on IRC. Most IM-protocols can also show this additional information to your buddies. +</para> + +<para> +If you want to set an away state for only one of your connections, you can use the per-account <emphasis>away</emphasis> setting. See <emphasis>help set away</emphasis>. +</para> + +</sect1> + +<sect1 id="nick_changes"> +<title>Changing your nickname</title> + +<para> +BitlBee now allows you to change your nickname. So far this was not possible because it made managing saved accounts more complicated. +</para> + +<para> +The restriction no longer exists now though. When you change your nick (just using the <emphasis>/nick</emphasis> command), your logged-in status will be reset, which means any changes made to your settings/accounts will not be saved. +</para> + +<para> +To restore your logged-in status, you need to either use the <emphasis>register</emphasis> command to create an account under the new nickname, or use <emphasis>identify -noload</emphasis> to re-identify yourself under the new nickname. The <emphasis>-noload</emphasis> flag tells the command to verify your password and log you in, but not load any new settings. See <emphasis>help identify</emphasis> for more information. +</para> + +</sect1> + +<sect1 id="channels"> +<title>Dealing with channels</title> + +<para> +You can have as many channels in BitlBee as you want. You maintain your channel list using the <emphasis>channel</emphasis> command. You can create new channels by just joining them, like on regular IRC networks. +</para> + +<para> +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 #. +</para> + +<para> +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. +</para> + +<para> +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". +</para> + +<para> +Type <emphasis>help channels2</emphasis> to read more. +</para> + +</sect1> + +<sect1 id="channels2"> +<title>Creating a channel</title> + +<para> +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. +</para> + +<para> +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. +</para> + +<para> +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. +</para> + +<para> +If you want to configure your own channels, you can use the <emphasis>channel set</emphasis> command. See <emphasis>help channels3</emphasis> for more information. +</para> + +</sect1> + +<sect1 id="channels3"> +<title>Configuring a control channel</title> + +<para> +The most important setting for a control channel is <emphasis>fill_by</emphasis>. It +tells BitlBee what information should be used to decide if someone should be shown +in the channel or not. After setting this setting to, for example, <emphasis>account</emphasis>, you +also have to set the <emphasis>account</emphasis> setting. Example: +</para> + +<ircexample> + <ircline nick="wilmer">chan set &wlm fill_by account</ircline> + <ircline nick="root">fill_by = `account'</ircline> + <ircline nick="wilmer">chan set &wlm account msn</ircline> + <ircline nick="root">account = `msn'</ircline> +</ircexample> + +<para> +Also, each channel has a <emphasis>show_users</emphasis> setting which lets you +choose, for example, if you want to see only online contacts in a channel, or +also/just offline contacts. Example: +</para> + +<ircexample> + <ircline nick="wilmer">chan set &offline show_users offline</ircline> + <ircline nick="root">show_users = `offline'</ircline> +</ircexample> + +<para> +See the help information for all these settings for more information. +</para> + +</sect1> + +<sect1 id="nick_format"> +<title>Nickname formatting</title> + +<para> +The <emphasis>nick_format</emphasis> setting can be set globally using +the <emphasis>set</emphasis> command, or per account using <emphasis>account +set</emphasis> (so that you can set a per-account suffix/prefix or have +nicknames generated from full names for certain accounts). +</para> + +<para> +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: +</para> + +<variablelist> + <varlistentry><term>%nick</term><listitem><para>Nickname suggested for this contact by the IM protocol, or just the handle if no nickname was suggested.</para></listitem></varlistentry> + <varlistentry><term>%handle</term><listitem><para>The handle/screenname of the contact.</para></listitem></varlistentry> + <varlistentry><term>%full_name</term><listitem><para>The full name of the contact.</para></listitem></varlistentry> + <varlistentry><term>%first_name</term><listitem><para>The first name of the contact (the full name up to the first space).</para></listitem></varlistentry> + <varlistentry><term>%group</term><listitem><para>The name of the group this contact is a member of</para></listitem></varlistentry> + <varlistentry><term>%account</term><listitem><para>Account tag of the contact</para></listitem></varlistentry> +</variablelist> + +<para> +Invalid characters (like spaces) will always be stripped. Depending on your +locale settings, characters with accents will be converted to ASCII. +</para> + +<para> +See <emphasis>help nick_format2</emphasis> for some more information. +</para> + +</sect1> + +<sect1 id="nick_format2"> +<title>Nickname formatting - modifiers</title> + +<para> +Two modifiers are currently available: You can include only the first few +characters of a variable by putting a number right after the %. For +example, <emphasis>[%3group]%-@nick</emphasis> will include only the first +three characters of the group name in the nick. +</para> + +<para> +Also, you can truncate variables from a certain character using +the <emphasis>-</emphasis> modifier. For example, you may want to leave out +everything after the @. <emphasis>%-@handle</emphasis> will expand to +everything in the handle up to the first @. +</para> + +</sect1> + +<sect1 id="whatsnew010206"> +<title>New stuff in BitlBee 1.2.6</title> + +<para> +Twitter support. See <emphasis>help account add twitter</emphasis>. +</para> +</sect1> + +<sect1 id="whatsnew010300"> +<title>New stuff in BitlBee 1.3dev</title> + +<para> +Support for multiple configurable control channels, each with a subset of +your contact list. See <emphasis>help channels</emphasis> for more +information. +</para> + +<para> +File transfer support for some protocols (more if you use libpurple). Just +/DCC SEND stuff. Incoming files also become DCC transfers. +</para> + +<para> +Only if you run your own BitlBee instance: You can build a BitlBee that uses +libpurple for connecting to IM networks instead of its own code, adding +support for some of the more obscure IM protocols and features. +</para> + +<para> +Many more things, briefly described in <emphasis>help news1.3</emphasis>. +</para> +</sect1> + +<sect1 id="whatsnew030000"> +<title>New stuff in BitlBee 3.0</title> + +<para> +BitlBee can be compiled with support for OTR message encryption (not available +on public servers since encryption should be end-to-end). +</para> + +<para> +The MSN module was heavily updated to support features added to MSN Messenger +over the recent years. You can now see/set status messages, send offline +messages, and many strange issues caused by Microsoft breaking old-protocol +compatibility should now be resolved. +</para> + +<para> +Twitter extended: IRC-style replies ("BitlBee:") now get converted to proper +Twitter replies ("@BitlBee") and get a reference to the original message +(see <emphasis>help set auto_reply_timeout</emphasis>). Retweets and some +other stuff is also supported now (see <emphasis>help set commands</emphasis>). +</para> +</sect1> + +<sect1 id="news1.3"> +<title>New stuff in BitlBee 1.3dev (details)</title> + +<para> +Most of the core of BitlBee was rewritten since the last release. This entry +should sum up the majority of the changes. +</para> + +<para> +First of all, you can now have as many control channels as you want. Or you +can have none, it's finally possible to leave &bitlbee and still talk to +all your contacts. Or you can have a &work with all your work-related +contacts, or a &msn with all your MSN Messenger contacts. See <emphasis>help +channels</emphasis> for more information about this. +</para> + +<para> +Also, you can change how nicknames are generated for your contacts. Like +automatically adding a [fb] tag to the nicks of all your Facebook contacts. +See <emphasis>help nick_format</emphasis>. +</para> + +<para> +When you're already connected to a BitlBee server and you connect from +elsewhere, you can take over the old session. +</para> + +<para> +Instead of account numbers, accounts now also get tags. These are +automatically generated but can be changed (<emphasis>help set +tag</emphasis>). You can now use them instead of accounts numbers. +(Example: <emphasis>acc gtalk on</emphasis>) +</para> + +<para> +Last of all: You can finally change your nickname and +shorten root commands (try <emphasis>acc li</emphasis> instead +of <emphasis>account list</emphasis>). +</para> + +</sect1> + +</chapter> diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml new file mode 100644 index 00000000..80c16ffb --- /dev/null +++ b/doc/user-guide/quickstart.xml @@ -0,0 +1,167 @@ +<chapter id="quickstart"> +<title>Quickstart</title> + +<para> +Welcome to BitlBee, your IRC gateway to ICQ, MSN, AOL, Jabber, Yahoo! and Twitter. +</para> + +<para> +The center of BitlBee is the control channel, <emphasis>&bitlbee</emphasis>. Two users will always be there, <emphasis>you</emphasis> (where "you" is the nickname you are using) and the system user, <emphasis>root</emphasis>. +</para> + +<para> +You need register so that all your IM settings (passwords, contacts, etc) can be saved on the BitlBee server. It's important that you pick a good password so no one else can access your account. Register with this password using the <emphasis>register</emphasis> command: <emphasis>register <password></emphasis> (without the brackets!). +</para> + +<para> +Be sure to remember your password. The next time you connect to the BitlBee server you will need to <emphasis>identify <password></emphasis> so that you will be recognised and logged in to all the IM services automatically. +</para> + +<para> +When finished, type <emphasis>help quickstart2</emphasis> to continue. +</para> + +<sect1 id="quickstart2"> +<title>Add and Connect To your IM Account(s)</title> +<!-- quickstart2 --> +<para> +<emphasis>Step Two: Add and Connect To your IM Account(s).</emphasis> +</para> + +<para> +To add an account to the account list you will need to use the <emphasis>account add</emphasis> command: <emphasis>account add <protocol> <username> <password> [<server>]</emphasis>. +</para> + +<para> +For instance, suppose you have a Jabber account at jabber.org with handle <emphasis>bitlbee@jabber.org</emphasis> with password <emphasis>QuickStart</emphasis>, you would: +</para> + +<ircexample> + <ircline nick="you">account add jabber bitlbee@jabber.org QuickStart</ircline> + <ircline nick="root">Account successfully added</ircline> +</ircexample> + +<para> +Other available IM protocols are msn, oscar, yahoo and twitter. OSCAR is the protocol used by ICQ and AOL. For more information about the <emphasis>account add</emphasis> command, see <emphasis>help account add</emphasis>. +</para> + +<para> +When you are finished adding your account(s) use the <emphasis>account on</emphasis> command to enable all your accounts, type <emphasis>help quickstart3</emphasis> to continue. +</para> + +</sect1> + +<sect1 id="quickstart3"> +<title>Managing Contact Lists: Rename</title> + +<!--quickstart3--> +<para> +<emphasis>Step Three: Managing Contact Lists: Rename</emphasis> +</para> + +<para> +Now BitlBee logs in and downloads the contact list from the IM server. In a few seconds, all your on-line buddies should show up in the control channel. +</para> + +<para> +BitlBee will convert names into IRC-friendly form (for instance: tux@example.com will be given the nickname tux). If you have more than one person who would have the same name by this logic (for instance: tux@example.com and tux@bitlbee.org) the second one to log on will be tux_. The same is true if you have a tux log on to AOL and a tux log on from Yahoo. +</para> + +<para> +It would be easy to get these two mixed up, so BitlBee has a <emphasis>rename</emphasis> command to change the nickname into something more suitable: <emphasis>rename <oldnick> <newnick></emphasis> +</para> + +<ircexample> + <ircline nick="you">rename tux_ bitlbeetux</ircline> + <ircaction nick="tux_">is now known as <emphasis>bitlbeetux</emphasis></ircaction> + <ircline nick="root">Nick successfully changed</ircline> +</ircexample> + +<para> +When finished, type <emphasis>help quickstart4</emphasis> to continue. +</para> + +</sect1> + +<sect1 id="quickstart4"> +<title>Step Four: Managing Contact Lists: Add and Remove.</title> + +<para> +<emphasis>Step Four: Managing Contact Lists: Add and Remove.</emphasis> +</para> + +<para> +Now you might want to add some contacts, to do this we will use the <emphasis>add</emphasis> command. It needs two arguments: a connection ID (which can be a number (try <emphasis>account list</emphasis>), protocol name or (part of) the screenname) and the user's handle. It is used in the following way: <emphasis>add <connection> <handle></emphasis> +</para> + +<ircexample> + <ircline nick="you">add 0 r2d2@example.com</ircline> + <ircaction nick="r2d2"> has joined <emphasis>&bitlbee</emphasis></ircaction> +</ircexample> + +<para> +In this case r2d2 is online, since he/she joins the channel immediately. If the user is not online you will not see them join until they log on. +</para> + +<para> +Lets say you accidentally added r2d3@example.com rather than r2d2@example.com, or maybe you just want to remove a user from your list because you never talk to them. To remove a name you will want to use the <emphasis>remove</emphasis> command: <emphasis>remove <nick></emphasis> +</para> + +<para> +When finished, type <emphasis>help quickstart5</emphasis> to continue. +</para> + +</sect1> + +<sect1 id="quickstart5"> +<title>Chatting</title> + +<para> +<emphasis>Step Five: Chatting.</emphasis> +</para> + +<para> +First of all, a person must be on your contact list for you to chat with them (unless it's a group chat, <emphasis>help groupchats</emphasis> for more). If someone not on your contact list sends you a message, simply add them to the proper account with the <emphasis>add</emphasis> command. Once they are on your list and online, you can chat with them in &bitlbee: +</para> + +<ircexample> + <ircline nick="you">tux: hey, how's the weather down there?</ircline> + <ircline nick="tux">you: a bit chilly!</ircline> +</ircexample> + +<para> +Note that, although all contacts are in the &bitlbee channel, only tux will actually receive this message. The &bitlbee channel shouldn't be confused with a real IRC channel. +</para> + +<para> +If you prefer chatting in a separate window, use the <emphasis>/msg</emphasis> or <emphasis>/query</emphasis> command, just like on real IRC. BitlBee will remember how you talk to someone and show his/her responses the same way. If you want to change the default behaviour (for people you haven't talked to yet), see <emphasis>help set private</emphasis>. +</para> + +<para> +You know the basics. If you want to get to know more about BitlBee, please type <emphasis>help quickstart6</emphasis>. +</para> + +</sect1> + +<sect1 id="quickstart6"> +<title>Further Resources</title> + +<para> +<emphasis>So you want more than just chatting? Or maybe you're just looking for a feature?</emphasis> +</para> + +<para> +You can type <emphasis>help set</emphasis> to learn more about the possible BitlBee user settings. Among these user settings you will find options for common issues, such as changing the charset, HTML stripping and automatic connecting (simply type <emphasis>set</emphasis> to see current user settings). +</para> + +<para> +For more subjects (like groupchats and away states), please type <emphasis>help index</emphasis>. +</para> + +<para> +If you're still looking for something, please visit us in #bitlbee on the OFTC network (you can connect via irc.bitlbee.org), or mail us your problem/suggestion. Good luck and enjoy the Bee! +</para> + +</sect1> + +</chapter> diff --git a/doc/user-guide/user-guide.xml b/doc/user-guide/user-guide.xml new file mode 100644 index 00000000..5e1c8fe0 --- /dev/null +++ b/doc/user-guide/user-guide.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + +<book id="BitlBee-User-Guide" xmlns:xi="http://www.w3.org/2003/XInclude"> +<bookinfo> + <title>BitlBee User Guide</title> + <author> + <firstname>Jelmer</firstname><surname>Vernooij</surname> + <address><email>jelmer@samba.org</email></address> + </author> + + <author> + <firstname>Wilmer</firstname><surname>van der Gaast</surname> + <address><email>wilmer@gaast.net</email></address> + </author> + + <author> + <firstname>Sjoerd</firstname><surname>Hemminga</surname> + <address><email>sjoerd@huiswerkservice.nl</email></address> + </author> + + <legalnotice id="legalnotice"> + </legalnotice> + + <releaseinfo> + This is the BitlBee User Guide. For now, the on-line help is + the most up-to-date documentation. Although this document shares + some parts with the on-line help system, other parts might be + very outdated. + </releaseinfo> + + </bookinfo> + + <xi:include href="Installation.xml"/> + <xi:include href="Usage.xml"/> + <xi:include href="Support.xml"/> + <xi:include href="quickstart.xml"/> + <xi:include href="commands.xml"/> + <xi:include href="misc.xml"/> + +</book> |