.ig Copyright (C) 2003 Jerry Talkington Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHOR, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the Free Documentation License is included as a file called FDL in the doc/ directory of the @package@ source package. .. .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "@uc_package_name@ 1" .TH @uc_package_name@ 1 "25 April 2003" "@PACKAGE_NAME@ @PACKAGE_VERSION@" "@PACKAGE_NAME@ Documentation" .SH "NAME" .IP "\fB@PACKAGE_NAME@\fR \- convert man pages to html." 4 .IX Item "@PACKAGE_NAME@ - convert man pages to html." .SH "SYNOPSIS" .IX Header "SYNOPSIS" .PD 0 .IP "\fB@PACKAGE_NAME@\fR [\fB\-s\fR \fIsection\fR | \fB\-\-section\fR=\fIsection\fR] [\fB\-r\fR | \fB\-\-raw\fR] [\fB\-l\fR | \fB\-\-lynx\fR] \fIname\fR" 4 .IX Item "@PACKAGE_NAME@ [-s section | --section=section] [-r | --raw] [-l | --lynx] name" .IP "\fB@PACKAGE_NAME@\fR \fB\-a\fR | \fB\-k\fR | \fB\-\-apropos\fR | \fB\-\-keyword\fR \fIkeyword\fR" 4 .IX Item "@PACKAGE_NAME@ -a | -k | --apropos | --keyword keyword" .IP "\fB@PACKAGE_NAME@\fR \fB\-p\fR | \fB\-\-print\-config\fR" 4 .IX Item "@PACKAGE_NAME@ -p | --print-config" .IP "\fB@PACKAGE_NAME@\fR \fB\-h\fR | \fB\-\-help\fR" 4 .IX Item "@PACKAGE_NAME@ -h | --help" .IP "\fB@PACKAGE_NAME@\fR \fB\-v\fR | \fB\-\-version\fR" 4 .IX Item "@PACKAGE_NAME@ -v | --version" .PD .SH "DESCRIPTION" .IX Header "DESCRIPTION" .IP "\fB@PACKAGE_NAME@\fR outputs man pages and keyword (apropos) searches in \s-1HTML\s0, and generates \s-1HTML\s0 indexes of man page sections." 4 .IX Item "@PACKAGE_NAME@ outputs man pages and keyword (apropos) searches in HTML, and generates HTML indexes of man page sections." .PD 0 .IP "\&" 4 .IP "\fB@PACKAGE_NAME@\fR's main purpose is as a \s-1CGI\s0 program, taking arguments from the environment (see \fB\s-1ENVIRONMENT\s0\fR below), but it can also be used on the command line to generate static \s-1HTML\s0 pages." 4 .IX Item "@PACKAGE_NAME@'s main purpose is as a CGI program, taking arguments from the environment (see ENVIRONMENT below), but it can also be used on the command line to generate static HTML pages." .PD .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-s\fR \fIsection\fR" 4 .IX Item "-s section" .PD 0 .IP "\fB\-\-section\fR=\fIsection\fR" 4 .IX Item "--section=section" .PD Specifiy the section of the manual to search in. .IP "\fB\-a\fR, \fB\-\-apropos\fR \fIkeyword\fR" 4 .IX Item "-a, --apropos keyword" .PD 0 .IP "\fB\-k\fR, \fB\-\-keyword\fR \fIkeyword\fR" 4 .IX Item "-k, --keyword keyword" .PD Do a keyword (apropos) search for \fIkeyword\fR. .IP "\fB\-i\fR, \fB\-\-index\fR \fIsection\fR" 4 .IX Item "-i, --index section" Generate and print an index for \fIsection\fR. .IP "\fB\-r\fR, \fB\-\-raw\fR" 4 .IX Item "-r, --raw" Do not convert the file, print the raw man output. .IP "\fB\-l\fR, \fB\-\-lynx\fR" 4 .IX Item "-l, --lynx" Display the output in Lynx. .IP "\fB\-p\fR, \fB\-\-print\-config\fR" 4 .IX Item "-p, --print-config" Print out the current configuration, suitable for saving as a \&\fB@PACKAGE_NAME@.conf\fR(5) config file. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Print a help message with a list of options. .IP "\fB\-v\fR, \fB\-\-version\fR" 4 .IX Item "-v, --version" Print the version number and exit. .SH "EXAMPLES" .IX Header "EXAMPLES" .Sh "Command Line" .IX Subsection "Command Line" .RS 4 .IP "\fB@PACKAGE_NAME@\fR \fIname\fR > \fIoutfile.html\fR" 4 .IX Item "@PACKAGE_NAME@ name > outfile.html" This would output the man page for \fIname\fR and and save it to a file. .IP "\fB@PACKAGE_NAME@ \-\-print\-config\fR > \fI@PACKAGE_NAME@.conf\fR" 4 .IX Item "@PACKAGE_NAME@ --print-config > @PACKAGE_NAME@.conf" This would print out the current configuration, saving it to \&\fI@PACKAGE_NAME@.conf\fR. .RE .RS 4 .RE .Sh "\s-1CGI\s0" .IX Subsection "CGI" .RS 4 This is the most common use for \fB@PACKAGE_NAME@\fR. The web server calls the \&\fB@PACKAGE_NAME@\fR setting the \s-1QUERY_STRING\s0 and \s-1SCRIPT_NAME\s0 environment variables (see \fB\s-1ENVIRONMENT\s0\fR below). Query string examples follow: .IP "\fBprogram=\fR\fIintro\fR\fB§ion=\fR\fI1\fR" 4 .IX Item "program=intro§ion=1" This would return the \fIintro\fR man page from section \fI1\fR. .IP "\fBprogram=\fR\fIsection-index\fR\fB§ion=\fR\fI2\fR" 4 .IX Item "program=section-index§ion=2" This would generate a section index for section \fI2\fR. .IP "\fBprogram=\fR\fIgroff\fR\fB§ion=\fR\fIapropos\fR" 4 .IX Item "program=groff§ion=apropos" This would return the results of a keyword (apropos) search for \fIgroff\fR. .RE .RS 4 .RE .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\fB\s-1QUERY_STRING\s0\fR" 4 .IX Item "QUERY_STRING" This is passed by the web server to the program specifying the type of action to be performed, and any parameters, See \fB\s-1EXAMPLES\s0\fR above for examples of what this looks like. .IP "\fB\s-1SCRIPT_NAME\s0\fR" 4 .IX Item "SCRIPT_NAME" This specifies the way the program is referenced by the web server, and how to write out self referencing URLs (links to other man pages, or the cover/search page.) If this is set, the command line is disabled, and options must be specified in the \s-1QUERY_STRING\s0 environment variable. .SH "AUTHOR" .IX Header "AUTHOR" .IP "Copyright (C) 2003 Jerry Talkington" 4 .IX Item "Copyright (C) 2003 Jerry Talkington" .PD 0 .IP "\&" 4 .IP "This document is distributed under the terms of the \s-1FDL\s0 (\s-1GNU\s0 Free Documentation License) version 1.1 or later. You should have received a copy of the \s-1FDL\s0 with this distribution, it is also available on-line at the \s-1GNU\s0 copyleft site <\fBhttp://www.gnu.org/copyleft/fdl.html\fR>." 4 .IX Item "This document is distributed under the terms of the FDL (GNU Free Documentation License) version 1.1 or later. You should have received a copy of the FDL with this distribution, it is also available on-line at the GNU copyleft site ." .IP "\&" 4 .IP "\fB@PACKAGE_NAME@\fR is distributed under the terms of the \s-1GNU\s0 General Public License (\s-1GPL\s0). You should have recieved a copy of the \s-1GPL\s0 with this distribution, it is also avaliable on the copyleft site <\fBhttp://www.gnu.org/copyleft/gpl.html\fR>." 4 .IX Item "@PACKAGE_NAME@ is distributed under the terms of the GNU General Public License (GPL). You should have recieved a copy of the GPL with this distribution, it is also avaliable on the copyleft site ." .PD .SH "FILES" .IX Header "FILES" .IP "\fI@sysconfdir@/@PACKAGE_NAME@.conf\fR" 4 .IX Item "@sysconfdir@/@PACKAGE_NAME@.conf" The configuration file. .SH "SEE ALSO" .IX Header "SEE ALSO" .RS 4 .IP "\fB@PACKAGE_NAME@.conf\fR(5)" 4 .IX Item "@PACKAGE_NAME@.conf(5)" .RE .RS 4