groff - En ligne dans le Cloud

PROGRAMME:

Nom

groff - front-end pour le système de formatage de documents groff

SYNOPSIS

groff [-abcegijklpstzCEGNRSUVXZ] [-d cs] [-D arg] [-f fam] [-F dir] [-I dir] [-K arg]
[-L arg] [-m prénom] [-M dir] [-n num] [-o liste] [-P arg] [-r cn] [-T dev] [-w prénom]
[-W prénom] [filet ...]
groff -h | --Aidez-moi
groff -v | --version [option ...]

DESCRIPTION

Ce document décrit les groff programme, la principale interface pour le groff document
système de formatage. Les groff programme et macro suite est la mise en œuvre d'un roff(7)
système au sein de la collection de logiciels libres GNU ⟨http://www.gnu.org. Les groff le système a
toutes les caractéristiques du classique roff, mais ajoute de nombreuses extensions.

Les groff programme permet de contrôler l'ensemble groff système par options de ligne de commande. Cette
est une grande simplification par rapport au cas classique (qui utilise uniquement des tuyaux).

OPTIONS

La ligne de commande est analysée selon la convention GNU habituelle. L'espace entre
une option de ligne de commande et son argument est facultatif. Les options peuvent être regroupées derrière un
simple '-' (caractère moins). Un nom de fichier de - (caractère moins) désigne la norme
contribution.

As groff est un programme wrapper pour trof les deux programmes partagent un ensemble d'options. Mais le
groff programme a des options natives supplémentaires et donne un nouveau sens à certains trof
option. D'un autre côté, pas tous trof les options peuvent être introduites dans groff.

Originaire groff Options
Les options suivantes n'existent pas pour trof ou sont interprétés différemment par
groff.

-D arg Définir le codage d'entrée par défaut utilisé par préconv à arg. Implique -k.

-e Prétraiter avec équi.

-g Prétraiter avec grn.

-G Prétraiter avec grap. Implique -p.

-h
--Aidez-moi Imprimez un message d'aide.

-I dir Cette option peut être utilisée pour spécifier un répertoire pour rechercher des fichiers (à la fois ceux sur
la ligne de commande et ceux nommés dans .psbb ainsi que .so demandes, et \X'ps : importer' ainsi que
\X'ps : déposer' échappe). Le répertoire courant est toujours recherché en premier. Cette
l'option peut être spécifiée plusieurs fois ; les répertoires sont recherchés dans l'ordre
spécifié. Aucune recherche de répertoire n'est effectuée pour les fichiers spécifiés à l'aide d'une valeur absolue
chemin. Cette option implique la -s option.

-j Prétraiter avec chem. Implique -p.

-k Prétraiter avec préconv. Ceci est exécuté avant tout autre préprocesseur. Se il vous plaît se référer
à préconvla page de manuel de son comportement si non -K (ou -D) est spécifiée.

-K arg Définir l'encodage d'entrée utilisé par préconv à arg. Implique -k.

-l Envoyez la sortie à un programme de spouleur pour impression. La commande à utiliser
car cela est spécifié par le impression dans le fichier de description de l'appareil, voir
groff_font(5). Si cette commande n'est pas présente, la sortie est redirigée vers le LPR(1)
programme par défaut. Voir les options -L ainsi que -X.

-L arg Passé arg au programme de spouleur. Plusieurs arguments doivent être passés avec un
option -L séparée chacun. Noter que groff ne préfixe pas '-' (un signe moins) pour
arg avant de le transmettre au programme de spouleur.

-N Ne pas autoriser les nouvelles lignes à l'intérieur équi délimiteurs. C'est le même que le -N option
équi.

-p Prétraiter avec pic.

-P -Option
-P -Option -P arg
Passé -Option or -Option arg au post-processeur. L'option doit être spécifiée
avec le(s) signe(s) moins nécessaire(s) '-' ou '--' car groff ne collecte
ajouter des tirets avant de les transmettre au postprocesseur. Par exemple, pour passer un
titre à la gxditview postprocesseur, la commande shell

