Snelle referentie

Ronn Handleiding Creatie Spiekbrief

Beknopte handleiding voor Ronn: Markdown-documenten converteren naar UNIX roff man-pages en HTML-documentatie.

· Gepubliceerd

Ronn bouwt man-pages van Markdown-tekst en genereert standaard UNIX roff-bestanden en standalone HTML-documentatie.

Basis man-documentstructuur (tool.1.ronn)

tool(1) -- beknopte beschrijving van tool
======================================

## SYNOPSIS

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

## DESCRIPTION

**tool** verwerkt bestanden en print resultaten naar standaarduitvoer.

## OPTIONS

  * `-v`, `--verbose`:
    Schakel gedetailleerde loguitvoer in.

  * `-o` <file>, `--output`=<file>:
    Specificeer doeluitvoerbestand.

  * `-h`, `--help`:
    Help-scherm weergeven.

## EXAMPLES

Voer de tool uit op alle markdown-bestanden:

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

## SEE ALSO

man(1), ronn(7)

Compilatiecommando's (Compilation Commands)

# Converteren naar standaard UNIX roff man-page (tool.1)
ronn --roff tool.1.ronn

# Converteren naar HTML-formaat (tool.1.html)
ronn --html tool.1.ronn

# Direct in de terminal bekijken zonder een bestand te schrijven
ronn --man tool.1.ronn

Referenties

Verwante onderwerpen