First attempt at documentation.

This relates to issue #16.

Signed-off-by: Mavridis Philippe <mavridisf@gmail.com>

1 files changed, 571 insertions, 400 deletions

diff --git a/doc/en/index.docbook b/doc/en/index.docbook
index 106d655..fbe7a48 100644
--- a/doc/en/index.docbook
+++ b/doc/en/index.docbook
@@ -1,42 +1,11 @@
 <?xml version="1.0" ?>
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
-  <!ENTITY klamav02 "<application>klamav02 0&#46;1</application>">
-  <!ENTITY kappname "&klamav02;"><!-- Do *not* replace kappname-->
-  <!ENTITY package "kde-module"><!-- tdebase, tdeadmin, etc -->
+  <!ENTITY klamav "<application>KlamAV</application>">
+  <!ENTITY klamav_version "0.46">
+  <!ENTITY kappname "&klamav;">
   <!ENTITY % addindex "IGNORE">
   <!ENTITY % English "INCLUDE"><!-- change language only here -->
-  
-  
-  <!-- Do not define any other entities; instead, use the entities
-       from kde-genent.entities and $LANG/user.entities. -->
 ]>
-<!-- kdoctemplate v0.8 October 1 1999 
-     Minor update to "Credits and Licenses" section on August 24, 2000
-     Removed "Revision history" section on 22 January 2001
-     Changed to Installation/Help menu entities 18 October 2001
-     Other minor cleanup and changes 18 October 2001 -->
-
-
-<!--
-This template was designed by: David Rugge davidrugge@mindspring.com
-with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
-and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
-of the KDE DocBook team.
-
-You may freely use this template for writing any sort of KDE documentation.
-If you have any changes or improvements, please let us know.
-
-Remember:
-- in XML, the case of the <tags> and attributes is relevant ;
-- also, quote all attributes.
-
-Please don't forget to remove all these comments in your final documentation,
-thanks ;-).
--->
-
-<!-- ................................................................ -->
-
-<!-- The language must NOT be changed here. -->
 
 <book lang="&language;">
 
@@ -44,512 +13,714 @@ thanks ;-).
 as Authors, publish date, the abstract, and Keywords -->
 
 <bookinfo>
-<title>The &klamav02; Handbook</title>
+<title>The &klamav; Handbook</title>
 
 <authorgroup>
+
 <author>
-<firstname></firstname>
-<othername></othername>
-<surname>Robert Hogan</surname>
+<firstname>Philippe</firstname>
+<surname>Mavridis</surname>
 <affiliation>
-<address><email>robert&#64;roberthogan&#46;net</email></address>
+<address><email>mavridisf@gmail.com</email></address>
 </affiliation>
 </author>
-</authorgroup>
+
+<othercredit role="developer">
+<firstname>Robert</firstname>
+<surname>Hogan</surname>
+<affiliation>
+<address><email>robert@roberthogan.net</email></address>
+</affiliation>
+<contrib>Original Developer</contrib>
+</othercredit>
 
 <!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
 
 <copyright>
-<year>1999</year>
-<year>2004</year>
-<holder>Robert Hogan</holder>
+<year>2020</year>
+<year>2021</year>
+<holder>The Trinity Desktop project</holder>
 </copyright>
-<!-- Translators: put here the copyright notice of the translation -->
-<!-- Put here the FDL notice.  Read the explanation in fdl-notice.docbook
-     and in the FDL itself on how to use it. -->
-<legalnotice>&FDLNotice;</legalnotice>
-
-<!-- Date and version information of the documentation
-Don't forget to include this last date and this last revision number, we
-need them for translation coordination !
-Please respect the format of the date (YYYY-MM-DD) and of the version
-(V.MM.LL), it could be used by automation scripts.
-Do NOT change these in the translation. -->
 
-<date>2001-10-18</date>
-<releaseinfo>0&#46;1</releaseinfo>
+<legalnotice>&FDLNotice;</legalnotice>
 
-<!-- Abstract about this handbook -->
+<date>2021-03-04</date>
+<releaseinfo>&klamav_version;</releaseinfo>
 
 <abstract>
 <para>
-&klamav02; is an application specially designed to do nothing you would
-ever want.
+&klamav; is a sophisticated anti-virus manager for ClamAV.
 </para>
 </abstract>
 
-<!-- This is a set of Keywords for indexing by search engines.
-Please at least include KDE, the KDE package it is in, the name
- of your application, and a few relevant keywords. -->
-
 <keywordset>
 <keyword>KDE</keyword>