groff -X -P -title -P 'groff' foo

équivaut à

groff -X -Z foo | gxditview -title 'groff it' -

-R Prétraiter avec reportez-vous. Aucun mécanisme n'est fourni pour passer des arguments à reportez-vous
parce que la plupart reportez-vous les options ont des éléments de langage équivalents qui peuvent être spécifiés
au sein du document. Voir reportez-vous(1) pour plus de détails.

-s Prétraiter avec soelim.

-S Mode plus sûr. Passe le -S Option de pic et désactiver les éléments suivants trof demandes :
.open, .ouvrir un, .pso, .syet .pi. Pour des raisons de sécurité, le mode plus sûr est activé par
défaut.

-t Prétraiter avec tbl.

-T dev Réglez le périphérique de sortie sur dev. Pour cet appareil, trof génère le intermédiaire
sortie; voir groff_out(5). Puis groff appelle un postprocesseur pour convertir trof's
intermédiaire sortie à son format final. De vrais appareils dans groff

dvi TeX format DVI (le postprocesseur est grodvi).

html
xhtml Sortie HTML et XHTML (les préprocesseurs sont soelim ainsi que pré-grohtml,
le post-processeur est post-grohtml).

Imprimantes lbp Canon CAPSL (imprimantes laser des séries LBP-4 et LBP-8 ;
le post-processeur est grlbp).

lj4 Imprimantes compatibles HP LaserJet4 (ou autres compatibles PCL5)
(le postprocesseur est grolj4).

ps sortie PostScript (le postprocesseur est tâtons).

pdf Sortie au format PDF (Portable Document Format) (le postprocesseur est gropdf).

Pour les périphériques de sortie TTY suivants (le postprocesseur est toujours moche), -T sélectionne
l'encodage de sortie :

ASCII 7 bits ASCII.

cp1047 Jeu de caractères Latin-1 pour les hôtes EBCDIC.

latin1 ISO 8859-1.

utf8 Jeu de caractères Unicode en codage UTF-8. Ce mode a le plus
polices utiles pour le mode TTY, c'est donc le meilleur mode pour la sortie TTY.

Les arguments suivants sélectionnent gxditview en tant que 'postprocesseur' (c'est plutôt un
programme de visualisation):

Résolution X75 75dpi, police de base du document 10pt.

Résolution X75-12 75dpi, police de base du document 12pt.

Résolution X100 100dpi, police de base du document 10pt.

X100-12
Résolution 100dpi, police de base du document 12pt.

L'appareil par défaut est ps.

-U Mode non sécurisé. Revient à l'(ancien) comportement dangereux ; voir option -S.

-v
--version
Informations sur la version de sortie de groff et de tous les programmes qui sont exécutés par elle ; cette
c'est-à-dire que la ligne de commande donnée est analysée de la manière habituelle, en passant -v à tous
sous-programmes.

-V Sortir le pipeline qui serait exécuté par groff (en tant que programme wrapper) sur le
sortie standard, mais ne l'exécutez pas. S'il est donné plus d'une fois, les commandes sont
à la fois imprimés sur l'erreur standard et exécutés.

-X Utilisez gxditview au lieu d'utiliser le postprocesseur habituel pour (pré)afficher un document.
Le comportement du spouleur d'impression comme indiqué avec les options -l ainsi que -L est reporté sur
gxditview(1) en déterminant un argument pour le -printCommande option de
gxditview(1). Cela définit la valeur par défaut Imprimé action et l'entrée de menu correspondante
à cette valeur. -X ne produit de bons résultats qu'avec -Tps, -TX75, -TX75-12, -TX100,
ainsi que -TX100-12. La résolution par défaut pour la prévisualisation -Tps la sortie est de 75 dpi ; cette
peut être modifié en passant le -résolution Option de gxditview, Par exemple

