| 1 |
== link:index.html[Index] -> link:bundle.html[Cherokee Bundle] |
|---|
| 2 |
|
|---|
| 3 |
Cherokee Bundle: cherokee |
|---|
| 4 |
------------------------- |
|---|
| 5 |
|
|---|
| 6 |
This command-line tool is the main Cherokee executable. It is used as |
|---|
| 7 |
a safety net to invoke `cherokee-worker` and to ensure it is always |
|---|
| 8 |
functioning. It also plays an important role in the |
|---|
| 9 |
link:other_goodies.html#zero-downtime[zero-downtime] mechanism |
|---|
| 10 |
implemented to allow graceful restarts of the server. |
|---|
| 11 |
|
|---|
| 12 |
This is the full information provided by the manpage. |
|---|
| 13 |
********************************************************************** |
|---|
| 14 |
*NAME*:: |
|---|
| 15 |
cherokee - Cherokee Web Server |
|---|
| 16 |
|
|---|
| 17 |
*SYNOPSIS*:: |
|---|
| 18 |
cherokee [options] |
|---|
| 19 |
|
|---|
| 20 |
*DESCRIPTION*:: |
|---|
| 21 |
`cherokee` is an extremely fast, flexible and embeddable web server. |
|---|
| 22 |
|
|---|
| 23 |
*OPTIONS*:: |
|---|
| 24 |
This command will launch the Cherokee webserver. It accepts the following options: |
|---|
| 25 |
|
|---|
| 26 |
-h, --help;; |
|---|
| 27 |
Prints a brief help message and terminates execution |
|---|
| 28 |
|
|---|
| 29 |
-V, --version;; |
|---|
| 30 |
Prints Cherokeeâs version and terminates execution |
|---|
| 31 |
|
|---|
| 32 |
-t, --test;; |
|---|
| 33 |
Perform a sanity check on the configuration file. The server will not run. |
|---|
| 34 |
|
|---|
| 35 |
-d, --detach;; |
|---|
| 36 |
Launches the server as a background process (default behaviour is to stay attached to the controlling terminal). |
|---|
| 37 |
|
|---|
| 38 |
-C, --config=PATH;; |
|---|
| 39 |
Specifies an alternative path for the configuration file to use instead of the default cherokee.conf |
|---|
| 40 |
|
|---|
| 41 |
-p, --port=PORT;; |
|---|
| 42 |
TCP port number to which the server will listen. |
|---|
| 43 |
|
|---|
| 44 |
-r, --documentroot=PATH;; |
|---|
| 45 |
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. |
|---|
| 46 |
|
|---|
| 47 |
-i, --print;; |
|---|
| 48 |
Print server technical information. |
|---|
| 49 |
|
|---|
| 50 |
*SIGNALS*:: |
|---|
| 51 |
The following signals are supported by Cherokee: |
|---|
| 52 |
|
|---|
| 53 |
SIGHUP;; Restarts the server gracefully |
|---|
| 54 |
|
|---|
| 55 |
SIGUSR1;; Restarts the server closing all the opened connections |
|---|
| 56 |
|
|---|
| 57 |
SIGUSR2;; Reopens the log files |
|---|
| 58 |
|
|---|
| 59 |
SIGTERM;; Exits |
|---|
| 60 |
|
|---|
| 61 |
*SEE ALSO*:: |
|---|
| 62 |
Cherokee can be run either with this command or |
|---|
| 63 |
`cherokee-worker`. This last option is discouraged if you are |
|---|
| 64 |
not developing though. Note that, for most systems, a |
|---|
| 65 |
startup/shutdown script such as /etc/init.d/cherokee is |
|---|
| 66 |
provided and will probably be the most convenient invocation |
|---|
| 67 |
method. |
|---|
| 68 |
********************************************************************** |
|---|
| 69 |
|
|---|