Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022

watchgnupg (1)


watchgnupg - Read and print logs from a socket


watchgnupg [--force] [--verbose] socketname


WATCHGNUPG(1)                GNU Privacy Guard 2.2               WATCHGNUPG(1)

       watchgnupg - Read and print logs from a socket

       watchgnupg [--force] [--verbose] socketname

       Most  of the main utilities are able to write their log files to a Unix
       Domain socket if configured that way.  watchgnupg is a simple  listener
       for  such  a  socket.   It ameliorates the output with a time stamp and
       makes sure that long lines are not interspersed with  log  output  from
       other utilities.  This tool is not available for Windows.

       watchgnupg is commonly invoked as

         watchgnupg --force $(gpgconf --list-dirs socketdir)/S.log

       watchgnupg understands these options:

              Delete an already existing socket file.

       --tcp n
              Instead  of  reading from a local socket, listen for connects on
              TCP port n.

              Do not print the date part of the timestamp.

              Enable extra informational output.

              Print version of the program and exit.

       --help Display a brief help page and exit.

         $ watchgnupg --force --time-only $(gpgconf --list-dirs socketdir)/S.log

       This   waits   for   connections   on   the    local    socket    (e.g.
       `/home/foo/.gnupg/S.log') and shows all log entries.  To make this work
       the option log-file needs to be used with all modules which logs are to
       be shown.  The suggested entry for the configuration files is:

         log-file socket://

       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 `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:

         log-file tcp://

       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 watchgnupg with the tcp option.  Note that under Windows the reg-
       istry  entry  HKCU\Software\GNU\GnuPG:DefaultLogFile  can  be  used  to
       change the default log output from stderr to whatever is given by  that
       entry.   However  the only useful entry is a TCP name for remote debug-

       See attributes(7) for descriptions of the following attributes:

       |Availability   | crypto/gnupg          |
       |Stability      | Pass-through volatile |

       gpg(1), gpgsm(1), gpg-agent(1), scdaemon(1)

       The full documentation for this tool is maintained as a Texinfo manual.
       If  GnuPG and the info program are properly installed at your site, the

         info gnupg

       should give you access to the complete manual including a  menu  struc-
       ture and an index.

       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source                was                downloaded                from

       Further information about this software can be found on the open source
       community website at http://www.gnupg.org/.

GnuPG 2.2.20                      2020-03-18                     WATCHGNUPG(1)