summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLuke Bratch <luke@bratch.co.uk>2019-07-10 14:14:25 +0100
committerLuke Bratch <luke@bratch.co.uk>2019-07-10 14:14:25 +0100
commitf5778572b16fd7c5fa7f61166e05d3db1831069a (patch)
tree0731089fa5e77be86661c897a3d85d2b08b0fb89 /README
parent4505e67c3c69f922a10c275b870dbe2ea362f335 (diff)
Various README file improvements.
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 11 insertions, 11 deletions
diff --git a/README b/README
index 135cbae..97bfb75 100644
--- a/README
+++ b/README
@@ -8,23 +8,23 @@ To compile run "make".
To run from the current directory once compiled run "./blabouncer".
-Running with command line arguments takes the form:
+Run with command line arguments like so:
./blabouncer [-f] [-c /path/to/blabouncer.conf]
-f sets foreground mode (without this, blabouncer will detach and run in the background as a daemon)
--c sets a path to a configuration file (this is optional)
+-c sets a path to a configuration file
-Arguments are all optional, but they must be specified in the order shown above.
+All arguments are optional, but they must be specified in the order shown above if given.
== Configuration ==
-An example configuration file is provided named "blabouncer.conf".
+An example configuration file is provided named "blabouncer.conf.example".
-If you don't specify one using "-c /path/to/configuration/file" then the example configuration one will
-be created for you in $HOME/.blabouncer/ when starting.
+If you don't specify one using "-c /path/to/configuration/file" then the example one will be created
+for you at $HOME/.blabouncer/blabouncer.conf when starting for the first time.
-Certain configuration options can be changed at runtime, either at any time, or by issuing a BLABOUNCER
-REHASH command or by sending SIGHUP to blabouncer.
+Certain configuration options can be changed at runtime by changing them in the configuration file, then
+issuing a BLABOUNCER REHASH command, or by sending SIGHUP to the blabouncer process.
These options can be changed by issuing a BLABOUNCER REHASH command or by sending SIGHUP to blabouncer:
- nick
@@ -39,7 +39,7 @@ These options can be changed by issuing a BLABOUNCER REHASH command or by sendin
== Commands ==
-Once connected to blabouncer with a client, you can use the following commands:
+Once connected to blabouncer with an IRC client, you can use the following special blabouncer commands:
"BLABOUNCER REPLAY [[[[days:]hours:]minutes:]seconds]" (To replay a given length of time of replay log.)
"BLABOUNCER QUIT [quit message]" (To quit blabouncer, optionally sending [quit message] to the server.)
@@ -55,10 +55,10 @@ You can request that history is replayed at any time by using the command BLABOU
[[[[days:]hours:]minutes:]seconds], assuming replaylogging is enabled in blabouncer.conf.
In addition, you can have history automatically replayed upon a client connecting. There are multiple
-automatic replay methods available by setting replaymode in blabouncer.conf:
+automatic replay methods available by setting "replaymode" in blabouncer.conf:
- "none"
- Don't auto replay.
+ Don't auto replay logs at all.
- "time"
Always send the last "replayseconds" worth of logs.