groff -X -P-résolution -P100 -man foo.1

-z Supprimer la sortie générée par trof. Seuls les messages d'erreur sont imprimés.

-Z Ne pas post-traiter automatiquement groff intermédiaire sortie de la manière habituelle.
Cela entraînera le trof sortie à apparaître sur la sortie standard, remplaçant l'habituel
sortie du post-processeur ; voir groff_out (5).

Transparent Options
Les options suivantes sont transmises de manière transparente au programme formateur trof qui est
appelé par groff ensuite. Ces options sont décrites plus en détail dans trof (1).

-a Approximation ASCII de la sortie.

-b Backtrace en cas d'erreur ou d'avertissement.

-c Désactivez la sortie couleur. Veuillez consulter le moche(1) page de manuel pour plus de détails.

-C Activer le mode de compatibilité.

-d cs
-d prénom=s
Définir la chaîne.

-E Désactiver trof messages d'erreur.

-f fam Définir la famille de polices par défaut.

-F dir Définir le chemin des fichiers DESC de police.

-i Traiter l'entrée standard après les fichiers d'entrée spécifiés.

-m prénom
Inclure le fichier de macro prénom.tmac (ou tmac.prénom) voir également groff_tmac (5).

-M dir Chemin des fichiers de macro.

-n num Numéroter la première page num.

-o liste
Sortir uniquement les pages dans liste.

-r cn
-r prénom=n
Définir le registre des numéros.

-w prénom
Activer l'avertissement prénom. Voir trof(1) pour les noms.

-W prénom
désactiver l'avertissement prénom. Voir trof(1) pour les noms.

EN UTILISANT GROFF

Les groff combustion propre implémente l'infrastructure de roff classique; voir roff(7) pour un sondage
sur la façon dont un roff le système fonctionne en général. En raison des programmes frontaux disponibles dans le
groff système, en utilisant groff est beaucoup plus facile que classique roff. Cette section donne un
aperçu des pièces qui constituent le groff système. Il complète roff(7) avec
groff-caractéristiques spécifiques. Cette section peut être considérée comme un guide de la documentation
autour de la groff système.

Papier Taille
Les virtuel format de papier utilisé par trof pour formater l'entrée est contrôlée globalement avec le
demandes .po, .plet .ll. Voir groff_tmac(5) pour le package macro 'papersize' qui
fournit une interface pratique.

Les Physique le format du papier, donnant les dimensions réelles des feuilles de papier, est contrôlé
par des périphériques de sortie comme tâtons avec les options de ligne de commande -p ainsi que -l. Voir groff_font(5)
et les pages de manuel des périphériques de sortie pour plus de détails. groff utilise la ligne de commande
option -P passer des options aux périphériques de sortie ; par exemple, ce qui suit sélectionne le papier A4
en orientation paysage pour l'appareil PS :

groff -Tps -P-pa4 -Pl ...

Parties avant
Les groff programme est un wrapper autour du trof(1) programme. Il permet de préciser le
préprocesseurs par les options de ligne de commande et exécute automatiquement le postprocesseur qui est
correspondant à l'appareil sélectionné. Ce faisant, le mécanisme de tuyauterie parfois fastidieux de
classique roff(7) peut être évité.

Les grog(1) le programme peut être utilisé pour deviner le bon groff ligne de commande pour formater un
fichier.

Les greffier(1) le programme est une visionneuse polyvalente pour groff fichiers et pages de manuel.

Préprocesseurs
Les groff les préprocesseurs sont des réimplémentations des préprocesseurs classiques avec des
prolongements. Les préprocesseurs standard distribués avec le groff paquet sont

équi(1) pour les formules mathématiques,

grn(1) pour inclure diablotin(1) photos,

pic(1) pour dessiner des schémas,

chem(1)
pour les diagrammes de structure chimique,

reportez-vous(1)
pour les références bibliographiques,

