From bb9bc9051629c3319c56785c2f4ae0e605d76329 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Frings-F=C3=BCrst?= Date: Sat, 21 Nov 2015 14:51:17 +0100 Subject: Initial import of bitz-server version 0.1.6-1 --- doc/bitz-server.man | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 doc/bitz-server.man (limited to 'doc/bitz-server.man') 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=] +.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= +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 +.SH AUTHOR +Uditha Atukorala +.SH "SEE ALSO" +.BR bitz-server.conf (5) + -- cgit v1.2.3