man-pages/man1/watchgnupg.1.html
2021-03-31 01:06:50 +01:00

190 lines
4.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of WATCHGNUPG</TITLE>
</HEAD><BODY>
<H1>WATCHGNUPG</H1>
Section: GNU Privacy Guard 2.2 (1)<BR>Updated: 2019-11-23<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
<B>watchgnupg</B>
- Read and print logs from a socket
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>watchgnupg</B>
[<B>--force</B>]
[<B>--verbose</B>]
<I>socketname</I>
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
Most of the main utilities are able to write their log files to a Unix
Domain socket if configured that way. <B>watchgnupg</B> 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.
<P>
<P>
<P>
<B>watchgnupg</B> is commonly invoked as
<P>
<DL COMPACT><DT id="1"><DD>
<PRE>
watchgnupg --force $(gpgconf --list-dirs socketdir)/S.log
</DL>
</PRE><A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>watchgnupg</B> understands these options:
<P>
<P>
<DL COMPACT>
<DT id="2"><B>--force</B>
<DD>
Delete an already existing socket file.
<P>
<P>
<DT id="3"><B>--tcp </B><I>n</I>
<DD>
Instead of reading from a local socket, listen for connects on TCP port
<I>n</I>.
<P>
<DT id="4"><B>--time-only</B>
<DD>
Do not print the date part of the timestamp.
<P>
<DT id="5"><B>--verbose</B>
<DD>
Enable extra informational output.
<P>
<DT id="6"><B>--version</B>
<DD>
Print version of the program and exit.
<P>
<DT id="7"><B>--help</B>
<DD>
Display a brief help page and exit.
<P>
</DL>
<P>
<P>
<P>
<A NAME="lbAF">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
<DL COMPACT><DT id="8"><DD>
<PRE>
$ watchgnupg --force --time-only $(gpgconf --list-dirs socketdir)/S.log
</PRE>
</DL>
<P>
This waits for connections on the local socket
(e.g. '<I>/home/foo/.gnupg/S.log</I>') and shows all log entries. To
make this work the option <B>log-file</B> needs to be used with all
modules which logs are to be shown. The suggested entry for the
configuration files is:
<P>
<DL COMPACT><DT id="9"><DD>
<PRE>
log-file socket://
</PRE>
</DL>
<P>
If the default socket as given above and returned by &quot;echo $(gpgconf
--list-dirs socketdir)/S.log&quot; is not desired an arbitrary socket name
can be specified, for example '<I><A HREF="socket:///home/foo/bar/mysocket">socket:///home/foo/bar/mysocket</A></I>'.
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:
<P>
<DL COMPACT><DT id="10"><DD>
<PRE>
log-file <A HREF="tcp://192.168.1.1:4711">tcp://192.168.1.1:4711</A>
</PRE>
</DL>
<P>
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 <B>watchgnupg</B> with the <B>tcp</B> option. Note that
under Windows the registry entry
<I>HKCU\Software\GNU\GnuPG:DefaultLogFile</I> can be used to change the
default log output from <B>stderr</B> to whatever is given by that
entry. However the only useful entry is a TCP name for remote
debugging.
<P>
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?1+gpg">gpg</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+gpgsm">gpgsm</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+gpg-agent">gpg-agent</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+scdaemon">scdaemon</A></B>(1)
<P>
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
command
<P>
<DL COMPACT><DT id="11"><DD>
<PRE>
info gnupg
</PRE>
</DL>
<P>
should give you access to the complete manual including a menu structure
and an index.
<P>
<P>
<P>
<P>
<P>
<P>
<P>
<P>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="12"><A HREF="#lbAB">NAME</A><DD>
<DT id="13"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="14"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="15"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="16"><A HREF="#lbAF">EXAMPLES</A><DD>
<DT id="17"><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:29 GMT, March 31, 2021
</BODY>
</HTML>