Updated the docs to match the changes I made to debug2html.
[samba.git] / docs / manpages / debug2html.1
index 8837f509d597f2d0cf36b02566e47c6e838e972d..a1071cfd8837e2b650fc516838e98229fbc5748b 100644 (file)
@@ -5,20 +5,23 @@ debug2html \- Samba DEBUG to HTML translation filter
 .PP 
 .SH "SYNOPSIS" 
 .PP 
-debug2html [<input-file] [>output-file]
+debug2html [input-file [output-file]]
 .PP 
 .SH "DESCRIPTION" 
 .PP 
 This program is part of the \fBSamba\fP suite\&.
 .PP 
-\fBdebug2html\fP is simple a filter\&.  That is, it accepts input from
-\fBstdin\fP and directs its output to \fBstdout\fP\&.  The input is expected to
-be a log file generated by \fBnmbd\fP(8) or \fBsmbd\fP(8)\&.  The output will be
-an HTML 3\&.2 document\&. 
+\fBdebug2html\fP generates HTML files from Samba log files\&.  Log files
+produced by \fBnmbd\fP(8) or \fBsmbd\fP(8) may then be viewed by a web
+browser\&.  The output conforms to the HTML 3\&.2 specification\&. 
 .PP 
-Example usage:
+The filenames specified on the command line are optional\&.  If the
+output-file is ommitted, output will go to \fBstdout\fP\&.  If the input-file
+is ommitted, \fBdebug2html\fP will read from \fBstdin\fP\&.  The filename "-" 
+can be used to indicate that input should be read from \fBstdin\fP\&.  For
+example:
 .PP 
-debug2html </usr/local/samba/var/log\&.nmb >nmblog\&.html 
+\f(CWcat /usr/local/samba/var/log\&.nmb | debug2html - nmblog\&.html\fP 
 .br 
 .PP 
 .SH "VERSION"