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

git-svn: trunk@4348

ChangeLog

@@ -1,3 +1,7 @@
+Thu Nov  6 21:46:47 CET 2008 (tk)
+---------------------------------
+  * docs/clamdoc.tex, docs/man/clamd.8.in: document nCOMMANDS (bb#1278)
+
 Thu Nov  6 15:24:34 EET 2008 (edwin)
 ------------------------------------
   * Makefile.am, clamd/, libclamav/, libclamunrar/,

docs/clamdoc.tex

@@ -565,7 +565,14 @@ N * * * *	/usr/local/bin/freshclam --quiet
 	    per TCP session (WARNING: due to the \verb+clamd+ implementation the
 	    \textbf{RELOAD} command will break the session).
     \end{itemize}
-    and reacts on the special signals:
+    It's recommended to prefix clamd commands with the letter \verb+n+
+    (eg. \verb+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.\\
+
+    \noindent
+    Clamd can handle the following signals:
     \begin{itemize}
 	\item \textbf{SIGTERM} - perform a clean exit
 	\item \textbf{SIGHUP} - reopen the log file

docs/man/clamd.8.in

@@ -10,7 +10,7 @@ clamd [options]
 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
 .SH "COMMANDS"
 .LP 
-clamd recognizes the following commands:
+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:
 
 .TP 
 \fBPING\fR
@@ -38,7 +38,7 @@ Scan file in a standard way or scan directory (recursively) using multiple threa
 Scan stream \- on this command clamd will return "PORT number" you should connect to and send data to scan.
 .TP 
 \fBSESSION, END\fR
-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.
+Start/end a clamd session which will allow you to run multiple commands per TCP session.
 .SH "OPTIONS"
 .LP