Browse code

update clamdoc

git-svn: trunk@4955

Tomasz Kojm authored on 2009/03/17 01:04:29
Showing 64 changed files
1 1
Binary files a/docs/clamdoc.pdf and b/docs/clamdoc.pdf differ
... ...
@@ -71,7 +71,7 @@
71 71
     \vspace{3cm}
72 72
     \begin{flushright}
73 73
 	\rule[-1ex]{8cm}{3pt}\\
74
-	\huge Clam AntiVirus 0.95rc1\\
74
+	\huge Clam AntiVirus 0.95rc2\\
75 75
 	\huge \emph{User Manual}\\
76 76
     \end{flushright}
77 77
 
... ...
@@ -907,17 +907,23 @@ N * * * *	/usr/local/bin/freshclam --quiet
907 907
     \subsection{Limits}
908 908
     When you create a new engine with \verb+cl_engine_new()+, it will have
909 909
     all internal settings set to default values as recommended by the
910
-    ClamAV authors. It's possible to check and modify the values using
911
-    this couple of functions:
910
+    ClamAV authors. It's possible to check and modify the values (numerical
911
+    and strings) using the following set of functions:
912 912
     \begin{verbatim}
913
-	int cl_engine_set(struct cl_engine *engine,
914
-	enum cl_engine_field field, const void *val);
913
+int cl_engine_set_num(struct cl_engine *engine,
914
+  enum cl_engine_field field, long long num);
915 915
 
916
-	int cl_engine_get(const struct cl_engine *engine,
917
-	enum cl_engine_field fi eld, void *val);
916
+long long cl_engine_get_num(const struct cl_engine *engine,
917
+  enum cl_engine_field field, int *err);
918
+
919
+int cl_engine_set_str(struct cl_engine *engine,
920
+  enum cl_engine_field field, const char *str);
921
+
922
+const char *cl_engine_get_str(const struct cl_engine *engine,
923
+  enum cl_engine_field field, int *err);
918 924
     \end{verbatim}
919 925
     Please don't modify the default values unless you know what you're doing.
920
-    Refer to ClamAV sources (clamscan, clamd) for examples.
926
+    Refer to the ClamAV sources (clamscan, clamd) for examples.
921 927
 
922 928
     \subsection{Database reloading}
923 929
     It's very important  to keep the internal instance of the database up to
... ...
@@ -56,7 +56,7 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
56 56
 <BR>
57 57
 <BR>
58 58
     <DIV ALIGN="RIGHT">
59
-<BR>	<BIG CLASS="HUGE">Clam AntiVirus 0.95rc1
59
+<BR>	<BIG CLASS="HUGE">Clam AntiVirus 0.95rc2
60 60
 <BR>	<BIG CLASS="HUGE"><SPAN  CLASS="textit">User Manual</SPAN>
61 61
 <BR>    
62 62
 </BIG></BIG></DIV>
... ...
@@ -225,7 +225,7 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
225 225
 <BR><HR>
226 226
 <ADDRESS>
227 227
 Tomasz Kojm
228
-2009-02-25
228
+2009-03-16
229 229
 </ADDRESS>
230 230
 </BODY>
231 231
 </HTML>
... ...
@@ -56,7 +56,7 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
56 56
 <BR>
57 57
 <BR>
58 58
     <DIV ALIGN="RIGHT">
59
-<BR>	<BIG CLASS="HUGE">Clam AntiVirus 0.95rc1
59
+<BR>	<BIG CLASS="HUGE">Clam AntiVirus 0.95rc2
60 60
 <BR>	<BIG CLASS="HUGE"><SPAN  CLASS="textit">User Manual</SPAN>
61 61
 <BR>    
62 62
 </BIG></BIG></DIV>
... ...
@@ -225,7 +225,7 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
225 225
 <BR><HR>
226 226
 <ADDRESS>
227 227
 Tomasz Kojm
228
-2009-02-25
228
+2009-03-16
229 229
 </ADDRESS>
230 230
 </BODY>
231 231
 </HTML>
... ...
@@ -188,7 +188,7 @@ ClamAV and Clam AntiVirus are trademarks of Sourcefire, Inc.
188 188
 <BR><HR>
189 189
 <ADDRESS>
190 190
 Tomasz Kojm
