README typo fixes.

This commit is contained in:
Arnaud Cornet 2008-01-07 22:53:40 +01:00
parent 74ef2e7460
commit f8e377c2b6
1 changed files with 52 additions and 37 deletions

49
README
View File

@ -1,14 +1,12 @@
This is the BIP IRC Proxy README.
This is the BIP IRC Proxy readme, you'll learn how to quickly use bip.
Bip can be used in two different way:
Bip can be used in two different ways:
- Old school bnc user style: easy and straightforward.
- Unix service style with and init.d scripts and the logs in /var/log
This small README file explains the usage "Old school" with which :
- you do not need the root privileges.
- gives easy access to the logs of the users of this bip to the one owning the
shell.
- gives easy access to the logs to the owner of the shell.
Table of contents :
@ -27,6 +25,16 @@ I. INSTALLATION
your personnal or shared server) either compiling the package or using your
distro's package. Then create a configuration file.
Choose your distribution package if available. If not, build bip the
old-fashioned way. You will need make, gcc, lex and yacc to build bip.
Just issue:
# ./configure --enable-oidentd && make
If openssl and its developement files are installed, bip should build with
SSL support. After a successful build the bip binary can be found in
./src/bip.
II. CONFIGURATION
@ -51,7 +59,7 @@ II. CONFIGURATION
If not, you'll find sample configuration file in the source package's
`samples' subdirectory.
Put the uncompressed configuration file in your ~/.bip directory (it's
Put the uncompressed configuration file in your ~/.bip directory (its
path should be ~/.bip/bip.conf), and edit it, most importantly the "user"
section that contains information about you and the servers you will want
to connect to. The "name" field in the "user" section is your login to
@ -82,10 +90,10 @@ II. CONFIGURATION
This script can be found either in the source package's `scripts'
directory or shipped with your distribution's package.
Using the script is very simple, and it'll generate a configuration file
but won't overwrite any existing configuration.
Using the script is very simple, and it will generate a configuration
file but won't overwrite any existing configuration.
It'll ask you the path to the bipmkpw binary, to automatically hash the
It will ask you the path to the bipmkpw binary, to automatically hash the
passwords you'll provide. Please make sure to enter the correct path to
the binary or you might observe unexpected behaviour.
@ -98,6 +106,11 @@ III. RUNNING BIP
Once all this is configured, start bip as your regular user:
# ./src/bip
If you have installed bip in your path (or if you are using you
distribution's package), simply use:
# bip
Once bip starts, it connects to the different servers your defined in
@ -106,20 +119,22 @@ III. RUNNING BIP
IV. USING BIP
Then you want to use your regular irc client and connect to bip.
Point your client to the machine bip is running and set the proper port number
Then you want to use your regular irc client and connect to bip. Point
your client to the machine bip is running and set the proper port number
(defined in your bip.conf). You should then configure the client to use a
specific irc server password constructed this way:
user:password:network
user:password:connection
The user is the name field of the "user" section, the password is the password
(*not* the hash) corresponding to the "password" field of the same user section
(which is the hash generated with bipmkpw) and the network is the "name" field
of the "connection" subsection. This is how bip authenticates you and puts your
client to the correct network.
The user is the name field of the "user" section, the password is the
password (*not* the hash) corresponding to the "password" field of the same
user section (which is the hash generated with bipmkpw) and the connection
is the "name" field of the "connection" subsection. This is how bip
authenticates you and puts your client to the correct network.
Using the default (or sample file) configuration, logs are in ~/.bip/logs/
Happy ircing!
-- Arnaud Cornet <nohar@t1r.net> and Loïc Gomez <opensource@kyoshiro.org>