Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

110 lines (108 sloc) 3.798 kb
.\" 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 "February 16, 2011"
.\" 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<PATH>, --config=<PATH>
Specifies an alternative path for the configuration file to use instead
of the default cherokee.conf
.TP 8
.B \-p<PORT>, --port=<PORT>
TCP port number to which the server will listen.
.TP 8
.B \-r<PATH>, --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-server-info
Print server technical information.
.TP 8
.B \-v, --valgrind
Execute the worker process under Valgrind. Used only for development
and troubleshooting purposes.
.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>.
.PP
This manpage is maintainted by Taher Shihadeh <taher@unixwars.com>.
Jump to Line
Something went wrong with that request. Please try again.