-<keyword>klamav02</keyword>
-<keyword>nothing</keyword>
-<keyword>nothing else</keyword>
+<keyword>KlamAV</keyword>
+<keyword>ClamAV</keyword>
+<keyword>Freshklam</keyword>
+<keyword>Klamonacc</keyword>
+<keyword>anti-virus</keyword>
 </keywordset>
 
 </bookinfo>
 
-<!-- The contents of the documentation begin here.  Label
-each chapter so with the id attribute. This is necessary for two reasons: it
-allows you to easily reference the chapter from other chapters of your
-document, and if there is no ID, the name of the generated HTML files will vary
-from time to time making it hard to manage for maintainers and for the CVS
-system. Any chapter labelled (OPTIONAL) may be left out at the author's
-discretion. Other chapters should not be left out in order to maintain a
-consistent documentation style across all KDE apps. -->
-
 <chapter id="introduction">
 <title>Introduction</title>
-
-<!-- The introduction chapter contains a brief introduction for the
-application that explains what it does and where to report
-problems. Basically a long version of the abstract.  Don't include a
-revision history. (see installation appendix comment) -->
+<para>
+&klamav; is an anti-virus manager for the Trinity Desktop Environment.
+</para>
 
 <para>
-&klamav02; is a program that lets you do absolutely nothing. Please report
-any problems or feature requests to the &kde; mailing lists.
+It is an advanced front-end to the Clam Anti-Virus toolkit with a lot of useful
+features: scan scheduling, on-access scanning, KMail protection, quarantine
+management, automatic database updates and even a Virus Browser to do your virus
+research.
 </para>
+
+<screenshot>
+<screeninfo>The main window of &klamav;</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="main.png" format="PNG"/>
+    </imageobject>
+  </mediaobject>
+</screenshot>
 </chapter>
 
-<chapter id="using-klamav02">
-<title>Using &klamav02;</title>
+<chapter id="using-klamav">
+<title>Using &klamav;</title>
 
-<!-- This chapter should tell the user how to use your app. You should use as
-many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
-your application. -->
+<para>
+The main window of &klamav; consists of tabs. Each tab has its own function and
+most of them can be closed if the user does not need them.
+</para>
 
 <para>
+Closing a tab disables it. This means that the next time &klamav; starts up,
+this tab will remain closed. You can close a tab either from its right-click
+context menu or through the <menuchoice><guimenu>Tabs</guimenu></menuchoice>
+menu on the top. You can use this menu to re-open any tabs you closed.
+</para>
 
-<!-- Note that all graphics should be in .png format. Use no gifs because of
-patent issues. -->
+<sect1 id="welcome-tab">
+<title>Welcome tab</title>
 
-<screenshot>
-<screeninfo>Here's a screenshot of &klamav02;</screeninfo>
-	<mediaobject>
-	  <imageobject>
-	    <imagedata fileref="screenshot.png" format="PNG"/>
-	  </imageobject>
-	  <imageobject>
-	    <imagedata fileref="screenshot.eps" format="EPS"/>
-	  </imageobject>
-	  <textobject>
-	    <phrase>Screenshot</phrase>
-	  </textobject>
-	</mediaobject>
-</screenshot>
+<para>
+This is probably the first tab that the user sees when they launch &klamav;.
+It includes an overview of the &klamav; features.
 </para>
 
+<para>
+This tab has no useful functionality yet, so it can be safely disabled.
+</para>
+</sect1>
+
+<sect1 id="scan-tab">
+<title>Scan tab</title>
+
+<para>
+This tab contains the scan manager. From here you can launch and control any
+of your &klamav; scans. This tab cannot be closed.
+</para>
 
-<sect1 id="klamav02-features">
-<title>More &klamav02; features</title>
+<para>
+By default the manager only contains the tab "Launcher". New scans and their
+results are shown in their own separate tabs. These tabs can be managed in the
+same fashion as the tabs of the main window.
+</para>
 
-<para>It slices! It dices! and it comes with a free toaster!</para>
 <para>
