Browse code

updated documentation with dependencies and program details, regenerated clamdoc.pdf

Kevin Lin authored on 2013/10/17 00:01:06
Showing 2 changed files
1 1
Binary files a/docs/clamdoc.pdf and b/docs/clamdoc.pdf differ
... ...
@@ -144,9 +144,12 @@
144 144
 		\item Gzip
145 145
 		\item Bzip2
146 146
                 \item DMG
147
-                \item IMG 9660
148
-                \item ISO
147
+                \item IMG
148
+                \item ISO 9660
149 149
                 \item PKG
150
+                \item HFS+ partition
151
+                \item HFSX partition
152
+                \item XAR
150 153
                 \item XZ
151 154
 		\item MS OLE2
152 155
 		\item MS Cabinet Files (including SFX)
... ...
@@ -253,7 +256,6 @@
253 253
     \begin{itemize}
254 254
 	\item bzip2 and bzip2-devel library
255 255
         \item libxml2 and libxml2-dev library
256
-        \item libxar-dev library
257 256
 	\item \verb+check+ unit testing framework \footnote{See section \ref{unit-testing} on how to run the unit tests}.
258 257
     \end{itemize}
259 258
     The following packages are optional, but \textbf{required for bytecode JIT support}:
... ...
@@ -789,6 +791,7 @@ N * * * *	/usr/local/bin/freshclam --quiet
789 789
     fully replaced after several failed attempts unless otherwise specified.
790 790
     \\\\
791 791
     Here is a sample usage including cdiffs:
792
+{\footnotesize
792 793
     \begin{verbatim}
793 794
 $ freshclam
794 795
 
... ...
@@ -803,6 +806,7 @@ Downloading bytecode-228.cdiff [100%]
803 803
 bytecode.cld updated (version: 228, sigs: 43, f-level: 63, builder: neo)
804 804
 Database updated (2831219 signatures) from database.clamav.net (IP: 64.6.100.177)
805 805
     \end{verbatim}
806
+}
806 807
     For more detailed help, type 'man clamscan' or 'clamscan --help'.
807 808
 
808 809
     \subsection{Clamconf}\label{sec:clamconf}
... ...
@@ -812,54 +816,56 @@ Database updated (2831219 signatures) from database.clamav.net (IP: 64.6.100.177
812 812
     properly configured), the contents of freshclam.conf, and display
813 813
     information about software settings, database, platform, and build
814 814
     information. Here is a sample clamconf output:
