Mention Artistic License 2.0 in README

[devedit.git] / README

diff --git a/README b/README
index 9c3808101c5d82ecbac01251ecf66b9af4c458e4..dc80581a1eb403a211c0de900e2605d1f523806e 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,31 @@
-ReadMe for Dev-Editor 3.x.x
-===========================
+ReadMe for Dev-Editor 3.2
+=========================

 
 Description
 -----------
 
 Dev-Editor is a simple CGI based editor written in Perl and licensed under the
 
 Description
 -----------
 
 Dev-Editor is a simple CGI based editor written in Perl and licensed under the

-terms of the Artistic License, which allows remote changes to files and
+terms of the Artistic License 2.0, which allows remote changes to files and

 directory structures on a web server. That's useful if you aren't able to access
 the files on your homepage directly, for example if you are on holiday.
 
 directory structures on a web server. That's useful if you aren't able to access
 the files on your homepage directly, for example if you are on holiday.
 

+Features
+--------
+
+- Browsing through directory structures
+- Viewing text files
+- Editing text files
+- Removing files and directories
+- Moving/renaming files and directories
+- Copying files and directories
+- Creating new files and directories
+- Executing a HTTP download of a file
+- Uploading files to the server via HTTP
+- Changing permissions (chmod) and group (chgrp) of files and directories (on
+  Unix systems)
+- Unpacking some types of archive files (Perl module Archive::Extract is
+  required - core module since Perl 5.10, I guess)
+

 Installation
 ------------
 
 Installation
 ------------
 


@@ -17,7 +34,7 @@ are able to execute scripts (in most cases, this is "cgi-bin"). I suggest to
 create a sub directory for Dev-Editor.
 Then, you have to change the first line of devedit.pl: Just replace
 /usr/bin/perl by the path to your Perl interpreter.
 create a sub directory for Dev-Editor.
 Then, you have to change the first line of devedit.pl: Just replace
 /usr/bin/perl by the path to your Perl interpreter.

-If you are on a UNIX based system, you have to set devedit.pl as executable
+If you are on a Unix based system, you have to set devedit.pl as executable

 (chmod 755 in most cases).
 You will also need to configure Dev-Editor. See the next section for details.
 
 (chmod 755 in most cases).
 You will also need to configure Dev-Editor. See the next section for details.
 


@@ -44,6 +61,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.
 
                          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
 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 +102,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.
 
                          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
 
 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.) get disabled.

 
 userconf_file            Specifies the path to a file which contains
                          user-dependent configuration options (see next section
 
 userconf_file            Specifies the path to a file which contains
                          user-dependent configuration options (see next section


@@ -109,8 +138,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
 
 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
 
 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 +174,8 @@ httproot = /
 aliases = marge bart
 
 Using this, the users whose usernames are "marge" and "bart" use the same
 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.
 
 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.
 


@@ -172,7 +208,7 @@ Hard links are not affected by this.
 ------------------------------------------------
 
 (C) 1999-2000 Roland Bluethgen, Frank Schoenmann
 ------------------------------------------------
 
 (C) 1999-2000 Roland Bluethgen, Frank Schoenmann

-(C) 2003-2009 Patrick Canterino
+(C) 2003-2011 Patrick Canterino

 
 E-Mail: patrick@patshaping.de
 WWW:    http://devedit.sourceforge.net/
\ No newline at end of file
 
 E-Mail: patrick@patshaping.de
 WWW:    http://devedit.sourceforge.net/
\ No newline at end of file