scd: After fatal error, shutdown a reader.
[gnupg.git] / doc / tools.texi
index 37a65d3..9301334 100644 (file)
@@ -20,7 +20,7 @@ GnuPG comes with a couple of smaller tools:
 * dirmngr-client::        How to use the Dirmngr client tool.
 * gpgparsemail::          Parse a mail message into an annotated format
 * symcryptrun::           Call a simple symmetric encryption tool.
-* gpg-zip::               Encrypt or sign files into an archive.
+* gpgtar::                Encrypt or sign files into an archive.
 @end menu
 
 @c
@@ -54,13 +54,14 @@ other utilities.  This tool is not available for Windows.
 @command{watchgnupg} is commonly invoked as
 
 @example
-watchgnupg --force ~/.gnupg/S.log
+watchgnupg --force $(gpgconf --list-dirs socketdir)/S.log
 @end example
 @manpause
 
 @noindent
-This starts it on the current terminal for listening on the socket
-@file{~/.gnupg/S.log}.
+This starts it on the current terminal for listening on the standard
+logging socket (which is either @file{~/.gnupg/S.log} or
+@file{/var/run/user/UID/gnupg/S.log}).
 
 @mansect options
 @noindent
@@ -77,6 +78,10 @@ Delete an already existing socket file.
 Instead of reading from a local socket, listen for connects on TCP port
 @var{n}.
 
+@item --time-only
+@opindex time-only
+Do not print the date part of the timestamp.
+
 @item --verbose
 @opindex verbose
 Enable extra informational output.
@@ -96,21 +101,22 @@ Display a brief help page and exit.
 @chapheading Examples
 
 @example
-$ watchgnupg --force /home/foo/.gnupg/S.log
+$ watchgnupg --force --time-only $(gpgconf --list-dirs socketdir)/S.log
 @end example
 
 This waits for connections on the local socket
-@file{/home/foo/.gnupg/S.log} and shows all log entries.  To make this
-work the option @option{log-file} needs to be used with all modules
-which logs are to be shown.  The value for that option must be given
-with a special prefix (e.g. in the conf files):
+(e.g. @file{/home/foo/.gnupg/S.log}) and shows all log entries.  To
+make this work the option @option{log-file} needs to be used with all
+modules which logs are to be shown.  The suggested entry for the
+configuration files is:
 
 @example
-log-file socket:///home/foo/.gnupg/S.log
+log-file socket://
 @end example
 
