Linux Man Page Howto
Indietro		Avanti

8. Quali sono le convenzioni sui font?

Prima di tutto: non usate gli operatori diretti dei font come \fB, \fP ecc.. Invece, usate le macro che accettano argomenti. In tal modo eviterete un errore comune: dimenticare il cambio del font alla fine della parola estendendo erroneamente il grassetto o il corsivo fino al successivo cambio di font. Succede più spesso di quanto si pensi, credetemi. Le macro di tmac.an forniscono i seguenti formati tipografici:

.B grassetto (bold)

.BI grassetto alternato al corsivo (italic)

.BR grassetto alternato al carattere Roman

.IB corsivo alternato al grassetto

.IR corsivo alternato al Roman

.RB Roman alternato al grassetto

.RI Roman alternato al corsivo

.SM small: piccolo (di dimensioni pari a 9/10 di quella normale)

.SB piccolo e grassetto (non piccolo alternato al grassetto)

X alternato con Y significa che gli argomenti di ordine dispari vengono resi nel formato X, mentre quelli pari sono in formato Y. Per esempio:

.BI "Arg 1 è grassetto, " "Arg 2 è corsivo, " "questo è grassetto, " "e questo corsivo."

Le doppie virgolette sono necessarie per includere gli spazi in un argomento; senza di esse non avremmo modo di far apparire gli spazi tra i diversi formati tipografici. A tutti gli effetti, quando al passaggio tra un formato tipografico e l'altro vorrete evitare la comparsa di spazi bianchi, saranno necessarie solo le macro con formato tipografico alternato. Ciò vale per la maggior parte dei casi. Ecco come dovreste far uso dei diversi formati tipografici (userò un frammento spudoratamente rubato da man(7)):

Benché nel mondo UNIX esistano molte convenzioni arbitrarie per le pagine man, l'esistenza di svariate centinaia di pagine man specifiche per Linux definiscono i nostri standard: nel caso delle funzioni, gli argomenti sono sempre indicati in corsivo, anche nella sezione SINTASSI, mentre il resto della funzione è indicata in grassetto:

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

I nomi dei file sono sempre in corsivo, tranne che nella sezione SINTASSI, in cui i file inclusi sono in grassetto. Quindi andrebbero utilizzati i formati

.I /usr/include/stdio.h

.B #include <stdio.h>

Le macro speciali (quelle della programmazione C, da non confondere con le macro delle pagine man, NdT), solitamente indicate in maiuscolo, sono in grassetto:

Quando si elenca una serie di codici d'errore, questi vanno resi in grassetto. Di solito, per questo elenco si utilizza la macro .TP (il paragrafo con i tag appesi) come segue:
.TP .B EBADF .I fd non è un descrittore di file valido. .TP .B EINVAL .I fd è inaffidabile in lettura

Ogni riferimento ad un'altra pagina man (o al soggetto della pagina man corrente) è in grassetto. Se presente, il numero di sezione del manuale viene reso in carattere roman, senza spazi:

Gli acronimi vengono resi meglio usando i caratteri tipografici piccoli, per cui raccomando di fare come negli esempi che seguono

Indietro	Partenza	Avanti
Dovrei distribuire il sorgente e/o la documentazione già formattata?		Come affinare una pagina man