Kurzreferenz

Ronn Handbuch-Erstellung Spickzettel

Kurzreferenz für Ronn: Konvertieren von Markdown-Dokumenten in UNIX-roff-Manpages und HTML-Dokumentation.

· Veröffentlicht

Ronn erstellt Manpages aus Markdown-Text und generiert Standard-UNIX-roff-Dateien sowie eigenständige HTML-Dokumentationen.

Grundlegende Man-Dokumentstruktur (tool.1.ronn)

tool(1) -- prägnante Beschreibung des Tools
======================================

## SYNOPSIS

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

## DESCRIPTION

**tool** verarbeitet Dateien und gibt Ergebnisse auf der Standardausgabe aus.

## OPTIONS

  * `-v`, `--verbose`:
    Ausführliche Protokollausgabe aktivieren.

  * `-o` <file>, `--output`=<file>:
    Ziel-Ausgabedatei angeben.

  * `-h`, `--help`:
    Hilfebildschirm anzeigen.

## EXAMPLES

Tool auf alle Markdown-Dateien anwenden:

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

## SEE ALSO

man(1), ronn(7)

Kompilierungsbefehle (Compilation Commands)

# In Standard-UNIX-roff-Manpage konvertieren (tool.1)
ronn --roff tool.1.ronn

# In HTML-Format konvertieren (tool.1.html)
ronn --html tool.1.ronn

# Direkt im Terminal anzeigen, ohne eine Datei zu schreiben
ronn --man tool.1.ronn

Referenzen

Verwandte Themen