soelim(1)
pour inclure des fichiers macro à partir d'emplacements standard,

ainsi que

tbl(1) pour les tableaux.

Un nouveau préprocesseur non disponible en classique trof is préconv(1) qui convertit divers
encodages d'entrée à quelque chose groff peut comprendre. Il est toujours exécuté en premier avant tout
autre préprocesseur.

En plus de ceux-ci, il existe des préprocesseurs internes qui sont automatiquement exécutés avec certains
dispositifs. Ceux-ci ne sont pas visibles pour l'utilisateur.

Macro Formules
Des packages de macros peuvent être inclus en option -mL’ groff système implémente et étend tous
packages de macros classiques d'une manière compatible et ajoute ses propres packages. Réellement,
les packages de macros suivants sont fournis avec groff:

man Le format de page de manuel traditionnel ; voir groff_man(7). Il peut être spécifié sur le
ligne de commande comme -homme or -m man.

mandoc Le package général pour les pages de manuel ; il reconnaît automatiquement si le
documents utilise le man au sein de l’ mdoc format et branches à la macro correspondante
emballer. Il peut être spécifié sur la ligne de commande comme -mandoc or -m mandoc.

mdoc Le format de page de manuel de style BSD ; voir groff_mdoc(7). Il peut être spécifié sur le
ligne de commande comme -mdoc or -m mdoc.

me Le classique me format des documents ; voir groff_moi(7). Il peut être spécifié sur le
ligne de commande comme Me or -m me.

mm Le classique mm format des documents ; voir groff_mm(7). Il peut être spécifié sur le
ligne de commande comme -mm or -m mm.

ms Le classique ms format des documents ; voir groff_ms(7). Il peut être spécifié sur le
ligne de commande comme -SP or -m ms.

www Macros de type HTML pour inclusion dans arbitraire groff documents ; voir groff_www (7).

Des détails sur le nom des fichiers de macros et leur placement peuvent être trouvés dans groff_tmac(5);
cette page de manuel documente également d'autres packages de macros auxiliaires mineurs non mentionnés
ici.

Programmation Langue
Concepts généraux communs à tous roff les langages de programmation sont décrits dans roff (7).

Les groff extensions au classique trof langue sont documentés dans groff_diff (7).

Les groff la langue dans son ensemble est décrite dans le (encore incomplet) groff info filet; à
une référence courte (mais complète) peut être trouvée dans groff (7).

Formateurs
Le central roff formateur au sein du groff Système est trof(1). Il fournit les fonctionnalités
des deux classiques trof ainsi que nroff, ainsi quedes groff prolongements. La ligne de commande
option -C commutateurs trof développement compatibilité mode qui essaie d'imiter le classique roff as
autant que possible.

Il existe un script shell nroff(1) qui émule le comportement du classique nroff. il essaie
pour sélectionner automatiquement l'encodage de sortie approprié, en fonction des paramètres régionaux actuels.

Le programme formateur génère intermédiaire sortie; voir groff_out (7).

Compatibles
In roff, les cibles de sortie sont appelées dispositifs. Un périphérique peut être un élément matériel,
par exemple, une imprimante ou un format de fichier logiciel. Un appareil est spécifié par l'option -TL’
groff les appareils sont les suivants.

ascii Sortie de texte à l'aide du ascii(7) jeu de caractères.

cp1047 Sortie de texte à l'aide de la page de codes EBCDIC IBM cp1047 (par exemple, OS/390 Unix).

Dvi Format TeX DVI.

html Sortie HTML.

latin1 Sortie de texte à l'aide du jeu de caractères ISO Latin-1 (ISO 8859-1) ; voir iso_8859_1 (7).

livres Sortie pour les imprimantes Canon CAPSL (imprimantes laser des séries LBP-4 et LBP-8).

lj4 Imprimantes compatibles HP LaserJet4 (ou autres compatibles PCL5).

