Browse code

docs/clamdoc.tex, docs/man/clamd.8.in: document nCOMMANDS (bb#1278)

git-svn: trunk@4348

Tomasz Kojm authored on 2008/11/07 06:48:44
Showing 4 changed files
... ...
@@ -1,3 +1,7 @@
1
+Thu Nov  6 21:46:47 CET 2008 (tk)
2
+---------------------------------
3
+  * docs/clamdoc.tex, docs/man/clamd.8.in: document nCOMMANDS (bb#1278)
4
+
1 5
 Thu Nov  6 15:24:34 EET 2008 (edwin)
2 6
 ------------------------------------
3 7
   * Makefile.am, clamd/, libclamav/, libclamunrar/,
4 8
Binary files a/docs/clamdoc.pdf and b/docs/clamdoc.pdf differ
... ...
@@ -565,7 +565,14 @@ N * * * *	/usr/local/bin/freshclam --quiet
565 565
 	    per TCP session (WARNING: due to the \verb+clamd+ implementation the
566 566
 	    \textbf{RELOAD} command will break the session).
567 567
     \end{itemize}
568
-    and reacts on the special signals:
568
+    It's recommended to prefix clamd commands with the letter \verb+n+
569
+    (eg. \verb+nSCAN+) to indicate that the command will be delimited by
570
+    a newline character and that clamd should continue reading command data
571
+    until a newline is read. The newline delimiter assures that the complete
572
+    command and its entire argument will be processed as a single command.\\
573
+
574
+    \noindent
575
+    Clamd can handle the following signals:
569 576
     \begin{itemize}
570 577
 	\item \textbf{SIGTERM} - perform a clean exit
571 578
 	\item \textbf{SIGHUP} - reopen the log file
... ...
@@ -10,7 +10,7 @@ clamd [options]
10 10
 The daemon listens for incoming connections on Unix and/or TCP socket and scans files or directories on demand. It reads the configuration from @CFGDIR@/clamd.conf
11 11
 .SH "COMMANDS"
12 12
 .LP 
13
-clamd recognizes the following commands:
13
+It's recommended to prefix clamd commands with the letter \fBn\fR (eg. nSCAN) to indicate that the command will be delimited by a newline character and that clamd should continue reading command data until a newline is read. The newline delimiter assures that the complete command and its entire argument will be processed as a single command. clamd recognizes the following commands:
14 14
 
15 15
 .TP 
16 16
 \fBPING\fR
... ...
@@ -38,7 +38,7 @@ Scan file in a standard way or scan directory (recursively) using multiple threa
38 38
 Scan stream \- on this command clamd will return "PORT number" you should connect to and send data to scan.
39 39
 .TP 
40 40
 \fBSESSION, END\fR
41
-Start/end a clamd session which will allow you to run multiple commands per TCP session. It's recommended to prefix clamd commands with the letter \fBn\fR (eg. nSCAN) to indicate that the command will be delimited by a newline character and that clamd should continue reading command data until a newline is read. The newline delimiter assures that the complete command and its entire argument will be processed as a single command.
41
+Start/end a clamd session which will allow you to run multiple commands per TCP session.
42 42
 .SH "OPTIONS"
43 43
 .LP 
44 44