Changeset 1922

Show
Ignore:
Timestamp:
08/31/08 18:37:10 (3 months ago)
Author:
alo
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • cherokee/trunk/ChangeLog

    r1921 r1922  
    112008-08-31  Alvaro Lopez Ortega  <alvaro@alobbs.com> 
     2 
     3        * cherokee.1, cherokee-worker.1, Makefile.am: Updates the manual 
     4        pages. Now cherokee.1 shows the information and cherokee-worker.1 
     5        is only a note. Additionally information about the signal handling 
     6        was added to the cherokee man page. 
    27 
    38        * cherokee/main_worker.c: Updates the signals. There were not 
  • cherokee/trunk/Makefile.am

    r1699 r1922  
    1616cherokee-tweak.1     \ 
    1717cherokee-admin.1     \ 
    18 cherokee-guardian.1 
     18cherokee-worker.1 
    1919 
    2020# pkg-config 
  • cherokee/trunk/cherokee-worker.1

    r1919 r1922  
    1313.\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 
    1414.\" 
    15 .TH cherokee-worker 1 "August 31, 2008" 
     15.TH Cherokee-Worker 1 "August 31, 2008" 
    1616.\" Please update the above date whenever this man page is modified. 
    1717.\" 
     
    2727.\" for manpage-specific macros, see man(7) 
    2828.SH NAME 
    29 cherokee-worker \- Cherokee Web Server 
     29cherokee-worker \- Cherokee Web Server internal worker 
    3030.SH SYNOPSIS 
    3131.B cherokee-worker [options] 
    3232.SH DESCRIPTION 
    33 \fBcherokee\fP is an extremely fast, flexible and embeddable web server. 
     33\fBcherokee-worker\fP is an part of Cherokee, an extremely fast, 
     34flexible and embeddable web server. This executable is meant to be 
     35invoked only by \&\fIcherokee\fR\|(1). Executing it directly is a 
     36discouraged practice. 
    3437.\" .PP 
    3538.\" It also... 
    36 .SH OPTIONS 
    37 This command will launch the Cherokee webserver as a stand alone 
    38 instance. It accepts the following parameters: 
     39.SH DEVELOPMENT 
     40This binary implements the Cherokee Web Server functionality, although 
     41it misses a few security features implemented on the main executable: 
     42\&\fIcherokee\fR\|(1). 
    3943.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 BUGS 
    68 .SS Bug reports 
    69 I would appreciate hearing of any problems you have with Cherokee.  I 
    70 would also like to hear from you if you have successfully used Cherokee, 
    71 especially if you are using it for a distribution. 
    72 .PP 
    73 Report bugs to  
    74 .B http://bugs.cherokee-project.com 
    75 .PP 
    76 There is a mailing list for discussion among Cherokee users and for 
    77 announcements of new and test versions. To join, send a message to 
    78 cherokee-admin@cherokee-project.com with the line: 
    79 .PP 
    80 .B subscribe cherokee 
    81 .PP 
    82 in the body of the message. The submission address is cherokee@cherokee-project.com. 
    83 .SH "SEE ALSO" 
    84 You will probably want to launch Cherokee via its guardian wrapper: lease refer to \&\fIcherokee\fR\|(1) 
    85 
    86 Note that in in Debian systems, a startup/shutdown script 
    87 /etc/init.d/cherokee is provided, and will probably be the most 
    88 convenient invocation method. 
     44Executing it alone could be only useful for debugging purposes. 
    8945.SH AUTHOR 
    9046Alvaro Lopez Ortega <alvaro@alobbs.com>. Manual page maintained by Taher Shihadeh <taher@unixwars.com> 
  • cherokee/trunk/cherokee.1

    r1919 r1922  
    1313.\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 
    1414.\" 
    15 .TH cherokee 1 "August 31, 2008" 
     15.TH Cherokee 1 "August 04, 2008" 
    1616.\" Please update the above date whenever this man page is modified. 
    1717.\" 
     
    2727.\" for manpage-specific macros, see man(7) 
    2828.SH NAME 
    29 cherokee \- Cherokee web server safe invoker 
     29cherokee \- Cherokee Web Server 
    3030.SH SYNOPSIS 
    31 .B cherokee 
     31.B cherokee [options] 
    3232.SH DESCRIPTION 
    33 \fBCherokee\fP is an extremely fast, flexible and embeddable web 
    34 server.  \fBcherokee\fP is the recommended way to invoke 
    35 cherokee-worker - It will launch Cherokee with any options specified to it 
    36 via the command line, and monitor it. In case Cherokee ends 
    37 abnormally, it will be immediately re-launched. 
    38 .PP 
    39 This program was previously called cherokee\-guardian, but became the 
    40 main binary to invoke Cherokee since release 0.9. 
     33\fBcherokee\fP is an extremely fast, flexible and embeddable web server. 
     34.\" .PP 
     35.\" It also... 
     36.SH OPTIONS 
     37This command will launch the Cherokee webserver. It accepts the 
     38following options: 
     39.TP 8 
     40.B \-h, --help 
     41Prints a brief help message and terminates execution 
     42.TP 8 
     43.B \-V, --version 
     44Prints Cherokee's version and terminates execution 
     45.TP 8 
     46.B \-t, --test 
     47Perform a sanity check on the configuration file. The server will not run. 
     48.TP 8 
     49.B \-d, --detach 
     50Launches the server as a background process (default behaviour is to 
     51stay attached to the controlling terminal). 
     52.TP 8 
     53.B \-C, --config=PATH 
     54Specifies an alternative path for the configuration file to use instead 
     55of the default cherokee.conf 
     56.TP 8 
     57.B \-p, --port=PORT 
     58TCP port number to which the server will listen. 
     59.TP 8 
     60.B \-r, --documentroot=PATH 
     61Launches a server exposing statically the specified directory. When 
     62launched with \-r, the configuration file is ignored, and the Cherokee 
     63instance runs with its default values. 
     64.TP 8 
     65.B \-i, --print 
     66Print server technical information. 
     67.SH SIGNALS 
     68The 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 
    4177.SH BUGS 
    4278.SS Bug reports 
     
    4480would also like to hear from you if you have successfully used Cherokee, 
    4581especially if you are using it for a distribution. 
     82.PP 
     83Report bugs to  
     84.B http://bugs.cherokee-project.com 
    4685.PP 
    4786There is a mailing list for discussion among Cherokee users and for 
     
    5392in the body of the message. The submission address is cherokee@cherokee-project.com. 
    5493.SH "SEE ALSO" 
    55 For information on the options which Cherokee itself accepts, 
    56 please refer to  \&\fIcherokee\-worker\fR\|(1) 
     94 
     95Cherokee can be run also with the either this command or 
     96\&\fIcherokee-worker\fR\|(1).  This last option is discouraged if you 
     97are not developing though. 
    5798. 
    58 Note that in in Debian systems, a startup/shutdown script 
     99Note that most of the systems, a startup/shutdown script such as  
    59100/etc/init.d/cherokee is provided, and will probably be the most 
    60101convenient invocation method.