Content-type: text/html Manpage of FTAGSHTML


Section: 0.515 (1)
Updated: Sunday, June 17th 2007
Index Return to Main Contents



ftagshtml - Analyze fortran 77, 90 and C procedures and constructs html indexes for navigating onto source code.  


ftagshtml [ -cgi string "Location of on your WEB server, such as '/cgi-bin'" ] [ -cvsweb string "Location of cvsweb on your WEB server, such as 'http://localhost/cgi-bin/cvsweb.cgi/my_path'" ] [ -code ] [ -conf string "Name of config file, such as 'mytest'" ] [ -debug ] [ -f90 ] [ -help ] [ -hevea ] [ -getin_format string "GETIN OUTPUT FORMAT" ] [ -I string "INCLUDE_PATH_VARIABLE" ] [ -L string "INPUT_PATH_VARIABLE" ] [ -latexindex ] [ -l2h ] [ -latex ] [ -nocolor ] [ -nofile ] [ -nojava ] [ -nolinenum ] [ -nostyle ] [ -numperindex int Maximum_Number_Of_Contents_In_Index ] [ -R ] [ -show ] [ -t string "Source files path" ] [ -v int verbosity ] [ -version ] [ -w string "Target files path" ] [ -www string "HTML code absolute PATH on WEB server, such as /mycode" ] [*.f ... *.c]  


Ftagshtml is a program 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 programming 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.  


ftagshtml can be easily run from a makefile
       @ftagshtml -cgi "/cgi-perso" -conf "MYCONF" -www "/code/MYCODE/HTML/ftagshtml" -code "MYCODE" -l2h -latexindex -hevea -I ./include:../include *.f *.c *.f90

       @rm -rf HTML/ftagshtml
       @ftagshtml -nojava -latex -I $(INCLUDE_PATH_VARIABLE) *.f *.c

       @rm -rf $(PWD)/doc
       @ftagshtml -hevea -latexindex -l2h -I $(INCLUDE_PATH_VARIABLE) -t $(PWD) -w $(PWD)/doc *.f *.c


[WEB PATH TO GETIN] give here the absolute location of your search tool (getin(1)), on your Apache Web Server. This PATH depends on the configuration of your Apache Web server.
[WEB PATH TO CVSWEB] give here the location to your cvsweb to the base location for your files, such as 'http://localhost/cgi-bin/cvsweb.cgi/my_path'"
[CODE_NAME] assumes CODE_NAME is the name of your code. If not specified, the name of the source directory will be taken.
[A File NAME] without the ".pm" extension, gives the name of the configuration file stored for (getin(1)), that will be stored on $FAGSHTML_DIR/lib/perl/getin/conf/. This configuration file helps getin knowing where you have your fortran source files, as well as where are your HTML target files.
prints debug information in case ftagshtml fails on your code.
extension files of type ".f" are assumed to be written in the fortran 90 free format.
usage output, useful to check your man page is up to date
specifies the getin default output format.
demands the hevea transformations of the inputed as (latex(1)), files. Hevea is a very efficient basic translator written by INRIA in France using Objective Caml (ocaml(1)) Hevea knows transforming equations and tables. Figures are not supported.
[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.
[INPUT_PATH_VARIABLE] this variable of the same syntax as the one of the PATH variable describes all the directoties where your tex input files can be found.
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 literate programming with ftagshtml using (latex(1)).
assumes the comments in your code are in (latex(1)), allowing you segmenting a procedure's listing
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 produce a PDF with hyperrefs.
prevents producing a nice fontification of the programming languages keywords (declarations, do if). This option is obsolete if you use Netscape release 4 or more since Cascading Style Sheets allow suppressing colors. This option is maintained for emacs-w3 users.
prevents printing the name of the current file and procedure every 10 lines (recommended)
prevents building very nice javascript indexes for viewing with netscape 3 or above.
prevents printing the line numbers from the source file.
prevents using stylesheets (CSS-1) in case you have an old browser. Do not use this option if you use Netscape 4 or more.
followed by an integer that gives the maximum number of entries in an index file related to functions, subroutines and modules.
looks for all program file down from local directory, recursively,
shows routine prototypes, (default is do not show)
[Source files path] Considers the source files are on this directory. Usefull if you do not have perl on the targeted system. Useless otherwise.
uses the HTML line feed marker instead of the pretty color line (not recommanded).
verboses the output at the level youy asked (maximum is 6)
[Target files path] the output files are written onto this directory instead of the default HTML/ftagshtml
[WEB PATH TO HTML SOURCES] give here the absolute location of your web sources on your Apache Web Server. this allows (getin(1)) to render HTML temprorary files that contain proper paths to your real source code. Without this option, you will get "file://" paths, these are valid paths only if you have an NFS mount point to HTML sources.


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{modif}[article] becomes "Modification article<I>"

\begin{verbatim} becomes "<PRE><FONT COLOR=$Couleur_Verbatim>"

\item becomes "<li>"

\item[article] becomes "<li><u>article</u>"

\verb+toto+ becomes "<CODE><FONT COLOR=$Couleur_Verbatim>"

\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 'areference' is declared#areference">areference</A> or <FONT COLOR=RED>areference</FONT> if the corresponding label is not found.

Tagslike \begin{keyword} are to be terminated by \end{keyword}  


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/bin/ftagshtml: main file

$FTAGSHTML_DIR/lib/perl/ftagshtml/ LaTeX writting routines

$FTAGSHTML_DIR/lib/perl/ftagshtml/ General defaults

$FTAGSHTML_DIR/lib/perl/ftagshtml/ OS specific functions

$FTAGSHTML_DIR/lib/perl/ftagshtml/ fontification of the key words of the language

$FTAGSHTML_DIR/lib/perl/ftagshtml/ HTML writting routines

$FTAGSHTML_DIR/lib/perl/ftagshtml/ perl index files module

$FTAGSHTML_DIR/lib/perl/ftagshtml/ perl help module

$FTAGSHTML_DIR/lib/perl/ftagshtml/ Marcelino Alves Martins Java Indexes creation,

$FTAGSHTML_DIR/lib/perl/ftagshtml/ perl html search engine module

$FTAGSHTML_DIR/lib/perl/ftagshtml/ perl latex index module

$FTAGSHTML_DIR/lib/perl/ftagshtml/ ftagshtml restart features are made by this module.

$FTAGSHTML_DIR/lib/perl/commun/ perl fortran and C analysis module



Olivier Cessenat  


getin(1), ftvisu(1), emacs(1)  


I would be pleased to here you found a bug: this means this program is useful to you.




This document was created by man2html, using the manual pages.
Time: 18:47:53 GMT, June 17, 2007