rman - En ligne dans le Cloud

PROGRAMME:

Nom

PolyglotMan, rman - Compilation inverse des pages de manuel à partir d'une forme formatée vers un certain nombre de sources
formats : ASCII, roff, TkMan, Tk, Sections, HTML, SGML, MIME, LaTeX, LaTeX2e, RTF, POD.

SYNOPSIS

homme [ Options ] [ filet ]

DESCRIPTION

Vous trouverez des instructions à jour sur http://polyglotman.sourceforge.net/rman.html

PolyglotteHomme prend les pages de manuel de la plupart des versions populaires d'UNIX et les transforme
dans l'un des nombreux formats de source de texte. PolyglotMan était auparavant connu sous le nom de RosettaMan.
Le nom du binaire s'appelle toujours homme, pour les scripts qui dépendent de ce nom ;
mnémotechniquement, il suffit de penser "homme inversé". Précédemment PolyglotteHomme les pages requises pour être
formaté par nroff(1) avant son traitement. Avec la version 3.0, il préfère [tn]roff
source et produit généralement des résultats encore meilleurs. Et le traitement à la source est le seul
façon de traduire des tableaux. La traduction du format source n'est pas aussi mature que formatée, cependant,
essayez donc la traduction formatée comme sauvegarde.

En analysant la source [tn]roff, on pourrait implémenter un sous-ensemble arbitrairement grand de [tn]roff,
ce que je n'ai pas fait et ne ferai pas, donc les résultats peuvent être erronés. J'ai mis en œuvre une importante
sous-ensemble de ceux utilisés dans les pages de manuel, y compris tbl (mais pas eqn), if tests, et
définitions de macros générales, les résultats sont donc généralement excellents. Si ce n'est pas le cas, formatez le
page avec nroff avant de l'envoyer à PolyglotMan. Si PolyglotMan ne reconnaît pas une clé
macro utilisée par une grande classe de pages, cependant, envoyez-moi par e-mail la source et un nroff- uuencodé
page formatée et je verrai ce que je peux faire. Lors de l'exécution de PolyglotMan avec la source de la page de manuel
qui inclut ou redirige vers une autre source [tn]roff en utilisant le .so (source ou inclusion)
macro, vous devriez être dans le répertoire parent de la page, puisque les pages sont écrites avec
cette hypothèse. Par exemple, si vous traduisez /usr/share/man/man1/ls.1, premier cd
dans /usr/share/man.

PolyglotteHomme accepte les pages de manuel de : SunOS, Sun Solaris, Hewlett-Packard HP-UX, AT&T
Système V, OSF/1 alias Digital UNIX, DEC Ultrix, SGI IRIX, Linux, FreeBSD, SCO. La source
le traitement fonctionne pour : SunOS, Sun Solaris, Hewlett-Packard HP-UX, AT&T System V, OSF/1 aka
UNIX numérique, DEC Ultrix. Il peut produire uniquement des caractères ASCII imprimables (caractères de contrôle
dépouillé), en-têtes de section uniquement, Tk, TkMan, [tn]roff (source de page de manuel traditionnelle), XML,
HTML, MIME, LaTeX, LaTeX2e, RTF, Perl 5 POD. Une architecture modulaire permet un ajout facile
de formats de sortie supplémentaires.

La dernière version de PolyglotMan est disponible sur http://polyglotman.sourceforge.net/ .

OPTIONS

Les options suivantes ne doivent pas être utilisées avec d'autres et quittez PolyglotMan sans
traiter toute entrée.

-h|--help Affiche la liste des options de la ligne de commande et quitte.

-v|--version Affiche le numéro de version et quitte.

Vous devrait spécifier le une fonction filtre premier, as ceci. ensembles a nombre of paramètres, et puis spécifier
autre options.

-f|--filtre
Réglez le filtre de sortie. La valeur par défaut est ASCII.

-S|--source PolyglotMan essaie de déterminer automatiquement si son entrée est source ou
formaté ; utilisez cette option pour déclarer l'entrée source.

-F|--format|--formaté
PolyglotMan essaie de déterminer automatiquement si son entrée est source ou
formaté ; utilisez cette option pour déclarer une entrée formatée.

-l|--titre chaîne_printf
En mode HTML, cela définit le des pages de manuel, étant donné le même
paramètres comme -r .

