Page suivantePage pr�c�denteTable 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 :

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 suivantePage pr�c�denteTable des mati�res

Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 18:01:31