.\"  $HeadURL$ $LastChangedRevision$
.\"
.\" In this example we *MUST* have a fixed date here! The reason
.\" is that if the test uses the official manual page as input,
.\" which it *did*, then at *RELEASE* time the SPPSYM marker in
.\" the footer is substituted; this results in a footer line which
.\" is slightly narrower that it should be (because the SPPSYM
.\" marker is wider than the text that replaces it). But the
.\" manual page generated by using ademan2html on the released
.\" man page *SOURCE* will be correctly formatted. This causes
.\" a difference! The workaround is *NOT* to have a symbol for 
.\" the date here, but to have a hard coded date value. For all
.\" other SPPSYM's this is not a problem, but for this one it is
.\" because there is some text on the same line coming after the
.\" date, and this is brought a bit to the left as result of the
.\" substitution.
.\" 
.TH ADEMAN2HTML 1 "28 Apr 2004"
.ne 5
.SH NAME
ademan2html \- convert man page sources to HTML
.br
.ne 5
.SH SYNOPSIS
.B ademan2html
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel\fR
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] 
.br
.ne 5
.SH DESCRIPTION
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of 
.B ademan2html\fR.
.PP 
.B Ademan2html
reads man page sources (see 
.B man\fR(7))
and converts then to HTML. It uses 
.B nroff\fR(1)
to convert from man page source to a formatted plaintext that uses CTRL-H-based
escape sequences for bold and italic. 
.B Ademan2html
then converts this to HTML.
.PP
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
.TP 25
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B ademan2html
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B ademan2html
uses.
.TP 
.B \-v\fR, \fB\-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR, \fB\-\-version
Print the program's version number and exit.
.br
.ne 5
.SH EXIT STATUS
On success
.B ademan2html
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
.TP 25 
.B PATH
Used to locate 
.B nroff\fR(1)).
.br
.ne 5
.SH EXAMPLES
.IP
.nf
.fam C
.B  zcat /usr/share/man/man1/ls.1.gz | ../bin/ademan2html > ~/public_html/ls.html
.fam T
.fi
.br
.ne 5
.SH SEE ALSO
nroff(1), man(1), man(7)
.br
.ne 5
.SH AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2004-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.