-r|--référence|--manref chaîne_printf
En modes HTML et XML, cela définit le formulaire URL par lequel récupérer un autre homme
pages. La chaîne peut utiliser deux paramètres fournis : le nom de la page de manuel et
sa rubrique. (Voir la section Exemples.) Si la chaîne est nulle (comme si elle était définie
à partir d'un shell par "-r ''"), '-' ou 'off', alors les références de page de manuel ne seront pas
être des HREF, juste mis en italique. Si votre printf prend en charge les positions XPG3
spécificateur, cela peut être assez flexible.

-V|--volumes <séparés par deux points liste>
Définissez la liste des volumes valides à vérifier lors de la recherche de
références à d'autres pages de manuel. Par défaut à 1:2:3:4:5:6:7:8:9:o:l:n:p
(les noms de volumes peuvent comporter plusieurs caractères). Si une chaîne sans espace dans le
page est immédiatement suivie d'une parenthèse gauche, puis d'une des
volumes, et se termine par d'autres caractères facultatifs, puis un droit
parenthèse--alors cette chaîne est signalée comme une référence à un autre manuel
page. Si cette chaîne -V commence par un signe égal, alors aucune option
caractères sont autorisés entre la correspondance avec la liste des valides et le
parenthèse droite. (Cette option est nécessaire pour SCO UNIX.)

Les options suivantes s'appliquent uniquement lorsque des pages formatées sont fournies en entrée. Ils ne
s'appliquent à ou sont toujours traités correctement avec la source.

-b|--sous-sections
Essayez de reconnaître les titres de sous-sections en plus des titres de section. Ceci peut
causer des problèmes sur certaines versions d'UNIX.

-K|--nobreak Indique que les pages de manuel n'ont pas de sauts de page, donc ne cherchez pas les pieds de page et
en-têtes autour d'eux. (Les anciennes macros nroff -man mettent toujours des sauts de page,
mais dernièrement, certains vendeurs se sont rendu compte que les impressions sont faites par
trof(1), alors que nroff -man est utilisé pour formater les pages pour une lecture à l'écran,
et ont ainsi éliminé les sauts de page.) PolyglotteHomme obtient généralement ce droit
même sans ce drapeau.

-k|--keep Conserve les en-têtes et les pieds de page, sous forme de rapport canonique à la fin de la page.
changeleft Déplacer les barres de changement, telles que celles trouvées dans les pages de manuel Tcl/Tk,
À gauche. --> non agressif Désactiver analyse agressive de la page de manuel.
Manuel agressif, qui est activé par défaut, les en-têtes elides d'analyse de page et
pieds de page, identifie les sections et plus encore. -->

-n|--nom prénom Définir le nom de la page de manuel (utilisé au format roff). Si le nom du fichier est indiqué dans le
former " prénom . ", le nom et la section sont déterminés automatiquement.
Si la page est analysée à partir de la source [tn]roff et qu'elle a une ligne .TH,
cette information est extraite de cette ligne.

-p|--bascule en mode paragraphe. Le filtre détermine si les lignes doivent être
linebreaked comme ils l'étaient par nroff, ou si les lignes devraient être coulées
ensemble en paragraphes. Principalement à usage interne.

-s|section # Définir le volume (alias section) du numéro de page de manuel (utilisé au format roff). les tables
Activez l'analyse de table agressive. -->

-t|--tabstops #
Pour les ensembles de macros qui utilisent des tabulations à la place des espaces lorsque cela est possible dans
afin de réduire le nombre de caractères utilisés, définissez des tabulations tous les #
Colonnes. La valeur par défaut est 8.

NOTES ON FILTRE TYPES

ROFF
Quelques variantes de la page de manuel UNIX sans source [tn]roff, permettant de créer son imprimante laser
un peu plus qu'une marguerite à laser. Ce filtre essaie d'intuitionner l'original
[tn]roff directives, qui peuvent ensuite être recompilées par [tn]roff.

TkMan
TkMan(1), un navigateur de page de manuel hypertexte, utilise PolyglotteHomme pour afficher les pages de manuel sans le
(généralement) en-têtes et pieds de page inutiles sur chaque page. Il recueille également la section et
(éventuellement) en-têtes de sous-section pour un accès direct à partir d'un menu déroulant. TkMan et Tcl/Tk,
la boîte à outils dans laquelle il est écrit, sont disponibles via ftp anonyme à partir de
ftp://ftp.smli.com/pub/tcl/

