Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 215 lines (209 sloc) 6.353 kb
1fcd8fa2 »
2003-02-25 add gpgdir man page
1 .\" Process this file with
2 .\" groff -man -Tascii foo.1
3 .\"
6d5d0484 »
2006-09-07 minor bugfix for gpgdir(1) man page section designation
4 .TH GPGDIR 1 "February, 2003" Linux
1fcd8fa2 »
2003-02-25 add gpgdir man page
5 .SH NAME
6 .B gpgdir
7 .SH SYNOPSIS
a6dd1229 »
2004-04-24 added -p option, various wording updates
8 .B gpgdir [-e
9 .I directory
10 .B ] [-d
11 .I directory
e96632fa »
2004-09-11 updated to include -g option
12 .B ] [-g
13 .I directory
6b0bb172 »
2005-01-05 updated to 0.9.2 options
14 .B ] [-p
15 .I pw-file
16 .B ] [--Exclude
8c52dcb0 »
2004-05-29 added --Exclude and --Exclude-from options
17 .I pattern
18 .B ] [--Exclude-from
19 .I file
31a9e9ed »
2005-02-20 added --Include and --Include-from options
20 .B ] [--Include
21 .I pattern
22 .B ] [--Include-from
23 .I file
7b7dc537 »
2006-09-09 added --Key-id command line argument so that use_key can be overridde…
24 .B ] [-K
25 .I Key-ID
7c8f2612 »
2006-09-13 added --Default-key option
26 .B ] [-D] [--no-recurse] [--no-delete] [--no-preserve-times] [-t] [-s] [-V] [-v] [-h]
1fcd8fa2 »
2003-02-25 add gpgdir man page
27 .SH DESCRIPTION
28 .B gpgdir
f1e66488 »
2006-07-04 merged changes from gpgdir_GPGINTERFACE branch for GunPG::Interface u…
29 is a perl script that uses the CPAN GnuPG::Interface perl module to encrypt and decrypt
a6dd1229 »
2004-04-24 added -p option, various wording updates
30 directories using a gpg key specified in ~/.gpgdirrc.
31 .B gpgdir
32 recursively descends through a directory in order to make sure it encrypts or
6b0bb172 »
2005-01-05 updated to 0.9.2 options
33 decrypts every file in a directory and all of its subdirectories. By default
34 the mtime and atime values of all files will be preserved upon encryption and
35 decryption (this can be disabled with the
36 .B --no-preserve-times
37 option). Note that in
38 .B --encrypt
39 mode, gpgdir will delete the original files that
40 it successfully encrypts (unless the
41 .B --no-delete
42 option is given). However,
43 upon startup gpgdir first asks for a the decryption password to be sure that a
44 dummy file can successfully be encrypted and decrypted. The initial test can
45 be disabled with the
46 .B --skip-test
47 option so that a directory can easily be encrypted without having to also
48 specify a password (this is consistent with
49 .B gpg
50 behavior). Also, note that gpgdir is careful not encrypt hidden files and
51 directories. After all, you probably don't want your ~/.gnupg directory or
52 ~/.bashrc file to be encrypted.
1fcd8fa2 »
2003-02-25 add gpgdir man page
53
54 .SH OPTIONS
f43f1363 »
2006-09-08 bugfix for missing .TP tag
55 .TP
1fcd8fa2 »
2003-02-25 add gpgdir man page
56 .BR \-e ", " \-\^\-encrypt\ \<directory>
57 Encrypt the directory specified on the command line.
58 .TP
59 .BR \-d ", " \-\^\-decrypt\ \<directory>
60 Decrypt the directory specified on the command line.
61 .TP
e96632fa »
2004-09-11 updated to include -g option
62 .BR \-g ", " \-\^\-gnupg-dir\ \<directory>
7c8f2612 »
2006-09-13 added --Default-key option
63 Specify which .gnupg directory will be used to find GnuPG keys. The default
e96632fa »
2004-09-11 updated to include -g option
64 is ~/.gnupg if this option is not used. This option allows gpgdir to be
65 run as one user but use the keys of another user (assuming permissions are
66 setup correctly, etc.).
67 .TP
6b0bb172 »
2005-01-05 updated to 0.9.2 options
68 .BR \-p ", " \-\^\-pw-file\ \<pw-file>
69 Read decryption password from
70 .B pw-file
71 instead of typing it on the command line.
72 .TP
73 .BR \-t ", " \-\^\-test-mode
74 Run an encryption and decryption test against a dummy file and exit. This
75 test is always run by default in both
76 .B --encrypt
77 and
78 .B --decrypt
79 mode.
1fcd8fa2 »
2003-02-25 add gpgdir man page
80 .TP
8c52dcb0 »
2004-05-29 added --Exclude and --Exclude-from options
81 .BR \-\^\-Exclude\ \<pattern>
82 Instruct gpgdir to skip all files that match
83 .B pattern
84 as a regex match against each filename. This is similar to the
85 .B --exclude
86 option in the standard GNU tar command.
87 .TP
88 .BR \-\^\-Exclude-from\ \<file>
89 Instruct gpgdir to exclude all files matched by patterns listed in
90 .B file.
91 This is similar to the
92 .B --exclude-from
93 the GNU tar command.
94 .TP
31a9e9ed »
2005-02-20 added --Include and --Include-from options
95 .BR \-\^\-Include\ \<pattern>
96 Instruct gpgdir to only include files that match
97 .B pattern
98 as a regex match against each filename.
99 .TP
100 .BR \-\^\-Include-from\ \<file>
101 Instruct gpgdir to only include files matched by patterns listed in
102 .B file.
103 .TP
7b7dc537 »
2006-09-09 added --Key-id command line argument so that use_key can be overridde…
104 .BR \-K ", " \-\^\-Key-id\ \<id>
105 Manually specify a GnuPG key ID from the command line. Because GnuPG
106 supports matching keys with a string,
107 .B id
108 does not strictly have to be a key ID; it can be a string that uniquely
109 matches a key in the GnuPG key ring.
110 .TP
7c8f2612 »
2006-09-13 added --Default-key option
111 .BR \-D ", " \-\^\-Default-key
112 Use the key that GnuPG defines as the default, i.e. the key that is specified
113 by the
114 .B default-key
115 variable in ~/.gnupg/options. If the default-key variable is not defined
116 within ~/.gnupg/options, then GnuPG tries to use the first suitable key on
117 its key ring (the initial encrypt/decrypt test makes sure that the user
118 knows the corresponding password for the key).
119 .TP
6b0bb172 »
2005-01-05 updated to 0.9.2 options
120 .BR " \-\^\-skip-test
121 Skip encryption and decryption test. This will allow
122 .B gpgdir
123 to be used to encrypt a directory without specifying a password (which
124 normally gets used in encryption mode to test to make sure decryption
125 against a dummy file works properly).
a1e283e5 »
2003-07-26 updated command line args
126 .TP
6b0bb172 »
2005-01-05 updated to 0.9.2 options
127 .BR \-\^\-no-recurse
128 Instruct gpgdir to not recurse through any subdirectories of the directory
129 that is being encrypted or decrypted.
a1e283e5 »
2003-07-26 updated command line args
130 .TP
6b0bb172 »
2005-01-05 updated to 0.9.2 options
131 .BR \-\^\-no-delete
132 Instruct gpgdir to not delete original files at encrypt time.
133 .TP
134 .BR \-\^\-no-preserve times
135 Instruct gpgdir to not preserve original file mtime and atime values
136 upon encryption or decryption.
137 .TP
138 .BR \-v ", " \-\^\-verbose
139 Run in verbose mode.
a6dd1229 »
2004-04-24 added -p option, various wording updates
140 .TP
6b0bb172 »
2005-01-05 updated to 0.9.2 options
141 .BR \-V ", " \-\^\-Version
a1e283e5 »
2003-07-26 updated command line args
142 Print version number and exit.
143 .TP
144 .BR \-h ", " \-\^\-help
145 Print usage information and exit.
146 .TP
1fcd8fa2 »
2003-02-25 add gpgdir man page
147 .SH FILES
148 .B ~/.gpgdirrc
149 .RS
150 Contains the key id of the user gpg key that will be used to encrypt
151 or decrypt the files within a directory.
152 .RE
40a103a5 »
2006-01-16 format fixes
153 .PP
1fcd8fa2 »
2003-02-25 add gpgdir man page
154 .SH EXAMPLES
155 The following examples illustrate the command line arguments that could
156 be supplied to gpgdir in a few situations:
40a103a5 »
2006-01-16 format fixes
157 .PP
1fcd8fa2 »
2003-02-25 add gpgdir man page
158 To encrypt a directory:
40a103a5 »
2006-01-16 format fixes
159 .PP
1fcd8fa2 »
2003-02-25 add gpgdir man page
160 .B $ gpgdir -e ~/testdir
40a103a5 »
2006-01-16 format fixes
161 .PP
7c8f2612 »
2006-09-13 added --Default-key option
162 To encrypt a directory with the default GnuPG key defined in ~/.gnupg/options:
163 .PP
164 .B $ gpgdir -e ~/testdir --Default-key
165 .PP
166 To decrypt a directory with a key specified in ~/.gpgdirrc:
40a103a5 »
2006-01-16 format fixes
167 .PP
1fcd8fa2 »
2003-02-25 add gpgdir man page
168 .B $ gpgdir -d ~/testdir
40a103a5 »
2006-01-16 format fixes
169 .PP
8c52dcb0 »
2004-05-29 added --Exclude and --Exclude-from options
170 To encrypt a directory but skip all filenames that contain the string "host":
40a103a5 »
2006-01-16 format fixes
171 .PP
8c52dcb0 »
2004-05-29 added --Exclude and --Exclude-from options
172 .B $ gpgdir -e ~/testdir --Exclude host
40a103a5 »
2006-01-16 format fixes
173 .PP
31a9e9ed »
2005-02-20 added --Include and --Include-from options
174 To encrypt a directory but only encrypt those files that contain the string "passwd":
40a103a5 »
2006-01-16 format fixes
175 .PP
31a9e9ed »
2005-02-20 added --Include and --Include-from options
176 .B $ gpgdir -e ~/testdir --Include passwd
40a103a5 »
2006-01-16 format fixes
177 .PP
414e53ec »
2005-01-06 updated docs
178 To encrypt a directory but skip the encryption/decryption test (so you will
179 not be prompted for a decryption password):
40a103a5 »
2006-01-16 format fixes
180 .PP
414e53ec »
2005-01-06 updated docs
181 .B $ gpgdir -e ~/testdir -s
40a103a5 »
2006-01-16 format fixes
182 .PP
1fcd8fa2 »
2003-02-25 add gpgdir man page
183 To encrypt a directory and no subdirectories:
40a103a5 »
2006-01-16 format fixes
184 .PP
a1e283e5 »
2003-07-26 updated command line args
185 .B $ gpgdir -e /home/user/testdir --no-recurse
40a103a5 »
2006-01-16 format fixes
186 .PP
7c8f2612 »
2006-09-13 added --Default-key option
187 To encrypt root's home directory, but use the GnuPG keys associated with the user "bob":
40a103a5 »
2006-01-16 format fixes
188 .PP
e96632fa »
2004-09-11 updated to include -g option
189 .B # gpgdir -e /root -g /home/bob/.gnupg
40a103a5 »
2006-01-16 format fixes
190 .PP
1fcd8fa2 »
2003-02-25 add gpgdir man page
191 .SH DEPENDENCIES
192 .B gpgdir
a6dd1229 »
2004-04-24 added -p option, various wording updates
193 requires that gpg, the Gnu Privacy Guard (http://www.gnupg.org) is installed.
8c52dcb0 »
2004-05-29 added --Exclude and --Exclude-from options
194 .B gpgdir
f1e66488 »
2006-07-04 merged changes from gpgdir_GPGINTERFACE branch for GunPG::Interface u…
195 also requires the GnuPG::Interface perl module from CPAN, but it is bundled with
8c52dcb0 »
2004-05-29 added --Exclude and --Exclude-from options
196 .B gpgdir
197 and is installed in /usr/lib/gpgdir at install-time so it does not pollute the
198 system perl library tree.
1fcd8fa2 »
2003-02-25 add gpgdir man page
199
200 .SH "SEE ALSO"
a6dd1229 »
2004-04-24 added -p option, various wording updates
201 .BR gpg (1)
1fcd8fa2 »
2003-02-25 add gpgdir man page
202
203 .SH AUTHOR
a6dd1229 »
2004-04-24 added -p option, various wording updates
204 Michael Rash <mbr@cipherdyne.org>
1fcd8fa2 »
2003-02-25 add gpgdir man page
205
206 .SH BUGS
a1e283e5 »
2003-07-26 updated command line args
207 Send bug reports to mbr@cipherdyne.org. Suggestions and/or comments are
1fcd8fa2 »
2003-02-25 add gpgdir man page
208 always welcome as well.
209
210 .SH DISTRIBUTION
211 .B gpgdir
212 is distributed under the GNU General Public License (GPL), and the latest
213 version may be downloaded from
a1e283e5 »
2003-07-26 updated command line args
214 .B http://www.cipherdyne.org
Something went wrong with that request. Please try again.