Imported both gpgdir and gpgwrap projects.
[pgp-tools.git] / gpgdir / README
1 File: gpgdir
2 Author: Michael Rash <mbr@cipherdyne.org>
3 Download: http://www.cipherdyne.org/gpgdir
4 License: GNU General Public License
5 Version: 0.9.8
6
7 gpgdir is a perl script that uses the CPAN GnuPG::Interface perl module to
8 encrypt and decrypt directories using a gpg key specified in ~/.gpgdirrc.
9 Gpgdir recursively descends through a directory in order to make sure it
10 encrypts or decrypts every file in a directory and all of its subdirectories.
11 By default the mtime and atime values of all files will be preserved upon
12 encryption and decryption (this can be disabled with the --no-preserve-times
13 option). Note that in --encrypt mode, gpgdir will delete the original files
14 that it successfully encrypts (unless the --no-delete option is given).
15 However, upon startup gpgdir first asks for the decryption password to be
16 sure that a dummy file can successfully be encrypted and decrypted. The
17 initial test can be disabled with the --skip-test option so that a directory
18 can easily be encrypted without having to also specify a password (this is
19 consistent with gpg behavior). Also, note that gpgdir is careful not encrypt
20 hidden files and directories. After all, you probably don't want your
21 ~/.gnupg directory or ~/.bashrc file to be encrypted.
22
23 Installation:
24 Just run the install.pl script (as root) that comes with the gpgdir
25 sources.