ps sortie PostScript ; adapté pour les imprimantes et les prévisualiseurs comme gv (1).

pdf fichiers PDF ; adapté à la visualisation avec des outils tels que montrerde Géographie (1) et avec la okulé (1).

utf8 Sortie de texte à l'aide du jeu de caractères Unicode (ISO 10646) avec codage UTF-8 ; voir
unicode (7).

xhtml Sortie XHTML.

X75 Sortie du système X Window 75 dpi adaptée aux prévisualiseurs xditview(1x) et
gxditview(1). Une variante pour une police de base de document 12pt est X75-12.

X100 Sortie du système X Window 100 dpi adaptée aux prévisualiseurs xditview(1x) et
gxditview(1). Une variante pour une police de base de document 12pt est X100-12.

Le postprocesseur à utiliser pour un périphérique est spécifié par le post-pro dans la commande
fichier de description de l'appareil ; voir groff_font(5). Ceci peut être annulé avec le -X option.

L'appareil par défaut est ps.

Post-processeurs
groff fournit 3 post-processeurs matériels :

grlbp(1)
pour certaines imprimantes Canon,

grolj4(1)
pour les imprimantes compatibles HP LaserJet 4 et PCL5,

moche(1)
pour la sortie de texte à l'aide de divers encodages, par exemple, sur des terminaux orientés texte ou en ligne
imprimantes.

Aujourd'hui, la plupart du matériel d'impression ou de dessin est géré par le système d'exploitation, par périphérique
pilotes, ou par des interfaces logicielles, acceptant généralement PostScript. Par conséquent, il
n'est pas un besoin urgent de plus de post-processeurs de périphériques matériels.

Les groff les dispositifs logiciels pour la conversion en d'autres formats de fichiers de documents sont

grodvi(1)
pour le format DVI,

groshtml(1)
pour les formats HTML et XHTML,

tâtons(1)
pour PostScript.

gropdf(1)
pour PDF.

Combiné avec les nombreux outils de conversion gratuits existants, cela devrait être suffisant pour convertir
a trof document dans pratiquement n'importe quel format de données existant.

Utilitaires
Les programmes utilitaires suivants autour groff sont disponibles.

infos supplémentaires(1)
Ajouter des informations à trof fichiers de description de police à utiliser avec groff.

afmtodit(1)
Créez des fichiers de description de police pour le périphérique PostScript.

eqn2graph(1)
Convertir un équi image dans une image recadrée.

gdiffmk(1)
Marquer les différences entre groff, nroffou trof fichiers.

graph2graph(1)
Convertir un grap diagramme dans une image bitmap recadrée.

greffier(1)
Programme téléspectateur général pour groff fichiers et pages de manuel.

gxditview(1)
Les groff Visionneuse X, la version GNU de xditview.

hpftodit(1)
Créez des fichiers de description de police pour le périphérique lj4.

indexbib(1)
Faire un index inversé pour les bases de données bibliographiques.

lkbib(1)
Rechercher des bases de données bibliographiques.

bavoir(1)
Recherche interactive dans les bases de données bibliographiques.

pdfroff(1)
Créer des documents PDF en utilisant groff.

pfbtops(1)
Traduisez une police PostScript au format .pfb en ASCII.

pic2graphe(1)
Convertir un pic diagramme dans une image recadrée.

tfmtodit(1)
Créez des fichiers de description de police pour le périphérique TeX DVI.

xditview(1x)
roff visionneuse distribuée avec X window.

xtotroff(1)
Convertir les métriques de polices X en GNU trof métriques de police.

ENVIRONNEMENT

Normalement, le séparateur de chemin dans les variables d'environnement suivantes est le deux-points ; Ceci peut
varient selon le système d'exploitation. Par exemple, DOS et Windows utilisent un point-virgule
à la place.

