Creare pagine di man

Archivio articoli e recensioni.

Creare pagine di man

Messaggioda ikir » mar ago 22, 2006 3:33 pm

Pubblicato su iksnetv3 il 26/10/2003 11:45 by sHaDy

MAN PAGES FOR FUN by sHaDy

Come tutti i programmi degni di chiamarsi tali hanno una loro documentazione. Su linux sono celebri le pagine di man avviabili con la
sintassi:
Codice: Seleziona tutto
   man nomeprogramma

Disponibili per quasi tutti i programmi esistenti. Spesso questa
documentazione supera in vastità e in completezza le varie guide in
linea. In questo doc molto semplice vedremo come crearne di nostre
per i nostri programmi.

Dunque cominciamo con il dire come sono suddivise le pagine di man.
Ve ne sarete già accorti, esse sono formate da vari paragrafi e più
precisamente:
Codice: Seleziona tutto
   Name
   Synopsis
   Description
   Options
   Files
   Environment
   Diagnostic
   Bugs
   Author

Per scrivere una pagina di man va bene un qualsiasi editor di testo.<br>
Ogni comando del codice di una pagina è preceduto da un punto ".".I
comandi sono i seguenti:
Codice: Seleziona tutto
   .TH  titolo
   .SH    paragrafo
   .TP  nuovo paragrafo
   .SS  sottoparagrafo
   .B   grassetto
   .BI   grassetto corsivo
   .BR  grassetto alternato
   .I   corsivo
   .IB   corsivo grassetto
   .IR   corsivo alternato
   .R   romanico
   .RB   romanico alternato con grassetto
   .RI   romanico alternato con corsivo
   ./"  commento

Ora vi faccio un esempio di pagina di man che chiarirà velocemente
le vostre perplessità. Eccovi il codice:
Codice: Seleziona tutto
   ./"Ciao a tutti ecco l'esempio =)
   .TH Prova
   .SH Name
   Prova di pagina man
   .SH SYNOPSIS
   .B comando [opzione] [opzione] [etc]
   .SH DESCRIPTION
   .B Questa pagina di man è un esempio scrivi quel che vuoi
   .SH OPTIONS
   .TP
   .[opzione] scrivi qual che vuoi
   .TP
   .[opzione] scrivi qual che vuoi
   .SH NOTES
   Esempio di pagina man
   .SH AUTHOR
   .I sHaDy
   .BR robcasanovi@virgilio.it

Per compilare una pagina bisogna utilizzare groff (per maggiori info
fate man groff) con la sintassi:
Codice: Seleziona tutto
   groff -Tascii -man nome_pagina.man<br><br>

Dove ovviamente nome_pagina.man è il nome della pagina che avrete
rinominato con l'estensione .man
Per impratichirvi non vi resta che fare un po' di esercizio osservando anche le pagine di man già esistenti (anche per capire gli
standard da rispettare e per non fare cose oscene ^_^). Con questa
guida abbiamo finito. Se qualcosa ancora vi sfugge digitate man man
e otterrete chiarezza. Spero che questo obrobrio sia servito a qualcuno. Bye


http://shadyhack.altervista.org/
Avatar utente
ikir

Admin
 
Messaggi: 10159
Iscritto il: mer gen 08, 2003 7:33 pm
Località: SYS:Prefs/

Torna a Articoli

Chi c’è in linea

Visitano il forum: Nessuno e 2 ospiti

cron