Section: User Commands (1)Index
Return to Main Contents
java2html - generates highlighted html-files from Java or C++ source
This manual page
documents how to use
If no arguments are given on the command line of
reads from stdin and writes to stdout.
If invoked with filenames as arguments
will write it's output into new files. Names of output
files are generated by appending ".html" to the
corresponding input filename.
Installing as a CGI program
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
AddType text/x-java .java
Action text/x-java /cgi-bin/java2html
to the webserver configuration file.
depends on the webserver properly setting environment variable
PATH_TRANSLATED to the pathname of the source file.
has been compiled with option -DCOMPRESSION=1 then it will invoke
to compress the generated HTML before sending it to the requesting
browser. Of course
takes care to check if the browser accepts gzip encoding.
Interpret all following arguments on the command line as filenames.
This is useful, if you want to convert files beginning with a '-'.
- -b filename
Insert the file 'filename' after converted data and before
HTML footer. See also the
Turns off CGI-script detection and HTTP header generation.
This is needed to use
as a subcommand in another CGI script.
- -h filename
Insert the file 'filename' after the HTML headers and before
the converted data. See also the
Generate an index only. This will generate a list of references (HREF's)
the labels that
creates for your source file. The references are created as list items
(<li>) in an HTML list. Each line has the form
so they can be used directly as an index list, or further parsed by
If you want the index at the top of the source file, you will need a
wrapper script like this one:
echo "Content-type: text/html"
echo "<meta name=\"generator\""
echo "content=\"`java2html -V`\">"
echo "<h1>Source of $PATH_TRANSLATED</h1>"
echo "<ul>Structures and functions"
cat $PATH_TRANSLATED | java2html -isc
cat $PATH_TRANSLATED | java2html -sc
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.java.html#line301">Go to line 301</A>
With this option you can suppress the generation of HTML headers.
This is especially useful together with options
- -t title
Set the title to 'title'. The default is the filename you
converted or "stdin" if reading from stdin. This option is only
is not set.
Print usage information.
- -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).
reports the version number of
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
cannot be invoked.
Florian Schintke <firstname.lastname@example.org
Martin Kammerhofer <email@example.com
> wrote the CGI feature.
Rob Ewan <firstname.lastname@example.org
> wrote the indexing feature.
- Installing as a CGI program
- EXIT STATUS
- SEE ALSO