- Updated ReadMe

[devedit.git] / README

diff --git a/README b/README
index 9c3808101c5d82ecbac01251ecf66b9af4c458e4..d887a35d03beb99009c4eb0d1040f19f1feae3ab 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-ReadMe for Dev-Editor 3.x.x
-===========================
+ReadMe for Dev-Editor 3.1
+=========================
 
 Description
 -----------
@@ -44,6 +44,9 @@ httproot                 This is the equivalent HTTP URL to the root directory.
                          It's just used for visual output, so it doesn't need to
                          be correct.
 
+startdir                 Here you may define the default directory Dev-Editor
+                         opens on start.
+
 max_file_size            Here you may define a maximum size for files (Bytes).
                          If the user wants to view or edit a file larger than
                          this defined size, Dev-Editor denies file access (but
@@ -82,16 +85,25 @@ 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.
 
-hide_dot_files           Set this option to 1 if you want to hide files
-                         beginning with a dot (e.g. ".htaccess") in directory
-                         listing.
+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").
+                         it into double quotation marks ("/file name").
+
+disable_commands         Specify a list of commands the user is not allowed to
+                         execute. The commands have to be separated by space
+                         characters.
+                         If you add "@write" to the list, all writing commands
+                         (for example edit, copy, rename etc.) are disabled.
 
 userconf_file            Specifies the path to a file which contains
                          user-dependent configuration options (see next section
@@ -109,8 +121,15 @@ 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 "fileroot", "httproot" and
-"forbidden".
+list of users. You may override the values for the following configuration
+options:
+
+- fileroot
+- httproot
+- startdir
+- hide_dot_files
+- forbidden
+- disable_commands
 
 For overriding configuration values you need a special configuration file. The
 path to this file is defined using the "userconf_file" configuration option in
@@ -138,8 +157,8 @@ 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.
+configuration as "homer". You can place an arbitrary number of usernames
+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.