aboutsummaryrefslogtreecommitdiffstats
path: root/doc/tools.texi
diff options
context:
space:
mode:
authorWerner Koch <[email protected]>2020-01-20 15:50:56 +0000
committerWerner Koch <[email protected]>2020-01-20 15:50:56 +0000
commite0d9181ad11aaf7e68231db4b3708978a9a52fd6 (patch)
treef579894c7fec6ab7d57c941009b65f220973d91d /doc/tools.texi
parentgpgconf,w32: Print a warning for a suspicious homedir. (diff)
downloadgnupg-e0d9181ad11aaf7e68231db4b3708978a9a52fd6.tar.gz
gnupg-e0d9181ad11aaf7e68231db4b3708978a9a52fd6.zip
tools: Let watchgnupg determine the socket name via gpgconf.
* tools/watchgnupg.c: Include sys/wait.h. (GNUPG_DEF_COPYRIGHT_LINE): Add a default value for standalone building. (get_logname): New. (main): Use a default socket name and add option --homedir. -- This is quite convenient and saves a lot of typing or shell alias definitions. Signed-off-by: Werner Koch <[email protected]>
Diffstat (limited to 'doc/tools.texi')
-rw-r--r--doc/tools.texi41
1 files changed, 30 insertions, 11 deletions
diff --git a/doc/tools.texi b/doc/tools.texi
index 0893c65a5..51bfb09eb 100644
--- a/doc/tools.texi
+++ b/doc/tools.texi
@@ -50,19 +50,30 @@ 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.
-
@noindent
@command{watchgnupg} is commonly invoked as
@example
+watchgnupg
+@end example
+
+which is a shorthand for
+
+@example
watchgnupg --force $(gpgconf --list-dirs socketdir)/S.log
@end example
+
+To watch GnuPG running with a different home directory, use
+
+@example
+watchgnupg --homedir DIR
+@end example
@manpause
@noindent
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}).
+logging socket (this is commonly @file{/var/run/user/UID/gnupg/S.log}
+or if no such user directory hierarchy exists @file{~/.gnupg/S.log}).
@mansect options
@noindent
@@ -72,12 +83,20 @@ logging socket (which is either @file{~/.gnupg/S.log} or
@item --force
@opindex force
-Delete an already existing socket file.
+Delete an already existing socket file. This option is implictly used
+if no socket name has been given on the command line.
+
+@item --homedir @var{DIR}
+If no socket name is given on the command line, pass @var{DIR} to
+gpgconf so that the socket for a GnuPG running with DIR has its home
+directory is used. Note that the environment variable @var{GNUPGHOME}
+is ignored by watchgnupg.
@anchor{option watchgnupg --tcp}
@item --tcp @var{n}
-Instead of reading from a local socket, listen for connects on TCP port
-@var{n}.
+Instead of reading from a local socket, listen for connects on TCP
+port @var{n}. A Unix domain socket can optionally also be given as a
+second source. This option does not use a default socket name.
@item --time-only
@opindex time-only
@@ -102,14 +121,14 @@ Display a brief help page and exit.
@chapheading Examples
@example
-$ watchgnupg --force --time-only $(gpgconf --list-dirs socketdir)/S.log
+$ watchgnupg --time-only
@end example
This waits for connections on the local socket
-(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:
+(e.g. @file{/var/run/user/1234/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://