updated user docs: removed Clamuko doc, added on-access doc

remotes/push_mirror/0.98.2
Kevin Lin 12 years ago
parent 16375c1452
commit e6931a440e
  1. 111
      docs/clamdoc.tex

@ -71,7 +71,7 @@
\vspace{3cm}
\begin{flushright}
\rule[-1ex]{8cm}{3pt}\\
\huge Clam AntiVirus 0.98\\
\huge Clam AntiVirus 0.98.1\\
\huge \emph{User Manual}\\
\end{flushright}
@ -126,7 +126,7 @@
\item{Licensed under the GNU General Public License, Version 2}
\item{POSIX compliant, portable}
\item{Fast scanning}
\item{Supports on-access scanning (Linux and FreeBSD only)}
\item{Supports on-access scanning (Linux only)}
\item{Detects over 1 million viruses, worms and trojans, including
Microsoft Office macro viruses, mobile malware, and other threats}
\item{Built-in bytecode interpreter allows the ClamAV signature writers
@ -443,35 +443,12 @@ $ CK_FORK=no ./libtool --mode=execute valgrind unit_tests/check-clamav
\subsubsection{On-access scanning}
One of the interesting features of \verb+clamd+ is on-access scanning
based on the Dazuko module, available from \url{http://dazuko.org/}.
\textbf{This module is not required to run clamd - furthermore, you
shouldn't run Dazuko on production systems}. At the moment Dazuko is
avaliable for Linux and FreeBSD, but the following information only covers
Linux.
\begin{verbatim}
$ tar zxpvf dazuko-a.b.c.tar.gz
$ cd dazuko-a.b.c
$ make dazuko
or
$ make dazuko-smp (for smp kernels)
$ su
# insmod dazuko.o
# cp dazuko.o /lib/modules/`uname -r`/misc
# depmod -a
\end{verbatim}
Depending on your Linux distribution you may need to add a "dazuko" entry to
\emph{/etc/modules} or run the module during system's startup by adding
\begin{verbatim}
/sbin/modprobe dazuko
\end{verbatim}
to some startup file. You must also create a new device:
\begin{verbatim}
$ cat /proc/devices | grep dazuko
254 dazuko
$ su -c "mknod -m 600 /dev/dazuko c 254 0"
\end{verbatim}
Now configure Clamuko in \verb+clamd.conf+ and read the \ref{clamuko}
section.
based on fanotify, included in Linux since kernel 2.6.36.
\textbf{This is not required to run clamd}. At the moment the fanotify header is
only avaliable for Linux.
\\\\
Configure on-access scanning in \verb+clamd.conf+ and read the
\ref{On-access} section for on-access scanning usage.
\subsection{clamav-milter}\label{sec:clamavmilter}
ClamAV $\ge0.95$ includes a new, redesigned clamav-milter. The most notable
@ -730,9 +707,9 @@ N * * * * /usr/local/bin/freshclam --quiet
try to workaround this limitation by using FILDES
\end{itemize}
\subsection{Clamuko}\label{clamuko}
Clamuko is a special thread in \verb+clamd+ that performs on-access
scanning under Linux and FreeBSD and shares internal virus database
\subsection{On-access Scanning}\label{On-access}
There is a special thread in \verb+clamd+ that performs on-access
scanning under Linux and shares internal virus database
with the daemon. \textbf{You must follow some important rules when
using it:}
\begin{itemize}
@ -748,14 +725,13 @@ N * * * * /usr/local/bin/freshclam --quiet
For example, to protect the whole system add the following lines to
\verb+clamd.conf+:
\begin{verbatim}
ClamukoScanOnAccess
ClamukoIncludePath /
ClamukoExcludePath /proc
ClamukoExcludePath /temporary/dir/of/your/mail/scanning/software
ScanOnAccess yes
OnAccessIncludePath /
OnAccessExcludePath /proc
OnAccessExcludePath /temporary/dir/of/your/mail/scanning/software
\end{verbatim}
You can also use clamuko to protect files on Samba/Netatalk but a far
more better and safe idea is to use the \textbf{samba-vscan} module.
NFS is not supported because Dazuko doesn't intercept NFS access calls.
For more configuration options, type 'man clamd.conf' or reference the
example clamd.conf.
\subsection{Clamdtop}
\verb+clamdtop+ is a tool to monitor one or multiple instances of clamd. It
@ -834,36 +810,36 @@ clamav-milter.conf not found
Software settings
-----------------
Version: 0.97.6
Optional features supported: MEMPOOL IPv6 CLAMUKO AUTOIT_EA06 BZIP2 RAR JIT
Version: 0.98.1
Optional features supported: MEMPOOL IPv6 AUTOIT_EA06 BZIP2 RAR JIT
Database information
--------------------
Database directory: /usr/local/share/clamav
Database directory: /xclam/gcc/release/share/clamav
WARNING: freshclam.conf and clamd.conf point to different database directories
print_dbs: Can't open directory /usr/local/share/clamav
print_dbs: Can't open directory /xclam/gcc/release/share/clamav
Platform information
--------------------
uname: Linux 2.6.32-279.el6.x86_64 #1 SMP Fri Jun 22 12:19:21 UTC 2012 x86_64
OS: linux-gnu, ARCH: x86_64, CPU: x86_64
Full OS version: ``CentOS release 6.3 (Final)''
zlib version: 1.2.3 (1.2.3), compile flags: a9
Triple: x86_64-unknown-linux-gnu
CPU: amdfam10, Little-endian
platform id: 0x0a2143430804040607040406
uname: Linux 3.5.0-44-generic #67~precise1-Ubuntu SMP Wed Nov 13 16:20:03 UTC 2013 i686
OS: linux-gnu, ARCH: i386, CPU: i686
Full OS version: Ubuntu 12.04.3 LTS
zlib version: 1.2.3.4 (1.2.3.4), compile flags: 55
Triple: i386-pc-linux-gnu
CPU: i686, Little-endian
platform id: 0x0a114d4d0404060401040604
Build information
-----------------
GNU C: 4.4.6 20120305 (Red Hat 4.4.6-4) (4.4.6)
GNU C++: 4.4.6 20120305 (Red Hat 4.4.6-4) (4.4.6)
CPPFLAGS:
CFLAGS: -g -O2 -fno-strict-aliasing
CXXFLAGS:
LDFLAGS:
Configure: '--enable-check' '--sysconfdir=/etc/clamav'
--enable-ltdl-convenience
sizeof(void*) = 8
GNU C: 4.6.4 (4.6.4)
GNU C++: 4.6.4 (4.6.4)
CPPFLAGS:
CFLAGS: -g -O0 -D_LARGEFILE_SOURCE -D_LARGEFILE64_SOURCE
CXXFLAGS:
LDFLAGS:
Configure: '--prefix=/xclam/gcc/release/' '--disable-clamav' '--enable-debug' 'CFLAGS=-g -O0'
sizeof(void*) = 4
Engine flevel: 77, dconf: 77
\end{verbatim}
}
For more detailed help, type 'man clamconf' or 'clamconf --help'.
@ -1760,7 +1736,7 @@ Verification OK.
Role: virus database maintainer
\item Joel Esler \email{<jesler*sourcefire.com>}, USA\\
Role: open source community manager
Role: community manager
\item Tom Judge \email{<tjudge*sourcefire.com>}, USA\\
Role: infrastucture developer
@ -1777,11 +1753,14 @@ Verification OK.
\item Shawn Webb \email{<swebb*sourcefire.com>}, USA\\
Role: ClamAV developer
\item Kevin Lin \email{<klin*sourcefire.com>}, USA\\
Role: ClamAV developer
\item Kevin Lin \email{<klin*sourcefire.com>}, USA\\
Role: ClamAV developer
\item Dave Suffling \email{<dsuffling*sourcefire.com>}, Canada\\
Role: ClamAV developer
\item Dave Suffling \email{<dsuffling*sourcefire.com>}, USA\\
Role: ClamAV developer
\item Samir Sapra \email{<ssapra*sourcefire.com>}, USA\\
Role: ClamAV developer
\item Alain Zidouemba \email{<azidouemba*sourcefire.com>}, USA\\
Role: virus database maintainer

Loading…
Cancel
Save