summaryrefslogtreecommitdiff
path: root/docs/manpages/debug2html.1
diff options
context:
space:
mode:
authorChristopher R. Hertel <crh@samba.org>1998-12-29 21:16:08 +0000
committerChristopher R. Hertel <crh@samba.org>1998-12-29 21:16:08 +0000
commita75a4daafd86f162c2c79f1b0ece373e7bcb7f65 (patch)
tree486d5906fcf5c54d0f62debe76af5fbe841b864d /docs/manpages/debug2html.1
parent8cb794707b4e25fdf008b57dd2f87b70e26f69c2 (diff)
downloadsamba-a75a4daafd86f162c2c79f1b0ece373e7bcb7f65.tar.gz
samba-a75a4daafd86f162c2c79f1b0ece373e7bcb7f65.tar.bz2
samba-a75a4daafd86f162c2c79f1b0ece373e7bcb7f65.zip
Updated the docs to match the changes I made to debug2html.
Chris -)----- (This used to be commit fcbdf5fe9790298d519b678ff3a6121641c1e6d9)
Diffstat (limited to 'docs/manpages/debug2html.1')
-rw-r--r--docs/manpages/debug2html.117
1 files changed, 10 insertions, 7 deletions
diff --git a/docs/manpages/debug2html.1 b/docs/manpages/debug2html.1
index 8837f509d5..a1071cfd88 100644
--- a/docs/manpages/debug2html.1
+++ b/docs/manpages/debug2html.1
@@ -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"