########################## ReadMe 1.3 ## About BorgBNC ######### ########################## BorgBNC is an IRC gateway program for UNIX-based systems. The name "BorgBNC" is based on the original IRC gateway program called "BNC" (a short for "bouncer"), although it was written from a scratch by a Polish dude that calls himself Borg88 and hangs around IRCnet. Borg88 doesn't like the name "BorgBNC" for some reason. He calls it just "BNC", though there is already a program named that. Go figure. So, don't expect to see "BorgBNC" in places other than this ReadMe. Also he INSISTS that he wrote it from a scratch and that it is not based on the original BNC, so even though I wrote it already I'm writing it again. Happy, Borg? ;/ Anyhow... BorgBNC allows you to keep the IRC connection online while the client is detached from it, like "psyBNC" - but BorgBNC is free of bugs and useless features unlike the big clumsy psyBNC. BorgBNC is a simple and small program which is designed to work smoothly. BorgBNC does not use IRC automation at all except for responding to CTCP VERSION requests. This means it won't rejoin a channel after being kicked, it won't "auto-op" anyone and it won't even reconnect to the IRC server if disconnected. I am currently trying to convince Borg88 to add a little logging system and to make BorgBNC use a configuration file. ########################## ## Package Contents ##### ########################## Makefile - The information file used for compiling the program. MAKEFILE.VC5 - I have no idea what the hell this is. readme.txt - The file you are reading right now. *.c/*.h files - The program's source code. ########################## ## Installation ########## ########################## 1) Optionally edit config.h to change precompile options. 2) Compile the package using "make". The compilation process will create some files with a ".o" prefix. You will not need these files, as they are assembled into an executable binary file called "bnc". this is the only file BorgBNC requires in order to run. 4) Copy the binary file to wherever you like and remove the source directory "bnc" if you want to, or just "rm *.o" to remove all unnecessary compilation files and keep the source code. ########################## ## Initialization ######## ########################## 1) Run the "bnc" file you compiled using the syntax: bnc [hostname] is the port which BorgBNC will use to listen for client connections. You must specify this parameter. [hostname] is the IP address or virtual hostname (Vhost) which orgBNC will use to listen for client connections. If you don't specify this optional parameter, BorgBNC will listen for client connections on all virtual hostnames available on the system. Note: Listening on a specific hostname may sometimes not work because Borg88 is too lazy to fix it. We noticed problems with it on Linux systems, where it listens on all hostnames even if a specific one was specified. 2) Connect to BorgBNC using an IRC client program: /server and are the virtual hostname and port that you specified when running BorgBNC, respectively. When first connecting to BorgBNC (after running it), you will be asked to enter a password. Choose your password and enter it using: /bpass would be the password you chose. Now you are logged in. Note that next time that you connect to BorgBNC, you can just use: /server The parameters should be clear to you by now. ###################### ## Usage ############# ###################### Okay, let's cover BorgBNC's commands now. You can issue these commands from your IRC client when you are connected to BorgBNC. If you get error messages from your IRC client when using these commands, use: /quote ### Configuration Commands ### The values you set with these commands won't change until you reset them or until BorgBNC restarts. # BPASS # Usage: /bpass Used to set BorgBNC's password when connecting for the first time after it has been run, or to change the password later. Example: /bpass my_password # BVHOST # Usage: /bvhost Used to set the virtual hostname ("Vhost/VH") which BorgBNC will use to to connect to the IRC server. If you enter "*" as the hostname, BorgBNC will use the system's default hostname. Examples: /bvhost i.am.lame.net /bvhost * # BVHOST6 # Usage: /bvhost6 It's same as BVHOST but uses IPv6. ### IRC Connection Commands ### # BSERVER # Usage: /bserver [port] [password] Used to connect to the actual IRC server. If you don't specify a port, BorgBNC will use port 6667 to connect. The "password" parameter is the password used to log into the IRC server and you will most probably not need it. Examples: /bserver irc.ircnet.net /bserver irc.stealth.net 5558 # BSERVER6 # Usage: /bserver [port] [password] It's same as BSERVER but uses IPv6. # BQUIT # Usage: /bquit : or: /quote BQUIT : Closes the connection to the IRC server with a specified quit message. Note that if you don't use a ":" (colon) before the quit message, only the first word will be displayed. And we don't want that, do we? # BDISCONNECT # Usage: /bdisconnect Closes the connection to the IRC server immediately without waiting for the server's acknowledgement like the BQUIT command. ### Statistics and Information Commands ### # BVERSION # Usage: /bversion Returns BorgBNC's version. # BUPTIME # Usage: /buptime Returns BorgBNC's uptime (how much time it has been up and running). # BSTAT # Usage: /bstat Returns some weird statistics only Borg88 understands. ;-) BorgBNC ReadMe by Rotem "sock" E. (sock@galanet.net)