-The Squiggle Tool <guiicon><inlinemediaobject>
-	  <imageobject>
-	    <imagedata fileref="squiggle.png" format="PNG"/>
-	  </imageobject>
-	  <imageobject>
-	    <imagedata fileref="squiggle.eps" format="EPS"/>
-	  </imageobject>
-	  <textobject>
-	    <phrase>Squiggle</phrase>
-	  </textobject>
-</inlinemediaobject></guiicon> is used to draw squiggly lines all over
-the &klamav02; main window. It's not a bug, it's a feature!
+In the "Launcher" tab you can set the directories you want to scan and control
+some scanning options.
+</para>
+
+<para>
+You can select what to do when a virus or a suspicious file is found. The
+default is to ask you whether you want to put that file in quarantine or not.
+</para>
+
+<para>
+Checking the "Scan Folders Recursively" checkbox enables scanning of the
+selected folders' subdirectories.
+</para>
+
+<para>
+The "Schedule" button permits to schedule a scan on the selected directories
+on a specific schedule.
+</para>
+
+<para>
+The "Options" button launches the general Options dialog. This option is also
+accessible from the <menuchoice><guimenu>Scanner</guimenu></menuchoice> menu.
+</para>
+
+<para>
+The three buttons on the top right (Scan, Stop and Close) control scans. When
+you choose the directories you want and press "Scan", a new tab will be created
+in which you can see the progress of the scan and, when the scan ends, its
+results. You can run several scans simultaneously (although this might have an
+effect on the system's performance).
+</para>
+
+<para>
+If you want to end a scan before it completes, use the "Stop" button. Closing
+the tab also terminates the associated scan. You cannot close &klamav; while at
+least one scan is active.
 </para>
 
 </sect1>
-</chapter>
 
-<chapter id="commands">
-<title>Command Reference</title>
+<sect1 id="update-tab">
+<title>Update tab</title>
+
+<para>
+This tab permits you to keep your signature databases up-to-date. You can
+control all the options related to database updates from this tab. This tab
+cannot be closed. You cannot close &klamav; while this feature is active.
+</para>
+
+<para>
+In the Virus Database Directory section you can set the folder where you want
+your personal copy of ClamAV's signature databases stored. It must be a folder
+you have access to.
+</para>
+
+<para>
+The next section permits you to set up Proxy information for use with Freshklam.
+</para>
+
+<para>
+Checking the "Update Virus Database Automatically" checkbox enables auto-updates
+for this user. You can set how many times a day you want Freshklam to check for
+updates.
+</para>
+
+<para>
+The buttons "Update" and "Cancel" allow you to start/stop the update process
+manually.
+</para>
+
+</sect1>
+
+<sect1 id="quarantine-tab">
+<title>Quarantine tab</title>
+
+<para>
+This tab permits you to see which files have been quarantined by &klamav;, delete
+them or restore them.
+</para>
+
+<para>
+The Quarantine Directory section allows you to set the folder where you want
+quarantined suspicious files to be stored. It must be a folder you have access
+to. The stored files lose their original permission information.
+</para>
+
+<para>
+The "Contents of Quarantine" section lists the files which are currently stored
+in the Quarantine directory. To see the latest additions you might need to
+refresh this list, by pressing the "Refresh" button. You can use the "Restore"
+and "Delete" buttons to decide on the fate of the quarantined files.
+</para>
+
+<para>
+The "Quarantine History" section lists the names of files which have once been
+quarantined, but which you have since chosen to delete.
+</para>
+</sect1>
+
+<sect1 id="dbviewer-tab">
+<title>Virus Browser tab</title>
+
+<para>
+This tab contains the Virus Browser, a tool which allows you to search for
+information related to any virus in the ClamAV signature databases on the
+Internet.
+</para>
+
+<para>
+As the Virus Browser deals with a big amount of virus signatures, extracting
+them may take some time. Thus, this tab may take a lot of time to load on an
+average machine.
+</para>
+
+<para>
+The left panel contains the name of every virus known to ClamAV, in alphabetical
+order, while the right panel contains an embedded web-browser. The web-browser
+has tabs, so you can inspect mulitple viruses at once. Common web-browser
+actions, like "Back" and "Forward" buttons, are accessible from the right-click
+context menu. The web-browser's tabs can be managed in the same fashion as the
+tabs of the main window.
+</para>
+
+<para>
+To inspect a virus, right-click on its name and select a search engine. The same
+right-click menu is also accessible from both scan results in the "Scan" tab and
+the Quarantine tab. In this case, the Virus Browser tab is automatically shown.
+</para>
+
+</sect1>
 
-<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
-application windows and their menubar and toolbar commands for easy reference.
-Also include any keys that have a special function but have no equivalent in the
-menus or toolbars. This may not be necessary for small apps or apps with no tool
-or menu bars. -->
+<sect1 id="events-tab">
+<title>Events tab</title>
 
-<sect1 id="klamav02-mainwindow">
-<title>The main &klamav02; window</title>
+<para>
+This tab contains the a detailed event log for &klamav; and its related parts
+(Freshklam, KlamOnAcc).
+</para>
+
+<para>
+You can filter entries by specifying event type and time span from the drop-down
+menus. You can also search through the events by using the search box above the
+list.
+</para>
 
-<sect2>
-<title>The File Menu</title>
 <para>
+You can configure the events which are written to the events log in the Options
+dialog. By pressing the "Options" button, the corresponding section of this
+dialog will be shown.
+</para>
+
+</sect1>
+</chapter>
+
+<chapter id="commands">
+<title>Commands Reference</title>
+
+<sect1 id="menu-scanner">
+<title>The <guimenu>Scanner</guimenu> Menu</title>
 <variablelist>
+
 <varlistentry>
 <term><menuchoice>
 <shortcut>
-<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
+<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
 </shortcut>
-<guimenu>File</guimenu>
-<guimenuitem>New</guimenuitem>
+<guimenu>Scanner</guimenu>
+<guimenuitem>Scan File...</guimenuitem>
 </menuchoice></term>
-<listitem><para><action>Creates a new document</action></para></listitem>
+<listitem><para><action>Open a file</action> to scan with &klamav;.</para></listitem>
 </varlistentry>
+
 <varlistentry>
 <term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
-</shortcut>
-<guimenu>File</guimenu>
-<guimenuitem>Save</guimenuitem>
+<guimenu>Scanner</guimenu>
+<guimenuitem>Scan Directory...</guimenuitem>
 </menuchoice></term>
-<listitem><para><action>Saves the document</action></para></listitem>
+<listitem><para><action>Open a directory</action> to scan with &klamav;.</para></listitem>
 </varlistentry>
+
 <varlistentry>
 <term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
-</shortcut>
-<guimenu>File</guimenu>
+<guimenu>Scanner</guimenu>
+<guimenuitem>Schedule scan...</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Schedule</action> a repeated scan at a specified time.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Scanner</guimenu>
+<guimenuitem>Options...</guimenuitem>
+</menuchoice></term>
+<listitem><para>Launch the <action>Options</action> dialog.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Scanner</guimenu>
 <guimenuitem>Quit</guimenuitem>
 </menuchoice></term>
-<listitem><para><action>Quits</action> &klamav02;</para></listitem>
+<listitem><para><action>Close</action> &klamav;.</para></listitem>
 </varlistentry>
 </variablelist>
-</para>
+</sect1>
+
+<sect1 id="menu-tabs">
+<title>The <guimenu>Tabs</guimenu> Menu</title>
+<variablelist>
 
-</sect2>
+<varlistentry>
+<term><menuchoice>
+<guimenu>Tabs</guimenu>
+<guimenuitem>Show Welcome tab</guimenuitem>
+</menuchoice></term>
+<listitem><para>Show/hide the Welcome tab.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Tabs</guimenu>
+<guimenuitem>Show Quarantine tab</guimenuitem>
+</menuchoice></term>
+<listitem><para>Show/hide the Quarantine tab.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Tabs</guimenu>
+<guimenuitem>Show Virus Browser tab</guimenuitem>
+</menuchoice></term>
+<listitem><para>Show/hide the Virus Browser tab.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Tabs</guimenu>
+<guimenuitem>Show Events tab</guimenuitem>
+</menuchoice></term>
+<listitem><para>Show/hide the Events tab.</para></listitem>
+</varlistentry>
+</variablelist>
+</sect1>
 
-<sect2>
+<sect1 id="menu-help">
 <title>The <guimenu>Help</guimenu> Menu</title>
+<variablelist>
+
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul"><keycap>F1</keycap></keycombo>
+</shortcut>
+<guimenu>Help</guimenu>
+<guimenuitem>The &klamav; Handbook</guimenuitem>
+</menuchoice></term>
+<listitem><para>Invokes the TDE Help System starting at the &klamav; help pages (this document).</para></listitem>
+</varlistentry>
 
-<!-- Assuming you have a standard help menu (help, what's this, about -->
-<!-- &klamav02;, about KDE) then the documentation is already written. -->
-<!-- The following entity is valid anywhere that a variablelist is -->
-<!-- valid.  -->
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>Report Bug/Request Enhancement...</guimenuitem>
+</menuchoice></term>
+<listitem><para>Opens the Bug report dialog where you can report a bug or request a “wishlist” feature.</para></listitem>
+</varlistentry>
 
-&help.menu.documentation;
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>Switch Application Language...</guimenuitem>
+</menuchoice></term>
+<listitem><para>Select the language which &klamav; will use.</para></listitem>
+</varlistentry>
 
-</sect2>
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>About &klamav;</guimenuitem>
+</menuchoice></term>
+<listitem><para>This will display version and author information.</para></listitem>
+</varlistentry>
 
+<varlistentry>
+<term><menuchoice>
+<guimenu>Help</guimenu>
+<guimenuitem>About TDE</guimenuitem>
+</menuchoice></term>
+<listitem><para>This displays the TDE version and other basic information.</para></listitem>
+</varlistentry>
+</variablelist>
 </sect1>
+
 </chapter>
 
-<chapter id="developers">
-<title>Developer's Guide to &klamav02;</title>
 
-<!-- (OPTIONAL) A Programming/Scripting reference chapter should be
-used for apps that use plugins or that provide their own scripting hooks
-and/or development libraries. -->
+<chapter id="options-dialog">
+<title>Options dialog</title>
 
 <para>
-Programming &klamav02; plugins is a joy to behold. Just read through the next
-66 pages of API's to learn how!
+The Options dialog contains important settings which affect different aspects of
+&klamav;.
 </para>
 
-<!-- Use refentries to describe APIs.  Refentries are fairly complicated and you
-should consult the docbook reference for further details. The example below was
-taken from that reference and shortened a bit for readability. -->
+<screenshot>
+<screeninfo>The Options dialog</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="opts.png" format="PNG"/>
+    </imageobject>
+  </mediaobject>
+</screenshot>
+
+<sect1 id="options-backend">
+<title>The Backend section</title>
 
-<refentry id="re-1007-unmanagechildren-1">
-<refmeta>
-<refentrytitle>XtUnmanageChildren</refentrytitle>
-<refmiscinfo>Xt - Geometry Management</refmiscinfo>
-</refmeta>
-<refnamediv>
-<refname>XtUnmanageChildren
-</refname>
-<refpurpose>remove a list of children from a parent widget's managed
-list.
-<indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm>
-<indexterm id="ix-1007-unmanagechildren-2"><primary>XtUnmanageChildren</primary></indexterm> 
-</refpurpose>
-
-</refnamediv>
-<refsynopsisdiv>
-<refsynopsisdivinfo>
-<date>4 March 1996</date>
-</refsynopsisdivinfo>
-<synopsis>
-void XtUnmanageChildren(<replaceable class="parameter">children</replaceable>, <replaceable class="parameter">num_children</replaceable>)
-    WidgetList <replaceable class="parameter">children</replaceable>;
-    Cardinal <replaceable class="parameter">num_children</replaceable>;
-</synopsis>
-
-<refsect2 id="r2-1007-unmanagechildren-1">
-<title>Inputs</title>
-<variablelist>
-<varlistentry>
-<term><replaceable class="parameter">children</replaceable>
-</term>
-<listitem>
-<para>Specifies an array of child widgets. Each child must be of
-class RectObj or any subclass thereof.
+<para>
+Here you can select the backend that &klamav; will use for its scans. Two backends
+are available.
 </para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><replaceable class="parameter">num_children</replaceable>
-</term>
-<listitem>
-<para>Specifies the number of elements in <replaceable class="parameter">children</replaceable>.
+
+<para>
+The default option is "Standalone scanner", which uses the 'clamscan' command to
+scan files and directories. It has the advantage of being the most simple one to
+set up and the most customizable option of the two.
 </para>
-</listitem>
-</varlistentry>
-</variablelist>
-</refsect2></refsynopsisdiv>
 
-<refsect1 id="r1-1007-unmanagechildren-1">
-<title>Description
-</title>
-<para><function>XtUnmanageChildren()</function> unmaps the specified widgets
-and removes them from their parent's geometry management.
-The widgets will disappear from the screen, and (depending
-on its parent) may no longer have screen space allocated for
-them.
-</para>
-<para>Each of the widgets in the <replaceable class="parameter">children</replaceable> array must have
-the same parent.
-</para>
-<para>See the &ldquo;Algorithm&rdquo; section below for full details of the
-widget unmanagement procedure.
-</para>
-</refsect1>
-
-<refsect1 id="r1-1007-unmanagechildren-2">
-<title>Usage</title>
-<para>Unmanaging widgets is the usual method for temporarily
-making them invisible.  They can be re-managed with
-<function>XtManageChildren()</function>.
-</para>
-<para>You can unmap a widget, but leave it under geometry
-management by calling <function>XtUnmapWidget()</function>.  You can
-destroy a widget's window without destroying the widget by
-calling <function>XtUnrealizeWidget()</function>.  You can destroy a
-widget completely with <function>XtDestroyWidget()</function>.
-</para>
-<para>If you are only going to unmanage a single widget, it is
-more convenient to call <function>XtUnmanageChild()</function>.  It is
-often more convenient to call <function>XtUnmanageChild()</function>
-several times than it is to declare and initialize an array
-of widgets to pass to <function>XtUnmanageChildren()</function>.  Calling
-<function>XtUnmanageChildren()</function> is more efficient, however,
-because it only calls the parent's <function>change_managed()</function>
-method once.
-</para>
-</refsect1>
-
-<refsect1 id="r1-1007-unmanagechildren-3">
-<title>Algorithm
-</title>
-<para><function>XtUnmanageChildren()</function> performs the following:
+<para>
+The other option is "ClamAV daemon", which uses the 'clamdscan' and the 'clamd'
+daemon to scan files and directories. It depends on a running 'clamd' daemon,
+but the scans overall start faster, as the virus signatures have already been
+loaded by the ClamAV daemon. When using this option, most settings depend on the
+configuration of the daemon and thus cannot be configured through &klamav;.
 </para>
-<variablelist>
-<varlistentry>
-<term>-
-</term>
-<listitem>
-<para>Ignores the child if it already is unmanaged or is being
-destroyed.
+
+<para>
+The Multiscan feature (available when "ClamAV daemon" is set as backend) makes
+clamd scan the contents of a directory in parallel using available threads.
 </para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>-
-</term>
-<listitem>
-<para>Otherwise, if the child is realized, it makes it nonvisible
-by unmapping it.
+</sect1>
+
+<sect1 id="options-archives">
+<title>The Archives section</title>
+
+<para>
+Here you can configure everything related to scanning archive files.
 </para>
-</listitem>
-</varlistentry>
-</variablelist>
+
 <para>
+You can disable scanning of archives by unchecking the "Scan Archives"
+checkbox. According to ClamAV's documentation: "If you turn off this option,
+the original files will still be scanned, but without unpacking and additional
+processing".
 </para>
-</refsect1>
 
-<refsect1 id="r1-1007-unmanagechildren-4">
-<title>Structures</title>
-<para>The <type>WidgetList</type> type is simply an array of widgets:
+<para>
+In the "Archive Limits" section you can impose some custom limits on archive
+scanning. Limits can be imposed on extracted file count, file size and archive
+recursion level.
 </para>
-<screen id="sc-1007-unmanagechildren-1">typedef Widget *WidgetList;
-</screen>
-</refsect1>
-</refentry>
+</sect1>
 
-</chapter>
+<sect1 id="options-email">
+<title>The E-Mail Protection section</title>
 
-<chapter id="faq">
-<title>Questions and Answers</title>
-
-<!-- (OPTIONAL but recommended) This chapter should include all of the silly
-(and not-so-silly) newbie questions that fill up your mailbox. This chapter
-should be reserved for BRIEF questions and answers! If one question uses more
-than a page or so then it should probably be part of the
-"Using this Application" chapter instead. You should use links to
-cross-reference questions to the parts of your documentation that answer them.
-This is also a great place to provide pointers to other FAQ's if your users
-must do some complicated configuration on other programs in order for your
-application work. -->
-
-&reporting.bugs;
-&updating.documentation;
-
-<qandaset id="faqlist">
-<qandaentry>
-<question>
-<para>My Mouse doesn't work. How do I quit &klamav02;?</para>
-</question>
-<answer>
-<para>You silly goose! Check out the <link linkend="commands">Commands
-Section</link> for the answer.</para>
-</answer>
-</qandaentry>
-<qandaentry>
-<question>
-<para>Why can't I twiddle my documents?</para>
-</question>
-<answer>
-<para>You can only twiddle your documents if you have the foobar.lib
-installed.</para>
-</answer>
-</qandaentry>
-</qandaset>
-</chapter>
+<para>
+Here you can configure your e-mail client to scan incoming and outgoing files
+with Klammail. Currently available clients are KMail and Evolution (untested).
+</para>
 
-<chapter id="credits">
+<para>
+You choose the preferred e-mail client from the drop-down list. Then, you can
+press the "Tell me how to do it" button to get the appropriate instructions.
+</para>
 
-<!-- Include credits for the programmers, documentation writers, and
-contributors here. The license for your software should then be included below
-the credits with a reference to the appropriate license file included in the KDE
-distribution. -->
+<para>
+For KMail, you can also press the "Configure Automatically" button to let &klamav;
+do it for you.
+</para>
+</sect1>
 
-<title>Credits and License</title>
+<sect1 id="options-filetypes">
+<title>The File Types section</title>
+
+<para>
+Here you can configure how different types of files will be treated by &klamav;.
+</para>
 
 <para>
-&klamav02;
+The "Exclude Quarantine Directory" option is on by default. You might want to
+keep this option on in order to prevent false positives.
 </para>
+
 <para>
-Program copyright 2004 Robert Hogan <email>robert&#64;roberthogan&#46;net</email>
+Options marked red are related to how &klamav; handles suspicious files and
+detected viruses.
 </para>
+
 <para>
-Contributors:
-<itemizedlist>
-<listitem><para>Konqui the KDE Dragon <email>konqui@kde.org</email></para>
-</listitem>
-<listitem><para>Tux the Linux Penguin <email>tux@linux.org</email></para>
-</listitem>
-</itemizedlist>
+All the other options enable/disable additional parsing of each file type. As
+the documentation has it, the original files are still scanned, but without
+decoding and additional processing.
 </para>
+</sect1>
+
+<sect1 id="options-klamonacc">
+<title>The On-Access Scanner section</title>
 
 <para>
-Documentation copyright 2004 Robert Hogan <email>robert&#64;roberthogan&#46;net</email>
+This sections allows you to configure your on-access file scanner.
 </para>
 
-<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+<para>
+Currently, this feature is experimental and may cause freezes and considerably
+lower performance. Use with care. You cannot close &klamav; while the on-access
+scanner is active.
+</para>
 
-&underFDL;               <!-- FDL: do not remove -->
+<para>
+You can enable this feature using the "Enable On-Access Scanner" checkbox.
+This feature depends on a running instance of the ClamAV daemon, 'clamd'
+(but not on the chosen scanning backend).
+</para>
 
-<!-- Determine which license your application is licensed under, 
-     and delete all the remaining licenses below:
+<para>
+The on-access scanner scans files as soon as you or the system access them. If
+a suspicious file is detected, then access to the file is prevented. Extra
+checks can be enabled by checking the "Scan Files/Directories When They Are
+Created or Moved" checkbox.
+</para>
 
-     (NOTE:  All documentation are licensed under the FDL, 
-     regardless of what license the application uses) -->
+<para>
+The "Exclude TDE Configuration Directory" is currently unavailable due to a
+possible bug in ClamAV.
+</para>
 
-&underGPL;        	 <!-- GPL License -->
-&underBSDLicense;        <!-- BSD License -->
-&underArtisticLicense;   <!-- BSD Artistic License -->
-&underX11License;        <!-- X11 License  -->
+<para>
+You can set a limit on the size of scanned files by setting a value for the
+"Max File Size" field.
+</para>
 
-</chapter>
+<para>
+Before you can enable the on-access scanner, you should set the directories
+which &klamav; will watch for activity. To do this, press the "Set up Directories
+to Watch" button.
+</para>
 
-<appendix id="installation">
-<title>Installation</title>
+<para>
+After you have enabled on-access scanning, you can start/stop the scanner daemon
+manually through the system tray icon of &klamav;.
+</para>
+</sect1>
 
-<sect1 id="getting-klamav02">
-<title>How to obtain &klamav02;</title>
+<sect1 id="options-events">
+<title>The Event Logging section</title>
 
-<!-- This first entity contains boiler plate for applications that are
-part of KDE CVS.  You should remove it if you are releasing your
-application --> 
+<para>
+Here you can configure how the event logging feature works.
+</para>
 
-&install.intro.documentation;
+<para>
+You can change the amount of days &klamav; will wait in order to purge old entries
+from its log by setting the "Expire events after..." field to a value of your
+preference.
+</para>
 
+<para>
+You can also configure the events that &klamav; will keep track of and log by
+checking/unchecking the appropriate checkboxes.
+</para>
 </sect1>
 
-<sect1 id="requirements">
-<title>Requirements</title>
+</chapter>
 
-<!--
-List any special requirements for your application here. This should include:
-.Libraries or other software that is not included in tdesupport,
-tdelibs, or tdebase.
-.Hardware requirements like amount of RAM, disk space, graphics card
-capabilities, screen resolution, special expansion cards, etc.
-.Operating systems the app will run on. If your app is designed only for a
-specific OS, (you wrote a graphical LILO configurator for example) put this
-information here.
--->
+<chapter id="tray-icon">
+<title>System Tray Icon</title>
 
 <para>
-In order to successfully use &klamav02;, you need &kde; 1.1. Foobar.lib is
-required in order to support the advanced &klamav02; features. &klamav02; uses
-about 5 megs of memory to run, but this may vary depending on your
-platform and configuration.
+The system tray icon indicates the state of &klamav; and allows you to start/stop
+some &klamav; services, notably Auto-Updates and On-Access Scanner (this might be
+useful when you want to quit &klamav; while one of these features is active).
 </para>
 
 <para>
-All required libraries as well as &klamav02; itself can be found
-on <ulink url="ftp://ftp.klamav02.org">The &klamav02; home page</ulink>.
+<guiicon><inlinemediaobject>
+    <imageobject>
+      <imagedata fileref="klamav_on_acc_disabled.png" format="PNG"/>
+    </imageobject>
+</inlinemediaobject></guiicon>means that &klamav; is open and the on-access
+scanner is inactive.
 </para>
 
-<!-- For a list of updates, you may refer to the application web site
-or the ChangeLog file, or ... -->
 <para>
-You can find a list of changes at <ulink
-url="http://apps.kde.org/klamav02">http://apps.kde.org/klamav02</ulink>.
+<guiicon><inlinemediaobject>
+    <imageobject>
+      <imagedata fileref="klamav_on_acc_enabled.png" format="PNG"/>
+    </imageobject>
+</inlinemediaobject></guiicon>means that the on-access scanner is active.
 </para>
-</sect1>
 
-<sect1 id="compilation">
-<title>Compilation and Installation</title>
+<para>
+<guiicon><inlinemediaobject>
+    <imageobject>
+      <imagedata fileref="klamav_scanning.png" format="PNG"/>
+    </imageobject>
+</inlinemediaobject></guiicon>means that one or more scans are active.
+</para>
 
-<!-- This entity contains the boilerplate text for standard -->
-<!-- compilation instructions.  If your application requires any -->
-<!-- special handling, remove it, and replace with your own text. -->
+<para>
+<guiicon><inlinemediaobject>
+    <imageobject>
+      <imagedata fileref="klamav_scan_safe.png" format="PNG"/>
+    </imageobject>
+</inlinemediaobject></guiicon>means that a scan has finished and no threats
+have been found.
+</para>
 
-&install.compile.documentation;
+<para>
+<guiicon><inlinemediaobject>
+    <imageobject>
+      <imagedata fileref="klamav_scan_found.png" format="PNG"/>
+    </imageobject>
+</inlinemediaobject></guiicon>means that a scan has finished and some viruses
+or suspicious files have been detected.
+</para>
 
-</sect1>
+<para>
+<guiicon><inlinemediaobject>
+    <imageobject>
+      <imagedata fileref="klamav_quarantining.png" format="PNG"/>
+    </imageobject>
+</inlinemediaobject></guiicon>means that some detected files are being put into
+quarantine.
+</para>
 
-<sect1 id="configuration">
-<title>Configuration</title>
+<para>
+<guiicon><inlinemediaobject>
+    <imageobject>
+      <imagedata fileref="klamav_error.png" format="PNG"/>
+    </imageobject>
+</inlinemediaobject></guiicon>means that an error has occured.
+</para>
 
-<para>Don't forget to tell your system to start the <filename>dtd</filename>
-dicer-toaster daemon first, or &klamav02; won't work !</para>
+<para>
+<guiicon><inlinemediaobject>
+    <imageobject>
+      <imagedata fileref="klamav_update_required.png" format="PNG"/>
+    </imageobject>
+</inlinemediaobject></guiicon>means that there is a newer version of ClamAV and
+you should update.
+</para>
 
-</sect1>
+</chapter>
 
-</appendix>
+<chapter id="credits">
+<title>Credits and License</title>
 
-&documentation.index;
-</book>
+<itemizedlist>
+<title>
+&klamav; &klamav_version;
+</title>
 
-<!--
-Local Variables:
-mode: sgml
-sgml-minimize-attributes:nil
-sgml-general-insert-case:lower
-sgml-indent-step:0
-sgml-indent-data:nil
-End:
+<listitem>
+<para>
+Program copyright 2004-2006 Robert Hogan <email>robert&#64;roberthogan&#46;net</email>
+</para>
+<para>
+and 2020-2021 The Trinity Desktop project
+</para>
+</listitem>
 
-vim:tabstop=2:shiftwidth=2:expandtab 
--->
+<listitem>
+<para>
+Documentation copyright 2021 Mavridis Philippe <email>mavridisf@gmail.com</email>
+</para>
+</listitem>
 
+<listitem>
+<para>
+Icons by Maarten van Gent (since version 0.45)
+</para>
+</listitem>
+</itemizedlist>
+
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
+&underFDL;              <!-- FDL: do not remove -->
+&underGPL;              <!-- GPL License -->
+
+</chapter>
+
+&documentation.index;
+</book>