doc/COPYING: add one to state the "or later" bit

[apply-default-acl.git] / doc / README

diff --git a/doc/README b/doc/README
index 15073deba3adf40b3b0f108700dad65ecf8c470c..7bdb51fd1e4930f8ba895bee1f248f8459d71964 100644 (file)
--- a/doc/README
+++ b/doc/README
@@ -1,6 +1,6 @@
 1. What is it?
 
-A utility to reapply default POSIX ACLs to files and directories.
+A utility to apply default POSIX ACLs to files and directories.
 
 The way some common utilities handle POSIX ACLs is busted. For more
 info, see [1].
@@ -16,13 +16,22 @@ least until I decide to replace acl_get_perm with something portable
 
 3. Installation
 
-Run `make` and put the resulting binary somewhere in your $PATH.
+It's using GNU Autotools, so run `./configure && make` and maybe `make
+install` if you think it's going to wind up in the right
+place. Otherwise you can just take the binary out of the 'src'
+directory and put it somewhere in your $PATH.
 
 
 4. Usage
 
-reapply_default_acl /path/to/whatever
+Basic usage:
 
+  $ apply-default-acl /path/to/whatever
+
+Work recursively (from the top down):
+
+  $ apply-default-acl --recursive /path/to/whatever
+  $ apply-default-acl -r /path/to/whatever
 
 5. How to report bugs
 
@@ -33,3 +42,4 @@ Email them to me at michael@orlitzky.com.
 [1] http://michael.orlitzky.com/articles/problems_with_posix_acls_and_common_utilities.php
 
 [2] http://savannah.nongnu.org/projects/acl
+