From 567574ed79dfbeda68dacced1a542431c2e5279d Mon Sep 17 00:00:00 2001 From: Mavridis Philippe Date: Thu, 4 Mar 2021 21:13:34 +0200 Subject: First attempt at documentation. This relates to issue #16. Signed-off-by: Mavridis Philippe --- doc/CMakeLists.txt | 35 +- doc/en/CMakeLists.txt | 5 + doc/en/index.docbook | 971 ++++++++++++++++++++++---------------- doc/en/klamav.png | Bin 0 -> 4727 bytes doc/en/klamav_error.png | Bin 0 -> 4577 bytes doc/en/klamav_on_acc_disabled.png | Bin 0 -> 4365 bytes doc/en/klamav_on_acc_enabled.png | Bin 0 -> 4381 bytes doc/en/klamav_quarantining.png | Bin 0 -> 4841 bytes doc/en/klamav_scan_found.png | Bin 0 -> 4904 bytes doc/en/klamav_scan_safe.png | Bin 0 -> 4895 bytes doc/en/klamav_scanning.png | Bin 0 -> 4725 bytes doc/en/klamav_update_required.png | Bin 0 -> 4385 bytes doc/en/klamav_virus.png | Bin 0 -> 4609 bytes 13 files changed, 577 insertions(+), 434 deletions(-) create mode 100644 doc/en/CMakeLists.txt create mode 100644 doc/en/klamav.png create mode 100644 doc/en/klamav_error.png create mode 100644 doc/en/klamav_on_acc_disabled.png create mode 100644 doc/en/klamav_on_acc_enabled.png create mode 100644 doc/en/klamav_quarantining.png create mode 100644 doc/en/klamav_scan_found.png create mode 100644 doc/en/klamav_scan_safe.png create mode 100644 doc/en/klamav_scanning.png create mode 100644 doc/en/klamav_update_required.png create mode 100644 doc/en/klamav_virus.png diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index f6eec15..3a2060f 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,34 +1 @@ -file( GLOB _dirs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} * ) -list( REMOVE_ITEM _dirs html man ) - -string( REGEX REPLACE "[ \r\n\t]+" ";" _linguas "$ENV{LINGUAS}" ) - -foreach( _dir IN LISTS _dirs ) - if( IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${_dir} - AND ( "${_dir}" STREQUAL "en" OR - "${_linguas}" MATCHES "^;*$" OR - ";${_linguas};" MATCHES ";${_dir};" )) - file( GLOB _doc_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}/${_dir} ${_dir}/*.docbook ) - if( _doc_files ) - list( FIND _doc_files "index.docbook" _find_index ) - if( -1 EQUAL _find_index ) - set( _noindex "NOINDEX" ) - else() - unset( _noindex ) - endif() - tde_create_handbook( - SOURCE_BASEDIR ${_dir} - ${_noindex} - LANG ${_dir} - DESTINATION ${PROJECT_NAME} - ) - endif() - endif() -endforeach() - -if( EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/html/CMakeLists.txt ) - add_subdirectory( html ) -endif() -if( EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/man/CMakeLists.txt ) - add_subdirectory( man ) -endif() +tde_auto_add_subdirectories( ) \ No newline at end of file diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt new file mode 100644 index 0000000..105110c --- /dev/null +++ b/doc/en/CMakeLists.txt @@ -0,0 +1,5 @@ +file( GLOB _srcs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.docbook *.css *.png *.jpg ) +tde_create_handbook( + FILES ${_srcs} + DESTINATION ${PROJECT_NAME} +) \ No newline at end of file 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 @@ klamav02 0.1"> - - + KlamAV"> + + - - - ]> - - - - - - - - @@ -44,512 +13,714 @@ thanks ;-). as Authors, publish date, the abstract, and Keywords --> -The &klamav02; Handbook +The &klamav; Handbook + - - -Robert Hogan +Philippe +Mavridis -
robert@roberthogan.net
+
mavridisf@gmail.com
 - + + +Robert +Hogan + +
