Changeset 2cdd8ce for doc

Timestamp:

2005-11-19T15:17:03Z (18 years ago)

Author:

Jelmer Vernooij <jelmer@…>

Branches:

master

Children:

9c8ae50, b20b32f

Parents:

c998255 (diff), 94281ef (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge Wilmer

Location:

doc

Files:

• CHANGES (modified) (1 diff)
• FAQ (modified) (1 diff)
• README (modified) (4 diffs)
• bitlbee.xinetd (modified) (1 diff)
• user-guide/commands.xml (modified) (2 diffs)
• user-guide/help.txt (deleted)
• user-guide/user-guide.html (deleted)
• user-guide/user-guide.txt (deleted)

doc/CHANGES

@@ -2 +2 @@
 - Removed some crashy debugging code.
 - QUIT command now works before logging in. (Mainly an RFC-compliancy fix.)
+- Hopefully slightly clearer handling of buddy add requests.
+- set buddy_sendbuffer_delay now also supports milisecond precision.
+- Renamed #bitlbee to &bitlbee to avoid confusion with the channel on OFTC.
+- Reviewed the xinetd file and installation instructions.
+- HTML stripping is configurable again.
+- Quit messages (at least on crashes) should appear again.
 
 Finished ...

doc/FAQ

@@ -38 +38 @@
    artistic creativity.
 
-Q: Why is there no mailing list/CVS/<insert your favourite development tool
-   here>?
-A: Short answer: we don't need it.
-   
-   Longer answer: and we're not completely convinced of their merits.
-   
-   Long answer: we currently use some shell scripts which make sure all
-   developers' copies are in sync with Wilmer's master copy. These shell
-   scripts also produce development "releases" and packages, as well as
-   stick them on a http-server. Patches are sent to Wilmer who decides
-   whether or not a patch should be applied and if it may need some
-   additional changes. This has the consistency advantage of a one-person
-   project while having the capacity of more people available. The system
-   works and we are kind of attached to it.
-   
 Q: When is $random_feature going to be implemented?
 A: Please do consult doc/TODO (preferably in a development snapshot, which

doc/README

@@ -9 +9 @@
 make install will move all the files to the right places.
 
+--- inetd installation
+
 After installation you have to set up inetd (you got that one running,
 right? If not, just take a look at utils/bitlbeed.c) to start BitlBee. You
@@ -18 +20 @@
 of just 'nobody') might be a good idea.
 
+*BSD/Darwin/OSX NOTE: Most *BSD inetds are more scrict than the one that
+comes with Linux systems. Possibly all non-Linux inetds are like this. They
+don't allow you to specify a port number in the inetd.conf entry, instead
+you have to put a service name there (one that is also mentioned in
+/etc/services). So if there's no line in /services for 6667/tcp (or whatever
+you choose), add it and use that name in the inetd.conf entry.
+
+-- xinetd installation
+
+Most machines use xinetd instead of inetd these days. If your machine runs
+xinetd, you can copy the bitlbee.xinetd file from the doc/ directory to your
+xinetd.d/ directory. Most likely you'll have to change a thing or two before
+it'll work.
+
+After configuring your (x)inetd, send the daemon a SIGHUP and things should
+work. If not, see your syslogs, since both daemons will complain there when
+something's wrong.
+
 Also, don't forget to create the configuration directory (/var/lib/bitlbee/
 by default) and chown it to the UID BitlBee is running as. Make sure this
 directory is read-/writable by this user only.
-
-(For xinetd users a xinetd configuration file is included: doc/bitlbee.xinetd)
 
 
@@ -48 +66 @@
 ==================
 
-FreeBSD NOTE: It looks like FreeBSD does allow port numbers instead of service
-names in inetd.conf, as long as the service for this port exists in
-/etc/services. Linux isn't this strict. If you got problems in FreeBSD, just
-add a line for your chosen port number to /etc/services.
-
-Darwin/Mac OS X is even more strict; you should add a bitlbee service to
-/etc/services and use that name in inetd.conf. Not really a problem, since
-that's the cleanest way of doing this on any operating system anyway.
-
 Cygwin NOTE: You'll need a glib installation to run BitlBee. However, Cygwin
 doesn't provide a glib package. You can download a binary tar.gz from:
@@ -66 +75 @@
 Please do report them, we might be able to fix them if they're not too
 mysterious.
+
+Also, the configure script is known to not work very well with non-Bash
+shells, so if you experience problems, make sure you use bash to run the
+script. Same for the Makefile, it only works well with GNU make. (gmake on
+most BSD systems)
+
+If someone can tell us how to write Makefiles that work with both/all
+versions of make, we'd love to hear it, but it seems this just isn't
+possible.
 
 

doc/bitlbee.xinetd

@@ -2 +2 @@
 ## user, port and/or binary location might be wrong.
 
-service 6667
+## This file assumes you have ircd somewhere in your /etc/services, if things
+## don't work, check that file first.
+service ircd
 {
         socket_type     = stream
         protocol        = tcp
         wait            = no
+        
+        ## You most likely want to change these two
         user            = nobody
         server          = /usr/local/sbin/bitlbee
-        port            = 6667
+        
+        ## xinetd is fucking retarded, what's the use of this port flag if
+        ## it HAS to be the same as in /etc/services ?
+        # port          = 6667
 }

doc/user-guide/commands.xml

@@ -303 +303 @@
         </bitlbee-setting>
 
-        <bitlbee-setting name="html" type="string">
-                <default>nostrip</default>
-                <possible-values>strip, nostrip</possible-values>
-
-                <description>
-                        <para>
-                                Determines what BitlBee should do with HTML in messages. If set to nostrip, HTML in messages will not be touched. If set to strip, all HTML will be stripped from messages. Unfortunately this sometimes strips too much.
+        <bitlbee-setting name="strip_html" type="boolean">
+                <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>
@@ -462 +464 @@
 
         <bitlbee-setting name="buddy_sendbuffer_delay" type="integer">
-                <description>
-
-                        <para>
-                                Tell BitlBee after how many seconds a buffered message should be sent.
+                <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>