Some changes in README file

[devedit.git] / README

diff --git a/README b/README
index c20d6fa5dc58035d70b24b4da6e194b533bb7865..3b3e27663ea6c80d3c6c4623bd1eb099e5f1cd6d 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-ReadMe for Dev-Editor 3.0 (CVS)
-===============================
+ReadMe for Dev-Editor 3.x.x
+===========================
 
 Description
 -----------
@@ -29,7 +29,7 @@ Configuration
 -------------
 
 Open the file devedit.conf. This file contains keys and values separated by a
-"=" sign.
+"=" sign. Lines beginning with a "#" sign are ignored.
 Here is a list of the configuration options currently available:
 
 Option                   Description
@@ -82,9 +82,23 @@ use_gmt                  Set this option to 1 if you want to use Greenwich Mean
                          Time (GMT/UTC) in directory listing and in the About
                          dialogue instead of the local time.
 
-forbidden                Specify . The filenames have to be separated by space characters.
-                         If a filename contains space characters, you have to
-                         put it into double quotation marks ("/filename").
+hide_dot_files           Set this option to 1 if you want to hide files or
+                         directories beginning with a dot (e.g. ".htaccess") in
+                         directory listing.
+                         The files are just hidden in the directory listing,
+                         you can still access them typing the name into the
+                         "Go to directory/file" box.
+
+forbidden                Specify a list of filenames the user is not allowed to
+                         access. The filenames have to be relative to the
+                         virtual root directory (they must also begin with a
+                         slash) and have to be separated by space characters. If
+                         a filename contains space characters, you have to put
+                         it into double quotation marks ("/filename").
+
+userconf_file            Specifies the path to a file which contains
+                         user-dependent configuration options (see next section
+                         for details).
 
 error_file               The path to the file which defines the error messages.
                          The file has the same format as this one.
@@ -93,6 +107,61 @@ template_file            The path to the file which defines the paths to the
                          template files. The file has the same format as this
                          one.
 
+User-dependent configuration
+----------------------------
+
+If you have placed Dev-Editor inside a directory protected using HTTP
+authentication, you may override some default configuration values for a defined
+list of users. You may override the values for the following configuration
+options:
+
+- fileroot
+- httproot
+- hide_dot_files
+- forbidden
+
+For overriding configuration values you need a special configuration file. The
+path to this file is defined using the "userconf_file" configuration option in
+the main configuration file (add the option if necessary). This file consists of
+key-value-pairs and sections, marked by a string encapsulated in square brackets
+(perhaps you know this format, it is nearly the same as the Windows INI files).
+Each section in this file describes an individual configuration, whereby the
+name of the section is the username for whom this configuration should be used.
+Here is an example:
+
+[homer]
+fileroot = /var/www/homer/htdocs
+httproot = /
+
+This sets the physical file root directory to "/var/www/homer/htdocs" and the
+virtual HTTP root to "/" - but only for the user whose HTTP authentication
+username is "homer".
+
+Using the "aliases" option, you may also define some other usernames for whom
+this configuration should be used:
+
+[homer]
+fileroot = /var/www/homer/htdocs
+httproot = /
+aliases = marge bart
+
+Using this, the users whose usernames are "marge" and "bart" use the same
+configuration as "homer". Place any number of username seperated by whitespaces
+here.
+Note: If one of the users mentioned as an alias and an individual configuration
+section for this user exists too, the one mentioned as an alias is ignored.
+
+If there are some files marked as inaccessible using the "forbidden"
+configuration option in the main configuration file, but some users should have
+access to these files, you may clear the default value of "forbidden":
+
+[homer]
+fileroot = /var/www/homer/htdocs
+httproot = /
+forbidden =
+
+Using this, "homer" has access to all files in "/var/www/homer/htdocs".
+
 Notes
 -----
 
@@ -111,7 +180,7 @@ Hard links are not affected by this.
 ------------------------------------------------
 
 (C) 1999-2000 Roland Bluethgen, Frank Schoenmann
-(C) 2003-2005 Patrick Canterino
+(C) 2003-2009 Patrick Canterino
 
 E-Mail: patrick@patshaping.de
 WWW:    http://devedit.sourceforge.net/
\ No newline at end of file