Permalink
Browse files

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

…7f1-0310-9951-d761b3857238
  • Loading branch information...
1 parent 4ab56c6 commit 7d035b062d6ce09c06f0aef4da58f0a5c7252be8 taher committed Aug 31, 2008
Showing with 96 additions and 119 deletions.
  1. +8 −0 ChangeLog
  2. +42 −14 cherokee-guardian.1 → cherokee-worker.1
  3. +14 −43 cherokee.1
  4. +1 −1 doc/Makefile.am
  5. +9 −10 doc/basics_running_cherokee.txt
  6. +2 −2 doc/bundle.txt
  7. +18 −47 doc/bundle_cherokee.txt
  8. +2 −2 doc/index.txt
View
@@ -1,3 +1,11 @@
+2008-08-31 Taher Shihadeh <taher@unixwars.com>
+
+ * cherokee.1, cherokee-worker.1: changed man pages to accomodate
+ recent program name changes.
+
+ * doc/basics_running_cherokee.txt, doc/index.txt, doc/bundle.txt,
+ doc/bundle_cherokee.txt: changed docs to reflect the new names.
+
2008-08-31 Alvaro Lopez Ortega <alvaro@alobbs.com>
* cherokee/Makefile.am, cherokee/main.c, cherokee/main_guardian.c,
@@ -12,7 +12,7 @@
.\" 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-guardian 1 "March 27, 2008"
+.TH cherokee-worker 1 "August 31, 2008"
.\" Please update the above date whenever this man page is modified.
.\"
.\" Some roff macros, for reference:
@@ -26,24 +26,53 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
-cherokee-guardian \- Cherokee web server safe invoker
+cherokee-worker \- Cherokee Web Server
.SH SYNOPSIS
-.B cherokee\-guardian
+.B cherokee-worker [options]
.SH DESCRIPTION
-\fBCherokee\fP is an extremely fast, flexible and embeddable web
-server. \fBcherokee\-guardian\fP is the recommended way to invoke
-cherokee - 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.
-.PP
-In future versions, cherokee\-guardian will probably become the main
-binary to invoke Cherokee.
+\fBcherokee\fP is an extremely fast, flexible and embeddable web server.
+.\" .PP
+.\" It also...
+.SH OPTIONS
+This command will launch the Cherokee webserver as a stand alone
+instance. It accepts the following parameters:
+.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, --config=PATH
+Specifies an alternative path for the configuration file to use instead
+of the default cherokee.conf
+.TP 8
+.B \-p, --port=PORT
+TCP port number to which the server will listen.
+.TP 8
+.B \-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.
+.TP 8
+.B \-i, --print
+Print server technical information.
.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:
@@ -52,11 +81,10 @@ cherokee-admin@cherokee-project.com with the line:
.PP
in the body of the message. The submission address is cherokee@cherokee-project.com.
.SH "SEE ALSO"
-For information on the options which Cherokee itself accepts,
-please refer to \&\fIcherokee\fR\|(1)
+You will probably want to launch Cherokee via its guardian wrapper: lease refer to \&\fIcherokee\fR\|(1)
.
Note that in in Debian systems, a startup/shutdown script
/etc/init.d/cherokee is provided, and will probably be the most
convenient invocation method.
.SH AUTHOR
-Alvaro Lopez Ortega <alvaro@alobbs.com>.
+Alvaro Lopez Ortega <alvaro@alobbs.com>. Manual page maintained by Taher Shihadeh <taher@unixwars.com>
View
@@ -12,7 +12,7 @@
.\" 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 "August 04, 2008"
+.TH cherokee 1 "August 31, 2008"
.\" Please update the above date whenever this man page is modified.
.\"
.\" Some roff macros, for reference:
@@ -26,53 +26,24 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
-cherokee \- Cherokee Web Server
+cherokee \- Cherokee web server safe invoker
.SH SYNOPSIS
-.B cherokee [options]
+.B cherokee
.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, --config=PATH
-Specifies an alternative path for the configuration file to use instead
-of the default cherokee.conf
-.TP 8
-.B \-p, --port=PORT
-TCP port number to which the server will listen.
-.TP 8
-.B \-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.
-.TP 8
-.B \-i, --print
-Print server technical information.
+\fBCherokee\fP is an extremely fast, flexible and embeddable web
+server. \fBcherokee\fP 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.
+.PP
+This program was previously called cherokee\-guardian, but became the
+main binary to invoke Cherokee since release 0.9.
.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:
@@ -81,11 +52,11 @@ cherokee-admin@cherokee-project.com with the line:
.PP
in the body of the message. The submission address is cherokee@cherokee-project.com.
.SH "SEE ALSO"
-You will probably want to launch Cherokee via its guardian wrapper, -
-Please refer to \&\fIcherokee-guardian\fR\|(1)
+For information on the options which Cherokee itself accepts,
+please refer to \&\fIcherokee\-worker\fR\|(1)
.
Note that in in Debian systems, a startup/shutdown script
/etc/init.d/cherokee is provided, and will probably be the most
convenient invocation method.
.SH AUTHOR
-Alvaro Lopez Ortega <alvaro@alobbs.com>. Manual page maintained by Taher Shihadeh <taher@unixwars.com>
+Alvaro Lopez Ortega <alvaro@alobbs.com>.
View
@@ -22,8 +22,8 @@ bundle.html \
bundle_cherokee.html \
bundle_cherokee-admin.html \
bundle_cherokee-config.html \
-bundle_cherokee-guardian.html \
bundle_cherokee-tweak.html \
+bundle_cherokee-worker.html \
bundle_spawn-fcgi.html \
bundle_cget.html \
config.html \
@@ -10,21 +10,20 @@ There are several ways you can run Cherokee:
will run making use of the link:dev_cherokee.conf.html[`cherokee.conf`]
present in your system.
-. Guardian wrapper: The
- link:bundle_cherokee-guardian.html[cherokee-guardian] program comes
- as a standard part of the Cherokee bundle. It is a security
+. Guardian wrapper: The link:bundle_cherokee.html[cherokee] program
+ comes as a standard part of the Cherokee bundle. It is a security
mechanism that ensures Cherokee's recovery in case of any system
- failure. This is what is actually launched when Cherokee is
- automatically started.
+ failure and wraps the calls to `cherokee-worker`. This is what is
+ actually launched when Cherokee is automatically started.
-. Command line: Cherokee supports a series of parameters to launch it
- from the command line. Refer to the the appropriate documentation
- section about link:bundle_cherokee.html[`cherokee`] to see the complete
- list of optional arguments.
+. Stand alone instance: Cherokee supports a series of parameters to
+ launch it from the command line. Refer to the the appropriate
+ documentation section about
+ link:bundle_cherokee-worker.html[`cherokee-worker`] to see the
+ complete list of optional arguments.
. Cherokee-Admin: The administrative web interface allows you to setup
and launch Cherokee. This is probably where you want to start if you
have just installed the web server. Launch the
link:bundle_cherokee_admin.html[`cherokee-admin`] process and follow the
link:config_walkthrough.html[Walktrhough] section of the documentation.
-
View
@@ -1,8 +1,8 @@
== link:index.html[Index] -> Cherokee Bundle
- . link:bundle_cherokee.html[cherokee]: The main program.
+ . link:bundle_cherokee.html[cherokee]: Main web server invoker.
. link:bundle_cherokee-admin.html[cherokee-admin]: The configuration UI.
. link:bundle_cherokee-config.html[cherokee-config]: Information retriever.
- . link:bundle_cherokee-guardian.html[cherokee-guardian]: Web server safe invoker.
. link:bundle_cherokee-tweak.html[cherokee-tweak]: Cherokee Swiss army knife
+ . link:bundle_cherokee-worker.html[cherokee-worker]: Web server stand alone program.
. link:bundle_cget.html[cget]: Web retriever.
@@ -3,60 +3,31 @@
Cherokee Bundle: cherokee
-------------------------
-This is the main Cherokee program. It can be launched in several ways
-as shown in the section link:basics_running_cherokee.txt[Running
-Cherokee]. Unless specified otherwise, `cherokee` will try to run with
-the configuration present in your default
-link:dev_cherokee.conf.html[cherokee.conf] file.
+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
+implemented to allow graceful restarts of the server.
-This is the full information provided by the manpage:
+This is the full information provided by the manpage.
**********************************************************************
*NAME*::
- `cherokee` - Cherokee Web Server
+ cherokee - Cherokee web server safe invoker
*SYNOPSIS*::
- `cherokee` [options]
+ cherokee
*DESCRIPTION*::
- `cherokee` is an extremely fast, flexible and embeddable web server.
-*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 a configuration file other than the default /etc/cherokee/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.
+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.
**********************************************************************
-To illustrate the usefulness of such options take the following
-example:
-
-----
-$ cherokee -p 8080 -r `pwd`
-----
-
-This would allow any non-privileged user to statically share the
-contents of the current directory. A great way to share files in a
-local network whenever you are in a hurry. Remember that in Unix
-systems only processes launched by the superuser have privileges to
-be hooked to the lower 1024 ports of the system.
+The accepcted parameters are those of the
+link:bundle_cherokee-worker.html[cherokee-worker] binary.
View
@@ -18,11 +18,11 @@ link:basics.html[Getting started]: Cherokee basics
link:bundle.html[Cherokee Bundle]: Details about each program bundled with Cherokee.
*********************************
- . link:bundle_cherokee.html[cherokee]: The main program.
+ . link:bundle_cherokee.html[cherokee]: Main web server invoker.
. link:bundle_cherokee-admin.html[cherokee-admin]: The configuration UI.
. link:bundle_cherokee-config.html[cherokee-config]: Information retriever.
- . link:bundle_cherokee-guardian.html[cherokee-guardian]: Web server safe invoker.
. link:bundle_cherokee-tweak.html[cherokee-tweak]: Cherokee Swiss army knife
+ . link:bundle_cherokee-worker.html[cherokee-worker]: Web server stand alone program.
. link:bundle_cget.html[cget]: Web retriever.
*********************************

0 comments on commit 7d035b0

Please sign in to comment.