Riferimento rapido

Scheda di riferimento stesura manuali Ronn

Guida di riferimento rapido per Ronn: convertire documenti Markdown in pagine man standard roff e documentazione HTML.

· Pubblicato

Ronn genera pagine man da testo Markdown, producendo file in formato roff UNIX standard e documentazione HTML autonoma.

Struttura base del documento man (tool.1.ronn)

tool(1) -- descrizione concisa dello strumento
======================================

## SYNOPSIS

`tool` [<options>] <files>...

## DESCRIPTION

**tool** elabora i file e stampa i risultati sullo standard output.

## OPTIONS

  * `-v`, `--verbose`:
    Abilita output di log dettagliato.

  * `-o` <file>, `--output`=<file>:
    Specifica il file di output di destinazione.

  * `-h`, `--help`:
    Visualizza la schermata di aiuto.

## EXAMPLES

Esegui lo strumento su tutti i file markdown:

    $ tool -v *.md -o output.log

## SEE ALSO

man(1), ronn(7)

Comandi di compilazione (Compilation Commands)

# Converti in pagina man UNIX roff standard (tool.1)
ronn --roff tool.1.ronn

# Converti in formato HTML (tool.1.html)
ronn --html tool.1.ronn

# Visualizza direttamente nel terminale senza creare un file
ronn --man tool.1.ronn

Riferimenti

Argomenti correlati