Γρήγορη αναφορά

Σημειώσεις συγγραφής εγχειριδίων Ronn

Σύντομος οδηγός αναφοράς για το Ronn: μετατροπή αρχείων Markdown σε τυπικές σελίδες man roff και τεκμηρίωση HTML.

· Δημοσιεύτηκε

Το Ronn δημιουργεί σελίδες man από κείμενο Markdown, παράγοντας αρχεία τυπικής μορφής UNIX roff και αυτόνομη τεκμηρίωση HTML.

Βασική δομή εγγράφου Man (tool.1.ronn)

tool(1) -- συνοπτική περιγραφή εργαλείου
======================================

## SYNOPSIS

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

## DESCRIPTION

Το **tool** επεξεργάζεται αρχεία και εκτυπώνει τα αποτελέσματα στην τυπική έξοδο.

## OPTIONS

  * `-v`, `--verbose`:
    Ενεργοποίηση αναλυτικής καταγραφής.

  * `-o` <file>, `--output`=<file>:
    Καθορισμός αρχείου εξόδου προορισμού.

  * `-h`, `--help`:
    Εμφάνιση οθόνης βοήθειας.

## EXAMPLES

Εκτέλεση του εργαλείου σε όλα τα αρχεία markdown:

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

## SEE ALSO

man(1), ronn(7)

Εντολές μεταγλώττισης (Compilation Commands)

# Μετατροπή σε τυπική σελίδα man UNIX roff (tool.1)
ronn --roff tool.1.ronn

# Μετατροπή σε μορφή HTML (tool.1.html)
ronn --html tool.1.ronn

# Άμεση προβολή στο τερματικό χωρίς εγγραφή αρχείου
ronn --man tool.1.ronn

Αναφορές

Σχετικά θέματα