This package is a collection of programs that given a source file, produces a document with syntax highlighting.
At the moment this package contains GNU java2html 1.10 and GNU cpp2html 1.6.
GNU Source-highlight is free software. Please see the file COPYING for details. For documentation, please read this file.
GNU Source-highlight is a GNU program
and its main home page is at GNU site:
http://www.gnu.org/software/src-highlite/source-highlight.html
I do not distribute Windows binaries anymore; since, they can be easily
built by using Cygnus C/C++ compiler, available at http://www.cygnus.com/.
However, if you don't feel like downloading such compiler, you can request
such binaries directly to me, by e-mail (bettini@gnu.org)
and I can send them to you.
An MS-Windows port of Source-highlight is available from http://gnuwin32.sourceforge.net/.
You may also want to check the md5sum of the archives, which are also digitally signed by me (Lorenzo Bettini) with GNU gpg (http://www.gnupg.org). My GPG public key can be found at my home page (see at the end of this doc).
You can also get the patches, if they are available for a particular release (see below for patching from a previous version).
CGI support was enabled thanks to Robert Wetzel <rw8@mail.inf.tu-dresden.de>; I haven't tested it personally yet, so you may ask him directly. Moreover he set up some examples at the page http://www.inf.tu-dresden.de/~rw8/java2.html.
Moreover there's also a Java version of java2html, made by bayard@generationjava.com, you can find it at http://www.generationjava.com/java/Java2Html.shtml.
see also NEWS file and ChangeLog for the complete list of changes between versions.
cd <source code main directory> ./configure make make installNote: unless you specify a different install directory by --prefix option of configure (e.g. ./configure --prefix=<your home>), you must be root to 'make install'.
It is also possible to specify as following option for configure: --enable-input-chroot to hardcode in the program the path to prepend for input files.
Before you run 'make install' you may want to check that the programs have compiled fine, so you can run 'make check'.
Files will be installed in the following directories:
source-highlight has been developed under Linux, using gcc (C++), and bison (yacc) and flex (lex), and ported under Win32 with Cygnus C/C++ compiler, available at http://www.cygnus.com/ (a .DLL is also distributed togheter with the .exe: you may simply copy it in the same place of the .exe). I used the excellent GNU Autoconf and Automake. I also used Autotools (ftp://ftp.ugcs.caltech.edu/pub/elef/autotools) which creates a starting source tree (according to GNU standards) with autoconf, automake starting files. Finally I used GNU gengetopt (http://www.gnu.org/software/gengetopt), for command line parsing.
Actually, unless you want to develop source-highlight, you don't need all these tools to build source-highlight because I provide generated sources; you don't need neither bison (yacc) nor flex (lex), for the same reason. Actually programs that use lex generated files need to link with library libfl (or libl for lex); anyway configuration phase can discover if this library is missing and in that case it sets the program to link with a source file I provide. This hack works for flex: I don't know about lex generated scanners. But, again, this is a problem only if you develop source-highlight and you use lex.
gunzip -cd ../source-highlight-1.3-1.3.1.patch.gz | patch -p1and restart the compilation process (if you had already run configure a simple make will do).
here's how to run a source-highlight program (for this example we will use cpp2html, but this is valid also for other source-highlight programs):
cpp2html --input <file (a C++ prog)> --output <file (an html)> [options]or
cpp2html [options] <input-files>As input files you can also use regular expression.
Here are some links to some of the sources of source-highlight colored with cpp2html itself:
startapp.cc.htmlgenerated with the following command
Obviosly it works with C files as well:cpp2html --doc startapp.cc
cmdline.c.htmlCreated with the command (notice that this one uses both CSS file and headers and footers):
And obviously it works with header file as well:cpp2html -i cmdline.c -o cmdline.c.html --css="cpp2html.css" --header="./header.html" --footer="./footer.html"
cmdline.h.htmlcreated with the command:
Here are some examples of java2html: Use Hello.java to make some test, if you want. Here's how Hello1.html, Hello2.html, Hello3.html, Hello4.html, Hello5.html, Hello_h_f.html were created:cpp2html *.h --css="mono.css"
java2html -i Hello.java -o Hello1.html java2html --input Hello.java --output Hello2.html --doc java2html -i Hello.java -o Hello3.html --title "Happy Java with java2html :-)" --tab 3 java2html < Hello.java > Hello4.html --title "and what about CSS :-)" --css "Hello.css" java2html < Hello.java > Hello5.html --title "Wooo... this is quite dark ;-D" --css "mono-alt.css" java2html --doc *.java Processed Hello.java (creates Hello.java.html) java2html --doc -i Hello.java -o Hello_h_f.html --tags-file="tags2.j2h" --header="header.html" --footer="footer.html"And here's the output of `cpp2html --help`
GNU cpp2html 1.6 (GNU source-highlight 1.2.1) source-highlight 1.0 Purpose: Highlight the syntax of a source file (e.g. Java) into a specific format (e.g. HTML) Usage: source-highlight [OPTIONS]... [FILES]... -h --help Print help and exit -V --version Print version and exit -v --verbose verbose mode on -d --doc create html with title and header -cSTRING --css=STRING use a css for formatting. Implies --doc -TSTRING --title=STRING give a title to the html. Implies --doc -iSTRING --input=STRING input file. default std input -oSTRING --output=STRING output file. default std output -tINT --tab=INT specify tab length. default 8 -HSTRING --header=STRING file to insert as header -FSTRING --footer=STRING file to insert as footer --tags-file=STRING specify format options (def. tags.j2h) --output-dir=STRING output directory Maintained by Lorenzo Bettini <bettini@gnu.org> Report bugs to <bug-source-highlight@gnu.org>As it handles standard output and input you may also run it like
cat MyFile.cpp | cpp2html | lprYou may want to specify your options for syntax highlighting in the file tags.j2h. If this file is not present in the current directory, some default colors will be used. Here's the tags.j2h file that comes with this distribution:
keyword blue b ; for language keywords type darkgreen ; for basic types string red ; for strings and chars comment brown i ; for comments number purple ; for literal numbers preproc darkblue b ; for preproc directives (e.g. #include, import) symbol darkred ; for simbols (e.g. <, >, +) function black b; for function calls and declarations cbracket red; for block brackets (e.g. {, })tags2.j2h also specify the color of normal text, indeed it adds this line
normal darkblue ;as you might see the syntax of this file is quite straightforward:
you may see all possible colors in the file colors.html but you can also use the standard #<number> html syntax for specifying a color.
if something goes wrong with your options try to run cpp2html with --verbose option enabled.
Actually I want to extend it, so if you have some ideas...
The most import one will be to make source-highlight more customizable
:-)
Please send all bug reports by electronic mail to:
bug-source-highlight@gnu.org
My home page is
http://w3.newnet.it/bettini
or
http://infostud.dsi.unifi.it/~bettini
(very fast if you're in University)
source-highlight is free software. See the file COPYING for copying conditions. Anyway I won't get offended if you send me a postcard :-)
Return to GNU's home page.
Please send FSF & GNU inquiries & questions to gnu@gnu.org. There are also other ways to contact the FSF.
Please send comments on these web pages to webmasters@gnu.org, send other questions to gnu@gnu.org.
Copyright (C) 2001 Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA
Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.
Updated:9 Jan 2001 mhw