/
cherokee.1
103 lines (102 loc) · 3.48 KB
/
cherokee.1
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
.\" hey, Emacs: -*- nroff -*-
.\" cherokee is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation version 2 of the License.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; see the file COPYING. If not, write to
.\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
.\"
.TH Cherokee 1 "August 04, 2008"
.\" Please update the above date whenever this man page is modified.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins (default)
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
cherokee \- Cherokee Web Server
.SH SYNOPSIS
.B cherokee [options]
.SH DESCRIPTION
\fBcherokee\fP is an extremely fast, flexible and embeddable web server.
.\" .PP
.\" It also...
.SH OPTIONS
This command will launch the Cherokee webserver. It accepts the
following options:
.TP 8
.B \-h, --help
Prints a brief help message and terminates execution
.TP 8
.B \-V, --version
Prints Cherokee's version and terminates execution
.TP 8
.B \-t, --test
Perform a sanity check on the configuration file. The server will not run.
.TP 8
.B \-d, --detach
Launches the server as a background process (default behaviour is to
stay attached to the controlling terminal).
.TP 8
.B \-C, --config=PATH
Specifies an alternative path for the configuration file to use instead
of the default cherokee.conf
.TP 8
.B \-p, --port=PORT
TCP port number to which the server will listen.
.TP 8
.B \-r, --documentroot=PATH
Launches a server exposing statically the specified directory. When
launched with \-r, the configuration file is ignored, and the Cherokee
instance runs with its default values.
.TP 8
.B \-i, --print
Print server technical information.
.SH SIGNALS
The following signals are supported by Cherokee:
.TP 8
\fBSIGHUP\fR, Restarts the server gracefully
.TP 8
\fBSIGUSR1\fR, Restarts the server closing all the opened connections
.TP 8
\fBSIGUSR2\fR, Reopens the log files
.TP 8
\fBSIGTERM\fR, Exits
.SH BUGS
.SS Bug reports
I would appreciate hearing of any problems you have with Cherokee. I
would also like to hear from you if you have successfully used Cherokee,
especially if you are using it for a distribution.
.PP
Report bugs to
.B http://bugs.cherokee-project.com
.PP
There is a mailing list for discussion among Cherokee users and for
announcements of new and test versions. To join, send a message to
cherokee-admin@cherokee-project.com with the line:
.PP
.B subscribe cherokee
.PP
in the body of the message. The submission address is cherokee@cherokee-project.com.
.SH "SEE ALSO"
Cherokee can be run either with this command or
\&\fIcherokee-worker\fR\|(1). This last option is discouraged if you
are not developing though.
.
Note that, for most systems, a startup/shutdown script such as
/etc/init.d/cherokee is provided and will probably be the most
convenient invocation method.
.SH AUTHOR
Alvaro Lopez Ortega <alvaro@alobbs.com>.