--verbose

Output additional information while running.

--quiet

Try to be as quiet as possible.

--homedir

Set the name of the home directory to dir. If this option is not used, the home directory defaults to ‘~/.gnupg’. It is onlyrecognized when given on the command line. It also overrides any home directory stated through the environment variable‘GNUPGHOME’ or (on Windows systems) by means of the Registry entry HKCU\Software\GNU\GnuPG:HomeDir.On Windows systems it is possible to install GnuPG as a portable application. In this case only this command line option isconsidered, all other ways to set a home directory are ignored.To install GnuPG as a portable application under Windows, create an empty file named ‘gpgconf.ctl’ in the same directory asthe tool ‘gpgconf.exe’. The root of the installation is then that directory; or, if ‘gpgconf.exe’ has been installed directlybelow a directory named ‘bin’, its parent directory. You also need to make sure that the following directories exist and arewritable: ‘ROOT/home’ for the GnuPG home and ‘ROOT/var/cache/gnupg’ for internal cache files.

--agent-program

Specify the agent program to be started if none is running. The default value is determined by running gpgconf with theoption --list-dirs. Note that the pipe symbol (|) is used for a regression test suite hack and may thus not be used in thefile name.

--dirmngr-program

Specify the directory manager (keyserver client) program to be started if none is running. This has only an effect if usedtogether with the option --dirmngr.

--dirmngr

Connect to a running directory manager (keyserver client) instead of to the gpg-agent. If a dirmngr is not running, start it.

--raw-socket

Connect to socket name assuming this is an Assuan style server. Do not run any special initializations or environment checks.This may be used to directly connect to any Assuan style socket server.

--no-ext-connect

When using -S or --exec, gpg-connect-agent connects to the Assuan server in extended mode to allow descriptor passing. Thisoption makes it use the old mode.

--no-autostart

Do not start the gpg-agent or the dirmngr if it has not yet been started.

--run

Run the commands from file at startup and then continue with the regular input method. Note, that commands given on the com‐mand line are executed after this file.

--subst

Run the command /subst at startup.

--hex

Print data lines in a hex format and the ASCII representation of non-control characters.

--decode

Decode data lines. That is to remove percent escapes but make sure that a new line always starts with a D and a space.CONTROL COMMANDSWhile reading Assuan commands, gpg-agent also allows a few special commands to control its operation. These control commands allstart with a slash (/)./echo argsJust print args./let name valueSet the variable name to value. Variables are only substituted on the input if the /subst has been used. Variables are ref‐erenced by prefixing the name with a dollar sign and optionally include the name in curly braces. The rules for a valid nameare identically to those of the standard bourne shell. This is not yet enforced but may be in the future. When used withcurly braces no leading or trailing white space is allowed.If a variable is not found, it is searched in the environment and if found copied to the table of variables.Variable functions are available: The name of the function must be followed by at least one space and the at least one argu‐ment. The following functions are available:get Return a value described by the argument. Available arguments are:cwd The current working directory.homedirThe gnupg homedir.sysconfdirGnuPG's system configuration directory.bindir GnuPG's binary directory.libdir GnuPG's library directory.libexecdirGnuPG's library directory for executable files.datadirGnuPG's data directory.serverpidThe PID of the current server. Command /serverpid must have been given to return a useful value.unescape argsRemove C-style escapes from args. Note that \0 and \x00 terminate the returned string implicitly. The string to beconverted are the entire arguments right behind the delimiting space of the function name.unpercent argsunpercent+ argsRemove percent style escaping from args. Note that %00 terminates the string implicitly. The string to be convertedare the entire arguments right behind the delimiting space of the function name. unpercent+ also maps plus signs to aspaces.percent argspercent+ argsEscape the args using percent style escaping. Tabs, formfeeds, linefeeds, carriage returns and colons are escaped.percent+ also maps spaces to plus signs.errcode argerrsource argerrstring argAssume arg is an integer and evaluate it using strtol. Return the gpg-error error code, error source or a formattedstring with the error code and error source.+

-

*/% Evaluate all arguments as long integers using strtol and apply this operator. A division by zero yields an emptystring.!|& Evaluate all arguments as long integers using strtol and apply the logical operators NOT, OR or AND. The NOT operatorworks on the last argument only./definq name varUse content of the variable var for inquiries with name. name may be an asterisk (*) to match any inquiry./definqfile name fileUse content of file for inquiries with name. name may be an asterisk (*) to match any inquiry./definqprog name progRun prog for inquiries matching name and pass the entire line to it as command line arguments./datafile nameWrite all data lines from the server to the file name. The file is opened for writing and created if it does not exists. Anexisting file is first truncated to 0. The data written to the file fully decoded. Using a single dash for name writes tostdout. The file is kept open until a new file is set using this command or this command is used without an argument./showdefPrint all definitions/cleardefDelete all definitions/sendfd file modeOpen file in mode (which needs to be a valid fopen mode string) and send the file descriptor to the server. This is usuallyfollowed by a command like INPUT FD to set the input source for other commands./recvfdNot yet implemented./open var file [mode]Open file and assign the file descriptor to var. Warning: This command is experimental and might change in future versions./close fdClose the file descriptor fd. Warning: This command is experimental and might change in future versions./showopenShow a list of open files./serverpidSend the Assuan command GETINFO pid to the server and store the returned PID for internal purposes./sleep Sleep for a second./hex/nohex Same as the command line option --hex./decode/nodecodeSame as the command line option --decode./subst/nosubstEnable and disable variable substitution. It defaults to disabled unless the command line option --subst has been used. If/subst as been enabled once, leading whitespace is removed from input lines which makes scripts easier to read./while condition/end These commands provide a way for executing loops. All lines between the while and the corresponding end are executed as longas the evaluation of condition yields a non-zero value or is the string true or yes. The evaluation is done by passing condi‐tion to the strtol function. Example:/subst/let i 3/while $i/echo loop couter is $i/let i ${- $i 1}/end/if condition/end These commands provide a way for conditional execution. All lines between the if and the corresponding end are executed onlyif the evaluation of condition yields a non-zero value or is the string true or yes. The evaluation is done by passing condi‐tion to the strtol function./run fileRun commands from file./bye Terminate the connection and the program./help Print a list of available control commands.