191
-2009-02-25
191
+2009-03-16
192 192
 </ADDRESS>
193 193
 </BODY>
194 194
 </HTML>
... ...
@@ -85,7 +85,7 @@ Requirements</A>
85 85
 <BR><HR>
86 86
 <ADDRESS>
87 87
 Tomasz Kojm
88
-2009-02-25
88
+2009-03-16
89 89
 </ADDRESS>
90 90
 </BODY>
91 91
 </HTML>
... ...
@@ -75,7 +75,7 @@ Installing on shell account</A>
75 75
 <BR><HR>
76 76
 <ADDRESS>
77 77
 Tomasz Kojm
78
-2009-02-25
78
+2009-03-16
79 79
 </ADDRESS>
80 80
 </BODY>
81 81
 </HTML>
... ...
@@ -69,7 +69,7 @@ Adding new system user and group</A>
69 69
 <BR><HR>
70 70
 <ADDRESS>
71 71
 Tomasz Kojm
72
-2009-02-25
72
+2009-03-16
73 73
 </ADDRESS>
74 74
 </BODY>
75 75
 </HTML>
... ...
@@ -75,7 +75,7 @@ Compilation of base package</A>
75 75
 <BR><HR>
76 76
 <ADDRESS>
77 77
 Tomasz Kojm
78
-2009-02-25
78
+2009-03-16
79 79
 </ADDRESS>
80 80
 </BODY>
81 81
 </HTML>
... ...
@@ -65,7 +65,7 @@ Compilation with clamav-milter enabled</A>
65 65
 <BR><HR>
66 66
 <ADDRESS>
67 67
 Tomasz Kojm
68
-2009-02-25
68
+2009-03-16
69 69
 </ADDRESS>
70 70
 </BODY>
71 71
 </HTML>
... ...
@@ -142,7 +142,7 @@ All 4 tests passed
142 142
 <!--End of Navigation Panel-->
143 143
 <ADDRESS>
144 144
 Tomasz Kojm
145
-2009-02-25
145
+2009-03-16
146 146
 </ADDRESS>
147 147
 </BODY>
148 148
 </HTML>
... ...
@@ -96,7 +96,7 @@ $ CK_FORK=no ./libtool --mode=execute valgrind unit_tests/check-clamav
96 96
 <BR><HR>
97 97
 <ADDRESS>
98 98
 Tomasz Kojm
99
-2009-02-25
99
+2009-03-16
100 100
 </ADDRESS>
101 101
 </BODY>
102 102
 </HTML>
... ...
@@ -87,7 +87,7 @@ Configuration</A>
87 87
 <BR><HR>
88 88
 <ADDRESS>
89 89
 Tomasz Kojm
90
-2009-02-25
90
+2009-03-16
91 91
 </ADDRESS>
92 92
 </BODY>
93 93
 </HTML>
... ...
@@ -79,7 +79,7 @@ clamd</A>
79 79
 <BR><HR>
80 80
 <ADDRESS>
81 81
 Tomasz Kojm
82
-2009-02-25
82
+2009-03-16
83 83
 </ADDRESS>
84 84
 </BODY>
85 85
 </HTML>
... ...
@@ -90,7 +90,7 @@ On-access scanning</A>
90 90
 <BR><HR>
91 91
 <ADDRESS>
92 92
 Tomasz Kojm
93
-2009-02-25
93
+2009-03-16
94 94
 </ADDRESS>
95 95
 </BODY>
96 96
 </HTML>
... ...
@@ -79,7 +79,7 @@ Introduction</A>
79 79
 <BR><HR>
80 80
 <ADDRESS>
81 81
 Tomasz Kojm
82
-2009-02-25
82
+2009-03-16
83 83
 </ADDRESS>
84 84
 </BODY>
85 85
 </HTML>
... ...
@@ -67,7 +67,7 @@ clamav-milter</A>
67 67
 <BR><HR>
68 68
 <ADDRESS>
69 69
 Tomasz Kojm
70
-2009-02-25
70
+2009-03-16
71 71
 </ADDRESS>
72 72
 </BODY>
73 73
 </HTML>
... ...
@@ -75,7 +75,7 @@ Testing</A>
75 75
 <BR><HR>
76 76
 <ADDRESS>
