ftagshtml
analyze fortran 77, 90 and C procedures and constructs
html indexes for navigating onto source code.
SYNOPSIS
ftagshtml [ -C ] [ -debug ] [ -f90 ] [ -file ] [ -help ] [
-hevea ] [ -I string "INCLUDE_PATH_VARIABLE" ] [ -l ] [
-info ] [ -l ] [ -l2h ] [ -latex ] [ -n ] [ -t string
"Source files path" ] [ -v int verbosity ] [ -version ] [
-w string "Target files path" ] [*.f ... *.c]
DESCRIPTION
Ftagshtml is a programme that transforms C, fortran 77 and
90 into HTML pages. Ftagshtml builds indexes of cross-
calling diagrams and allows navigating on include files.
As a default, ftagshtml writes ALL its output to the
HTML/ftagshtml subdirectory of the users's current's
directory.
Ftagshtml also can be used as a very simple literate pro
gramming tool transforming (latex(1)), basic tags into
HTML: chapters, sections, lists as well as labels and
cross-references. Equations, figures and tables are not
supported.
EXAMPLES
ftagshtml can be easily run from a makefile
html:
@rm -rf HTML/ftagshtml
@ftagshtml -latex -I $(INCLUDE_PATH_VARIABLE)
*.f *.c
doc:
@rm -rf $(PWD)/doc
@ftagshtml -C -hevea -l -l2h -file -n -I
$(INCLUDE_PATH_VARIABLE) -t $(PWD) -w $(PWD)/doc
*.f *.c
OPTIONS
-C produces a nice fontification of the programming
languages keywords (declarations, do if)
-debug prints debug information in case ftagshtml fails on
your code.
-f90 extension files of type ".f" are assumed to be
written in the fortran 90 free format.
-file prints the name of the current file and procedure
every 10 lines (recommended)
-hevea demands the hevea transformations of the inputed as
tions and tables. Figures are not supported.
-help usage output, useful to check your man page is up
to date
-I [INCLUDE_PATH_VARIABLE] this variable of the same
syntax as the one of the PATH variable describes
all the directoties where your includes can be
found.
-l asks for a (latex(1)), index to produce a printable
output of the indexes. If you have (pdflatex(1)),
installed on your system, you will be able to pro
duce a PDF with hyperrefs.
-l2h produces external refernces for (latex2html(1)),
allowing the build of a pretty documentation about
your code referring to it avec des renvois directs
au code source. This is the best way to make lit
erate programming with ftagshtml using (latex(1)).
-latex assumes the comments in your code are in
(latex(1)), allowing you segmenting a procedure's
listing
-n prints the line numbers (recommended)
-t [Source files path] Considers the source files are
on this directory. Usefull if you do not have perl
on the targeted system. Useless otherwise.
-v verboses the output at the level youy asked (maxi
mum is 6)
-w [Target files path] the output files are written
onto this directory instead of the default
HTML/ftagshtml
FTAGSHTML AND LATEX
ftagshtml understands some basic tags (latex(1)). These
are
\begin{enumerate} becomes "<ol>"
\begin{description} becomes "<ul>"
\begin{itemize} becomes "<ul>"
\begin{definition}[article] becomes "<h2>article</h2><I>"
\begin{remark}[article] becomes "Remarque article<I>"
\begin{verbatim} becomes "<PRE><FONT COLOR=$Couleur_Ver
batim>"
\item becomes "<li>"
\item[article] becomes "<li><u>article</u>"
\verb+toto+ becomes "<CODE><FONT COLOR=$Couleur_Verba
tim>"
\chapter{chapitre} becomes "<h1>chapitre</h1>"
\section{section} becomes "<h2>section</h2>"
\subsection{section} becomes "<h3>section</h3>"
\subsubsection{section} becomes "<h4>section</h4>"
\label{alabel} becomes "<A Name=alabel></A>"
\ref{areference} becomes <A Href="file where label 'aref
erence' is declared#areference">areference</A> or <FONT
COLOR=RED>areference</FONT> if the corresponding label is
not found.
Tags like \begin{motclé} are to be terminated by
\end{motclé}
ENVIRONMENT
Compulsory environment.
FTAGSHTML_DIR: ftagshtml installation directory
Customisation environment.
Couleur_Code Code's color. By default: Orange.
Couleur_Comment Comment's color. By default: Black.
Couleur_Header Routines' arguments color. By default:
Magenta.
Couleur_LiensIndex Index table color. By default: Green.
Couleur_Branchement Color of the raguments of a a called
routine. By default: Pink.
Couleur_Verbatim Verbatim style color. By default: Green.
$FTAGSHTML_DIR/lib/perl/ftagshtml/fontify.pm: fontifica
tion of the key words of the language
$FTAGSHTML_DIR/lib/perl/ftagshtml/html.pm: HTML writting
routines
$FTAGSHTML_DIR/lib/perl/ftagshtml/index.pm: perl index
files module
$FTAGSHTML_DIR/lib/perl/ftagshtml/information.pm: perl
help module
$FTAGSHTML_DIR/lib/perl/ftagshtml/javanavig.pm: perl html
search engine module
$FTAGSHTML_DIR/lib/perl/ftagshtml/LaTeX.pm: LaTeX writting
routines
$FTAGSHTML_DIR/lib/perl/ftagshtml/latex.pm: perl latex
index module
$FTAGSHTML_DIR/lib/perl/commun/searchfc.pm: perl fortran
and C analysis module
AUTHOR
Olivier Cessenat
SEE ALSO
getin(1), ftvisu(1), emacs(1)
BUGS
I would be pleased to here you found a bug: this means
this program is useful to you.
Man(1) output converted with
man2html