txt2man - En ligne dans le Cloud

PROGRAMME:

Nom

txt2man - convertir du texte ASCII plat au format de page de manuel

SYNOPSIS

txt2man [-hpTX] [-t montitre] [-P nom de p] [-r rel] [-s secte]
[-v vol] [-I txt] [-B txt] [-d données] [sifichier]

DESCRIPTION

txt2man convertit le texte saisi au format standard nroff/troff man(7) macros utilisées pour formater
Pages de manuel Unix. Des pages soignées peuvent être générées spécialement pour les commandes (section 1 ou 8) ou
pour référence des fonctions C (sections 2, 3), avec la capacité de reconnaître et de formater
noms de commandes et de fonctions, indicateurs, types et arguments.

txt2man est également capable de reconnaître et de formater des sections, des paragraphes, des listes (standard,
numéroté, description, imbriqué), références croisées et blocs d'affichage littéraux.

Si le fichier d'entrée sifichier est omis, l'entrée standard est utilisée. Le résultat est affiché sur l'entrée standard.
sortie.

Voici comment les modèles de texte sont reconnus et traités :

sections
Ces en-têtes sont définis par une ligne en majuscules, commençant par la colonne 1. S'il y a
un ou plusieurs espaces de début, une sous-section sera générée à la place.

Paragraphes
Ils doivent être séparés par une ligne vide et alignés à gauche.

Jour liste
La définition de l'article est séparée de la description de l'article par au moins deux espaces
espaces, même avant un retour à la ligne, si la définition est trop longue. La définition sera
mis en valeur par défaut.

Canon liste
Les éléments de la liste à puces sont définis par le premier mot « - » ou « * » ou « o ».

Dénombré liste
Le premier mot doit être un chiffre suivi d'un point.

Littéral l’affichage blocs
Ce type de paragraphe est utilisé pour afficher du texte non modifié, par exemple du code source. Il
doivent être séparés par une ligne vide et être indentés. Il est principalement utilisé pour formater
Code source non modifié. Il sera imprimé avec une police fixe autant que possible.
(troff).

Cross
Une référence croisée (une autre page de manuel) est définie par un mot suivi d'un numéro dans
parenthèse.

Sections spéciales:

Nom Le nom de la fonction ou de la commande et une brève description sont définis dans cette section.

SYNOPSIS
Cette section reçoit un traitement spécial pour identifier le nom de la commande, les drapeaux et
arguments et propager les attributs correspondants plus loin dans le texte. Si un C comme
la fonction est reconnue (mot immédiatement suivi d'une parenthèse ouverte), txt2man
imprimera le nom de la fonction en gras, les types en police normale et les variables en
Police italique. Toute la section sera imprimée avec une police fixe (courier).
chaque fois que possible (troff).

C'est une bonne pratique d'intégrer la documentation dans le code source, en utilisant des commentaires ou
variables de texte constantes. txt2man permet de faire cela, en conservant la source du document
lisible, utilisable même sans formatage supplémentaire (c'est-à-dire pour l'aide en ligne) et facile à écrire.
Le résultat est un document de haute qualité et conforme aux normes.

OPTIONS

-h L'option -h affiche de l'aide.

-d données
complet » données dans l'en-tête. La valeur par défaut est actuelle données.

-P nom de p
complet » nom de p comme nom de projet dans l'en-tête. Par défaut, uname -s.

-p Titre de la sonde, nom de la section et volume.

-t montitre
complet » montitre comme titre de la page de manuel générée.

-r rel complet » rel comme nom de projet et version.

-s secte
complet » secte en tant que section dans le titre, généralement une valeur de 1 à 8.

-v vol complet » vol comme nom de volume, c'est-à-dire « manuel de l'utilisateur Unix ».

-I txt Mettre en italique txt en sortie. Peut être spécifié plusieurs fois.

-B txt Mettre en valeur (en gras) txt en sortie. Peut être spécifié plusieurs fois.

-T Aperçu du résultat du texte à l'aide de PAGER, généralement plus (1).

-X Aperçu des résultats X11 à l'aide de gxditview (1).

ENVIRONNEMENT

PAGER nom de la commande de pagination, généralement plus(1), ou moins(1). Si non défini revient à
plus (1).

EXEMPLE

Essayez cette commande pour formater ce texte lui-même :

$ txt2man -h 2>&1 | txt2man -T

ASTUCES

Pour obtenir une bonne mise en forme globale du document de sortie, conservez les paragraphes en retrait
correctement. Si vous avez des sections en gras indésirables, recherchez plusieurs espaces entre les mots,
qui servent à identifier une liste de balises (terme suivi d'une description). Choisissez aussi
soigneusement le nom des paramètres de ligne de commande ou de fonction, car ils seront mis en valeur à chaque fois
chaque fois qu'ils sont rencontrés dans le document.

Utilisez txt2man en ligne avec les services onworks.net