summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLuke Bratch <luke@bratch.co.uk>2019-05-30 23:33:21 +0100
committerLuke Bratch <luke@bratch.co.uk>2019-05-30 23:33:21 +0100
commitd5ab728e85409b5074d4d61aaf5ba60862528e60 (patch)
tree4e2c9d687fb417668054a826bd30d1892bc3ea25 /README
parentfd33289346881b96841a598a1f8980212b0bab62 (diff)
Implement daemon (background) mode by default with optional foreground mode that can be specified on the command line.
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
index 9bee79b..c399a62 100644
--- a/README
+++ b/README
@@ -8,6 +8,14 @@ To compile run "make".
To run from the current directory once compiled run "./blabouncer".
+Running with command line arguments takes the form:
+./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)
+
+Arguments are all optional, but they must be specified in the order shown above.
+
== Configuration ==
An example configuration file is provided named "blabouncer.conf".