]> gitweb.michael.orlitzky.com - dead/htsn.git/commitdiff
Update the man page with new logging plans.
authorMichael Orlitzky <michael@orlitzky.com>
Fri, 20 Dec 2013 23:35:10 +0000 (18:35 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Fri, 20 Dec 2013 23:35:10 +0000 (18:35 -0500)
doc/man1/htsn.1

index d23642c0546285702b54ecf6c58f071ef3ecee57..7d4db34fcb7603a751251ec0cd486ee3a110550b 100644 (file)
@@ -26,15 +26,15 @@ There are three \(dqoutput streams\(dq:
 
 .nr step 1 1
 .IP \n[step] 2
 
 .nr step 1 1
 .IP \n[step] 2
-\fIStandard output/error\fR. The entire conversation with the feed
-will be output to standard out in the default color.
-
-The username and password prompt from TSN will be highlighted in
-green. Errors will be highlighted in red. Informational messages will
-NOT be output to standard out, as they would interfere with the
-display of the XML on the wire.
-
-Warnings and errors will be written, in red, to standard error.
+\fIStandard output/error\fR. If the log level is set to DEBUG, all
+data received from the feed will be output to standard out in the
+default color. This is the default.
+
+Data sent to the remote host (i.e. your username and password) will be
+highlighted in green at all log levels. Informational (status)
+messages will be displayed in blue at log levels greater than
+INFO. Warnings and errors will displayed in red at log levels greater
+than WARNING and ERROR respectively.
 .IP \n+[step]
 \fIXML files\fR. Each XML received from the feed will be inspected for
 an XML_File_ID element, and then written to a file named
 .IP \n+[step]
 \fIXML files\fR. Each XML received from the feed will be inspected for
 an XML_File_ID element, and then written to a file named
@@ -42,5 +42,4 @@ accordingly. The name fill be of the form <XML_File_ID>.xml, and it
 will be written to the \fBoutput_directory\fR described below.
 .IP \n+[step]
 \fILogs\fR. Informational messages, warnings, and errors will all be
 will be written to the \fBoutput_directory\fR described below.
 .IP \n+[step]
 \fILogs\fR. Informational messages, warnings, and errors will all be
-logged. This should eventually be configurable.
-
+logged by default to syslog (on Unix) or the event log (on Windows).