robert@roberthogan.net
+ +Original Developer + + -1999 -2004 -Robert Hogan +2020 +2021 +The Trinity Desktop project - - -&FDLNotice; - - -2001-10-18 -0.1 +&FDLNotice; - +2021-03-04 +&klamav_version; -&klamav02; is an application specially designed to do nothing you would -ever want. +&klamav; is a sophisticated anti-virus manager for ClamAV. - - KDE -klamav02 -nothing -nothing else +KlamAV +ClamAV +Freshklam +Klamonacc +anti-virus - - Introduction - - + +&klamav; is an anti-virus manager for the Trinity Desktop Environment. + -&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. + + +The main window of &klamav; + + + + + + - -Using &klamav02; + +Using &klamav; - + +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. + +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 Tabs +menu on the top. You can use this menu to re-open any tabs you closed. + - + +Welcome tab - -Here's a screenshot of &klamav02; - - - - - - - - - Screenshot - - - + +This is probably the first tab that the user sees when they launch &klamav;. +It includes an overview of the &klamav; features. + +This tab has no useful functionality yet, so it can be safely disabled. + + + + +Scan tab + + +This tab contains the scan manager. From here you can launch and control any +of your &klamav; scans. This tab cannot be closed. + - -More &klamav02; features + +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. + -It slices! It dices! and it comes with a free toaster! -The Squiggle Tool - - - - - - - - Squiggle - - 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. + + + +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. + + + +Checking the "Scan Folders Recursively" checkbox enables scanning of the +selected folders' subdirectories. + + + +The "Schedule" button permits to schedule a scan on the selected directories +on a specific schedule. + + + +The "Options" button launches the general Options dialog. This option is also +accessible from the Scanner menu. + + + +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). + + + +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. - - -Command Reference + +Update tab + + +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. + + + +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. + + + +The next section permits you to set up Proxy information for use with Freshklam. + + + +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. + + + +The buttons "Update" and "Cancel" allow you to start/stop the update process +manually. + + + + + +Quarantine tab + + +This tab permits you to see which files have been quarantined by &klamav;, delete +them or restore them. + + + +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. + + + +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. + + + +The "Quarantine History" section lists the names of files which have once been +quarantined, but which you have since chosen to delete. + + + + +Virus Browser tab + + +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. + + + +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. + + + +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. + + + +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. + + + - + +Events tab - -The main &klamav02; window + +This tab contains the a detailed event log for &klamav; and its related parts +(Freshklam, KlamOnAcc). + + + +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. + - -The File Menu +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. + + + + + + +Commands Reference + + +The <guimenu>Scanner</guimenu> Menu + -&Ctrl;N +&Ctrl;O -File -New +Scanner +Scan File... -Creates a new document +Open a file to scan with &klamav;. + - -&Ctrl;S - -File -Save +Scanner +Scan Directory... -Saves the document +Open a directory to scan with &klamav;. + - -&Ctrl;Q - -File +Scanner +Schedule scan... + +Schedule a repeated scan at a specified time. + + + + +Scanner +Options... + +Launch the Options dialog. + + + + +Scanner Quit -Quits &klamav02; +Close &klamav;. - + + + +The <guimenu>Tabs</guimenu> Menu + - + + +Tabs +Show Welcome tab + +Show/hide the Welcome tab. + + + + +Tabs +Show Quarantine tab + +Show/hide the Quarantine tab. + + + + +Tabs +Show Virus Browser tab + +Show/hide the Virus Browser tab. + + + + +Tabs +Show Events tab + +Show/hide the Events tab. + + + - + The <guimenu>Help</guimenu> Menu + + + + + +F1 + +Help +The &klamav; Handbook + +Invokes the TDE Help System starting at the &klamav; help pages (this document). + - - - - + + +Help +Report Bug/Request Enhancement... + +Opens the Bug report dialog where you can report a bug or request a “wishlist” feature. + -&help.menu.documentation; + + +Help +Switch Application Language... + +Select the language which &klamav; will use. + - + + +Help +About &klamav; + +This will display version and author information. + + + +Help +About TDE + +This displays the TDE version and other basic information. + + + - -Developer's Guide to &klamav02; - + +Options dialog -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;. - + +The Options dialog + + + + + + + + +The Backend section - - -XtUnmanageChildren -Xt - Geometry Management - - -XtUnmanageChildren - -remove a list of children from a parent widget's managed -list. -widgetsremoving -XtUnmanageChildren - - - - - -4 March 1996 - - -void XtUnmanageChildren(children, num_children) - WidgetList children; - Cardinal num_children; - - - -Inputs - - -children - - -Specifies an array of child widgets. Each child must be of -class RectObj or any subclass thereof. + +Here you can select the backend that &klamav; will use for its scans. Two backends +are available. - - - -num_children - - -Specifies the number of elements in children. + + +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. - - - - - -Description - -XtUnmanageChildren() 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. - -Each of the widgets in the children array must have -the same parent. - -See the “Algorithm” section below for full details of the -widget unmanagement procedure. - - - - -Usage -Unmanaging widgets is the usual method for temporarily -making them invisible. They can be re-managed with -XtManageChildren(). - -You can unmap a widget, but leave it under geometry -management by calling XtUnmapWidget(). You can -destroy a widget's window without destroying the widget by -calling XtUnrealizeWidget(). You can destroy a -widget completely with XtDestroyWidget(). - -If you are only going to unmanage a single widget, it is -more convenient to call XtUnmanageChild(). It is -often more convenient to call XtUnmanageChild() -several times than it is to declare and initialize an array -of widgets to pass to XtUnmanageChildren(). Calling -XtUnmanageChildren() is more efficient, however, -because it only calls the parent's change_managed() -method once. - - - - -Algorithm - -XtUnmanageChildren() performs the following: + +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;. - - -- - - -Ignores the child if it already is unmanaged or is being -destroyed. + + +The Multiscan feature (available when "ClamAV daemon" is set as backend) makes +clamd scan the contents of a directory in parallel using available threads. - - - -- - - -Otherwise, if the child is realized, it makes it nonvisible -by unmapping it. + + + +The Archives section + + +Here you can configure everything related to scanning archive files. - - - + +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". - - -Structures -The WidgetList type is simply an array of widgets: + +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. -typedef Widget *WidgetList; - - - + - + +The E-Mail Protection section - -Questions and Answers - - - -&reporting.bugs; -&updating.documentation; - - - - -My Mouse doesn't work. How do I quit &klamav02;? - - -You silly goose! Check out the Commands -Section for the answer. - - - - -Why can't I twiddle my documents? - - -You can only twiddle your documents if you have the foobar.lib -installed. - - - - + +Here you can configure your e-mail client to scan incoming and outgoing files +with Klammail. Currently available clients are KMail and Evolution (untested). + - + +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. + - + +For KMail, you can also press the "Configure Automatically" button to let &klamav; +do it for you. + + -Credits and License + +The File Types section + + +Here you can configure how different types of files will be treated by &klamav;. + -&klamav02; +The "Exclude Quarantine Directory" option is on by default. You might want to +keep this option on in order to prevent false positives. + -Program copyright 2004 Robert Hogan robert@roberthogan.net +Options marked red are related to how &klamav; handles suspicious files and +detected viruses. + -Contributors: - -Konqui the KDE Dragon konqui@kde.org - -Tux the Linux Penguin tux@linux.org - - +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. + + + +The On-Access Scanner section -Documentation copyright 2004 Robert Hogan robert@roberthogan.net +This sections allows you to configure your on-access file scanner. - + +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. + -&underFDL; + +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). + - + +The "Exclude TDE Configuration Directory" is currently unavailable due to a +possible bug in ClamAV. + -&underGPL; -&underBSDLicense; -&underArtisticLicense; -&underX11License; + +You can set a limit on the size of scanned files by setting a value for the +"Max File Size" field. + - + +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. + - -Installation + +After you have enabled on-access scanning, you can start/stop the scanner daemon +manually through the system tray icon of &klamav;. + + - -How to obtain &klamav02; + +The Event Logging section - + +Here you can configure how the event logging feature works. + -&install.intro.documentation; + +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. + + +You can also configure the events that &klamav; will keep track of and log by +checking/unchecking the appropriate checkboxes. + - -Requirements + - + +System Tray Icon -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). -All required libraries as well as &klamav02; itself can be found -on The &klamav02; home page. + + + + +means that &klamav; is open and the on-access +scanner is inactive. - -You can find a list of changes at http://apps.kde.org/klamav02. + + + + +means that the on-access scanner is active. - - -Compilation and Installation + + + + + +means that one or more scans are active. + - - - + + + + + +means that a scan has finished and no threats +have been found. + -&install.compile.documentation; + + + + + +means that a scan has finished and some viruses +or suspicious files have been detected. + - + + + + + +means that some detected files are being put into +quarantine. + - -Configuration + + + + + +means that an error has occured. + -Don't forget to tell your system to start the dtd -dicer-toaster daemon first, or &klamav02; won't work ! + + + + + +means that there is a newer version of ClamAV and +you should update. + - + - + +Credits and License -&documentation.index; - + + +&klamav; &klamav_version; + - + + +Documentation copyright 2021 Mavridis Philippe mavridisf@gmail.com + + + + +Icons by Maarten van Gent (since version 0.45) + + + + + + +&underFDL; +&underGPL; + + + +&documentation.index; + diff --git a/doc/en/klamav.png b/doc/en/klamav.png new file mode 100644 index 0000000..e8afac3 Binary files /dev/null and b/doc/en/klamav.png differ diff --git a/doc/en/klamav_error.png b/doc/en/klamav_error.png new file mode 100644 index 0000000..40e5c7e Binary files /dev/null and b/doc/en/klamav_error.png differ diff --git a/doc/en/klamav_on_acc_disabled.png b/doc/en/klamav_on_acc_disabled.png new file mode 100644 index 0000000..bcdc517 Binary files /dev/null and b/doc/en/klamav_on_acc_disabled.png differ diff --git a/doc/en/klamav_on_acc_enabled.png b/doc/en/klamav_on_acc_enabled.png new file mode 100644 index 0000000..a113d9d Binary files /dev/null and b/doc/en/klamav_on_acc_enabled.png differ diff --git a/doc/en/klamav_quarantining.png b/doc/en/klamav_quarantining.png new file mode 100644 index 0000000..7dab54f Binary files /dev/null and b/doc/en/klamav_quarantining.png differ diff --git a/doc/en/klamav_scan_found.png b/doc/en/klamav_scan_found.png new file mode 100644 index 0000000..50d0697 Binary files /dev/null and b/doc/en/klamav_scan_found.png differ diff --git a/doc/en/klamav_scan_safe.png b/doc/en/klamav_scan_safe.png new file mode 100644 index 0000000..1d1639c Binary files /dev/null and b/doc/en/klamav_scan_safe.png differ diff --git a/doc/en/klamav_scanning.png b/doc/en/klamav_scanning.png new file mode 100644 index 0000000..87dd00d Binary files /dev/null and b/doc/en/klamav_scanning.png differ diff --git a/doc/en/klamav_update_required.png b/doc/en/klamav_update_required.png new file mode 100644 index 0000000..0c40372 Binary files /dev/null and b/doc/en/klamav_update_required.png differ diff --git a/doc/en/klamav_virus.png b/doc/en/klamav_virus.png new file mode 100644 index 0000000..e6ed403 Binary files /dev/null and b/doc/en/klamav_virus.png differ -- cgit v1.2.1