txt2man - Online nel cloud

PROGRAMMA:

NOME

txt2man - convertire testo ASCII piatto in formato pagina man

SINOSSI

txt2man [-HPTX] [-t miotitolo] [-P nome] [-r rel] [-s setta]
[-v vol] [-I txt] [-B txt] [-d quando] [iffile]

DESCRIZIONE

txt2man converte il testo di input nello standard nroff/troff uomo(7) macro usate per formattare
Pagine di manuale Unix. Le belle pagine possono essere generate appositamente per i comandi (sezione 1 o 8) oppure
per riferimento alle funzioni C (sezioni 2, 3), con la capacità di riconoscere e formattare
nomi di comandi e funzioni, flag, tipi e argomenti.

txt2man è inoltre in grado di riconoscere e formattare sezioni, paragrafi, elenchi (standard,
numerati, descrittivi, nidificati), riferimenti incrociati e blocchi di visualizzazione letterali.

Se il file di input iffile viene omesso, viene utilizzato l'input standard. Il risultato viene visualizzato su standard
produzione.

Ecco come vengono riconosciuti ed elaborati i modelli di testo:

sezioni
Queste intestazioni sono definite da una riga in maiuscolo, a partire dalla colonna 1. Se c'è
uno o più spazi iniziali, verrà invece generata una sottosezione.

I paragrafi
Devono essere separati da una riga vuota e allineati a sinistra.

Etichetta stratagemma
La definizione dell'oggetto è separata dalla descrizione dell'oggetto da almeno 2 spazi vuoti
spazi, anche prima di una nuova riga, se la definizione è troppo lunga. La definizione sarà
enfatizzato per impostazione predefinita.

proiettile stratagemma
Gli elementi dell'elenco puntato sono definiti dalla prima parola "-" o "*" o "o".

Enumerato stratagemma
La prima parola deve essere un numero seguito da un punto.

letterale dalla visualizzazione blocchi
Questo tipo di paragrafo viene utilizzato per visualizzare il testo non modificato, ad esempio il codice sorgente. Esso
deve essere separato da una riga vuota ed essere rientrato. Viene utilizzato principalmente per formattare
codice sorgente non modificato. Verrà stampato utilizzando caratteri fissi quando possibile
(troff).

Cross Riferimenti
Un riferimento incrociato (un'altra pagina man) è definito da una parola seguita da un numero in
parentesi.

Sezioni speciali:

NOME In questa sezione vengono impostati il ​​nome della funzione o del comando e una breve descrizione.

SINOSSI
Questa sezione riceve un trattamento speciale per identificare il nome del comando, i flag e
argomenti e propagare gli attributi corrispondenti più avanti nel testo. Se una C mi piace
la funzione è riconosciuta (parola immediatamente seguita da una parentesi aperta), txt2man
stamperà il nome della funzione in grassetto, i tipi in normale e le variabili in
carattere corsivo. L'intera sezione verrà stampata utilizzando una famiglia di caratteri fissa (corriere)
quando possibile (troff).

È buona norma incorporare la documentazione nel codice sorgente, utilizzando commenti o
variabili di testo costanti. txt2man permette di farlo, mantenendo la fonte del documento
leggibile, utilizzabile anche senza ulteriore formattazione (es. per la guida in linea) e facile da scrivere.
Il risultato è un documento di alta qualità e conforme agli standard.

VERSIONI

-h L'opzione -h visualizza la guida.

-d quando
Impostato quando nell'intestazione. Predefinito su corrente quando.

-P nome
Impostato nome come nome del progetto nell'intestazione. Di default uname -s.

-p Titolo della sonda, nome della sezione e volume.

-t miotitolo
Impostato miotitolo come titolo della pagina man generata.

-r rel Impostato rel come nome del progetto e release.

-s setta
Impostato setta come sezione nell'intestazione, di solito un valore da 1 a 8.

-v vol Impostato vol come nome del volume, ad esempio "Manuale dell'utente Unix".

-I txt stampare in corsivo txt in uscita. Può essere specificato più di una volta.

-B txt Enfatizzare (grassetto) txt in uscita. Può essere specificato più di una volta.

-T Anteprima dei risultati del testo utilizzando PAGER, di solito Scopri di più(1).

-X Anteprima dei risultati X11 utilizzando gxditview(1).

AMBIENTE

PAGER nome del comando di paging, di solito Scopri di più(1), o meno(1). Se non impostato ritorna a
Scopri di più(1).

ESEMPIO

Prova questo comando per formattare questo testo stesso:

$ txt2man -h 2>&1 | txt2man -T

CONSIGLI

Per ottenere una buona formattazione complessiva del documento di output, mantenere i paragrafi rientrati
correttamente. Se hai sezioni in grassetto indesiderate, cerca più spazi tra le parole,
che vengono utilizzati per identificare un elenco di tag (termine seguito da una descrizione). Scegli anche
attentamente il nome della riga di comando o dei parametri della funzione, poiché verranno enfatizzati ciascuno
volta che si incontrano nel documento.

Usa txt2man online usando i servizi onworks.net