wks: Allow reading of --install-key arguments from stdin.
[gnupg.git] / doc / opt-homedir.texi
1 @c This option is included at several places.
2 @item --homedir @var{dir}
3 @opindex homedir
4 @efindex GNUPGHOME
5 @efindex HKCU\Software\GNU\GnuPG:HomeDir
6 Set the name of the home directory to @var{dir}. If this option is not
7 used, the home directory defaults to @file{~/.gnupg}.  It is only
8 recognized when given on the command line.  It also overrides any home
9 directory stated through the environment variable @env{GNUPGHOME} or
10 (on Windows systems) by means of the Registry entry
11 @var{HKCU\Software\GNU\GnuPG:HomeDir}.
12
13 On Windows systems it is possible to install GnuPG as a portable
14 application.  In this case only this command line option is
15 considered, all other ways to set a home directory are ignored.
16
17 @efindex gpgconf.ctl
18 To install GnuPG as a portable application under Windows, create an
19 empty file named @file{gpgconf.ctl} in the same directory as the tool
20 @file{gpgconf.exe}.  The root of the installation is then that
21 directory; or, if @file{gpgconf.exe} has been installed directly below
22 a directory named @file{bin}, its parent directory.  You also need to
23 make sure that the following directories exist and are writable:
24 @file{ROOT/home} for the GnuPG home and @file{ROOT@value{LOCALCACHEDIR}}
25 for internal cache files.