1WATCHGNUPG(1)                GNU Privacy Guard 2.4               WATCHGNUPG(1)
2
3
4

NAME

6       watchgnupg - Read and print logs from a socket
7

SYNOPSIS

9       watchgnupg [--force] [--verbose] socketname
10
11

DESCRIPTION

13       Most  of the main utilities are able to write their log files to a Unix
14       Domain socket if configured that way.  watchgnupg is a simple  listener
15       for  such  a  socket.   It ameliorates the output with a time stamp and
16       makes sure that long lines are not interspersed with  log  output  from
17       other utilities.  This tool is not available for Windows.
18
19
20       watchgnupg is commonly invoked as
21
22         watchgnupg
23
24       which is a shorthand for
25
26         watchgnupg --force $(gpgconf --list-dirs socketdir)/S.log
27
28       To watch GnuPG running with a different home directory, use
29
30         watchgnupg --homedir DIR
31
32

OPTIONS

34       watchgnupg understands these options:
35
36
37
38       --force
39              Delete  an already existing socket file.  This option is implic‐
40              itly used if no socket name has been given on the command line.
41
42
43       --homedir DIR
44              If no socket name is given on the command line, pass DIR to gpg‐
45              conf  so  that  the  socket for a GnuPG running with DIR has its
46              home directory is used.   Note  that  the  environment  variable
47              GNUPGHOME is ignored by watchgnupg.
48
49
50
51       --tcp n
52              Instead  of  reading from a local socket, listen for connects on
53              TCP port n.  A Unix domain socket can optionally also  be  given
54              as  a  second source.  This option does not use a default socket
55              name.
56
57
58       --time-only
59              Do not print the date part of the timestamp.
60
61
62       --verbose
63              Enable extra informational output.
64
65
66       --version
67              Print version of the program and exit.
68
69
70       --help Display a brief help page and exit.
71
72

EXAMPLES

74         $ watchgnupg --time-only
75
76       This   waits   for   connections   on   the    local    socket    (e.g.
77       ‘/var/run/user/1234/gnupg/S.log’)  and  shows all log entries.  To make
78       this work the option log-file needs to be used with all  modules  which
79       logs  are to be shown.  The suggested entry for the configuration files
80       is:
81
82         log-file socket://
83
84       If the default socket as given above and returned  by  "echo  $(gpgconf
85       --list-dirs  socketdir)/S.log"  is not desired an arbitrary socket name
86       can be specified, for example  ‘socket:///home/foo/bar/mysocket’.   For
87       debugging purposes it is also possible to do remote logging.  Take care
88       if you use this feature because the information is send  in  the  clear
89       over the network.  Use this syntax in the conf files:
90
91         log-file tcp://192.168.1.1:4711
92
93       You  may  use  any  port  and not just 4711 as shown above; only IP ad‐
94       dresses are supported (v4 and v6) and no host names.  You need to start
95       watchgnupg  with  the tcp option.  Note that under Windows the registry
96       entry HKCU\Software\GNU\GnuPG:DefaultLogFile can be used to change  the
97       default  log  output  from  stderr  to whatever is given by that entry.
98       However the only useful entry is a TCP name for remote debugging.
99
100
101

SEE ALSO

103       gpg(1), gpgsm(1), gpg-agent(1), scdaemon(1)
104
105       The full documentation for this tool is maintained as a Texinfo manual.
106       If  GnuPG and the info program are properly installed at your site, the
107       command
108
109         info gnupg
110
111       should give you access to the complete manual including a  menu  struc‐
112       ture and an index.
113
114
115
116
117
118
119
120
121
122
123
124GnuPG 2.4.3                       2023-06-21                     WATCHGNUPG(1)