diff --git a/ChangeLog b/ChangeLog index 318f47744..9f2fd9985 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2008-07-28 Taher Shihadeh + * cherokee-tweak.1, cherokee-admin.1, cherokee.1: manpages needed + an update. + 2008-07-28 Taher Shihadeh * admin/PageEntry.py, admin/PageEncoders.py, admin/PageAdvanced.py, admin/PageVServers.py, admin/PageGeneral.py, admin/PageMime.py, diff --git a/cherokee-admin.1 b/cherokee-admin.1 index 90bb06d67..39e4d7840 100644 --- a/cherokee-admin.1 +++ b/cherokee-admin.1 @@ -1,4 +1,4 @@ -.TH cherokee-admin 8 +.TH cherokee-admin 8 "July 28, 2008" .SH NAME cherokee-admin - Runs Cherokee's administrative interface .SH SYNOPSIS diff --git a/cherokee_tweak.1 b/cherokee-tweak.1 similarity index 53% rename from cherokee_tweak.1 rename to cherokee-tweak.1 index 7b1255705..e03b7bf25 100644 --- a/cherokee_tweak.1 +++ b/cherokee-tweak.1 @@ -3,43 +3,50 @@ cherokee_tweak - Command-line interface to the Cherokee administrative interface .SH SYNOPSIS .B cherokee_tweak -\-c command \-u url [options] +\-c command \-a url [options] .SH DESCRIPTION -\fIcherokee_tweak\fP connects via HTTP to a running cherokee-admin, +\fIcherokee_tweak\fP connects to running cherokee instance, either local or remote, and requests it to perform one of several actions. .SH OPTIONS \fIcherokee_tweak\fP accepts the following options: .TP 8 -.B \-h +.B \-h, --help Shows brief usage information .TP 8 -.B \-V +.B \-V, --version Prints version and exits .TP 8 -.B \-u STRING +.B \-u, --user= STRING Specifies the user name with which to identify to the server .TP 8 -.B \-p STRING +.B \-p, --password= STRING Specifies the password with which to identify to the server .TP 8 -.B \-c STRING +.B \-c, --command=STRING Required option. Command to execute: logrotate, trace or info .TP 8 -.B \-a URL +.B \-a, --url=URL Required option. URL where the administrative interface can be found. +This target must be defined previously in cherokee-admin, enabling +a "Remote Administration" type handler (Virtual Servers->Behaviour->Add new rule, +and then Handler->"Remote Administration"). The deffinition of a security mechanisim +is highly encouraged. .TP 8 -.B \-l PATH +.B \-l, --log=PATH Log file to be rotated (Only to be used when -c is logrotate) .TP 8 -.B \-t STRING -Modules to be traced (Only to be used when -c is trace) +.B \-t, --trace=STRING +Modules to be traced (Only to be used when -c is trace). Cherokee must have +been compiled with the --enable-trace for this to work. Everything traceable +with CHEROKEE_TRACE can also be traced this way. .SH SEE ALSO \&\fIcherokee-admin\fR\|(8) .PP This program is a part of the Cherokee web server, \&\fIcherokee\fR\|(1) .SH AUTHOR This manual page was written by Gunnar Wolf , for -the Debian GNU/linux system (but may be used by others). +the Debian GNU/linux system (but may be used by others). Updated by Taher +Shihadeh . .PP Cherokee itself was written by Álvaro López Ortega . diff --git a/cherokee.1 b/cherokee.1 index fc832f315..84f64a8ff 100644 --- a/cherokee.1 +++ b/cherokee.1 @@ -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 "December 20, 2001" +.TH Cherokee 1 "July 28, 2008" .\" Please update the above date whenever this man page is modified. .\" .\" Some roff macros, for reference: @@ -26,9 +26,9 @@ .\" .sp insert n+1 empty lines .\" for manpage-specific macros, see man(7) .SH NAME -cherokee \- Cherokee web server +cherokee \- Cherokee Web Server .SH SYNOPSIS -.B cherokee [\-C configfile] [\-b] [\-r DIR [-p PORT]] [-t] [\-v] [\-h] +.B cherokee [options] .SH DESCRIPTION \fBcherokee\fP is an extremely fast, flexible and embedable web server. .\" .PP @@ -37,29 +37,32 @@ cherokee \- Cherokee web server This command will launch the Cherokee webserver. It accepts the following options: .TP 8 -.B \-b +.B \-d, --detach Launches the server as a background process (default behaviour is to stay attached to the controlling terminal). .TP 8 -.B \-C configfile +.B \-C, --config=PATH Specifies a configuration file other than the default /etc/cherokee/cherokee.conf .TP 8 -.B \-r /directory/to/share +.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 \-p PORT -It used with -r specifies the port to which the server will listen. +.B \-p, --port=PORT +TCP port number to which the server will listen. .TP 8 -.B \-t +.B \-t, --test Perform a sanity check on the configuration file. The server will not run. .TP 8 -.B \-h +.B \-h, --help Prints a brief help message and terminates execution .TP 8 -.B \-v +.B \-i, --print +Print server technical information.TP 8 +.TP 8 +.B \-V, --version Prints Cherokee's version and terminates execution .SH BUGS .SS Bug reports @@ -67,6 +70,9 @@ 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: @@ -82,4 +88,4 @@ 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 Lopez Ortega . Manual page maintained by Taher Shihadeh