From: Michael Orlitzky Date: Fri, 20 Dec 2013 23:35:10 +0000 (-0500) Subject: Update the man page with new logging plans. X-Git-Tag: 0.0.2~34 X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhtsn.git;a=commitdiff_plain;h=0b964afe4e7dd1ed45e0bc76a4dce760513b1fe0 Update the man page with new logging plans. --- diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1 index d23642c..7d4db34 100644 --- a/doc/man1/htsn.1 +++ b/doc/man1/htsn.1 @@ -26,15 +26,15 @@ There are three \(dqoutput streams\(dq: .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 @@ -42,5 +42,4 @@ accordingly. The name fill be of the form .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 -logged. This should eventually be configurable. - +logged by default to syslog (on Unix) or the event log (on Windows).