aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarius Halden <marius.h@lden.org>2018-04-19 10:23:08 +0200
committerMarius Halden <marius.h@lden.org>2018-04-19 10:23:08 +0200
commitdb02ac8971379f9fee2f3a618bb08b8076d1a83d (patch)
tree0e7d46bad6162509300aa73ae6d77e571a5b26d0 /doc
parent6dc54671e368d03ed447d0fbd2d662af6c36b7fd (diff)
parent246b98bbdf221448fd7a638fea04373ed1612de5 (diff)
Merge branch 'master' into patched-master
Diffstat (limited to 'doc')
-rw-r--r--doc/bitlbee.846
-rw-r--r--doc/user-guide/Installation.xml5
-rw-r--r--doc/user-guide/commands.xml50
-rw-r--r--doc/user-guide/misc.xml51
-rw-r--r--doc/user-guide/quickstart.xml4
5 files changed, 39 insertions, 117 deletions
diff --git a/doc/bitlbee.8 b/doc/bitlbee.8
index 2170270d..f3f5159d 100644
--- a/doc/bitlbee.8
+++ b/doc/bitlbee.8
@@ -40,34 +40,48 @@ networks and acts as a gateway. Users can connect to the server
with any normal IRC client and see their 'buddy list' in
&bitlbee.
-\fBbitlbee\fP should be called by
-.BR inetd (8),
-or you can run it as a stand-alone daemon.
+\fBbitlbee\fP is normally started as a system service (with init
+scripts, systemd units or equivalent). It can also be run as an
+.BR inetd (8)
+/
+.BR xinetd (8)
+service or a stand-alone daemon with the options below.
+
+To use it, connect to it with an IRC client with a command such as
+"/connect localhost"
+
.PP
-.SH OPTIONS
+.SH RUN MODES
.PP
.IP "-I"
Run in
.BR inetd (8)
-mode. This is the default setting, you usually don't have to specify this
-option.
+mode. This is the default setting for historical reasons, but not the
+recommended one (See ForkDaemon below).
.IP "-D"
-Run in daemon mode. In this mode, BitlBee forks to the background and
+Run in \fBDaemon\fP mode. In this mode, BitlBee forks to the background and
waits for new connections. All clients will be served from one process.
+This mode is also useful for debugging.
.IP "-F"
-Run in ForkDaemon mode. This is similar to ordinary daemon mode, but every
+Run in \fBForkDaemon\fP mode. This is similar to ordinary daemon mode, but every
client gets its own process. Easier to set up than inetd mode, and without
-the possible stability issues.
+the possible stability issues. This is the recommended runmode for most
+use cases.
+
+.PP
+.SH OPTIONS
+.PP
+
.IP "-i \fIaddress\fP"
-Only useful when running in daemon mode, to specify the network interface
+When running in daemon mode, specifies the network interface
(identified by IP address) to which the daemon should attach. Use this if
you don't want BitlBee to listen on every interface (which is the default
behaviour).
.IP "-p \fIport number\fP"
-Only useful when running in daemon mode, to specify the port number on
+When running in daemon mode, specifies the port number on
which BitlBee should listen for connections. 6667 is the default value.
.IP "-n"
-Only useful when running in daemon mode. This option prevents BitlBee from
+Wehn running in daemon mode, this option prevents BitlBee from
forking into the background.
.IP "-v"
Be more verbose. This only works together with the \fB-n\fP flag.
@@ -81,17 +95,15 @@ have write permissions in the default location), use this option.
Show help information.
.SH COMMANDS
To get a complete list of commands, please use the \fBhelp commands\fP
-command in the &bitlbee channel.
+command in the &bitlbee channel after connecting to bitlbee.
.SH "SEE ALSO"
-.BR ircd (8),
.BR inetd (8),
-.BR inetd.conf (5),
-.BR gaim (1).
+.BR inetd.conf (5)
.BR http://www.bitlbee.org/
For more information on using BitlBee, once connected, you should use
-the on-line help system.
+the \fBhelp\fP command in the &bitlbee channel.
.SH BUGS
Of course there are bugs. If you find some, please report them at
\fBhttp://bugs.bitlbee.org/\fP.
diff --git a/doc/user-guide/Installation.xml b/doc/user-guide/Installation.xml
index 9d555d46..879649f6 100644
--- a/doc/user-guide/Installation.xml
+++ b/doc/user-guide/Installation.xml
@@ -35,7 +35,7 @@ specify them all separately, just specifying prefix (or keeping the default
<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, twitter - By default, support for all
+<listitem><para>jabber, oscar, twitter - 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>
@@ -49,8 +49,7 @@ will be stripped out to make it as small as possible. If you don't want this
<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,
+<listitem><para>ssl - 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
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml
index f20e3298..35a1300c 100644
--- a/doc/user-guide/commands.xml
+++ b/doc/user-guide/commands.xml
@@ -42,16 +42,6 @@
</description>
</bitlbee-command>
- <bitlbee-command name="msn">
- <syntax>account add msn &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
-
- <description>
- <para>
- For MSN connections there are no special arguments.
- </para>
- </description>
- </bitlbee-command>
-
<bitlbee-command name="oscar">
<syntax>account add oscar &lt;handle&gt; [&lt;password&gt;]</syntax>
@@ -923,13 +913,10 @@
<bitlbee-setting name="display_name" type="string" scope="account">
<description>
<para>
- Currently only available for MSN connections, and for jabber groupchats.
- </para>
- <para>
- For MSN: 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.
+ Currently only available for jabber groupchats.
</para>
<para>
- For jabber groupchats: this sets the default value of 'nick' for newly created groupchats. There is no way to set an account-wide nick like MSN.
+ For jabber groupchats: this sets the default value of 'nick' for newly created groupchats. There is no way to set an account-wide nick.
</para>
</description>
</bitlbee-setting>
@@ -1027,17 +1014,6 @@
</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>
@@ -1061,11 +1037,11 @@
</bitlbee-setting>
<bitlbee-setting name="message_length" type="integer" scope="account">
- <default>140</default>
+ <default>280</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.
+ Since Twitter rejects messages longer than 280 characters, BitlBee can count message length and emit a warning instead of waiting for Twitter to reject it.
</para>
<para>
@@ -1619,24 +1595,6 @@
</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>
diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml
index 457d5d35..1201467f 100644
--- a/doc/user-guide/misc.xml
+++ b/doc/user-guide/misc.xml
@@ -1,53 +1,6 @@
<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>(&amp;)</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>
@@ -152,7 +105,7 @@ Control channels are where you see your contacts. By default, you will have one
</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".
+For example, you can have one channel with all contacts from your jabber account in it. Or all contacts from the group called "Work".
</para>
<para>
@@ -169,7 +122,7 @@ When you create a new channel, BitlBee will try to guess from its name which con
</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 &amp;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 &amp;facebook.
+Any valid account ID (so a number, protocol name or part of screenname, as long as it's unique) can also be used as a channel name. So if you just join &amp;jabber, it will contain all your jabber contacts. And if you have a Facebook account set up, you can see its contacts by just joining &amp;facebook.
</para>
<para>
diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml
index 2eda6be1..6de9b953 100644
--- a/doc/user-guide/quickstart.xml
+++ b/doc/user-guide/quickstart.xml
@@ -42,7 +42,7 @@ For instance, suppose you have a Jabber account at jabber.org with handle <empha
</ircexample>
<para>
-Other built-in IM protocols include msn, oscar and twitter. OSCAR is the protocol used by ICQ and AOL. Some protocols may be available as plugins that you can install, such as facebook, steam, discord and omegle. And you can get even more protocols by using the libpurple variant of BitlBee.
+Other built-in IM protocols include oscar and twitter. OSCAR is the protocol used by ICQ and AOL. Some protocols may be available as plugins that you can install, such as facebook, steam, discord and omegle. And you can get even more protocols by using the libpurple variant of BitlBee.
</para>
<para>
@@ -123,7 +123,7 @@ You know the basics. If you want to know about some of the neat features BitlBee
</para>
<para>
-With multiple channel support you can have contacts for specific protocols in their own channels, for instance, if you <emphasis>/join &amp;msn</emphasis> you will join a channel that only contains your MSN contacts.
+With multiple channel support you can have contacts for specific protocols in their own channels, for instance, if you <emphasis>/join &amp;jabber</emphasis> you will join a channel that only contains your jabber contacts.
</para>
<para>