Changeset 315
- Timestamp:
- 08/31/08 19:24:15 (3 months ago)
- Files:
-
- gpgdir/trunk/gpgdir.1 (modified) (10 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
gpgdir/trunk/gpgdir.1
r293 r315 6 6 .B gpgdir 7 7 .SH SYNOPSIS 8 .B gpgdir -e|-d <directory> [options]8 .B gpgdir \-e|\-d <directory> [options] 9 9 .SH DESCRIPTION 10 10 .B gpgdir … … 16 16 the mtime and atime values of all files will be preserved upon encryption and 17 17 decryption (this can be disabled with the 18 .B --no-preserve-times18 .B \-\-no-preserve-times 19 19 option). Note that in 20 .B --encrypt20 .B \-\-encrypt 21 21 mode, gpgdir will delete the original files that 22 22 it successfully encrypts (unless the 23 .B --no-delete23 .B \-\-no-delete 24 24 option is given). However, 25 25 upon startup gpgdir first asks for a the decryption password to be sure that a 26 26 dummy file can successfully be encrypted and decrypted. The initial test can 27 27 be disabled with the 28 .B --skip-test28 .B \-\-skip-test 29 29 option so that a directory can easily be encrypted without having to also 30 30 specify a password (this is consistent with … … 41 41 .B wipe 42 42 program with the 43 .B --Wipe43 .B \-\-Wipe 44 44 command line option to securely delete the original unencrypted files after they 45 45 have been successfully encrypted. This elevates the security stance of gpgdir … … 51 51 .TP 52 52 .BR \-e ", " \-\^\-encrypt\ \<directory> 53 Encrypt the directory specified on the command line. 53 Recursively encrypt all files in the directory specified on the command line. 54 All original files will be deleted (a password check is performed first to make 55 sure that the correct password to unlock the private GnuPG key is known to the 56 user). 54 57 .TP 55 58 .BR \-d ", " \-\^\-decrypt\ \<directory> 56 Decrypt the directory specified on the command line. 59 Recursively decrypt all files in the directory specified on the command line. 60 The encrypted .gpg version of each file will be deleted. 61 .TP 62 .BR \-\^\-sign\ \<directory> 63 Recursively sign all files in the directory specified on the command line. For 64 each file, a detached .asc signature will be created. 65 .TP 66 .BR \-\^\-verify\ \<directory> 67 Recursively verify all .asc signatures for files in the directory specified on the 68 command line. 57 69 .TP 58 70 .BR \-g ", " \-\^\-gnupg-dir\ \<directory> … … 70 82 Run an encryption and decryption test against a dummy file and exit. This 71 83 test is always run by default in both 72 .B --encrypt84 .B \-\-encrypt 73 85 and 74 .B --decrypt86 .B \-\-decrypt 75 87 mode. 76 88 .TP … … 102 114 .B pattern 103 115 as a regex match against each filename. This is similar to the 104 .B --exclude116 .B \-\-exclude 105 117 option in the standard GNU tar command. 106 118 .TP … … 109 121 .B file. 110 122 This is similar to the 111 .B --exclude-from123 .B \-\-exclude-from 112 124 the GNU tar command. 113 125 .TP … … 129 141 Tell 130 142 .B gpgdir 131 to obfuscate the file names of files that it encrypts (in -e mode). The143 to obfuscate the file names of files that it encrypts (in \-e mode). The 132 144 names of each file are stored within the file .gpgdir_map_file for every 133 sub-directory, and this file is itself encrypted. In decryption mode ( -d),134 the -O argument reverses the process so that the original files are145 sub-directory, and this file is itself encrypted. In decryption mode (\-d), 146 the \-O argument reverses the process so that the original files are 135 147 restored. 136 148 .TP … … 168 180 Specify the value of the GPG_AGENT_INFO environment variable as returned 169 181 by the 170 .B gpg-agent --daemon182 .B gpg-agent \-\-daemon 171 183 command. If the 172 .B gpgdir --agent184 .B gpgdir \-\-agent 173 185 command line argument is used instead of 174 .B --Agent-info,186 .B \-\-Agent-info, 175 187 then gpgdir assumes that the GPG_AGENT_INFO environment variable has already 176 188 been set in the current shell. … … 229 241 To encrypt a directory: 230 242 .PP 231 .B $ gpgdir -e /some/dir243 .B $ gpgdir \-e /some/dir 232 244 .PP 233 245 To encrypt a directory, and use the wipe command to securely delete the original 234 246 unencrypted files: 235 247 .PP 236 .B $ gpgdir -W-e /some/dir248 .B $ gpgdir \-W \-e /some/dir 237 249 .PP 238 250 To encrypt a directory with the default GnuPG key defined in ~/.gnupg/options: 239 251 .PP 240 .B $ gpgdir -e /some/dir --Default-key252 .B $ gpgdir \-e /some/dir \-\-Default-key 241 253 .PP 242 254 To decrypt a directory with a key specified in ~/.gpgdirrc: 243 255 .PP 244 .B $ gpgdir -d /some/dir256 .B $ gpgdir \-d /some/dir 245 257 .PP 246 258 To encrypt a directory but skip all filenames that contain the string "host": 247 259 .PP 248 .B $ gpgdir -e /some/dir --Exclude host260 .B $ gpgdir \-e /some/dir \-\-Exclude host 249 261 .PP 250 262 To encrypt a directory but only encrypt those files that contain the string "passwd": 251 263 .PP 252 .B $ gpgdir -e /some/dir --Include passwd264 .B $ gpgdir \-e /some/dir \-\-Include passwd 253 265 .PP 254 266 To acquire the GnuPG key password from a running gpg-agent daemon in order to decrypt 255 267 a directory (this requires that gpg-agent has the password): 256 268 .PP 257 .B $ gpgdir -A /tmp/gpg-H4DBhc/S.gpg-agent:7046:1-d /some/dir269 .B $ gpgdir \-A /tmp/gpg-H4DBhc/S.gpg-agent:7046:1 \-d /some/dir 258 270 .PP 259 271 To encrypt a directory but skip the encryption/decryption test (so you will 260 272 not be prompted for a decryption password): 261 273 .PP 262 .B $ gpgdir -e /some/dir-s274 .B $ gpgdir \-e /some/dir \-s 263 275 .PP 264 276 To encrypt a directory and no subdirectories: 265 277 .PP 266 .B $ gpgdir -e /some/dir --no-recurse278 .B $ gpgdir \-e /some/dir \-\-no-recurse 267 279 .PP 268 280 To encrypt root's home directory, but use the GnuPG keys associated with the user "bob": 269 281 .PP 270 .B # gpgdir -e /root-g /home/bob/.gnupg282 .B # gpgdir \-e /root \-g /home/bob/.gnupg 271 283 .PP 272 284 .SH DEPENDENCIES
