Snabbreferens

Ronn Manualskrivande Fusklapp

Snabbreferens för Ronn: konvertera Markdown-dokument till UNIX roff man-sidor och HTML-dokumentation.

· Publicerad

Ronn skapar man-sidor från Markdown-text och genererar standard UNIX roff-filer samt fristående HTML-dokumentation.

Grundläggande Man-dokumentstruktur (tool.1.ronn)

tool(1) -- kortfattad beskrivning av verktyget
======================================

## SYNOPSIS

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

## DESCRIPTION

**tool** bearbetar filer och skriver ut resultat till standardutmatning.

## OPTIONS

  * `-v`, `--verbose`:
    Aktivera utförlig loggutmatning.

  * `-o` <file>, `--output`=<file>:
    Ange destinationsfil för utdata.

  * `-h`, `--help`:
    Visa hjälpskärm.

## EXAMPLES

Kör verktyget över alla markdown-filer:

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

## SEE ALSO

man(1), ronn(7)

Kompileringskommandon (Compilation Commands)

# Konvertera till standard UNIX roff man-sida (tool.1)
ronn --roff tool.1.ronn

# Konvertera till HTML-format (tool.1.html)
ronn --html tool.1.ronn

# Visa direkt i terminalen utan att skriva en fil
ronn --man tool.1.ronn

Referenser

Relaterade ämnen