Browse code

bb#6451 - docs: add notes on cl_init macro

Kevin Lin authored on 2016/04/20 01:49:57
Showing 2 changed files
1 1
Binary files a/docs/clamdoc.pdf and b/docs/clamdoc.pdf differ
... ...
@@ -1055,9 +1055,10 @@ Engine flevel: 77, dconf: 77
1055 1055
 
1056 1056
     \subsubsection{Initialization}
1057 1057
     Before using libclamav, you should call \verb+cl_init()+ to initialize
1058
-    it. When it's done, you're ready to create a new scan engine by calling
1059
-    \verb+cl_engine_new()+. To free resources allocated by the engine use
1060
-    \verb+cl_engine_free()+. Function prototypes:
1058
+    it. \verb+CL_INIT_DEFAULT+ is a macro that can be passed to \verb+cl_init()+
1059
+    representing the default initialization settings. When it's done, you're ready
1060
+    to create a new scan engine by calling \verb+cl_engine_new()+. To free resources
1061
+    allocated by the engine use \verb+cl_engine_free()+. Function prototypes:
1061 1062
     \begin{verbatim}
1062 1063
 	int cl_init(unsigned int options);
1063 1064
 	struct cl_engine *cl_engine_new(void);
... ...
@@ -1108,7 +1109,7 @@ Engine flevel: 77, dconf: 77
1108 1108
 	    unsigned int sigs = 0;
1109 1109
 	    int ret;
1110 1110
 
1111
-	if((ret = cl_init()) != CL_SUCCESS) {
1111
+	if((ret = cl_init(CL_INIT_DEFAULT)) != CL_SUCCESS) {
1112 1112
 	    printf("cl_init() error: %s\n", cl_strerror(ret));
1113 1113
 	    return 1;
1114 1114
 	}