X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2FREADME;fp=doc%2FREADME;h=15073deba3adf40b3b0f108700dad65ecf8c470c;hb=9b560cbf082997fed089cbc24e994f94691fcd28;hp=0000000000000000000000000000000000000000;hpb=263849b3e05d7ed79fffb0751683ecd740cc90af;p=apply-default-acl.git

diff --git a/doc/README b/doc/README
new file mode 100644
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