77 77
 Tomasz Kojm
78
-2009-02-25
78
+2009-03-16
79 79
 </ADDRESS>
80 80
 </BODY>
81 81
 </HTML>
... ...
@@ -140,7 +140,7 @@ N * * * *	/usr/local/bin/freshclam --quiet
140 140
 <!--End of Navigation Panel-->
141 141
 <ADDRESS>
142 142
 Tomasz Kojm
143
-2009-02-25
143
+2009-03-16
144 144
 </ADDRESS>
145 145
 </BODY>
146 146
 </HTML>
... ...
@@ -77,7 +77,7 @@ Closest mirrors</A>
77 77
 <BR><HR>
78 78
 <ADDRESS>
79 79
 Tomasz Kojm
80
-2009-02-25
80
+2009-03-16
81 81
 </ADDRESS>
82 82
 </BODY>
83 83
 </HTML>
... ...
@@ -108,7 +108,7 @@ The only private data that is transferred is an IP address, which is used
108 108
 <!--End of Navigation Panel-->
109 109
 <ADDRESS>
110 110
 Tomasz Kojm
111
-2009-02-25
111
+2009-03-16
112 112
 </ADDRESS>
113 113
 </BODY>
114 114
 </HTML>
... ...
@@ -80,7 +80,7 @@ Usage</A>
80 80
 <BR><HR>
81 81
 <ADDRESS>
82 82
 Tomasz Kojm
83
-2009-02-25
83
+2009-03-16
84 84
 </ADDRESS>
85 85
 </BODY>
86 86
 </HTML>
... ...
@@ -230,7 +230,7 @@ Scan stream: clamd will return a new port number you should
230 230
 <!--End of Navigation Panel-->
231 231
 <ADDRESS>
232 232
 Tomasz Kojm
233
-2009-02-25
233
+2009-03-16
234 234
 </ADDRESS>
235 235
 </BODY>
236 236
 </HTML>
... ...
@@ -76,7 +76,7 @@ Clam<SPAN  CLASS="textbf">d</SPAN>scan</A>
76 76
 <BR><HR>
77 77
 <ADDRESS>
78 78
 Tomasz Kojm
79
-2009-02-25
79
+2009-03-16
80 80
 </ADDRESS>
81 81
 </BODY>
82 82
 </HTML>
... ...
@@ -92,7 +92,7 @@ SIGTERM signal. In other case you can lose access
92 92
 <BR><HR>
93 93
 <ADDRESS>
94 94
 Tomasz Kojm
95
-2009-02-25
95
+2009-03-16
96 96
 </ADDRESS>
97 97
 </BODY>
98 98
 </HTML>
... ...
@@ -70,7 +70,7 @@ Output format</A>
70 70
 <BR><HR>
71 71
 <ADDRESS>
72 72
 Tomasz Kojm
73
-2009-02-25
73
+2009-03-16
74 74
 </ADDRESS>
75 75
 </BODY>
76 76
 </HTML>
... ...
@@ -183,7 +183,7 @@ Features</A>
183 183
 <!--End of Navigation Panel-->
184 184
 <ADDRESS>
185 185
 Tomasz Kojm
186
-2009-02-25
186
+2009-03-16
187 187
 </ADDRESS>
188 188
 </BODY>
189 189
 </HTML>
... ...
@@ -79,7 +79,7 @@ clamscan</A>
79 79
 <BR><HR>
80 80
 <ADDRESS>
81 81
 Tomasz Kojm
82
-2009-02-25
82
+2009-03-16
83 83
 </ADDRESS>
84 84
 </BODY>
85 85
 </HTML>
... ...
@@ -83,7 +83,7 @@ Error messages are printed in the following format:
83 83
 <BR><HR>
84 84
 <ADDRESS>
85 85
 Tomasz Kojm
86
-2009-02-25
86
+2009-03-16
87 87
 </ADDRESS>
88 88
 </BODY>
89 89
 </HTML>
... ...
@@ -135,7 +135,7 @@ LibClamAV</A>
135 135
 <BR><HR>
136 136
 <ADDRESS>
137 137
 Tomasz Kojm
138
-2009-02-25
138
+2009-03-16
139 139
 </ADDRESS>
140 140
 </BODY>
141 141
 </HTML>
