diff options
Diffstat (limited to 'docs/yodldocs')
| -rw-r--r-- | docs/yodldocs/debug2html.1.yo | 17 |
1 files changed, 10 insertions, 7 deletions
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) |