Tk
Cette option affiche le texte dans une série de listes Tcl constituées de paires de balises texte, où
les noms de balises correspondent à peu près au HTML. Cette sortie peut être insérée dans un widget texte Tk
en faisant un eval insérer fin . Ce format devrait être relativement facile
analysable par d'autres programmes qui veulent à la fois le texte et les balises. Voir aussi ASCII.

ASCII
Lorsqu'elles sont imprimées sur une imprimante ligne, les pages de manuel tentent de produire des effets de texte spéciaux en
caractères en surimpression avec eux-mêmes (pour produire du gras) et des traits de soulignement (souligné).
Les autres logiciels de traitement de texte, tels que les éditeurs de texte, les chercheurs et les indexeurs, doivent
contrecarrer cela. Le filtre ASCII supprime ce formatage. Tuyauterie nroff sortie à travers
avec -b supprime également ce formatage, mais il laisse des en-têtes de page disgracieux et
pieds de page. Voir aussi Tk.

sections
Section de vidages et (éventuellement) titres de sous-section. Cela pourrait être utile pour un autre programme
qui traite les pages de manuel.

HTML
Avec une simple extension à un serveur HTTP pour Mosaic(1) ou autre navigateur World Wide Web,
PolyglotteHomme peut produire du HTML de haute qualité à la volée. Plusieurs de ces extensions et
des pointeurs vers plusieurs autres sont inclus dans PolyglotteHomme 's contribution répertoire.

XML
C'est l'approche du Docbook DTD, mais j'espère que quelqu'un avec un réel intérêt pour
cela va peaufiner les balises générées. Essayez-le pour voir à quel point les balises sont proches maintenant.

MIME
MIME (Multipurpose Internet Mail Extensions) tel que défini par RFC 1563, bon pour la consommation
par des e-mails compatibles MIME ou sous forme de documents enrichis Emacs (>=19.29).

Latex et LaTeX2e
Pourquoi pas ?

RTF
Utilisez la sortie sur Mac ou NeXT ou autre. Peut-être prendre des pages de manuel au hasard et les intégrer
mieux avec le système de documentation de NeXT. Peut-être que NeXT a ses propres macros de page de manuel qui
ce.

PostScript et FrameMaker
Pour produire du PostScript, utilisez groff or psroff . Pour produire FrameMaker MIF, utilisez FrameMaker
filtre intégré. Dans les deux cas, vous avez besoin [tn]roff source, donc si vous n'avez qu'un fichier formaté
version de la page de manuel, utilisez PolyglotteHomme le filtre roff en premier.

EXEMPLES

Pour convertir le mis en forme page de manuel nommée ls.1 retour sous la forme source [tn]roff :

homme -f roff /usr/local/man/cat1/ls.1 > /usr/local/man/man1/ls.1

Les longues pages de manuel sont souvent compressées pour économiser de l'espace (la compression est particulièrement efficace
sur les pages de manuel formatées car de nombreux caractères sont des espaces). Comme il s'agit d'une longue page de manuel, il
a probablement des sous-sections, que nous essayons de séparer (certains ensembles de macros ne distinguent pas
sous-sections assez bien pour PolyglotteHomme pour les détecter). Convertissons ceci en LaTeX
Format:

PCAT /usr/catman/a_man/cat1/automount.z | homme -b -n automount -s 1 -f latex >
montage automatique.man

Alternativement, man 1 automount | homme -b -n automount -s 1 -f latex > montage automatique.man

Pour les utilisateurs HTML/Mosaïque, PolyglotteHomme peut, sans modification du code source, produire
Liens HTML qui pointent vers d'autres pages de manuel HTML soit prégénérées soit générées à la volée.
Supposons d'abord des versions HTML prégénérées des pages de manuel stockées dans /usr/share/man/html .
Générez-les un par un avec le formulaire suivant :
homme -f html -r 'http:/usr/share/man/html/%s.%s.html' /usr/share/man/cat1/ls.1 >
/usr/share/man/html/ls.1.html

Si vous avez étendu votre client HTML pour générer du HTML à la volée, vous devriez utiliser quelque chose
comme:
homme -f html -r 'http:~/bin/man2html?%s:%s' /usr/share/man/cat1/ls.1
lors de la génération du code HTML.

Utiliser rman en ligne à l'aide des services onworks.net