Add LICENSE and README files.

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

diff --git a/doc/README b/doc/README
new file mode 100644 (file)
index 0000000..15073de
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,35 @@
+1. What is it?
+
+A utility to reapply default POSIX ACLs to files and directories.
+
+The way some common utilities handle POSIX ACLs is busted. For more
+info, see [1].
+
+
+2. Requirements
+
+Right now, this will probably only work on Linux because I'm
+lazy. You'll need the sys/acl.h and acl/libacl.h headers from [2], at
+least until I decide to replace acl_get_perm with something portable
+(or just steal it).
+
+
+3. Installation
+
+Run `make` and put the resulting binary somewhere in your $PATH.
+
+
+4. Usage
+
+reapply_default_acl /path/to/whatever
+
+
+5. How to report bugs
+
+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