Page suivante - Page précédente - Table des matières

8. Quelles sont les conventions pour les fontes ?

Avant tout, n'utilisez pas les opérateurs directs de fonte comme \fB \fP, etc. Employez des macros avec des arguments. Cette méthode vous évitera une erreur classique : oublier un changement de fonte à la fin d'un mot ce qui provoque la continuation du gras ou de l'italique jusqu'au prochain changement de fonte. Croyez-moi, ça arrive plus souvent qu'on ne le pense !

Les macros tmac.an offrent les possibilités suivantes :

  • .B caractères gras
  • .BI gras et italiques en alternance
  • .BR gras et romain en alternance
  • .I italiques
  • .IB italiques et gras en alternance
  • .IR italiques et romain en alternance
  • .RB romain et gras en alternance
  • .RI romain et italiques en alternance
  • .SM taille réduite (9/10 du corps normal)
  • .SB gras, taille réduite (NON petit et gras en alternance)

X et Y en alternance signifie que les arguments impairs seront imprimés en X et les pairs en Y. Par exemple : 

.BI "Arg 1 est gras, " "arg2 est en italiques, " "arg3 en gras"

Les guillemets sont nécessaires pour placer des espaces dans un argument.

Voilà donc pour ce qui est possible. Voyons maintenant comment il faut utiliser ces possibilités (des parties ont été honteusement copiées de man(7)) :

Bien qu'il existe de nombreuses conventions typographiques pour les pages de manuel dans le monde UNIX, l'existence de plusieurs centaines de pages de manuel spécifiques à Linux définit nos standards :

Pour les fonctions, les arguments sont toujours en italiques, même dans la section SYNOPSYS, alors que le reste est en gras. Vous écrirez donc : 

.BI "mafonction(int " argc ", char **" argv );

Les noms de fichiers sont toujours en italiques, hormis dans la section SYNOPSYS où les fichiers à inclure sont en gras. Vous écrirez alors : 

.I /usr/include/stdio.h
et 
.B #include <stdio.h>

Les noms des macros, qui sont habituellement en majuscules, sont en gras : 

.B MAXINT

Lors de l'énumération d'une liste de codes d'erreurs, ces codes sont en gras. Cette liste fait généralement appel à la macro .TP (paragraphe avec titre) comme ci-dessous : 

.TP
.B EBADF
.I fd n'est pas un descripteur de fichier valide
.TP
.B EINVAL
.I fd ne convient pas pour être lu

Toute référence à une autre page de manuel (ou à la page courante) est en gras. Si le numéro de la section du manuel est indiqué, il s'écrit en roman, sans espace : 

.BR man (7)

Les acronymes sont plus élégants lorsqu'ils apparaissent dans un corps plus petit. Je recommande donc : 

.SM UNIX
.SM ASCII
.SM TAB
.SM NFS
.SM LALR(1)

Page suivante - Page précédente - Table des matières