Implemented and documented a '-g' option for WebCit to enable a default landing page...

[citadel.git] / webcit / README.txt

diff --git a/webcit/README.txt b/webcit/README.txt
index 7d6bd8593cd479218942197cd5e5e6cdbb725cab..14a20655e87d1ca8f7a864d5186421935c9960e9 100644 (file)
--- a/webcit/README.txt
+++ b/webcit/README.txt
@@ -13,9 +13,10 @@
        Dave Lindquist
        Matt Pfleger
        Martin Mouritzen
+       Stefan Garthe
 
    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
@@ -108,11 +109,13 @@ something like this:
 the "webcit" program:
   
  webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite] [-t tracefile]
+           [-g guest_landing_page ]
            [-c] [-f] [remotehost [remoteport]]
  
    *or*
  
  webcit [-i ip_addr] [-p http_port] [-s] [-S cipher_suite] [-t tracefile]
+           [-g guest_landing_page ]
            [-c] [-f] uds /your/citadel/directory
  
  Explained: 
@@ -133,6 +136,12 @@ the "webcit" program:
      
   -> 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: