ftagshtml  -  mise en forme HTML des fichiers sources for­
       tran et C.


SYNOPSIS

       ftagshtml [ -C ] [ -file ] [ -h ] [ -I  INCLUDE_PATH_VARI­
       ABLE ] [ -l ] [ -l2h ] [ -latex ] [ -n ] [ -t Source files
       path ] [ -v ] [ -w 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  fonc­
       tions  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 commen­
       taires (latex(1)), en Html. Il s'agit des instructions  de
       mise en forme de base: chapitres, sections, 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   -h   -l   -l2h   -file    -n
              -I$(INCLUDE_PATH_VARIABLE)   -t$(PWD)  -w$(PWD)/doc
              *.f *.c


OPTIONS

       -C     effectue une fontification des  mots-clés  du  for­
              tran.

       -file  demande  l'affichage  du  fichier  et  du programme
              courant.

       -h     demande la  transformation  en  Html  des  fichiers
              (latex(1)),  mis  en input à l'aide d'hevea le tra­
              ducteur  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  variable.  Fonctionne
              exactement  comme la variable PATH de recherche des
              exécutables.

              l'architecture.  Si vous disposez de (pdflatex(1)),
              vous pourrez générer un document PDF.

       -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  commen­
              taires  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  fortran)  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éper­
              toire sur lequel  les  fichiers  HTML  sont  écrits
              (option w)

       -v     Donne   plus  de  messages,  particulièrement  pour
              générer une documentation 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_Ver­
       batim>"


        \verb+toto+  devient  "<CODE><FONT  COLOR=$Couleur_Verba­
       tim>"

        \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 'aref­
       erence' 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 pro­
       grammes. 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

       help  module   $FTAGSHTML_DIR/lib/perl/ftagshtml/latex.pm:
       perl             latex             index            module
       $FTAGSHTML_DIR/lib/perl/ftagshtml/index.pm:   perl   index
       files                                               module
       $FTAGSHTML_DIR/lib/perl/ftagshtml/javanavig.pm: perl  html
       search    engine    module    $FTAGSHTML_DIR/lib/perl/com­
       mun/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