summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/htmldocs/debug2html.1.html17
-rw-r--r--docs/manpages/debug2html.117
-rw-r--r--docs/yodldocs/debug2html.1.yo17
3 files changed, 30 insertions, 21 deletions
diff --git a/docs/htmldocs/debug2html.1.html b/docs/htmldocs/debug2html.1.html
index 3e2c293bc8..d0d6373a3d 100644
--- a/docs/htmldocs/debug2html.1.html
+++ b/docs/htmldocs/debug2html.1.html
@@ -24,17 +24,20 @@
<p><br><a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
-<p><br>debug2html [&lt;input-file] [&gt;output-file]
+<p><br>debug2html [input-file [output-file]]
<p><br><a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<p><br>This program is part of the <strong>Samba</strong> suite.
-<p><br><strong>debug2html</strong> is simple a filter. That is, it accepts input from
-<strong>stdin</strong> and directs its output to <strong>stdout</strong>. The input is expected to
-be a log file generated by <strong>nmbd</strong>(8) or <strong>smbd</strong>(8). The output will be
-an HTML 3.2 document.
-<p><br>Example usage:
-<p><br>debug2html &lt;/usr/local/samba/var/log.nmb &gt;nmblog.html <br>
+<p><br><strong>debug2html</strong> generates HTML files from Samba log files. Log files
+produced by <strong>nmbd</strong>(8) or <strong>smbd</strong>(8) may then be viewed by a web
+browser. The output conforms to the HTML 3.2 specification.
+<p><br>The filenames specified on the command line are optional. If the
+output-file is ommitted, output will go to <strong>stdout</strong>. If the input-file
+is ommitted, <strong>debug2html</strong> will read from <strong>stdin</strong>. The filename "-"
+can be used to indicate that input should be read from <strong>stdin</strong>. For
+example:
+<p><br><code>cat /usr/local/samba/var/log.nmb | debug2html - nmblog.html</code> <br>
<p><br><a name="VERSION"></a>
<h2>VERSION</h2>
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"
diff --git a/docs/yodldocs/debug2html.1.yo b/docs/yodldocs/debug2html.1.yo
index 4b009fc01b..ffbd3c5b0e 100644
--- a/docs/yodldocs/debug2html.1.yo
+++ b/docs/yodldocs/debug2html.1.yo
@@ -10,21 +10,24 @@ manpagename(debug2html)(Samba DEBUG to HTML translation filter)
label(SYNOPSIS)
manpagesynopsis()
-debug2html [<input-file] [>output-file]
+debug2html [input-file [output-file]]
label(DESCRIPTION)
manpagedescription()
This program is part of the bf(Samba) suite.
-bf(debug2html) is simple a filter. That is, it accepts input from
-bf(stdin) and directs its output to bf(stdout). The input is expected to
-be a log file generated by bf(nmbd)(8) or bf(smbd)(8). The output will be
-an HTML 3.2 document.
+bf(debug2html) generates HTML files from Samba log files. Log files
+produced by bf(nmbd)(8) or bf(smbd)(8) may then be viewed by a web
+browser. The output conforms to the HTML 3.2 specification.
-Example usage:
+The filenames specified on the command line are optional. If the
+output-file is ommitted, output will go to bf(stdout). If the input-file
+is ommitted, bf(debug2html) will read from bf(stdin). The filename "-"
+can be used to indicate that input should be read from bf(stdin). For
+example:
- debug2html </usr/local/samba/var/log.nmb >nmblog.html nl()
+tt(cat /usr/local/samba/var/log.nmb | debug2html - nmblog.html) nl()
label(VERSION)
manpagesection(VERSION)