-If only @code{socket://} is used a default socket file named
-@file{S.log} in the standard socket directory is used.
+If the default socket as given above and returned by "echo $(gpgconf
+--list-dirs socketdir)/S.log" is not desired an arbitrary socket name
+can be specified, for example @file{socket:///home/foo/bar/mysocket}.
 For debugging purposes it is also possible to do remote logging.  Take
 care if you use this feature because the information is send in the
 clear over the network.  Use this syntax in the conf files:
@@ -119,13 +125,14 @@ clear over the network.  Use this syntax in the conf files:
 log-file tcp://192.168.1.1:4711
 @end example
 
-You may use any port and not just 4711 as shown above; only IP addresses
-are supported (v4 and v6) and no host names.  You need to start
-@command{watchgnupg} with the @option{tcp} option.  Note that under
-Windows the registry entry @var{HKCU\Software\GNU\GnuPG:DefaultLogFile}
-can be used to change the default log output from @code{stderr} to
-whatever is given by that entry.  However the only useful entry is a TCP
-name for remote debugging.
+You may use any port and not just 4711 as shown above; only IP
+addresses are supported (v4 and v6) and no host names.  You need to
+start @command{watchgnupg} with the @option{tcp} option.  Note that
+under Windows the registry entry
+@var{HKCU\Software\GNU\GnuPG:DefaultLogFile} can be used to change the
+default log output from @code{stderr} to whatever is given by that
+entry.  However the only useful entry is a TCP name for remote
+debugging.
 
 
 @mansect see also
@@ -149,7 +156,7 @@ name for remote debugging.
 @c
 @manpage addgnupghome.8
 @node addgnupghome
-@section Create .gnupg home directories.
+@section Create .gnupg home directories
 @ifset manverb
 .B addgnupghome
 \- Create .gnupg home directories
@@ -184,7 +191,7 @@ addgnupghome account1 account2 ... accountn
 @c
 @manpage gpgconf.1
 @node gpgconf
-@section Modify .gnupg home directories.
+@section Modify .gnupg home directories
 @ifset manverb
 .B gpgconf
 \- Modify .gnupg home directories
@@ -250,6 +257,7 @@ throughout this section.
 * Listing options::        List all options of a component.
 * Changing options::       Changing options of a component.
 * Listing global options:: List all global options.
+* Querying versions::      Get and compare software versions.
 * Files used by gpgconf::  What files are used by gpgconf.
 @end menu
 
@@ -278,6 +286,15 @@ Change the options of the component @var{component}.
 @item --check-options @var{component}
 Check the options for the component @var{component}.
 
+@item --apply-profile @var{file}
+Apply the configuration settings listed in @var{file} to the
+configuration files.  If @var{file} has no suffix and no slashes the
+command first tries to read a file with the suffix @code{.prf} from
+the the data directory (@code{gpgconf --list-dirs datadir}) before it
+reads the file verbatim.  A profile is divided into sections using the
+bracketed  component name.  Each section then lists the option which
+shall go into the respective configuration file.
+
 @item --apply-defaults
 Update all configuration files with values taken from the global
 configuration file (usually @file{/etc/gnupg/gpgconf.conf}).
@@ -302,11 +319,27 @@ List the global configuration file in a colon separated format.  If
 Run a syntax check on the global configuration file.  If @var{filename}
 is given, check that file instead.
 
+
+@item --query-swdb @var{package_name} [@var{version_string}]
+Returns the current version for @var{package_name} and if
+@var{version_string} is given also an indicator on whether an update
+is available.  The actual file with the software version is
+automatically downloaded and checked by @command{dirmngr}.
+@command{dirmngr} uses a thresholds to avoid download the file too
+often and it does this by default only if it can be done via Tor.  To
+force an update of that file this command can be used:
+
+@example
+       gpg-connect-agent --dirmngr 'loadswdb --force' /bye
+@end example
+
+
 @item --reload [@var{component}]
 @opindex reload
-Reload all or the given component. This is basically the same as sending
-a SIGHUP to the component.  Components which don't support reloading are
-ignored.
+Reload all or the given component. This is basically the same as
+sending a SIGHUP to the component.  Components which don't support
+reloading are ignored.  Without @var{component} or by using "all" for
+@var{component} all components which are daemons are reloaded.
 
 @item --launch [@var{component}]
 @opindex launch
@@ -314,14 +347,16 @@ If the @var{component} is not already running, start it.
 @command{component} must be a daemon.  This is in general not required
 because the system starts these daemons as needed.  However, external
 software making direct use of @command{gpg-agent} or @command{dirmngr}
-may use this command to ensure that they are started.
+may use this command to ensure that they are started.  Using "all" for
+@var{component} launches all components which are daemons.
 
 @item --kill [@var{component}]
 @opindex kill
 Kill the given component.  Components which support killing are
 @command{gpg-agent} and @command{scdaemon}.  Components which don't
-support reloading are ignored.  Note that as of now reload and kill
-have the same effect for @command{scdaemon}.
+support reloading are ignored.  Using "all" for @var{component} kills
+all components running as daemons.  Note that as of now reload and
+kill have the same effect for @command{scdaemon}.
 
 @item --create-socketdir
 @opindex create-socketdir
@@ -372,6 +407,14 @@ changing.
 This means that the changes will take effect at run-time, as far as
 this is possible.  Otherwise, they will take effect at the next start
 of the respective backend programs.
+
+@item --status-fd @var{n}
+@opindex status-fd
+Write special status strings to the file descriptor @var{n}.  This
+program returns the status messages SUCCESS or FAILURE which are
+helpful when the caller uses a double fork approach and can't easily
+get the return code of the process.
+
 @manpause
 @end table
 
@@ -953,6 +996,85 @@ Unknown record types should be ignored.  Note that there is intentionally
 no feature to change the global option file through @command{gpgconf}.
 
 
+@node Querying versions
+@subsection Get and compare software versions.
+
+The GnuPG Project operates a server to query the current versions of
+software packages related to GnuPG.  @command{gpgconf} can be used to
+access this online database.  To allow for offline operations, this
+feature works by having @command{dirmngr} download a file from
+@code{https://versions.gnupg.org}, checking the signature of that file
+and storing the file in the GnuPG home directory.  If
+@command{gpgconf} is used and @command{dirmngr} is running, it may ask
+@command{dirmngr} to refresh that file before itself uses the file.
+
+The command @option{--query-swdb} returns information for the given
+package in a colon delimited format:
+
+@table @var
+
+@item name
+This is the name of the package as requested.  Note that "gnupg" is a
+special name which is replaced by the actual package implementing this
+version of GnuPG.  For this name it is also not required to specify a
+version because @command{gpgconf} takes its own version in this case.
+
+@item iversion
+The currently installed version or an empty string.  The value is
+taken from the command line argument but may be provided by gpg
+if not given.
+
+@item status
+The status of the software package according to this table:
+@table @code
+@item -
+No information available.  This is either because no current version
+has been specified or due to an error.
+@item ?
+The given name is not known in the online database.
+@item u
+An update of the software is available.
+@item c
+The installed version of the software is current.
+@item n
+The installed version is already newer than the released version.
+@end table
+
+@item urgency
+If the value (the empty string should be considered as zero) is
+greater than zero an important update is available.
+
+@item error
+This returns an @command{gpg-error} error code to distinguish between
+various failure modes.
+
+@item filedate
+This gives the date of the file with the version numbers in standard
+ISO format (@code{yyyymmddThhmmss}).  The date has been extracted by
+@command{dirmngr} from the signature of the file.
+
+@item verified
+This gives the date in ISO format the file was downloaded.  This value
+can be used to evaluate the freshness of the information.
+
+@item version
+This returns the version string for the requested software from the
+file.
+
+@item reldate
+This returns the release date in ISO format.
+
+@item size
+This returns the size of the package as decimal number of bytes.
+
+@item hash
+This returns a hexified SHA-2 hash of the package.
+
+@end table
+
+@noindent
+More fields may be added in future to the output.
+
 
 @mansect files
 @node Files used by gpgconf
@@ -965,6 +1087,12 @@ no feature to change the global option file through @command{gpgconf}.
   If this file exists, it is processed as a global configuration file.
   A commented example can be found in the @file{examples} directory of
   the distribution.
+
+@item @var{GNUPGHOME}/swdb.lst
+@cindex swdb.lst
+  A file with current software versions.  @command{dirmngr} creates
+  this file on demand from an online resource.
+
 @end table
 
 
@@ -985,7 +1113,7 @@ no feature to change the global option file through @command{gpgconf}.
 @c
 @manpage applygnupgdefaults.8
 @node applygnupgdefaults
-@section Run gpgconf for all users.
+@section Run gpgconf for all users
 @ifset manverb
 .B applygnupgdefaults
 \- Run gpgconf --apply-defaults for all users.
@@ -1018,7 +1146,7 @@ applygnupgdefaults
 @c   GPG-PRESET-PASSPHRASE
 @c
 @node gpg-preset-passphrase
-@section Put a passphrase into the cache.
+@section Put a passphrase into the cache
 @manpage gpg-preset-passphrase.1
 @ifset manverb
 .B gpg-preset-passphrase
@@ -1040,6 +1168,8 @@ useful for unattended machines, where the usual @command{pinentry} tool
 may not be used and the passphrases for the to be used keys are given at
 machine startup.
 
+This program works with GnuPG 2 and later.  GnuPG 1.x is not supported.
+
 Passphrases set with this utility don't expire unless the
 @option{--forget} option is used to explicitly clear them from the
 cache --- or @command{gpg-agent} is either restarted or reloaded (by
@@ -1054,7 +1184,7 @@ this passphrase presetting by starting @command{gpg-agent} with the
 
 @manpause
 @node Invoking gpg-preset-passphrase
-@subsection List of all commands and options.
+@subsection List of all commands and options
 @mancont
 
 @noindent
@@ -1067,10 +1197,12 @@ gpg-preset-passphrase [options] [command] @var{cacheid}
 @var{cacheid} is either a 40 character keygrip of hexadecimal
 characters identifying the key for which the passphrase should be set
 or cleared.  The keygrip is listed along with the key when running the
-command: @code{gpgsm --dump-secret-keys}.  Alternatively an arbitrary
-string may be used to identify a passphrase; it is suggested that such
-a string is prefixed with the name of the application (e.g
-@code{foo:12346}).
+command: @code{gpgsm --with-keygrip --list-secret-keys}.
+Alternatively an arbitrary string may be used to identify a
+passphrase; it is suggested that such a string is prefixed with the
+name of the application (e.g @code{foo:12346}).  Scripts should always
+use the option @option{--with-colons}, which provides the keygrip in a
+"grp" line (cf. @file{doc/DETAILS})/
 
 @noindent
 One of the following command options must be given:
@@ -1121,7 +1253,7 @@ for other users.
 @c   GPG-CONNECT-AGENT
 @c
 @node gpg-connect-agent
-@section Communicate with a running agent.
+@section Communicate with a running agent
 @manpage gpg-connect-agent.1
 @ifset manverb
 .B gpg-connect-agent
@@ -1151,7 +1283,7 @@ here we connect to a running instance.
 
 @manpause
 @node Invoking gpg-connect-agent
-@subsection List of all options.
+@subsection List of all options
 
 @noindent
 @command{gpg-connect-agent} is invoked this way:
@@ -1251,7 +1383,7 @@ a new line always starts with a D and a space.
 
 @mansect control commands
 @node Controlling gpg-connect-agent
-@subsection Control commands.
+@subsection Control commands
 
 While reading Assuan commands, gpg-agent also allows a few special
 commands to control its operation.  These control commands all start
@@ -1542,7 +1674,7 @@ abbreviate this command.
 @item --help, -h
 @opindex help
 Print a usage message summarizing the most useful command-line options.
-Note that you can abbreviate this command.
+Note that you cannot abbreviate this command.
 
 @item --quiet, -q
 @opindex quiet
@@ -1652,7 +1784,7 @@ debugging.  Run it with @code{--help} for usage information.
 @c   SYMCRYPTRUN
 @c
 @node symcryptrun
-@section Call a simple symmetric encryption tool.
+@section Call a simple symmetric encryption tool
 @manpage symcryptrun.1
 @ifset manverb
 .B symcryptrun
@@ -1692,7 +1824,7 @@ configured with @samp{--enable-symcryptrun} at build time.
 
 @manpause
 @node Invoking symcryptrun
-@subsection List of all commands and options.
+@subsection List of all commands and options
 
 @noindent
 @command{symcryptrun} is invoked this way:
@@ -1770,23 +1902,19 @@ The possible exit status codes of @command{symcryptrun} are:
 
 
 @c
-@c  GPG-ZIP
+@c  GPGTAR
 @c
-@c The original manpage on which this section is based was written
-@c by Colin Tuckley  <colin@tuckley.org> and Daniel Leidert
-@c <daniel.leidert@wgdd.de> for the Debian distribution (but may be used by
-@c others).
-@manpage gpg-zip.1
-@node gpg-zip
+@manpage gpgtar.1
+@node gpgtar
 @section Encrypt or sign files into an archive
 @ifset manverb
-.B gpg-zip
+.B gpgtar
 \- Encrypt or sign files into an archive
 @end ifset
 
 @mansect synopsis
 @ifset manverb
-.B  gpg-zip
+.B  gpgtar
 .RI [ options ]
 .I filename1
 .I [ filename2, ... ]
@@ -1795,61 +1923,130 @@ The possible exit status codes of @command{symcryptrun} are:
 @end ifset
 
 @mansect description
-@command{gpg-zip} encrypts or signs files into an archive.  It is an
+@command{gpgtar} encrypts or signs files into an archive.  It is an
 gpg-ized tar using the same format as used by PGP's PGP Zip.
 
 @manpause
 @noindent
-@command{gpg-zip} is invoked this way:
+@command{gpgtar} is invoked this way:
 
 @example
-gpg-zip [options] @var{filename1} [@var{filename2}, ...] @var{directory} [@var{directory2}, ...]
+gpgtar [options] @var{filename1} [@var{filename2}, ...] @var{directory} [@var{directory2}, ...]
 @end example
 
 @mansect options
 @noindent
-@command{gpg-zip} understands these options:
+@command{gpgtar} understands these options:
 
 @table @gnupgtabopt
 
+@item --create
+@opindex create
+Put given files and directories into a vanilla ``ustar'' archive.
+
+@item --extract
+@opindex extract
+Extract all files from a vanilla ``ustar'' archive.
+
 @item --encrypt
 @itemx -e
 @opindex encrypt
-Encrypt data.  This option may be combined with @option{--symmetric} (for  output that may be decrypted via a secret key or a passphrase).
+Encrypt given files and directories into an archive.  This option may
+be combined with option @option{--symmetric} for an archive that may
+be decrypted via a secret key or a passphrase.
 
 @item --decrypt
 @itemx -d
 @opindex decrypt
-Decrypt data.
+Extract all files from an encrypted archive.
+
+@item --sign
+@itemx -s
+Make a signed archive from the given files and directories.  Thsi can
+be combined with option @option{--encrypt} to create a signed and then
+encrypted archive.
+
+@item --list-archive
+@itemx -t
+@opindex list-archive
+List the contents of the specified archive.
 
 @item --symmetric
 @itemx -c
 Encrypt with a symmetric cipher using a passphrase.  The default
-symmetric cipher used is CAST5, but may be chosen with the
+symmetric cipher used is @value{GPGSYMENCALGO}, but may be chosen with the
 @option{--cipher-algo} option to @command{gpg}.
 
-@item --sign
-@itemx -s
-Make a signature.  See @command{gpg}.
-
 @item --recipient @var{user}
 @itemx -r @var{user}
 @opindex recipient
-Encrypt for user id @var{user}. See @command{gpg}.
+Encrypt for user id @var{user}. For details see @command{gpg}.
 
 @item --local-user @var{user}
 @itemx -u @var{user}
 @opindex local-user
-Use @var{user} as the key to sign with.  See @command{gpg}.
-
-@item --list-archive
-@opindex list-archive
-List the contents of the specified archive.
+Use @var{user} as the key to sign with.  For details see @command{gpg}.
 
 @item --output @var{file}
 @itemx -o @var{file}
 @opindex output
-Write output to specified file @var{file}.
+Write the archive to the specified file @var{file}.
+
+@item --verbose
+@itemx -v
+@opindex verbose
+Enable extra informational output.
+
+@item --quiet
+@itemx -q
+@opindex quiet
+Try to be as quiet as possible.
+
+@item --skip-crypto
+@opindex skip-crypto
+Skip all crypto operations and create or extract vanilla ``ustar''
+archives.
+
+@item --dry-run
+@opindex dry-run
+Do not actually output the extracted files.
+
+@item --directory @var{dir}
+@itemx -C @var{dir}
+@opindex directory
+Extract the files into the directory @var{dir}.  The
+default is to take the directory name from
+the input filename.  If no input filename is known a directory named
+@file{GPGARCH} is used.
+
+@item --files-from @var{file}
+@itemx -T @var{file}
+Take the file names to work from the file @var{file}; one file per
+line.
+
+@item --null
+@opindex null
+Modify option @option{--files-from} to use a binary nul instead of a
+linefeed to separate file names.
+
+@item --openpgp
+@opindex openpgp
+This option has no effect becuase OpenPGP encryption and signing is
+the default.
+
+@item --cms
+@opindex cms
+This option is reserved and shall not be used.  It will eventually be
+used to encrypt or sign using the CMS protocol; but that is not yet
+implemented.
+
+
+@item --set-filename @var{file}
+@opindex set-filename
+Use the last component of @var{file} as the output directory.  The
+default is to take the directory name from the input filename.  If no
+input filename is known a directory named @file{GPGARCH} is used.
+This option is deprecated in favor of option @option{--directory}.
 
 @item --gpg @var{gpgcmd}
 @opindex gpg
@@ -1857,15 +2054,14 @@ Use the specified command @var{gpgcmd} instead of @command{gpg}.
 
 @item --gpg-args @var{args}
 @opindex gpg-args
-Pass the specified options to @command{gpg}.
-
-@item --tar @var{tarcmd}
-@opindex tar
-Use the specified command @var{tarcmd} instead of @command{tar}.
+Pass the specified extra options to @command{gpg}.
 
 @item --tar-args @var{args}
 @opindex tar-args
-Pass the specified options to @command{tar}.
+Assume @var{args} are standard options of the command @command{tar}
+and parse them.  The only supported tar options are "--directory",
+"--files-from", and "--null" This is an obsolete options because those
+supported tar options can also be given directly.
 
 @item --version
 @opindex version
@@ -1893,14 +2089,14 @@ Encrypt the contents of directory @file{mydocs} for user Bob to file
 @file{test1}:
 
 @example
-gpg-zip --encrypt --output test1 --gpg-args  -r Bob mydocs
+gpgtar --encrypt --output test1 -r Bob mydocs
 @end example
 
 @noindent
 List the contents of archive @file{test1}:
 
 @example
-gpg-zip --list-archive test1
+gpgtar --list-archive test1
 @end example