.TH COMMANDS2HTML "1" "January 2016" "commands2html" "User Commands"
.SH NAME
commands2html \- simple command interpreter that outputs HTML
.SH SYNOPSIS
.B commands2html
[\fIOPTION\fR..]
\fIFILE\fR
[\fIOPTION\fR..]
.SH DESCRIPTION
.PP
Execute the commands listed in given .commands file and output to a .html_snippet file, in a format that appears that the commands were run at a sh prompt.
.PP
The commands are executed with the current directory set to the directory containing the input .commands file.
.PP
The generated HTML snippet is a PRE block, intended for inclusion in an HTML page.
Use of the options can output other bits of relevant HTML.
.PP
The generated .html_snippet (or .html, depending on options used) file is overwritten if it already exists.
.TP
FILE
input file listing the commands to be executed.
.SH OPTIONS
.TP
\fB\-V\fR, \fB\-\-version\fR
show version
.TP
\fB\-\-head\fR
output (to stdout) the suggested snippet for within
.TP
\fB\-\-css\fR
output (to stdout) the suggested snippet for within an included CSS file
.TP
\fB\-\-fullpage\fR
write a full .html page (instead of .html_snippet)
.SH EXIT STATUS
.TP
0
if OK,
.TP
1
when errors are encountered.
.SH FILES
None but that given on the command line and the same but with either .html or .html_snippet appended.
.SH EXAMPLES
Run the commands listed in myscript.commands (output is written to myscript.commands.html_snippet):
.IP
commands2html myscript.commands
.PP
Run the commands listed in all .commands files below the current directory, writing the results out as full html pages ready for viewing in a web browser (each output is written to FILE.html):
.IP
find . -name '*.commands' -type f -exec commands2html --fullpage '{}' ';'
.SH AUTHOR
Written by Anthony Doggett
.SH REPORTING BUGS
Please email the author at the above address, preferably with sufficient information to reproduce the bug.
.SH COPYRIGHT
Copyright (c) 2015-2016 Anthony Doggett
.PP