Content-type: text/html Manpage of FTAGSHTML

FTAGSHTML

Section: 0.515 (1)
Updated: Dimanche 17 juin 2007
Index Return to Main Contents

 

NOM

ftagshtml - Mise en forme HTML des fichiers sources fortran et C.  

SYNOPSIS

ftagshtml [ -cgi string "Location de getin.pl sur votre serveur WEB, comme '/cgi-bin'" ] [ -cvsweb string "Location de cvsweb sur votre serveur WEB, comme 'http://localhost/cgi-bin/cvsweb.cgi/mon-répertoire'" ] [ -code ] [ -conf string "Nom du fichier de configuration, comme '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 rechercher tous les fichiers programmes fortran et C récursivement à partir du répertoire courant. ] [ -show montre le prototype des routines et des appels de fonctions ] [ -t string "Chemin vers le répertoire des sources" ] [ -u utilise le marqueur de trait de ligne HTML à la place de la ligne arc-en-ciel ] [ -v int verbosity ] [ -version ] [ -w string "Chemin vers le répertoire d'écriture" ] [ -www string "Chemin absolu sur votre serveur WEB du code HTML, comme /mycode" ] [*.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, sections, listes...  

EXEMPLES

ftagshtml se lance aisément à partir d'un makefile:
cgi:
       @ftagshtml -cgi "/cgi-perso" -conf "MACONF" -www "/code/MONCODE/HTML/ftagshtml" -code "MONCODE" -l2h -latexindex -hevea -I ./include:../include *.f *.c *.f90

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

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

OPTIONS

-cgi
[CHEMIN WEB VERS GETIN] option donnant le chemin vers le moteur de recherche (getin(1)), sur le serveur WEB. Ce chemin dépend de la configuration de votre serveur WEB Apache évidemment.
-code
[CODE_NAME] suppose que CODE_NAME est le nom de votre code. Si non simplifié, le nom du répertoire courant de travail où se trouvent les sources sera utilisé.
-conf
[Nom du fichier de configuration] sans l'extension ".pm". Ce fichier de configuration permet à (getin(1)), le moteur de recherche intelligent de trouver l'emplacement de votre code et de vos fichiers HTML obtenus par ftagshtml. Ce fichier de configuration sera stockè sous le répertoire $FAGSHTML_DIR/lib/perl/getin/conf/.
-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.
-help
produit une notice réduite d'utilisation, utile si votre page de manuel ne concorde pas avec le produit.
-getin_format
donne le format d'affichage par défaut de getin.
-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 variable. Fonctionne exactement comme la variable PATH de recherche des exécutables.
-L
[INPUT_PATH_VARIABLE] est capable de rechercher les fichiers tex input sur ce PATH, dans l'ordre de recherche spécifié par cette variable. Fonctionne exactement comme la variable PATH de recherche des exécutables.
-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.
-latexindex
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.
-nocolor
inhibe la fontification du code à l'aide de couleurs. Cette option est obsolète, car les feuilles de style permettent de réaliser cette opération. Cette option est maintenue pour les clients emacs-w3.
-nofile
demande de ne pas afficher le nom du fichier et du programme courant (toutes les 10 lignes)
-nojava
ne crée pas les index java (en plus des index logiques).
-nolinenum
demande de ne pas afficher les numéros de ligne du fichier source.
-nostyle
inhibe l'utilisation des feuilles de style (CSS-1) au cas où votre navigateur ne le supporte pas. N'utilisez pas cette option si vous utilisez Netscape 4 ou supérieur.
-numperindex
suivi par un entier donnant le nombre maximum d'entrées dans les index de fonctions, subroutines et modules.
-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épertoire 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é.
-www
[CHEMIN WEB VERS VOS SOURCES HTML] donne le chemin absolu sur votre serverur WEB de l'emplacement de vos sources. Ceci permet à (getin(1)) de vous rendre des fichiers HTML temporaires avec des chemins corrects. Sans cette option, vous aurez des chemins de la forme "file://", valides uniquement par NFS.
 

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>"

\item devient "<li>"

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

\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é.

Lesbalisesdelaforme \begin{motclé} sont à terminer par des balises \end{motclé} et ftagshtml met en place la fin du TAG correspondant.  

ENVIRONNEMENT

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.

.IRCouleur_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.  

FICHIERS

$FTAGSHTML_DIR/bin/ftagshtml: le programme principal

$FTAGSHTML_DIR/lib/perl/ftagshtml/LaTeX.pm: routines d'écriture en LaTeX

$FTAGSHTML_DIR/lib/perl/ftagshtml/defaults.pm: Préférences générales

$FTAGSHTML_DIR/lib/perl/ftagshtml/fichiers.pm: Fonctions de manipulation de fichiers spécifiques du système d'exploitation.

$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/index.pm: perl index files module

$FTAGSHTML_DIR/lib/perl/ftagshtml/information.pm: perl help module

$FTAGSHTML_DIR/lib/perl/ftagshtml/javaindex.pm: Création des index JavaScript de Marcelino Alves Martins. http://www.geocities.com/Paris/LeftBank/2178/

$FTAGSHTML_DIR/lib/perl/ftagshtml/javanavig.pm: perl html search engine module

$FTAGSHTML_DIR/lib/perl/ftagshtml/latex.pm: perl latex index module

$FTAGSHTML_DIR/lib/perl/ftagshtml/restart.pm: Les capacités de reprise de ftagshtml sont implémentées dans ce module.

$FTAGSHTML_DIR/lib/perl/commun/searchfc.pm: perl fortran and C analysis module

 

AUTEUR

Olivier Cessenat  

VOIR AUSSI

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

BUGS

A votre écoute.


 

Index

NOM
SYNOPSIS
DESCRIPTION
EXEMPLES
OPTIONS
FTAGSHTML ET LATEX
ENVIRONNEMENT
FICHIERS
AUTEUR
VOIR AUSSI
BUGS

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