ftagshtml
mise en forme HTML des fichiers sources fortran et C.
SYNOPSIS
ftagshtml [ -C ] [ -debug ] [ -f90 ] [ -file ] [ -help ] [ -hevea ] [ -I
string "INCLUDE_PATH_VARIABLE" ] [ -java ] [ -l ] [ -l2h ] [ -latex ] [ -n
] [ -t string "Source files path" ] [ -v int verbosity ] [ -version ] [ -w
string "Target files path" ] [*.f ... *.c]
DESCRIPTION
Ftagshtml est un programme de transformation des sources C et fortran en
Html. Ftagshtml effectue une copie de ces fichiers en Html en permettant
de naviguer sur les fonctions et subroutines, ainsi que sur les includes.
Par défaut, Ftagshtml écrit sur le répertoire HTML/ftagshtml à partir du
répertoire de lancement du programme.
Ftagshtml effectue une mini-transformation des commentaires (latex(1)), en
Html. Il s'agit des instructions de mise en forme de base: chapitres, sec
tions, listes...
EXAMPLES
ftagshtml se lance aisément à partir d'un 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_VARI
ABLE) -t $(PWD) -w $(PWD)/doc *.f *.c
OPTIONS
-C effectue une fontification des mots-clés du fortran.
-debug affiche des informations de debug (réservé au développement de
ftagshtml)
-f90 considère les fichiers d'extension ".f"comme des fichiers fortran
90.
-file demande l'affichage du nom du fichier et du programme courant
(toutes les 10 lignes)
-help produit une notice réduite d'utilisation, utile si votre page de
manuel ne concorde pas avec le produit.
-hevea demande la transformation en Html des fichiers (latex(1)), mis en
input à l'aide d'hevea le traducteur de l'INRIA écrit en Objective
Caml (ocaml(1)) ce qui permet de voir les formules mathématiques.
-I [INCLUDE_PATH_VARIABLE] est capable de rechercher les fichiers
include sur ce PATH, dans l'ordre de recherche spécifié par cette
-java crée des index java en plus des index logiques.
-l demande la constitution d'un index (latex(1)), ce qui permet de
constituer un document écrit sur l'architecture. Si vous disposez
de (pdflatex(1)), vous pourrez générer un document PDF.
-l demande la création d'un index (latex(1)).
-l2h demande la constitution d'un index de références externes pour
(latex2html(1)), ce qui permet de constituer un document HTML de
référence sur un logiciel avec des renvois directs au code source.
Ceci n'a bien sûr un intérêt que si (latex(1)) est le format de
sauvegarde de votre traitement de texte.
-latex considère que les commentaires du code sont en (latex(1)), ce qui
permet d'afficher les commentaires sous un format flottant au lieu
du format par défaut qui respecte les espaces, tabulations et
retours chariot.
-n demande l'affichage des numéros de ligne.
-t [Source files path] considère que les fichiers sources (C et for
tran) sont sur le répertoire indiqué. Utile pour lancer ftagshtml
sur un remote architecture filesystem. Si vous mettez un chemin
relatif à ce niveau, ce sera par rapport au répertoire sur lequel
les fichiers HTML sont écrits (option w)
-v Donne plus de messages, particulièrement pour générer une documen
tation PDF.
-w [Target files path] écrit les fichiers HTML sur le répertoire
spécifié.
FTAGSHTML ET LATEX
ftagshtml comprend (nativement) un certain nombre de balises (latex(1)).
Ces balises sont à ce jour:
\begin{enumerate} devient "<ol>"
\begin{description} devient "<ul>"
\begin{itemize} devient "<ul>"
\begin{definition}[article] devient "<h2>article</h2><I>"
\begin{remark}[article] devient "Remarque article<I>"
\begin{modif}[article] devient "Modification article<I>"
\begin{verbatim} devient "<PRE><FONT COLOR=$Couleur_Verbatim>"
\verb+toto+ devient "<CODE><FONT COLOR=$Couleur_Verbatim>"
\chapter{chapitre} devient "<h1>chapitre</h1>"
\section{section} devient "<h2>section</h2>"
\subsection{section} devient "<h3>section</h3>"
\subsubsection{section} devient "<h4>section</h4>"
\label{alabel} devient "<A Name=alabel></A>"
\ref{areference} devient <A Href="fichier où label 'areference' est
déclaré#areference">areference</A> ou <FONT COLOR=RED>areference</FONT> si
le label correspondant n'est pas trouvé.
Les balises de la forme \begin{motclé} sont à terminer par des balises
\end{motclé} et ftagshtml met en place la fin du TAG correspondant.
ENVIRONMENT
Environnement obligatoire.
FTAGSHTML_DIR: le répertoire d'installation de ftagshtml.
Environnement de customisation.
FTAGSHTML_DOC: le répertoire documentant ftagshtml.
Couleur_Code Couleur du code. Par défaut Orange.
Couleur_Comment Couleur des commentaires. Par défaut Black.
Couleur_Header Couleur des arguments des programmes. Par défaut Magenta.
Couleur_LiensIndex Couleur de la table d'index des programmes. Par défaut
Green.
Couleur_Branchement Couleur des arguments des programmes appelés. Par
défaut Pink.
Couleur_Verbatim Couleur du style verbatim. Par défaut Green.
FILES
$FTAGSHTML_DIR/bin/ftagshtml: le programme principal
$FTAGSHTML_DIR/lib/perl/ftagshtml/fontify.pm: routines de fontification
des mots-clés du langage
$FTAGSHTML_DIR/lib/perl/ftagshtml/html.pm: routines d'écriture en HTML
$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: routines d'écriture en LaTeX
$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
A votre écoute.
Man(1) output converted with
man2html