<FILENAME filename="index.html"><html><head><title>The KWatchGnuPG Handbook</title><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-default.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-docs.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-localised.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><meta name="description" content="KWatchGnuPG is a simple GnuPG log viewer."><meta name="keywords" content="KDE, gpg, gpgsm, GnuPG, Log viewer"><link rel="home" href="index.html" title="The KWatchGnuPG Handbook"><link rel="next" href="introduction.html" title="Chapter 1. Introduction"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.14 using libxslt"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div id="content"><div id="header"><div id="header_content"><div id="header_left"><div id="header_right"><img src="help:/kdoctools5-common/top-kde.jpg" width="36" height="34"> The <span class="application">KWatchGnuPG</span> Handbook</div></div></div></div><div class="navCenter"><table class="navigation"><tr><td class="prevCell"></td><td class="upCell"> </td><td class="nextCell"><a accesskey="n" href="introduction.html">Next</a></td></tr></table></div><div id="contentBody"><div lang="en" class="book"><div class="titlepage"><div><div><h1 class="title"><a name="kwatchgnupg"></a>The <span class="application">KWatchGnuPG</span> Handbook</h1></div><div><div class="authorgroup"><p class="author"><span class="firstname">Marc</span> <span class="surname">Mutz</span> <code class="email"><mutz@kde.org></code></p><span class="othercredit"><span class="contrib">Developer</span>: <span class="firstname">Steffen</span> <span class="surname">Hansen</span><br></span><span class="othercredit"><span class="contrib">Developer</span>: <span class="firstname">David</span> <span class="surname">Faure</span><br></span></div></div><div>Revision <span class="releaseinfo">1.0 (Applications 16.08) (<span class="date">2016-07-26</span>)</span></div><div><p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p><p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p></div><div><div><div class="abstract"><p> <span class="application">KWatchGnuPG</span> is a simple <acronym class="acronym">GnuPG</acronym> log viewer. </p></div></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="introduction.html">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="introduction.html#mainfunc">Main Functions</a></span></dt><dd><dl><dt><span class="sect2"><a href="introduction.html#mainfunc.viewing">Viewing the Log</a></span></dt><dt><span class="sect2"><a href="introduction.html#mainfunc.saving">Saving the Contents of the Log Window to a File</a></span></dt><dt><span class="sect2"><a href="introduction.html#mainfunc.clear">Clearing the Log Window</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="configure.html">2. Configuring <span class="application">KWatchGnuPG</span></a></span></dt><dd><dl><dt><span class="sect1"><a href="configure.html#configure.dialog">Settings Dialog</a></span></dt><dd><dl><dt><span class="sect2"><a href="configure.html#configure.watchgnupg"><span class="application">WatchGnuPG</span> Settings</a></span></dt><dt><span class="sect2"><a href="configure.html#configure.logwindow">Log Window Settings</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="credits-and-license.html">3. Credits and License</a></span></dt></dl></div><FILENAME filename="introduction.html"><html><head><title>Chapter 1. Introduction</title><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-default.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-docs.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-localised.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><meta name="keywords" content="KDE, gpg, gpgsm, GnuPG, Log viewer"><link rel="home" href="index.html" title="The KWatchGnuPG Handbook"><link rel="up" href="index.html" title="The KWatchGnuPG Handbook"><link rel="prev" href="index.html" title="The KWatchGnuPG Handbook"><link rel="next" href="configure.html" title="Chapter 2. Configuring KWatchGnuPG"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.14 using libxslt"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div id="content"><div id="header"><div id="header_content"><div id="header_left"><div id="header_right"><img src="help:/kdoctools5-common/top-kde.jpg" width="36" height="34"> Introduction</div></div></div></div><div class="navCenter"><table class="navigation"><tr><td class="prevCell"><a accesskey="p" href="index.html">Prev</a></td><td class="upCell"> </td><td class="nextCell"><a accesskey="n" href="configure.html">Next</a></td></tr></table></div><div id="contentBody"><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="introduction"></a>Chapter 1. Introduction</h1></div></div></div><p><span class="application">KWatchGnuPG</span> is simple <acronym class="acronym">GnuPG</acronym> log viewer for the <acronym class="acronym">GnuPG</acronym> versions 1.4, 2.0 and 2.1. It works as a <acronym class="acronym">GUI</acronym> wrapper around the command line tool <span class="application">WatchGnuPG</span>, which listens on a socket for log lines from the <acronym class="acronym">GnuPG</acronym> backend applications. See <strong class="userinput"><code>info watchgnupg</code></strong> for more information about <span class="application">WatchGnuPG</span>.</p><p><span class="application">KWatchGnuPG</span> can be started from the <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenu">Tools</span></span> → <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenuitem">GnuPG Log Viewer</span></span> menu of both <span class="application">Kleopatra</span> and <span class="application">KMail</span>, as well as from the command line. The <span class="application">KWatchGnuPG</span> executable is named <strong class="userinput"><code>kwatchgnupg</code></strong>. </p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="mainfunc"></a>Main Functions</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="mainfunc.viewing"></a>Viewing the Log</h3></div></div></div><p> <span class="application">KWatchGnuPG</span>'s main function is of course to present the <acronym class="acronym">GnuPG</acronym> debugging and logging information to the user. The main window is divided into a large text viewing area, where <acronym class="acronym">GnuPG</acronym> messages will appear as they are generated, a toolbar giving quick access to the most often needed functions, as well as the obligatory menu bar. </p><p> Each line in the text view is normally prefixed with a <acronym class="acronym">FD</acronym> identifier and a time stamp in ISO format. The <acronym class="acronym">FD</acronym> identifier can be used to distinguish between output from different <acronym class="acronym">GnuPG</acronym> instances running in parallel. Following the timestamp is the name of the component that is the source of the log line, together with some internal information in sqare brackets, followed by the original debugging or log output as printed by the component. </p><p> By default, the number of log lines that are kept in the history is limited to 10000 lines. You can configure the history size in the configuration dialog. </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="mainfunc.saving"></a>Saving the Contents of the Log Window to a File</h3></div></div></div><p> Sometimes it might be convenient to save the current log window contents to a file, <abbr class="abbrev">e.g.</abbr> to mail it to the developers as part of a bug report. There are two ways to achieve this in <span class="application">KWatchGnuPG</span>: </p><p> First, you can choose <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">File</span></span> → <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenuitem">Save As...</span></span> (or the corresponding toolbar icon) to save the complete log window contents to a file. You will be prompted to specify a save file location. </p><p> Second, you can select the interesting lines with normal left-mouse selection and paste them into a word processor or mail user agent, just like any other text. You should make sure, though, that lines are not broken, since this reduces the readability of the log. </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="mainfunc.clear"></a>Clearing the Log Window</h3></div></div></div><p> For convenience, you can instruct <span class="application">KWatchGnuPG</span> to clear the log window using <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenu">File</span></span> → <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenuitem">Clear History</span></span> (or the corresponding toolbar icon). </p><p> Use this prior to starting the crypto operation that you want to monitor to get only the output from that operation. You can then save the log using <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenu">File</span></span> → <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenuitem">Save As...</span></span> as described above. </p><p> Clearing the log discards any previous log window contents. If you are unsure about whether you'll need the current contents afterwards, you should save them to a file (see above) before clearing. </p></div></div></div></div><div id="footer"><div class="navCenter"><table class="navigation"><tr><td class="prevCell"><a accesskey="p" href="index.html">Prev</a></td><td class="upCell"><a accesskey="h" href="index.html">Contents</a></td><td class="nextCell"><a accesskey="n" href="configure.html">Next</a></td></tr><tr><td class="prevCell">The <span class="application">KWatchGnuPG</span> Handbook </td><td class="upCell"> </td><td class="nextCell"> Configuring <span class="application">KWatchGnuPG</span></td></tr></table></div><div id="footer_text">Would you like to make a comment or contribute an update to this page?<br>Send feedback to the <a href="mailto:kde-doc-english@kde.org" class="footer_email">KDE Docs Team</a></div></div></div></body></html></FILENAME><FILENAME filename="configure.html"><html><head><title>Chapter 2. Configuring KWatchGnuPG</title><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-default.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-docs.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-localised.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><meta name="keywords" content="KDE, gpg, gpgsm, GnuPG, Log viewer"><link rel="home" href="index.html" title="The KWatchGnuPG Handbook"><link rel="up" href="index.html" title="The KWatchGnuPG Handbook"><link rel="prev" href="introduction.html" title="Chapter 1. Introduction"><link rel="next" href="credits-and-license.html" title="Chapter 3. Credits and License"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.14 using libxslt"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div id="content"><div id="header"><div id="header_content"><div id="header_left"><div id="header_right"><img src="help:/kdoctools5-common/top-kde.jpg" width="36" height="34"> Configuring <span class="application">KWatchGnuPG</span></div></div></div></div><div class="navCenter"><table class="navigation"><tr><td class="prevCell"><a accesskey="p" href="introduction.html">Prev</a></td><td class="upCell"> </td><td class="nextCell"><a accesskey="n" href="credits-and-license.html">Next</a></td></tr></table></div><div id="contentBody"><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="configure"></a>Chapter 2. Configuring <span class="application">KWatchGnuPG</span></h1></div></div></div><p> To configure <span class="application">KWatchGnuPG</span>, select <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenu">Settings</span></span> → <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guimenuitem">Configure <span class="application">KWatchGnuPG</span></span></span>, or the corresponding toolbar icon. <span class="application">KWatchGnuPG</span>'s configure dialog is divided into two parts, each of which will be described below. </p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="configure.dialog"></a>Settings Dialog</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="configure.watchgnupg"></a><span class="application">WatchGnuPG</span> Settings</h3></div></div></div><p> <span class="application">WatchGnuPG</span> is the process that actually monitors the logging socket for activity and formats the lines as seen in the <span class="application">KWatchGnuPG</span> text view. Settings in this group are passed down to the backend using the <span class="application">GPGConf</span> mechanism. </p><p> <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Executable</span></span> contains the path to the <span class="application">WatchGnuPG</span> application. If <span class="application">WatchGnuPG</span> is in your <code class="varname">$PATH</code>, you can keep the default <strong class="userinput"><code>watchgnupg</code></strong>. If <span class="application">WatchGnuPG</span> is not in your <code class="varname">$PATH</code>, or if you have more than one version installed, enter the absolute filename of the watchgnupg executable here. </p><p> <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Socket</span></span> contains the socket that <span class="application">WatchGnuPG</span> should listen on. A change here is distributed to all <acronym class="acronym">GnuPG</acronym> backend modules using <span class="application">GPGConf</span>, so you don't need to change this setting if your <acronym class="acronym">GnuPG</acronym> config files have another <code class="varname">log-file</code> set. </p><p> <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Default log level</span></span> determines the amount of logging information returned by the backend modules. See the <span class="application">WatchGnuPG</span> documentation for what level includes which information. A change here is distributed to all <acronym class="acronym">GnuPG</acronym> backend modules using <span class="application">GPGConf</span>, so you don't need to change this setting if your <acronym class="acronym">GnuPG</acronym> config files have another <code class="varname">log-level</code> set. </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="configure.logwindow"></a>Log Window Settings</h3></div></div></div><p> Here, you can configure the size of the history buffer, <abbr class="abbrev">i.e.</abbr> the number of log lines that is kept. If more lines have been emitted by the <acronym class="acronym">GnuPG</acronym> backend since the last clearance of the history, then the oldest lines are discarded until there is enough room for the new lines again. </p><p> You can disable the history size limit by clicking <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guibutton">Set Unlimited</span></span>. Note, however, that <span class="application">KWatchGnuPG</span>'s memory consumption will grow with the number of lines it currently displays. If you use an unlimited history size, then make sure to run <span class="application">KWatchGnuPG</span> only for short operations, or regularly clear the history manually. </p></div></div></div></div><div id="footer"><div class="navCenter"><table class="navigation"><tr><td class="prevCell"><a accesskey="p" href="introduction.html">Prev</a></td><td class="upCell"><a accesskey="h" href="index.html">Contents</a></td><td class="nextCell"><a accesskey="n" href="credits-and-license.html">Next</a></td></tr><tr><td class="prevCell">Introduction </td><td class="upCell"> </td><td class="nextCell"> Credits and License</td></tr></table></div><div id="footer_text">Would you like to make a comment or contribute an update to this page?<br>Send feedback to the <a href="mailto:kde-doc-english@kde.org" class="footer_email">KDE Docs Team</a></div></div></div></body></html></FILENAME><FILENAME filename="credits-and-license.html"><html><head><title>Chapter 3. Credits and License</title><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-default.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-docs.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-localised.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><meta name="keywords" content="KDE, gpg, gpgsm, GnuPG, Log viewer"><link rel="home" href="index.html" title="The KWatchGnuPG Handbook"><link rel="up" href="index.html" title="The KWatchGnuPG Handbook"><link rel="prev" href="configure.html" title="Chapter 2. Configuring KWatchGnuPG"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.14 using libxslt"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div id="content"><div id="header"><div id="header_content"><div id="header_left"><div id="header_right"><img src="help:/kdoctools5-common/top-kde.jpg" width="36" height="34"> Credits and License</div></div></div></div><div class="navCenter"><table class="navigation"><tr><td class="prevCell"><a accesskey="p" href="configure.html">Prev</a></td><td class="upCell"> </td><td class="nextCell"></td></tr></table></div><div id="contentBody"><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="credits-and-license"></a>Chapter 3. Credits and License</h1></div></div></div><p><span class="application">KWatchGnuPG</span> copyright 2004 Klarälvdalens Datakonsult AB</p><p>Documentation copyright 2004 Klarälvdalens Datakonsult AB</p><div class="itemizedlist"><p class="title"><b>Contributors</b></p><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="firstname">Steffen</span> <span class="surname">Hansen</span> <code class="email">(hansen AT kde.org)</code></p></li><li class="listitem"><p><span class="firstname">Marc</span> <span class="surname">Mutz</span> <code class="email">(mutz AT kde.org)</code></p></li><li class="listitem"><p><span class="firstname">David</span> <span class="surname">Faure</span> <code class="email">(faure AT kde.org)</code></p></li></ul></div><p><a name="gnu-fdl"></a>This documentation is licensed under the terms of the <a class="ulink" href="help:/kdoctools5-common/fdl-license.html" target="_top">GNU Free Documentation License</a>.</p><p>This program is licensed under the terms of the <a class="ulink" href="help:/kdoctools5-common/gpl-license.html" target="_top">GNU General Public License</a>.</p></div></div><div id="footer"><div class="navCenter"><table class="navigation"><tr><td class="prevCell"><a accesskey="p" href="configure.html">Prev</a></td><td class="upCell"><a accesskey="h" href="index.html">Contents</a></td><td class="nextCell"></td></tr><tr><td class="prevCell">Configuring <span class="application">KWatchGnuPG</span> </td><td class="upCell"> </td><td class="nextCell"> </td></tr></table></div><div id="footer_text">Would you like to make a comment or contribute an update to this page?<br>Send feedback to the <a href="mailto:kde-doc-english@kde.org" class="footer_email">KDE Docs Team</a></div></div></div></body></html></FILENAME></div></div><div id="footer"><div class="navCenter"><table class="navigation"><tr><td class="prevCell"></td><td class="upCell"> </td><td class="nextCell"><a accesskey="n" href="introduction.html">Next</a></td></tr><tr><td class="prevCell"> </td><td class="upCell"> </td><td class="nextCell"> Introduction</td></tr></table></div><div id="footer_text">Would you like to make a comment or contribute an update to this page?<br>Send feedback to the <a href="mailto:kde-doc-english@kde.org" class="footer_email">KDE Docs Team</a></div></div></div></body></html></FILENAME>
Generated by dwww version 1.15 on Thu Jun 20 13:36:55 CEST 2024.