... ...
@@ -65,7 +65,7 @@ Licence</A>
65 65
 <BR><HR>
66 66
 <ADDRESS>
67 67
 Tomasz Kojm
68
-2009-02-25
68
+2009-03-16
69 69
 </ADDRESS>
70 70
 </BODY>
71 71
 </HTML>
... ...
@@ -79,7 +79,7 @@ Supported formats</A>
79 79
 <BR><HR>
80 80
 <ADDRESS>
81 81
 Tomasz Kojm
82
-2009-02-25
82
+2009-03-16
83 83
 </ADDRESS>
84 84
 </BODY>
85 85
 </HTML>
... ...
@@ -87,7 +87,7 @@ Executables</A>
87 87
 <BR><HR>
88 88
 <ADDRESS>
89 89
 Tomasz Kojm
90
-2009-02-25
90
+2009-03-16
91 91
 </ADDRESS>
92 92
 </BODY>
93 93
 </HTML>
... ...
@@ -62,7 +62,7 @@ Mail files</A>
62 62
 <BR><HR>
63 63
 <ADDRESS>
64 64
 Tomasz Kojm
65
-2009-02-25
65
+2009-03-16
66 66
 </ADDRESS>
67 67
 </BODY>
68 68
 </HTML>
... ...
@@ -92,7 +92,7 @@ Archives and compressed files</A>
92 92
 <BR><HR>
93 93
 <ADDRESS>
94 94
 Tomasz Kojm
95
-2009-02-25
95
+2009-03-16
96 96
 </ADDRESS>
97 97
 </BODY>
98 98
 </HTML>
... ...
@@ -73,7 +73,7 @@ Documents</A>
73 73
 <BR><HR>
74 74
 <ADDRESS>
75 75
 Tomasz Kojm
76
-2009-02-25
76
+2009-03-16
77 77
 </ADDRESS>
78 78
 </BODY>
79 79
 </HTML>
... ...
@@ -62,7 +62,7 @@ Data Loss Prevention</A>
62 62
 <BR><HR>
63 63
 <ADDRESS>
64 64
 Tomasz Kojm
65
-2009-02-25
65
+2009-03-16
66 66
 </ADDRESS>
67 67
 </BODY>
68 68
 </HTML>
... ...
@@ -86,7 +86,7 @@ Alternatively you can try asking on the <code>#clamav</code> IRC channel - launc
86 86
 <BR><HR>
87 87
 <ADDRESS>
88 88
 Tomasz Kojm
89
-2009-02-25
89
+2009-03-16
90 90
 </ADDRESS>
91 91
 </BODY>
92 92
 </HTML>
... ...
@@ -75,7 +75,7 @@ Others</A>
75 75
 <BR><HR>
76 76
 <ADDRESS>
77 77
 Tomasz Kojm
78
-2009-02-25
78
+2009-03-16
79 79
 </ADDRESS>
80 80
 </BODY>
81 81
 </HTML>
... ...
@@ -69,7 +69,7 @@ API</A>
69 69
 <BR><HR>
70 70
 <ADDRESS>
71 71
 Tomasz Kojm
72
-2009-02-25
72
+2009-03-16
73 73
 </ADDRESS>
74 74
 </BODY>
75 75
 </HTML>
... ...
@@ -63,7 +63,7 @@ Header file</A>
63 63
 <BR><HR>
64 64
 <ADDRESS>
65 65
 Tomasz Kojm
66
-2009-02-25
66
+2009-03-16
67 67
 </ADDRESS>
68 68
 </BODY>
69 69
 </HTML>
... ...
@@ -86,7 +86,7 @@ Initialization</A>
86 86
 <BR><HR>
87 87
 <ADDRESS>
88 88
 Tomasz Kojm
89
-2009-02-25
89
+2009-03-16
90 90
 </ADDRESS>
91 91
 </BODY>
92 92
 </HTML>
... ...
@@ -122,7 +122,7 @@ Load CVD files directly without unpacking them into a temporary
122 122
 <BR><HR>
123 123
 <ADDRESS>
124 124
 Tomasz Kojm
125
-2009-02-25
125
+2009-03-16
126 126
 </ADDRESS>
127 127
 </BODY>
128 128
 </HTML>
