summaryrefslogtreecommitdiff
path: root/doc/bitz-server.man
blob: 543cd6900c63c133c3f72a5daddd0eaa8a47fefb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
.TH bitz-server 1 "November 2015" 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 <https://github.com/uditha-atukorala/bitz-server/issues>
.SH AUTHOR
Uditha Atukorala <ua@nuked.zone>
.SH "SEE ALSO"
.BR bitz-server.conf (5)