Cerca all'interno del corso
Ricevi un consiglio a settimana !!

Corso di C con Linux

Scrivere la guida in linea (man page)
Lezione 18
Parte 2 di 3

 

Vedi anche i corsi correlati:


Partner:


 

Vediamo ora la struttura di una tipica man page:

        
          .TH nome sezione data
                 specifica l'intestazione della man page
                                che ha la seguente struttura:
                
       +--------------------------------------------+
       |nome(sezione)                  nome(sezione)|
       |                                            |
       /                                            /
       |                                            |
       |               data            numero_pagina|
       +--------------------------------------------+

          .SH "descrizione"
               Intestazione della sezione descrizione 
                
          .SS "descrizione"
                  Intestazione della sotto-sessione di "descrizione"      

                
          .B scritta
                 scritta in grassetto
                
          .I scritta
                 scritta in corsivo
                
          .BI a b a b a b a...
                 .IB a b a b a b a...
                 .RI a b a b a b a...
                 .IR a b a b a b a...
                 .RB a b a b a b a...
                 .BR a b a b a b a...
                 BI  pone le a in grassetto e le b in corsivo
                 RI  pone le a in roman e la le b in corsivo
                 IR  pone le a in corsivo e le b in roman
                 RB  pone le a in roman e le b in grassetto
                 BR  pone le a in grassetto e le b in roman
                 
                
          .P
                 .LP
                 .PP
                 Tre sinonimi per le interruzioni di paragrafo
                
          .TP colonne
                 termine
                 paragrafo...
                 
          .IP inizio
                 Inizia un paragrafo indentato, l'argomento
                                inizio é presente viene posto alla sinistra del paragrafo.
               
                
                   
          .RS
                 ...
                 .RE

                 Definisce un regione indentata.
                
                   
                
         Comandi generici
                     
          .\" linea di commento
                
Queste macro appena descritte compongono un elenco completo di come può essere fatta una man page, ma effettivamente alcune di esse sono poco usate. Scriviamo ora una man page, rispettando le regole fin ora dette, chiameremo tale man page mioprogramma.1, dove mio programma sarà un comando utente che può essere avviato da chiunque.

Ecco un esempio di come deve essere tale file:

 


   
Home Page

A Cura di Angelo Carpenzano (©)

Scarica questa lezione: Clicca qui per scaricare la lezione


 

Segnala questa lezione ad un amico!
Nome Amico:
eMail Amico:
Tuo Nome:
Regalagli anche la Newsletter di questo corso!