[myserver-commit] [3016] Added directory listing and error pages documentation.

[Giuseppe Scrivano]

Revision: 3016
          http://svn.sv.gnu.org/viewvc/?view=rev&root=myserver&revision=3016
Author:   gscrivano
Date:     2009-02-27 19:47:06 +0000 (Fri, 27 Feb 2009)

Log Message:
-----------
Added directory listing and error pages documentation.

Modified Paths:
--------------
    trunk/myserver/documentation/Makefile.am
    trunk/myserver/documentation/basic_configuration.texi
    trunk/myserver/documentation/mime_types.texi
    trunk/myserver/documentation/myserver.texi

Added Paths:
-----------
    trunk/myserver/documentation/directory_listing.texi
    trunk/myserver/documentation/error_pages.texi

Modified: trunk/myserver/documentation/Makefile.am
===================================================================
--- trunk/myserver/documentation/Makefile.am    2009-02-26 20:26:13 UTC (rev 
3015)
+++ trunk/myserver/documentation/Makefile.am    2009-02-27 19:47:06 UTC (rev 
3016)
@@ -1,6 +1,6 @@
 info_TEXINFOS=myserver.texi
 
 #any other .texi that is not myserver.texi
-myserver_TEXINFOS=basic_configuration.texi  doclicense.texi mime_types.texi 
process_security.texi virtual_hosts.texi ssl_certificates.texi
+myserver_TEXINFOS=basic_configuration.texi directory_listing.texi 
doclicense.texi error_pages.texi mime_types.texi process_security.texi 
virtual_hosts.texi ssl_certificates.texi
 
 SUBDIRS = 

Modified: trunk/myserver/documentation/basic_configuration.texi
===================================================================
--- trunk/myserver/documentation/basic_configuration.texi       2009-02-26 
20:26:13 UTC (rev 3015)
+++ trunk/myserver/documentation/basic_configuration.texi       2009-02-27 
19:47:06 UTC (rev 3016)
@@ -30,74 +30,12 @@
 By default the english language is used, the value specified here must
 refer to a xml file contained in the @file{languages/} directory.
 
address@hidden Default resource
-In the @file{myserver.xml} file it is possible to set the default page
-for the HTTP/HTTPS sites hosted on MyServer.
-
-Similar lines already exist in the default configuration file:
-
address@hidden
-<DEFAULT_FILENAME>default.htm</DEFAULT_FILENAME>
-<DEFAULT_FILENAME>default.php</DEFAULT_FILENAME>
-<DEFAULT_FILENAME>default.php3</DEFAULT_FILENAME>
-<DEFAULT_FILENAME>index.htm</DEFAULT_FILENAME>
-<DEFAULT_FILENAME>index.php</DEFAULT_FILENAME>
-<DEFAULT_FILENAME>index.php3</DEFAULT_FILENAME>
-<DEFAULT_FILENAME>default.htm</DEFAULT_FILENAME>
address@hidden example
-
-The previous line define the order of files to look for when a
-directory is requested.  If a default file is not found and the user
-has browsing access permissions then the directory contents are
-listed.
-
-It is possible to specify a page when a HTTP error happens using the
-option:
-
address@hidden
-<USE_ERROR_FILE>YES</USE_ERROR_FILE>
address@hidden example
-
-So, if you set the value to @code{NO}, like in the line below,
-
address@hidden
-<USE_ERROR_FILE>NO</USE_ERROR_FILE>
address@hidden example
-
-If an error page is not used MyServer will (by default) just send a
-header to your browser with the error code.
-You have the option to send a HTTP body included in the error, by
-adding this line:
-
address@hidden
-<ERRORS_INCLUDE_BODY>YES</ERRORS_INCLUDE_BODY>
address@hidden example
-
-You can change the layout of the directory browsing page. The line
-below, in @file{myserver.xml}, points to the CSS file used to
-configure the layout for the browsing directory pages:
-
address@hidden
-<BROWSEFOLDER_CSS>system/folderstyle.css</BROWSEFOLDER_CSS>
address@hidden example
-
-CGI Scripts can get the Server Administrator E-mail and show them to
address@hidden Server administrator
+CGI scripts can get the server administrator e-mail and show them to
 the user (through the SERVER_ADMIN environment variable). So, it can
 be important you define this address properly, by setting the value in
 the line below, in @file{myserver.xml}:
 
 @example
-<SERVER_ADMIN>administrator@@localhost</SERVER_ADMIN>
+<SERVER_ADMIN>root@@foo.com</SERVER_ADMIN>
 @end example
-
-MyServer offers the feature to follow symlinks on Unix-like Operating
-systems (e.g.: Linux, *BSD, GNU/HURD, Solaris, etc.).
-You can add the symlink following feature for all hosts in the
address@hidden file.
-
address@hidden
-<FOLLOW_LINKS>YES</FOLLOW_LINKS>
address@hidden example
-
-The default value used by MyServer is:
address@hidden<FOLLOW_LINKS>NO</FOLLOW_LINKS>}.

