summaryrefslogtreecommitdiff
path: root/doc/bitz-server.man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/bitz-server.man')
-rw-r--r--doc/bitz-server.man47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/bitz-server.man b/doc/bitz-server.man
new file mode 100644
index 0000000..d59ffc1
--- /dev/null
+++ b/doc/bitz-server.man
@@ -0,0 +1,47 @@
+.TH bitz-server 1 "March 2013" Linux "User Manuals"
+.SH NAME
+bitz-server \- An ICAP server
+.SH SYNOPSIS
+.B bitz-server
+[\-\-version] [\-\-help] [\-\-usage] [\-\-debug] [\-\-config=<config file>]
+.SH DESCRIPTION
+.B bitz-server
+is an ICAP server implementation in C++. Starting from scratch,
+the server is developed with a modular architecture in mind.
+The server core (written in C++) will handle the client requests,
+manage workers (child processes) etc. and will provide basic handlers
+to serve ICAP requests but won't do any actual content adaptation.
+.P
+To extend this core functionality and do some actual content adaptation
+a pluggable modules architecture is used. These modules will provide
+features like content filtering, anti-virus scanning etc. and to make it
+easier to write (and faster to implement) such modules a python interface
+module is included.
+.SH OPTIONS
+.TP
+.B \-\-version, \-v
+Prints version information
+.TP
+.B \-\-help, \-\-usage, \-h
+Prints the synopsis
+.TP
+.B \-\-debug
+Run the server in debug mode. This will force the server to run in the
+terminal rather than in the background.
+.TP
+.B \-\-config=<config file>
+Set the alternative config file to use instead of the compiled default.
+.SH FILES
+.I /etc/bitz/bitz-server.conf
+.RS
+Default configuration file. See
+.BR bitz-server.conf (5)
+for further details.
+.RE
+.SH BUGS
+Please report all bugs and feature requests at <http://bugs.geniusse.com/>
+.SH AUTHOR
+Uditha Atukorala <udi at geniusse dot com>
+.SH "SEE ALSO"
+.BR bitz-server.conf (5)
+