.TH PERL2HTML 1 \" -*- nroff -*-
.SH NAME
perl2html \- generates highlighted html-files from Perl source
.SH SYNOPSIS
.B perl2html
[options] [filename...]
.br
.SH DESCRIPTION
This manual page
documents how to use
.BR perl2html .
If no arguments are given on the command line of
.BR perl2html ,
it 
reads from stdin and writes to stdout.

If invoked with filenames as arguments
.B perl2html
will write it's output into new files. Names of output
files  are  generated by appending ".html" to the 
corresponding input filename. 

.SS Installing as a CGI program
.B perl2html
can be installed as a CGI program and convert source files on the
fly. In order to set this up for apache the webmaster has to add the
two lines

.RS
 AddType text/x-perl .pl .pm
 Action text/x-perl /cgi-bin/perl2html
.RE

to the webserver configuration file.
.B perl2html
depends on the webserver properly setting environment variable
PATH_TRANSLATED to the pathname of the source file.
If 
.B perl2html
has been compiled with option -DCOMPRESSION=1 then it will invoke
.B gzip
to compress the generated HTML before sending it to the requesting
browser. Of course
.B perl2html
takes care to check if the browser accepts gzip encoding.
.SS OPTIONS
.TP
.I "--"
Interpret all following arguments on the command line as filenames.
This is useful, if you want to convert files beginning with a '-'.
.TP
.I "-b filename"
Insert the file 'filename' after converted data and before
HTML footer. See also the
.I "-s"
option.
.TP
.I "-c"
Turns off CGI-script detection and HTTP header generation.
This is needed to use
.B perl2html
as a subcommand in another CGI script.
.TP
.I "-h filename"
Insert the file 'filename' after the HTML headers and before
the converted data. See also the
.I "-s"
option.
.TP
.I "-n"
Number lines and label them with 'line' followed by the line
number. Empty lines get no label, but the linecounter will count 
them nevertheless. With this feature you can refer to special
lines of code from other parts of the generated file 
or from external files with a line like this:

<A HREF="foo.pl.html#line301">Go to line 301</A>
.TP
.I "-s"
With this option you can suppress the generation of HTML headers.
This is especially useful together with options
.I "-b file" 
and 
.IR "-h file" .
.TP
.I "-t title"
Set the title to 'title'. The default is the filename you 
converted or "stdin" if reading from stdin. This option is only
used if
.I "-s"
is not set.
.TP 
.I "-u"
Print usage information.
.TP
.I "-w width"
sets the WIDTH attribute for HTML tag <PRE>. If this option is not
used a default of 80 is assumed.  (Currently most browsers are
ignoring this attribute).
.TP
.I -V
reports the version number of
.BR perl2html .
.SH EXIT STATUS
.B perl2html
returns 0 on success, 1 if input files are not existing/readable, 2 if
output files are not creatable/writable, 3 if invoked with illegal
options and 4 if
.B gzip
cannot be invoked.
.SH AUTHORS
Florian Schintke <schintke@cs.tu-berlin.de>
.br
Martin Kammerhofer <mkamm@gmx.net> wrote the CGI feature.
.SH SEE ALSO
.BR c2html (1),
.BR java2html (1),
.BR pas2html (1).