Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

git-svn-id: svn://cherokee-project.com/cherokee/trunk@1923 5dc97367-9…

…7f1-0310-9951-d761b3857238
  • Loading branch information...
commit 5bfd3e03426484b957cc0b6eb35cecaf1780eaaf 1 parent 5f04150
taher authored
View
2  cherokee-worker.1
@@ -30,7 +30,7 @@ cherokee-worker \- Cherokee Web Server internal worker
.SH SYNOPSIS
.B cherokee-worker [options]
.SH DESCRIPTION
-\fBcherokee-worker\fP is an part of Cherokee, an extremely fast,
+\fBcherokee-worker\fP is a part of Cherokee, an extremely fast,
flexible and embeddable web server. This executable is meant to be
invoked only by \&\fIcherokee\fR\|(1). Executing it directly is a
discouraged practice.
View
6 cherokee.1
@@ -92,12 +92,12 @@ cherokee-admin@cherokee-project.com with the line:
in the body of the message. The submission address is cherokee@cherokee-project.com.
.SH "SEE ALSO"
-Cherokee can be run also with the either this command or
+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 most of the systems, a startup/shutdown script such as
-/etc/init.d/cherokee is provided, and will probably be the most
+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>.
View
68 doc/bundle_cherokee.txt
@@ -3,31 +3,67 @@
Cherokee Bundle: cherokee
-------------------------
-This command-line tool is a wrapper for the main Cherokee
-executable. It is used as a safety net to invoke `cherokee-worker` and
-to ensure it is always functioning. It also plays an important role in
-the link:other_goodies.html#zero-downtime[zero-downtime] mechanism
+This command-line tool is the main Cherokee executable. It is used as
+a safety net to invoke `cherokee-worker` and to ensure it is always
+functioning. It also plays an important role in the
+link:other_goodies.html#zero-downtime[zero-downtime] mechanism
implemented to allow graceful restarts of the server.
This is the full information provided by the manpage.
**********************************************************************
*NAME*::
- cherokee - Cherokee web server safe invoker
+ cherokee - Cherokee Web Server
*SYNOPSIS*::
- cherokee
+ cherokee [options]
*DESCRIPTION*::
+ `cherokee` is an extremely fast, flexible and embeddable web server.
-Cherokee is an extremely fast, flexible and embeddable web
-server. `cherokee` is the recommended way to invoke
-`cherokee-worker`. It will launch Cherokee with any options specified
-to it via the command line, and monitor it. In case Cherokee ends
-abnormally, it will be immediately re-launched.
-+
-This program was previously called cherokee-guardian, but became the
-main binary to invoke Cherokee since release 0.9.
+*OPTIONS*::
+ This command will launch the Cherokee webserver. It accepts the following options:
+
+ -h, --help;;
+ Prints a brief help message and terminates execution
+
+ -V, --version;;
+ Prints Cherokee’s version and terminates execution
+
+ -t, --test;;
+ Perform a sanity check on the configuration file. The server will not run.
+
+ -d, --detach;;
+ Launches the server as a background process (default behaviour is to stay attached to the controlling terminal).
+
+ -C, --config=PATH;;
+ Specifies an alternative path for the configuration file to use instead of the default cherokee.conf
+
+ -p, --port=PORT;;
+ TCP port number to which the server will listen.
+
+ -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.
+
+ -i, --print;;
+ Print server technical information.
+
+*SIGNALS*::
+ The following signals are supported by Cherokee:
+
+ SIGHUP;; Restarts the server gracefully
+
+ SIGUSR1;; Restarts the server closing all the opened connections
+
+ SIGUSR2;; Reopens the log files
+
+ SIGTERM;; Exits
+
+*SEE ALSO*::
+ Cherokee can be run either with this command or
+ `cherokee-worker`. 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.
**********************************************************************
-The accepcted parameters are those of the
-link:bundle_cherokee-worker.html[cherokee-worker] binary.
View
1  doc/index.txt
@@ -95,6 +95,7 @@ link:other.html[Other information]: Miscellaneus.
- link:other_goodies.html[Cherokee Goodies]: Interesting Cherokee features.
////
- Community
+ - Signals: Signals supported by Cherokee.
////
*********************************
Please sign in to comment.
Something went wrong with that request. Please try again.