Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 110 lines (108 sloc) 3.776 kb
ae9d971 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@243 5dc97367-97…
alobbs authored
1 .\" hey, Emacs: -*- nroff -*-
2 .\" cherokee is free software; you can redistribute it and/or modify
3 .\" it under the terms of the GNU General Public License as published by
4 .\" the Free Software Foundation version 2 of the License.
5 .\"
6 .\" This program is distributed in the hope that it will be useful,
7 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
8 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 .\" GNU General Public License for more details.
10 .\"
11 .\" You should have received a copy of the GNU General Public License
12 .\" along with this program; see the file COPYING. If not, write to
13 .\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
14 .\"
4d3edd6 Updates list of program parameters in documentation
taher authored
15 .TH Cherokee 1 "December 13, 2010"
ae9d971 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@243 5dc97367-97…
alobbs authored
16 .\" Please update the above date whenever this man page is modified.
17 .\"
18 .\" Some roff macros, for reference:
19 .\" .nh disable hyphenation
20 .\" .hy enable hyphenation
21 .\" .ad l left justify
22 .\" .ad b justify to both left and right margins (default)
23 .\" .nf disable filling
24 .\" .fi enable filling
25 .\" .br insert line break
26 .\" .sp <n> insert n+1 empty lines
27 .\" for manpage-specific macros, see man(7)
28 .SH NAME
5f04150 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1922 5dc97367-9…
alobbs authored
29 cherokee \- Cherokee Web Server
ae9d971 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@243 5dc97367-97…
alobbs authored
30 .SH SYNOPSIS
5f04150 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1922 5dc97367-9…
alobbs authored
31 .B cherokee [options]
ae9d971 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@243 5dc97367-97…
alobbs authored
32 .SH DESCRIPTION
5f04150 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1922 5dc97367-9…
alobbs authored
33 \fBcherokee\fP is an extremely fast, flexible and embeddable web server.
34 .\" .PP
35 .\" It also...
36 .SH OPTIONS
37 This command will launch the Cherokee webserver. It accepts the
38 following options:
39 .TP 8
40 .B \-h, --help
41 Prints a brief help message and terminates execution
42 .TP 8
43 .B \-V, --version
44 Prints Cherokee's version and terminates execution
45 .TP 8
46 .B \-t, --test
47 Perform a sanity check on the configuration file. The server will not run.
48 .TP 8
49 .B \-d, --detach
50 Launches the server as a background process (default behaviour is to
51 stay attached to the controlling terminal).
52 .TP 8
53 .B \-C, --config=PATH
54 Specifies an alternative path for the configuration file to use instead
55 of the default cherokee.conf
56 .TP 8
57 .B \-p, --port=PORT
58 TCP port number to which the server will listen.
59 .TP 8
60 .B \-r, --documentroot=PATH
61 Launches a server exposing statically the specified directory. When
62 launched with \-r, the configuration file is ignored, and the Cherokee
63 instance runs with its default values.
64 .TP 8
4d3edd6 Updates list of program parameters in documentation
taher authored
65 .B \-i, --print-server-info
5f04150 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1922 5dc97367-9…
alobbs authored
66 Print server technical information.
4d3edd6 Updates list of program parameters in documentation
taher authored
67 .TP 8
68 .B \-v, --valgrind
69 Execute the worker process under Valgrind. Used only for development
70 and troubleshooting purposes.
5f04150 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1922 5dc97367-9…
alobbs authored
71 .SH SIGNALS
72 The following signals are supported by Cherokee:
73 .TP 8
74 \fBSIGHUP\fR, Restarts the server gracefully
75 .TP 8
76 \fBSIGUSR1\fR, Restarts the server closing all the opened connections
77 .TP 8
78 \fBSIGUSR2\fR, Reopens the log files
79 .TP 8
80 \fBSIGTERM\fR, Exits
ae9d971 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@243 5dc97367-97…
alobbs authored
81 .SH BUGS
82 .SS Bug reports
83 I would appreciate hearing of any problems you have with Cherokee. I
84 would also like to hear from you if you have successfully used Cherokee,
85 especially if you are using it for a distribution.
86 .PP
5f04150 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1922 5dc97367-9…
alobbs authored
87 Report bugs to
88 .B http://bugs.cherokee-project.com
89 .PP
ae9d971 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@243 5dc97367-97…
alobbs authored
90 There is a mailing list for discussion among Cherokee users and for
91 announcements of new and test versions. To join, send a message to
e8c75f5 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@438 5dc97367-97…
alobbs authored
92 cherokee-admin@cherokee-project.com with the line:
ae9d971 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@243 5dc97367-97…
alobbs authored
93 .PP
94 .B subscribe cherokee
95 .PP
e8c75f5 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@438 5dc97367-97…
alobbs authored
96 in the body of the message. The submission address is cherokee@cherokee-project.com.
d098777 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1337 5dc97367-9…
alobbs authored
97 .SH "SEE ALSO"
5f04150 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1922 5dc97367-9…
alobbs authored
98
5bfd3e0 git-svn-id: svn://cherokee-project.com/cherokee/trunk@1923 5dc97367-9…
taher authored
99 Cherokee can be run either with this command or
5f04150 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1922 5dc97367-9…
alobbs authored
100 \&\fIcherokee-worker\fR\|(1). This last option is discouraged if you
101 are not developing though.
d098777 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1337 5dc97367-9…
alobbs authored
102 .
5bfd3e0 git-svn-id: svn://cherokee-project.com/cherokee/trunk@1923 5dc97367-9…
taher authored
103 Note that, for most systems, a startup/shutdown script such as
104 /etc/init.d/cherokee is provided and will probably be the most
d098777 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@1337 5dc97367-9…
alobbs authored
105 convenient invocation method.
ae9d971 @alobbs git-svn-id: svn://cherokee-project.com/cherokee/trunk@243 5dc97367-97…
alobbs authored
106 .SH AUTHOR
7d035b0 git-svn-id: svn://cherokee-project.com/cherokee/trunk@1919 5dc97367-9…
taher authored
107 Alvaro Lopez Ortega <alvaro@alobbs.com>.
4d3edd6 Updates list of program parameters in documentation
taher authored
108 .PP
109 This manpage is maintainted by Taher Shihadeh <taher@unixwars.com>.
Something went wrong with that request. Please try again.