... ...
@@ -69,7 +69,7 @@ Error handling</A>
69 69
 <BR><HR>
70 70
 <ADDRESS>
71 71
 Tomasz Kojm
72
-2009-02-25
72
+2009-03-16
73 73
 </ADDRESS>
74 74
 </BODY>
75 75
 </HTML>
... ...
@@ -74,7 +74,7 @@ Engine structure</A>
74 74
 <BR><HR>
75 75
 <ADDRESS>
76 76
 Tomasz Kojm
77
-2009-02-25
77
+2009-03-16
78 78
 </ADDRESS>
79 79
 </BODY>
80 80
 </HTML>
... ...
@@ -57,23 +57,29 @@ Limits</A>
57 57
 </H2>
58 58
     When you create a new engine with <code>cl_engine_new()</code>, it will have
59 59
     all internal settings set to default values as recommended by the
60
-    ClamAV authors. It's possible to check and modify the values using
61
-    this couple of functions:
60
+    ClamAV authors. It's possible to check and modify the values (numerical
61
+    and strings) using the following set of functions:
62 62
     <PRE>
63
-	int cl_engine_set(struct cl_engine *engine,
64
-	enum cl_engine_field field, const void *val);
63
+int cl_engine_set_num(struct cl_engine *engine,
64
+  enum cl_engine_field field, long long num);
65 65
 
66
-	int cl_engine_get(const struct cl_engine *engine,
67
-	enum cl_engine_field fi eld, void *val);
66
+long long cl_engine_get_num(const struct cl_engine *engine,
67
+  enum cl_engine_field field, int *err);
68
+
69
+int cl_engine_set_str(struct cl_engine *engine,
70
+  enum cl_engine_field field, const char *str);
71
+
72
+const char *cl_engine_get_str(const struct cl_engine *engine,
73
+  enum cl_engine_field field, int *err);
68 74
 </PRE>
69 75
     Please don't modify the default values unless you know what you're doing.
70
-    Refer to ClamAV sources (clamscan, clamd) for examples.
76
+    Refer to the ClamAV sources (clamscan, clamd) for examples.
71 77
 
72 78
 <P>
73 79
 <BR><HR>
74 80
 <ADDRESS>
75 81
 Tomasz Kojm
76
-2009-02-25
82
+2009-03-16
77 83
 </ADDRESS>
78 84
 </BODY>
79 85
 </HTML>
... ...
@@ -103,7 +103,7 @@ Database reloading</A>
103 103
 <BR><HR>
104 104
 <ADDRESS>
105 105
 Tomasz Kojm
106
-2009-02-25
106
+2009-03-16
107 107
 </ADDRESS>
108 108
 </BODY>
109 109
 </HTML>
... ...
@@ -220,7 +220,7 @@ Allow heuristic match to take precedence. When enabled, if
220 220
 <!--End of Navigation Panel-->
221 221
 <ADDRESS>
222 222
 Tomasz Kojm
223
-2009-02-25
223
+2009-03-16
224 224
 </ADDRESS>
225 225
 </BODY>
226 226
 </HTML>
... ...
@@ -65,7 +65,7 @@ Virus submitting</A>
65 65
 <BR><HR>
66 66
 <ADDRESS>
67 67
 Tomasz Kojm
68
-2009-02-25
68
+2009-03-16
69 69
 </ADDRESS>
70 70
 </BODY>
71 71
 </HTML>
... ...
@@ -63,7 +63,7 @@ Memory</A>
63 63
 <BR><HR>
64 64
 <ADDRESS>
65 65
 Tomasz Kojm
66
-2009-02-25
66
+2009-03-16
67 67
 </ADDRESS>
68 68
 </BODY>
69 69
 </HTML>
... ...
@@ -65,7 +65,7 @@ Forking daemons</A>
65 65
 <BR><HR>
66 66
 <ADDRESS>
67 67
 Tomasz Kojm
68
-2009-02-25
68
+2009-03-16
69 69
 </ADDRESS>
70 70
 </BODY>
71 71
 </HTML>
... ...
@@ -67,7 +67,7 @@ clamav-config</A>
67 67
 <BR><HR>
68 68
 <ADDRESS>
69 69
 Tomasz Kojm
70
-2009-02-25
70
+2009-03-16
71 71
 </ADDRESS>
