| 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 |
.\" |
|---|
| 15 |
.TH Cherokee 1 "August 04, 2008" |
|---|
| 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 |
|---|
| 29 |
cherokee \- Cherokee Web Server |
|---|
| 30 |
.SH SYNOPSIS |
|---|
| 31 |
.B cherokee [options] |
|---|
| 32 |
.SH DESCRIPTION |
|---|
| 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 |
|---|
| 65 |
.B \-i, --print |
|---|
| 66 |
Print server technical information. |
|---|
| 67 |
.SH SIGNALS |
|---|
| 68 |
The following signals are supported by Cherokee: |
|---|
| 69 |
.TP 8 |
|---|
| 70 |
\fBSIGHUP\fR, Restarts the server gracefully |
|---|
| 71 |
.TP 8 |
|---|
| 72 |
\fBSIGUSR1\fR, Restarts the server closing all the opened connections |
|---|
| 73 |
.TP 8 |
|---|
| 74 |
\fBSIGUSR2\fR, Reopens the log files |
|---|
| 75 |
.TP 8 |
|---|
| 76 |
\fBSIGTERM\fR, Exits |
|---|
| 77 |
.SH BUGS |
|---|
| 78 |
.SS Bug reports |
|---|
| 79 |
I would appreciate hearing of any problems you have with Cherokee. I |
|---|
| 80 |
would also like to hear from you if you have successfully used Cherokee, |
|---|
| 81 |
especially if you are using it for a distribution. |
|---|
| 82 |
.PP |
|---|
| 83 |
Report bugs to |
|---|
| 84 |
.B http://bugs.cherokee-project.com |
|---|
| 85 |
.PP |
|---|
| 86 |
There is a mailing list for discussion among Cherokee users and for |
|---|
| 87 |
announcements of new and test versions. To join, send a message to |
|---|
| 88 |
cherokee-admin@cherokee-project.com with the line: |
|---|
| 89 |
.PP |
|---|
| 90 |
.B subscribe cherokee |
|---|
| 91 |
.PP |
|---|
| 92 |
in the body of the message. The submission address is cherokee@cherokee-project.com. |
|---|
| 93 |
.SH "SEE ALSO" |
|---|
| 94 |
|
|---|
| 95 |
Cherokee can be run either with this command or |
|---|
| 96 |
\&\fIcherokee-worker\fR\|(1). This last option is discouraged if you |
|---|
| 97 |
are not developing though. |
|---|
| 98 |
. |
|---|
| 99 |
Note that, for most systems, a startup/shutdown script such as |
|---|
| 100 |
/etc/init.d/cherokee is provided and will probably be the most |
|---|
| 101 |
convenient invocation method. |
|---|
| 102 |
.SH AUTHOR |
|---|
| 103 |
Alvaro Lopez Ortega <alvaro@alobbs.com>. |
|---|