JAVA2HTML(1)

💖 JAVA2HTML 💖

okay bestie, pull up a chair, because this is the java2html manual page from the General Commands Manual and we are about to make highlighted source code look stunning. 🎀

---

✨ NAME ✨

java2html — generates highlighted html-files from Java or C++ source. no cap, that's the whole job and it does it gorgeously. 💅

---

🌸 SYNOPSIS 🌸

java2html [options] [filename...]

---

🦋 DESCRIPTION 🦋

This manual page documents how to use java2html. So here's the tea, bestie: if you give java2html no arguments at all on the command line, it reads from stdin and writes to stdout. classic pipes-and-vibes situation. 🫶

But if you invoke it with filenames as arguments, java2html will write its output into new files. Names of output files are generated by appending .html to the corresponding input filename. so Foo.java becomes Foo.java.html and honestly? slay. ✨

🧚 Installing as a CGI program 🧚

java2html 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

AddType text/x-java .java
Action text/x-java /cgi-bin/java2html

to the webserver configuration file. heads up though: java2html depends on the webserver properly setting environment variable PATH_TRANSLATED to the pathname of the source file. If java2html has been compiled with option -DCOMPRESSION=1 then it will invoke gzip to compress the generated HTML before sending it to the requesting browser. Of course java2html takes care to check if the browser accepts gzip encoding — it's polite like that. 😌

👑 OPTIONS 👑

• -- — Interpret all following arguments on the command line as filenames. This is useful, if you want to convert files beginning with a -. (yes, the dash-files. we see them. we support them.) 🩷
• -b filename — Insert the file filename after converted data and before HTML footer. See also the -s option.
• -c — Turns off CGI-script detection and HTTP header generation. This is needed to use java2html as a subcommand in another CGI script. lowkey essential for nesting. 🪺
• -h filename — Insert the file filename after the HTML headers and before the converted data. See also the -s option.
• -i — Generate an index only. This will generate a list of references (HREF's) to the labels that java2html creates for your source file. The references are created as list items (<li>) in an HTML list. Each line has the form

<li><a href="#name">prototype()</a></li>

so they can be used directly as an index list, or further parsed by another script.

If you want the index at the top of the source file, you will need a wrapper script like this one:

#! /bin/sh
echo "Content-type: text/html"
echo ""
echo "<html>"
echo "<head><title>$PATH_TRANSLATED</title>"
echo "<meta name=\"generator\""
echo "content=\"`java2html -V`\">"
echo "</head>"
echo "<body>"
echo "<h1>Source of $PATH_TRANSLATED</h1>"
echo "<ul>Structures and functions"
cat $PATH_TRANSLATED | java2html -isc
echo "</ul>"
echo "<hr></hr>"
cat $PATH_TRANSLATED | java2html -sc
echo "</body></html>"
exit

• -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.java.html#line301">Go to line 301</A>

it's giving jump to the exact line energy and we're obsessed. 🔥

• -s — With this option you can suppress the generation of HTML headers. This is especially useful together with options -b file and -h file.
• -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 -s is not set.
• -u — 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). 😭 the disrespect honestly
• -V — reports the version number of java2html.

---

💀 EXIT STATUS 💀

java2html returns:

1. 0 on success 🌈
2. 1 if input files are not existing/readable
3. 2 if output files are not creatable/writable
4. 3 if invoked with illegal options
5. 4 if gzip cannot be invoked

so if something goes wrong you will know which something it was. no mystery. periodt. 💅

---

🫶 AUTHORS 🫶

• Florian Schintke <schintke@cs.tu-berlin.de>
• Martin Kammerhofer <mkamm@gmx.net> wrote the CGI feature.
• Rob Ewan <rob@ewan.com> wrote the indexing feature.

icons. legends. the blueprint. 👑

---

🎀 SEE ALSO 🎀

c2html(1), pas2html(1), perl2html(1).

---

ok that's the whole page bestie, every flag, every exit code, every author, all of it — nothing skipped, nothing invented, fr fr. 🌸

and that's a wrap on the JAVA2HTML(1) page from the General Commands Manual — go forth and highlight something gorgeous. 💖✨🎀