72 72
 </BODY>
73 73
 </HTML>
... ...
@@ -65,7 +65,7 @@ Example</A>
65 65
 <BR><HR>
66 66
 <ADDRESS>
67 67
 Tomasz Kojm
68
-2009-02-25
68
+2009-03-16
69 69
 </ADDRESS>
70 70
 </BODY>
71 71
 </HTML>
... ...
@@ -82,7 +82,7 @@ Verification OK.
82 82
 <BR><HR>
83 83
 <ADDRESS>
84 84
 Tomasz Kojm
85
-2009-02-25
85
+2009-03-16
86 86
 </ADDRESS>
87 87
 </BODY>
88 88
 </HTML>
... ...
@@ -613,7 +613,7 @@ Contributors</A>
613 613
 <!--End of Navigation Panel-->
614 614
 <ADDRESS>
615 615
 Tomasz Kojm
616
-2009-02-25
616
+2009-03-16
617 617
 </ADDRESS>
618 618
 </BODY>
619 619
 </HTML>
... ...
@@ -459,7 +459,7 @@ Donors</A>
459 459
 <!--End of Navigation Panel-->
460 460
 <ADDRESS>
461 461
 Tomasz Kojm
462
-2009-02-25
462
+2009-03-16
463 463
 </ADDRESS>
464 464
 </BODY>
465 465
 </HTML>
... ...
@@ -63,7 +63,7 @@ Graphics</A>
63 63
 <BR><HR>
64 64
 <ADDRESS>
65 65
 Tomasz Kojm
66
-2009-02-25
66
+2009-03-16
67 67
 </ADDRESS>
68 68
 </BODY>
69 69
 </HTML>
... ...
@@ -62,7 +62,7 @@ OpenAntiVirus</A>
62 62
 <BR><HR>
63 63
 <ADDRESS>
64 64
 Tomasz Kojm
65
-2009-02-25
65
+2009-03-16
66 66
 </ADDRESS>
67 67
 </BODY>
68 68
 </HTML>
... ...
@@ -134,7 +134,7 @@ Role: coder
134 134
 <BR><HR>
135 135
 <ADDRESS>
136 136
 Tomasz Kojm
137
-2009-02-25
137
+2009-03-16
138 138
 </ADDRESS>
139 139
 </BODY>
140 140
 </HTML>
... ...
@@ -71,7 +71,7 @@ Base package</A>
71 71
 <BR><HR>
72 72
 <ADDRESS>
73 73
 Tomasz Kojm
74
-2009-02-25
74
+2009-03-16
75 75
 </ADDRESS>
76 76
 </BODY>
77 77
 </HTML>
... ...
@@ -64,11 +64,11 @@ Mathematics Department, Macquarie University, Sydney.
64 64
 The command line arguments were: <BR>
65 65
  <STRONG>latex2html</STRONG> <TT>-local_icons clamdoc.tex</TT>
66 66
 <P>
67
-The translation was initiated by Tomasz Kojm on 2009-02-25
67
+The translation was initiated by Tomasz Kojm on 2009-03-16
68 68
 <BR><HR>
69 69
 <ADDRESS>
70 70
 Tomasz Kojm
71
-2009-02-25
71
+2009-03-16
72 72
 </ADDRESS>
73 73
 </BODY>
74 74
 </HTML>
... ...
@@ -80,7 +80,7 @@ Supported platforms</A>
80 80
 <BR><HR>
81 81
 <ADDRESS>
82 82
 Tomasz Kojm
83
-2009-02-25
83
+2009-03-16
84 84
 </ADDRESS>
85 85
 </BODY>
86 86
 </HTML>
... ...
@@ -61,7 +61,7 @@ Binary packages</A>
61 61
 <BR><HR>
62 62
 <ADDRESS>
63 63
 Tomasz Kojm
64
-2009-02-25
64
+2009-03-16
65 65
 </ADDRESS>
66 66
 </BODY>
67 67
 </HTML>
... ...
@@ -81,7 +81,7 @@ Installation</A>
81 81
 <BR><HR>
82 82
 <ADDRESS>
83 83
 Tomasz Kojm
84
-2009-02-25
84
+2009-03-16
85 85
 </ADDRESS>
86 86
 </BODY>
87 87
 </HTML>