minor tuning to previous commit

[citadel.git] / webcit / README.txt

diff --git a/webcit/README.txt b/webcit/README.txt
index 7d6bd8593cd479218942197cd5e5e6cdbb725cab..aa8f6061fddcc2af4e0a05eafd855431d6eb015d 100644 (file)
--- a/webcit/README.txt
+++ b/webcit/README.txt
@@ -1,6 +1,6 @@
                         WEBCIT for the Citadel System
  
                         WEBCIT for the Citadel System
  

-   Copyright (C) 1996-2011 by the authors.  Portions written by:
+   Copyright (C) 1996-2012 by the authors.  Portions written by:

  
        Art Cancro
        Wilfried Goesgens
  
        Art Cancro
        Wilfried Goesgens


@@ -13,9 +13,10 @@
        Dave Lindquist
        Matt Pfleger
        Martin Mouritzen
        Dave Lindquist
        Matt Pfleger
        Martin Mouritzen

+       Stefan Garthe

 
    This program is open source software released under the terms of the GNU
 
    This program is open source software released under the terms of the GNU

-   General Public License, version 3.  Please read COPYING.txt for more
+   General Public License, version 3. Please read COPYING.txt for more

    licensing information.
  
    WebCit bundles the Prototype JavaScript Framework, writen by Sam
    licensing information.
  
    WebCit bundles the Prototype JavaScript Framework, writen by Sam


@@ -107,12 +108,14 @@ something like this:
  Several command-line options are also available.  Here's the usage for
 the "webcit" program:
   
  Several command-line options are also available.  Here's the usage for
 the "webcit" program:
   

- webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite] [-t tracefile]
+ webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite]
+           [-g guest_landing_page]

            [-c] [-f] [remotehost [remoteport]]
  
    *or*
  
            [-c] [-f] [remotehost [remoteport]]
  
    *or*
  

- webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite] [-t tracefile]
+ webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite]
+           [-g guest_landing_page]

            [-c] [-f] uds /your/citadel/directory
  
  Explained: 
            [-c] [-f] uds /your/citadel/directory
  
  Explained: 


@@ -131,8 +134,11 @@ the "webcit" program:
      different port.  If you do not specify a port number, WebCit will attempt
      to use port 80.
      
      different port.  If you do not specify a port number, WebCit will attempt
      to use port 80.
      

-  -> tracefile: where you want WebCit to log to.  This can be a file, a
-     virtual console, or /dev/null to suppress logging altogether.
+  -> The "guest landing page" is a location on your WebCit installation where
+     unauthenticated guest users are taken when they first enter the root of
+     your site.  If guest mode is not enabled on your Citadel server, they will
+     be taken to a login page instead.  If guest mode is enabled but no landing
+     page is defined, they will be taken to the Lobby.

  
   -> The "-c" option causes WebCit to output an extra cookie containing the
      identity of the WebCit server.  The cookie will look like this:
  
   -> The "-c" option causes WebCit to output an extra cookie containing the
      identity of the WebCit server.  The cookie will look like this: