Changeset 1919

Show
Ignore:
Timestamp:
08/31/08 14:53:49 (3 months ago)
Author:
taher
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cherokee/trunk/ChangeLog

    r1918 r1919  
     12008-08-31  Taher Shihadeh <taher@unixwars.com> 
     2 
     3        * cherokee.1, cherokee-worker.1: changed man pages to accomodate 
     4        recent program name changes. 
     5 
     6        * doc/basics_running_cherokee.txt, doc/index.txt, doc/bundle.txt, 
     7        doc/bundle_cherokee.txt: changed docs to reflect the new names. 
     8 
    192008-08-31  Alvaro Lopez Ortega  <alvaro@alobbs.com> 
    210 

  • cherokee/trunk/doc/Makefile.am

    r1900 r1919  
    2323bundle_cherokee-admin.html \ 
    2424bundle_cherokee-config.html \ 
    25 bundle_cherokee-guardian.html \ 
    2625bundle_cherokee-tweak.html \ 
     26bundle_cherokee-worker.html \ 
    2727bundle_spawn-fcgi.html \ 
    2828bundle_cget.html \ 

  • cherokee/trunk/doc/basics_running_cherokee.txt

    r1816 r1919  
    1111  present in your system. 
    1212 
    13 . Guardian wrapper: The 
    14   link:bundle_cherokee-guardian.html[cherokee-guardian] program comes 
    15   as a standard part of the Cherokee bundle. It is a security 
     13. Guardian wrapper: The link:bundle_cherokee.html[cherokee] program 
     14  comes as a standard part of the Cherokee bundle. It is a security 
    1615  mechanism that ensures Cherokee's recovery in case of any system 
    17   failure. This is what is actually launched when Cherokee is 
    18   automatically started. 
     16  failure and wraps the calls to `cherokee-worker`. This is what is 
     17  actually launched when Cherokee is automatically started. 
    1918 
    20 . Command line: Cherokee supports a series of parameters to launch it 
    21   from the command line. Refer to the the appropriate documentation 
    22   section about link:bundle_cherokee.html[`cherokee`] to see the complete 
    23   list of optional arguments. 
     19. Stand alone instance: Cherokee supports a series of parameters to 
     20  launch it from the command line. Refer to the the appropriate 
     21  documentation section about 
     22  link:bundle_cherokee-worker.html[`cherokee-worker`] to see the 
     23  complete list of optional arguments. 
    2424 
    2525. Cherokee-Admin: The administrative web interface allows you to setup 
    …… 
    2828  link:bundle_cherokee_admin.html[`cherokee-admin`] process and follow the 
    2929  link:config_walkthrough.html[Walktrhough] section of the documentation. 
    30  

  • cherokee/trunk/doc/bundle.txt

    r1816 r1919  
    11== link:index.html[Index] -> Cherokee Bundle 
    22 
    3  . link:bundle_cherokee.html[cherokee]: The main program. 
     3 . link:bundle_cherokee.html[cherokee]: Main web server invoker. 
    44 . link:bundle_cherokee-admin.html[cherokee-admin]: The configuration UI. 
    55 . link:bundle_cherokee-config.html[cherokee-config]: Information retriever. 
    6  . link:bundle_cherokee-guardian.html[cherokee-guardian]: Web server safe invoker. 
    76 . link:bundle_cherokee-tweak.html[cherokee-tweak]: Cherokee Swiss army knife 
     7 . link:bundle_cherokee-worker.html[cherokee-worker]: Web server stand alone program. 
    88 . link:bundle_cget.html[cget]: Web retriever. 

  • cherokee/trunk/doc/bundle_cherokee.txt

    r1816 r1919  
    44------------------------- 
    55 
    6 This is the main Cherokee program. It can be launched in several ways 
    7 as shown in the section link:basics_running_cherokee.txt[Running 
    8 Cherokee]. Unless specified otherwise, `cherokee` will try to run with 
    9 the configuration present in your default 
    10 link:dev_cherokee.conf.html[cherokee.conf] file. 
     6This command-line tool is a wrapper for the main Cherokee 
     7executable. It is used as a safety net to invoke `cherokee-worker` and 
     8to ensure it is always functioning. It also plays an important role in 
     9the link:other_goodies.html#zero-downtime[zero-downtime] mechanism 
     10implemented to allow graceful restarts of the server. 
    1111 
    12 This is the full information provided by the manpage: 
     12This is the full information provided by the manpage. 
    1313********************************************************************** 
    1414*NAME*:: 
    15        `cherokee` - Cherokee Web Server 
     15       cherokee - Cherokee web server safe invoker 
    1616 
    1717*SYNOPSIS*:: 
    18        `cherokee` [options] 
     18       cherokee 
    1919 
    2020*DESCRIPTION*:: 
    21        `cherokee` is an extremely fast, flexible and embeddable web server. 
    2221 
    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  a  configuration  file  other   than   the   default /etc/cherokee/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. 
     22Cherokee is an extremely fast, flexible and embeddable web 
     23server. `cherokee` is the recommended way to invoke 
     24`cherokee-worker`. It will launch Cherokee with any options specified 
     25to it via the command line, and monitor it. In case Cherokee ends 
     26abnormally, it will be immediately re-launched. 
     27+ 
     28This program was previously called cherokee-guardian, but became the 
     29main binary to invoke Cherokee since release 0.9. 
    4930********************************************************************** 
    5031 
    51 To illustrate the usefulness of such options take the following 
    52 example: 
    53  
    54 ---- 
    55 $ cherokee -p 8080 -r `pwd` 
    56 ---- 
    57  
    58 This would allow any non-privileged user to statically share the 
    59 contents of the current directory. A great way to share files in a 
    60 local network whenever you are in a hurry. Remember that in Unix 
    61 systems only processes launched by the superuser have privileges to 
    62 be hooked to the lower 1024 ports of the system. 
     32The accepcted parameters are those of the 
     33link:bundle_cherokee-worker.html[cherokee-worker] binary. 

  • cherokee/trunk/doc/index.txt

    r1900 r1919  
    1919********************************* 
    2020 
    21  . link:bundle_cherokee.html[cherokee]: The main program. 
     21 . link:bundle_cherokee.html[cherokee]: Main web server invoker. 
    2222 . link:bundle_cherokee-admin.html[cherokee-admin]: The configuration UI. 
    2323 . link:bundle_cherokee-config.html[cherokee-config]: Information retriever. 
    24  . link:bundle_cherokee-guardian.html[cherokee-guardian]: Web server safe invoker. 
    2524 . link:bundle_cherokee-tweak.html[cherokee-tweak]: Cherokee Swiss army knife 
     25 . link:bundle_cherokee-worker.html[cherokee-worker]: Web server stand alone program. 
    2626 . link:bundle_cget.html[cget]: Web retriever. 
    2727