815
+{\footnotesize
815 816
     \begin{verbatim}
816
-        $ clamconf
817
-
818
-        Checking configuration files in /etc/clamav
819
-
820
-        Config file: clamd.conf
821
-        -----------------------
822
-        ERROR: Please edit the example config file /etc/clamav/clamd.conf
823
-
824
-        Config file: freshclam.conf
825
-        ---------------------------
826
-        ERROR: Please edit the example config file /etc/clamav/freshclam.conf
827
-
828
-        clamav-milter.conf not found
829
-
830
-        Software settings
831
-        -----------------
832
-        Version: 0.97.6
833
-        Optional features supported: MEMPOOL IPv6 CLAMUKO AUTOIT_EA06 BZIP2 RAR JIT
834
-
835
-        Database information
836
-        --------------------
837
-        Database directory: /usr/local/share/clamav
838
-        WARNING: freshclam.conf and clamd.conf point to different database directories
839
-        print_dbs: Can't open directory /usr/local/share/clamav
840
-
841
-        Platform information
842
-        --------------------
843
-        uname: Linux 2.6.32-279.el6.x86_64 #1 SMP Fri Jun 22 12:19:21 UTC 2012 x86_64
844
-        OS: linux-gnu, ARCH: x86_64, CPU: x86_64
845
-        Full OS version: ``CentOS release 6.3 (Final)''
846
-        zlib version: 1.2.3 (1.2.3), compile flags: a9
847
-        Triple: x86_64-unknown-linux-gnu
848
-        CPU: amdfam10, Little-endian
849
-        platform id: 0x0a2143430804040607040406
850
-
851
-        Build information
852
-        -----------------
853
-        GNU C: 4.4.6 20120305 (Red Hat 4.4.6-4) (4.4.6)
854
-        GNU C++: 4.4.6 20120305 (Red Hat 4.4.6-4) (4.4.6)
855
-        CPPFLAGS: 
856
-        CFLAGS: -g -O2 -fno-strict-aliasing
857
-        CXXFLAGS: 
858
-        LDFLAGS: 
859
-        Configure: '--enable-check' '--sysconfdir=/etc/clamav'
860
-        --enable-ltdl-convenience
861
-        sizeof(void*) = 8
862
-    \end{verbatim}
817
+$ clamconf
818
+
819
+Checking configuration files in /etc/clamav
820
+
821
+Config file: clamd.conf
822
+-----------------------
823
+ERROR: Please edit the example config file /etc/clamav/clamd.conf
824
+
825
+Config file: freshclam.conf
826
+---------------------------
827
+ERROR: Please edit the example config file /etc/clamav/freshclam.conf
828
+
829
+clamav-milter.conf not found
830
+
831
+Software settings
832
+-----------------
833
+Version: 0.97.6
834
+Optional features supported: MEMPOOL IPv6 CLAMUKO AUTOIT_EA06 BZIP2 RAR JIT
835
+
836
+Database information
837
+--------------------
838
+Database directory: /usr/local/share/clamav
839
+WARNING: freshclam.conf and clamd.conf point to different database directories
840
+print_dbs: Can't open directory /usr/local/share/clamav
841
+
842
+Platform information
843
+--------------------
844
+uname: Linux 2.6.32-279.el6.x86_64 #1 SMP Fri Jun 22 12:19:21 UTC 2012 x86_64
845
+OS: linux-gnu, ARCH: x86_64, CPU: x86_64
846
+Full OS version: ``CentOS release 6.3 (Final)''
847
+zlib version: 1.2.3 (1.2.3), compile flags: a9
848
+Triple: x86_64-unknown-linux-gnu
849
+CPU: amdfam10, Little-endian
850
+platform id: 0x0a2143430804040607040406
851
+
852
+Build information
853
+-----------------
854
+GNU C: 4.4.6 20120305 (Red Hat 4.4.6-4) (4.4.6)
855
+GNU C++: 4.4.6 20120305 (Red Hat 4.4.6-4) (4.4.6)
856
+CPPFLAGS: 
857
+CFLAGS: -g -O2 -fno-strict-aliasing
858
+CXXFLAGS: 
859
+LDFLAGS: 
860
+Configure: '--enable-check' '--sysconfdir=/etc/clamav'
861
+--enable-ltdl-convenience
862
+sizeof(void*) = 8
863
+ \end{verbatim}
864
+}
863 865
     For more detailed help, type 'man clamconf' or 'clamconf --help'.
864 866
 
865 867
     \subsection{Output format}
... ...
@@ -958,9 +964,12 @@ Database updated (2831219 signatures) from database.clamav.net (IP: 64.6.100.177
958 958
 	\item Gzip
959 959
 	\item Bzip2
960 960
         \item DMG
961
-        \item IMG 9660
962
-        \item ISO
961
+        \item IMG
962
+        \item ISO 9660
963 963
         \item PKG
964
+        \item HFS+ partition
965
+        \item HFSX partition
966
+        \item XAR
964 967
         \item XZ
965 968
 	\item MS OLE2
966 969
 	\item MS Cabinet Files (+ SFX)
... ...
@@ -1768,9 +1777,6 @@ Verification OK.
1768 1768
 	\item Shawn Webb \email{<swebb*sourcefire.com>}, USA\\
1769 1769
 	Role: ClamAV developer
1770 1770
 
1771
-	\item Carl Wu \email{<cwu*sourcefire.com>}, USA\\
1772
-        Role: ClamAV developer
1773
-
1774 1771
         \item Kevin Lin \email{<klin*sourcefire.com>}, USA\\
1775 1772
         Role: ClamAV developer
1776 1773