| 1 |
1026 |
ivang |
src2html - Hyperlink a C source code tree using HTML, Version 1.3-alpha
|
| 2 |
|
|
|
| 3 |
|
|
Warren Toomey wkt@cs.adfa.oz.au June 1995
|
| 4 |
|
|
|
| 5 |
|
|
|
| 6 |
|
|
Src2html is a program which takes a C source tree and creates a set of
|
| 7 |
|
|
HTML hypertext documents that allows the most important symbols in the
|
| 8 |
|
|
source tree to be found easily. As well, a HTML version of the source
|
| 9 |
|
|
tree is created, with the symbols given in bold font where they are defined
|
| 10 |
|
|
in the source.
|
| 11 |
|
|
|
| 12 |
|
|
|
| 13 |
|
|
REQUIREMENTS
|
| 14 |
|
|
|
| 15 |
|
|
You will need:
|
| 16 |
|
|
|
| 17 |
|
|
+ Perl 4.x
|
| 18 |
|
|
+ a standard Unix sort(1) command.
|
| 19 |
|
|
+ a mkdir(1) that supports recursive creation of directories.
|
| 20 |
|
|
src2html is configured to use `mkdir -p' to do this.
|
| 21 |
|
|
+ an egrep(1) if you're going to use the search facility.
|
| 22 |
|
|
+ httpd(1) if you're going to use the search facility.
|
| 23 |
|
|
+ Ctags-new, which is bundled with src2html, and a C compiler
|
| 24 |
|
|
to compile it.
|
| 25 |
|
|
|
| 26 |
|
|
|
| 27 |
|
|
INSTALLATION
|
| 28 |
|
|
|
| 29 |
|
|
Extract the src2html archive, including the Ctags-new and Example directories;
|
| 30 |
|
|
you probably have already done that. Go into the Ctags-new directory and make
|
| 31 |
|
|
ctags-new. This should be very straight-forward.
|
| 32 |
|
|
|
| 33 |
|
|
Install ctags-new and src2html in a directory on your path, make them
|
| 34 |
|
|
executable and install their man pages as well. If your mkdir(1) uses a
|
| 35 |
|
|
different option to -p, edit src2html to fix this.
|
| 36 |
|
|
|
| 37 |
|
|
If you want to use the search facility, you need to install src2html.cgi
|
| 38 |
|
|
in your httpd script directory, and edit it to reflect the root of your
|
| 39 |
|
|
HTML documents, as set in DirectryRoot in conf/srm.conf.
|
| 40 |
|
|
|
| 41 |
|
|
Make sure that ctags-new, src2html and src2html.cgi are executable, and
|
| 42 |
|
|
that the latter two can find the Perl interpreter. Installation is complete.
|
| 43 |
|
|
|
| 44 |
|
|
|
| 45 |
|
|
USING SRC2HTML
|
| 46 |
|
|
|
| 47 |
|
|
Using src2html is pretty straight-forward. Print out and read the man page
|
| 48 |
|
|
before trying anything. In the FreeBSD directory I have included the config
|
| 49 |
|
|
file and header files for my src2html conversion of the FreeBSD-2.0.5 source
|
| 50 |
|
|
tree; read the man page and FreeBSD/FreeBSD.s2h in tandem. The root document of
|
| 51 |
|
|
this HTML tree is at http://minnie.cs.adfa.oz.au/FreeBSD-srctree/FreeBSD.html.
|
| 52 |
|
|
|
| 53 |
|
|
|
| 54 |
|
|
COMMENTS AND QUESTIONS
|
| 55 |
|
|
|
| 56 |
|
|
Surprisingly, src2html is reasonably fast even on large source trees. This was
|
| 57 |
|
|
my first Perl program, so it could probably be made faster and smaller. I've
|
| 58 |
|
|
placed comments in the source to give you an idea of what each section does. If
|
| 59 |
|
|
you have any questions or comments, please email them to me at
|
| 60 |
|
|
wkt@cs.adfa.oz.au. Now that it's finished I'm not that keen on overhauling it
|
| 61 |
|
|
etc. I consider it as a good prototype. Getting inter-source hyperlinks done
|
| 62 |
|
|
would be great, but I really don't want to write a C parser myself.
|
| 63 |
|
|
|
| 64 |
|
|
Cheers,
|
| 65 |
|
|
Warren Toomey
|