Added: trunk/myserver/documentation/directory_listing.texi
===================================================================
--- trunk/myserver/documentation/directory_listing.texi                         
(rev 0)
+++ trunk/myserver/documentation/directory_listing.texi 2009-02-27 19:47:06 UTC 
(rev 3016)
@@ -0,0 +1,71 @@
address@hidden -*-texinfo-*-
+
address@hidden Directory Listing
+When a resource mapped to a local directory is requested, MyServer
+shows its content like an usual file manager does.
+
+
address@hidden Default files
+In the @file{myserver.xml} file it is possible to set the default file
+to send instead of the directory content.
+
+Default files are defined using the @code{DEFAULT_FILENAME} element
+and they are checked in the specified order until one is found.
+If a default file can't be found in the directory then its content is
+listed.
+
address@hidden
+<DEFAULT_FILENAME>default.htm</DEFAULT_FILENAME>
+<DEFAULT_FILENAME>index.htm</DEFAULT_FILENAME>
+<DEFAULT_FILENAME>default.html</DEFAULT_FILENAME>
+<DEFAULT_FILENAME>index.html</DEFAULT_FILENAME>
address@hidden example
+
+The previous lines define the order of files that are checked by the
+web server when a directory is requested.
+For example, given the previous configuration and a request to the
address@hidden://foo/bar/} resource, where @file{bar/} is mapped to a
+local directory, the server will look for these files in order:
+
address@hidden
+http://foo/bar/default.htm
+http://foo/bar/index.htm
+http://foo/bar/default.html
+http://foo/bar/index.html
address@hidden example
+
+If that resources don't exist then the content of @file{bar/} is
+listed.
+
address@hidden Directory listing columns
+When the directory content is listed, by default MyServer shows the
+file name, last modified time and file size.  This default bahaviour
+can be changed redefining the @code{http.dir.format} value.
+
+It can be redefined in the local security file, in the virtual host or
+in the global server configuration.
+Its value is a formatting string, columns are showed in the same order
+that they are specified.
+
address@hidden
address@hidden %f
+specifies the file name.
address@hidden %t
+specifies the file last modified time.
address@hidden %s
+specifies the file size.
address@hidden itemize
+
+For example, the @code{%f%s} value displays the file name followed
+by its size, while @code{%f%t} displays the file name and its last
+modified time.
+
address@hidden Directory listing layout
+
+You can change the layout of the directory browsing page. The line
+below, in @file{myserver.xml}, points to the CSS file used to
+configure the layout for the browsing directory pages:
+
address@hidden
+<BROWSEFOLDER_CSS>system/folderstyle.css</BROWSEFOLDER_CSS>
address@hidden example

Added: trunk/myserver/documentation/error_pages.texi
===================================================================
--- trunk/myserver/documentation/error_pages.texi                               
(rev 0)
+++ trunk/myserver/documentation/error_pages.texi       2009-02-27 19:47:06 UTC 
(rev 3016)
@@ -0,0 +1,23 @@
address@hidden -*-texinfo-*-
+
address@hidden Error pages
+It is possible to specify a page when a HTTP error happens using the
+option:
+
address@hidden
+<USE_ERROR_FILE>YES</USE_ERROR_FILE>
address@hidden example
+
+So, if you set the value to @code{NO}, like in the line below,
+
address@hidden
+<USE_ERROR_FILE>NO</USE_ERROR_FILE>
address@hidden example
+
+If an error page is not used MyServer will (by default) just send a
+header to your browser with the error code.
+It is possible to include a HTTP body in the error page, using:
+
address@hidden
+<ERRORS_INCLUDE_BODY>YES</ERRORS_INCLUDE_BODY>
address@hidden example

Modified: trunk/myserver/documentation/mime_types.texi
===================================================================
--- trunk/myserver/documentation/mime_types.texi        2009-02-26 20:26:13 UTC 
(rev 3015)
+++ trunk/myserver/documentation/mime_types.texi        2009-02-27 19:47:06 UTC 
(rev 3016)
@@ -123,3 +123,15 @@
 
 The @code{PATH} regular expressions are checked before the file
 extension, in the order they are specified in the configuration file.
+
address@hidden Symbolic links
+MyServer offers the feature to follow symlinks where they are
+supported.
+You can configure MyServer to follow symbolic links specifying this
+line in the @file{myserver.xml} file.
+
address@hidden
+<FOLLOW_LINKS>YES</FOLLOW_LINKS>
address@hidden example
+
+By default MyServer doesn't follow symbolic links.

Modified: trunk/myserver/documentation/myserver.texi
===================================================================
--- trunk/myserver/documentation/myserver.texi  2009-02-26 20:26:13 UTC (rev 
3015)
+++ trunk/myserver/documentation/myserver.texi  2009-02-27 19:47:06 UTC (rev 
3016)
@@ -69,8 +69,10 @@
 * Process security:: Process security.
 * Security files:: Describe how to use security files.
 * SSL certificates:: Show how to use SSL certificates.
+* Error pages:: How configure error pages.
+* Directory listing:: Show how directories are handled.
 * Log management:: Describe how to use the log management features.
-* Concept index::       An item for each concept.
+* Concept index:: An item for each concept.
 * GNU Free Documentation License:: The license for this documentation.
 @end menu
 
@@ -94,12 +96,22 @@
 @cindex Process security
 @include process_security.texi
 
address@hidden Security files, SSL certificates, Process security, Top
address@hidden Security files, Error pages, Process security, Top
 @chapter Process security
 @cindex Process security
 @include security.texi
 
address@hidden SSL certificates, Log management, Security files, Top
address@hidden Error pages, Directory listing, Security files, Top
address@hidden Error pages
address@hidden Error pages
address@hidden error_pages.texi
+
address@hidden Directory listing, SSL certificates, Error pages, Top
address@hidden Directory listing
address@hidden Directory listing
address@hidden directory_listing.texi
+
address@hidden SSL certificates, Log management, Directory listing, Top
 @chapter SSL certificates
 @cindex SSL certificates
 @include ssl_certificates.texi