NAME

PodFr::Text - conversion de données POD en texte ASCII formatté


SYNOPSIS

        use PodFr::Text;

        pod2textfr("perlfunc.pod");

Also:

        pod2textfr [B<-a>] [B<->I<width>] < input.pod


DESCRIPTION

PodFr::Text est une adaptation très simple du module originale de conversion POD vers du texte: Pod::Text. La description de ce module suit. Les messages en anglais ont été traduit en français afin de faciliter la lecture des documents POD francophone.

PodFr::Text est un module qui convertit une documentation en format POD (telle que celles que l'on peut trouver dans la distribution de Perl) en un texte formaté en ISO-8859-1. Termcap est accepté de manière optionnelle pour le gras et le souligné et peut être activé via $PodFr::Text::termcap=1. Si termcap n'est pas activé, des backspaces (caractère de retour en arrière) sont utilisés pour simuler le gras et le souligné.

Le programme pod2textfr est fourni comme point d'entrée du module PodFr::Text.

La fonction pod2textfr() peut prendre une première option -a pour spécifier un format de sortie puis une seconde option -width spécifiant la largeur du terminal suivi par un ou deux arguments. Le premier devrait être le nom du fichier pod à lire ou ``<&STDIN'' pour lire directement STDIN. Le second argument, lorsqu'il est fourni, devrait être un filehandle global vers lequel sera envoyé le résultat.


AUTEUR

Tom Christiansen <tchrist@mox.perl.com>


TRADUCTION

Traduction et adaptation : Paul Gaborit (Paul.Gaborit@enstimac.fr)


À FAIRE

Nettoyer tout ça. L'entrée et la sortie devrait être plus flexible. termcap ne devrait pas être une variable globale et la vitesse du terminal devrait être calculer proprement.