GROFF_BIN_PATH
Ce chemin de recherche, suivi de $ CHEMIN, est utilisé pour les commandes exécutées par
groff. S'il n'est pas défini, le répertoire dans lequel le groff les binaires ont été installés
est précédé de PATH.

GROFF_COMMAND_PREFIX
Lorsqu'il est nécessaire d'exécuter différents roff réalisations en même temps groff
offre la possibilité d'ajouter un préfixe à la plupart de ses programmes qui pourraient
provoquer des conflits de noms au moment de l'exécution (par défaut, il n'y en a pas). Historiquement, ce
le préfixe était le caractère g, mais ça peut être n'importe quoi. Par exemple, gtroff représentait
groff's trof, gtbl pour le groff version de tbl. En définissant GROFF_COMMAND_PREFIX
à des valeurs différentes, les différentes roff les installations peuvent être adressées. Suite
exactement, s'il est défini sur le préfixe xxx puis groff en tant que programme wrapper en interne
en cours xxxtrof au lieu de trof. Ceci s'applique également aux préprocesseurs équi, grn,
pic, reportez-vous, tbl, soelim, et aux services publics indexbib ainsi que bavoir. Cette fonctionnalité
ne s'applique à aucun programme différent de ceux ci-dessus (notamment groff
lui-même) car ils sont uniques au groff paquet.

GROFF_ENCODAGE
La valeur de cette valeur d'environnement est transmise au préconv préprocesseur pour sélectionner
l'encodage des fichiers d'entrée. La définition de cette option implique groffla ligne de commande de
option -k (c'est, groff en fait appelle toujours préconv). Si défini sans valeur,
groff en cours préconv sans argument. Un explicite -K option de ligne de commande
remplace la valeur de GROFF_ENCODAGE. Voir préconv(1) pour plus de détails.

GROFF_FONT_PATH
Une liste de répertoires dans lesquels rechercher le devprénom répertoire en plus de
ceux par défaut. Voir trofde Géographie (1) et avec la groff_font(5) pour plus de détails.

GROFF_TMAC_PATH
Une liste de répertoires dans lesquels rechercher des fichiers de macros en plus du répertoire par défaut
répertoires. Voir trofde Géographie (1) et avec la groff_tmac(5) pour plus de détails.

GROFF_TMPDIR
Le répertoire dans lequel les fichiers temporaires sont créés. Si ce n'est pas défini mais que le
variable d'environnement TMPDIR à la place, des fichiers temporaires sont créés dans le répertoire
$ TMPDIR. Sur les plateformes MS-DOS et Windows 32, les variables d'environnement TMP ainsi que
TEMP (dans cet ordre) sont également recherchés, après GROFF_TMPDIR ainsi que TMPDIR. Autrement,
les fichiers temporaires sont créés dans / TmpL’ reportez-vous(1), greffier(1), groshtml(1), et
tâtons(1) les commandes utilisent des fichiers temporaires.

GROFF_TYPESETTER
Préréglez l'appareil par défaut. Si ce n'est pas défini, le ps l'appareil est utilisé par défaut.
Ce nom d'appareil est écrasé par l'option -T.

EXEMPLES

L'exemple suivant illustre la puissance du groff programme comme un wrapper
trof.

Pour traiter un roff fichier utilisant les préprocesseurs tbl ainsi que pic et par me ensemble de macros, classique
trof a dû être appelé par

photo foo.me | tbl | troff -me -Tlatin1 | moche

En utilisant groff, ce tuyau peut être raccourci à la commande équivalente

groff -p -t -me -T latin1 foo.me

Un moyen encore plus simple d'appeler ceci est d'utiliser grog(1) pour deviner le préprocesseur et la macro
options et exécutez la commande générée (en utilisant des guillemets pour spécifier la commande shell
substitution)

`grog -Tlatin1 foo.me`

Le moyen le plus simple est de visualiser le contenu de manière automatisée en appelant

groffer foo.me

Utilisez groff en ligne en utilisant les services onworks.net