Imported both gpgdir and gpgwrap projects.

[pgp-tools.git] / gpgdir / README

diff --git a/gpgdir/README b/gpgdir/README
new file mode 100644 (file)
index 0000000..03b722a
--- /dev/null
+++ b/gpgdir/README
@@ -0,0 +1,25 @@
+File:     gpgdir
+Author:   Michael Rash <mbr@cipherdyne.org>
+Download: http://www.cipherdyne.org/gpgdir
+License:  GNU General Public License
+Version:  0.9.8
+
+gpgdir is a perl script that uses the CPAN GnuPG::Interface perl module to
+encrypt and decrypt directories using a gpg key specified in ~/.gpgdirrc.
+Gpgdir recursively descends through a directory in order to make sure it
+encrypts or decrypts every file in a directory and all of its subdirectories.
+By default the mtime and atime values of all files will be preserved upon
+encryption and decryption (this can be disabled with the --no-preserve-times
+option).  Note that in --encrypt mode, gpgdir will delete the original files
+that it successfully encrypts (unless the --no-delete option is given).
+However, upon startup gpgdir first asks for the decryption password to be
+sure that a dummy file can successfully be encrypted and decrypted.  The
+initial test can be disabled with the --skip-test option so that a directory
+can easily be encrypted without having to also specify a password (this is
+consistent with gpg behavior).  Also, note that gpgdir is careful not encrypt
+hidden files and directories.  After all, you probably don't want your
+~/.gnupg directory or ~/.bashrc file to be encrypted.
+
+Installation:
+    Just run the install.pl script (as root) that comes with the gpgdir
+    sources.