doc: Update man page for watchgnupg

--

Signed-off-by: Werner Koch <wk@gnupg.org>
This commit is contained in:
Werner Koch 2017-01-09 08:54:45 +01:00
parent 88dc3af3d4
commit 2baba11fad
No known key found for this signature in database
GPG Key ID: E3FDFF218E45B72B
1 changed files with 25 additions and 18 deletions

View File

@ -54,13 +54,14 @@ other utilities. This tool is not available for Windows.
@command{watchgnupg} is commonly invoked as @command{watchgnupg} is commonly invoked as
@example @example
watchgnupg --force ~/.gnupg/S.log watchgnupg --force $(gpgconf --list-dirs socketdir)/S.log
@end example @end example
@manpause @manpause
@noindent @noindent
This starts it on the current terminal for listening on the socket This starts it on the current terminal for listening on the standard
@file{~/.gnupg/S.log}. logging socket (which is either @file{~/.gnupg/S.log} or
@file{/var/run/user/UID/gnupg/S.log}).
@mansect options @mansect options
@noindent @noindent
@ -77,6 +78,10 @@ Delete an already existing socket file.
Instead of reading from a local socket, listen for connects on TCP port Instead of reading from a local socket, listen for connects on TCP port
@var{n}. @var{n}.
@item --time-only
@opindex time-only
Do not print the date part of the timestamp.
@item --verbose @item --verbose
@opindex verbose @opindex verbose
Enable extra informational output. Enable extra informational output.
@ -96,21 +101,22 @@ Display a brief help page and exit.
@chapheading Examples @chapheading Examples
@example @example
$ watchgnupg --force /home/foo/.gnupg/S.log $ watchgnupg --force --time-only $(gpgconf --list-dirs socketdir)/S.log
@end example @end example
This waits for connections on the local socket This waits for connections on the local socket
@file{/home/foo/.gnupg/S.log} and shows all log entries. To make this (e.g. @file{/home/foo/.gnupg/S.log}) and shows all log entries. To
work the option @option{log-file} needs to be used with all modules make this work the option @option{log-file} needs to be used with all
which logs are to be shown. The value for that option must be given modules which logs are to be shown. The suggested entry for the
with a special prefix (e.g. in the conf files): configuration files is:
@example @example
log-file socket:///home/foo/.gnupg/S.log log-file socket://
@end example @end example
If only @code{socket://} is used a default socket file named If the default socket as given above and returned by "echo $(gpgconf
@file{S.log} in the standard socket directory is used. --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 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 care if you use this feature because the information is send in the
clear over the network. Use this syntax in the conf files: 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 log-file tcp://192.168.1.1:4711
@end example @end example
You may use any port and not just 4711 as shown above; only IP addresses You may use any port and not just 4711 as shown above; only IP
are supported (v4 and v6) and no host names. You need to start addresses are supported (v4 and v6) and no host names. You need to
@command{watchgnupg} with the @option{tcp} option. Note that under start @command{watchgnupg} with the @option{tcp} option. Note that
Windows the registry entry @var{HKCU\Software\GNU\GnuPG:DefaultLogFile} under Windows the registry entry
can be used to change the default log output from @code{stderr} to @var{HKCU\Software\GNU\GnuPG:DefaultLogFile} can be used to change the
whatever is given by that entry. However the only useful entry is a TCP default log output from @code{stderr} to whatever is given by that
name for remote debugging. entry. However the only useful entry is a TCP name for remote
debugging.
@mansect see also @mansect see also