Référence rapide

Aide-mémoire de rédaction de manuels Ronn

Guide de référence rapide pour Ronn : convertir des documents Markdown en pages de manuel roff UNIX standard et en documentation HTML.

· Publié le

Ronn crée des pages de manuel à partir de texte Markdown, générant des fichiers roff UNIX standards et une documentation HTML autonome.

Structure de base du document Man (tool.1.ronn)

tool(1) -- description concise de l'outil
======================================

## SYNOPSIS

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

## DESCRIPTION

**tool** traite les fichiers et affiche les résultats sur la sortie standard.

## OPTIONS

  * `-v`, `--verbose`:
    Activer la sortie détaillée du journal.

  * `-o` <file>, `--output`=<file>:
    Spécifier le fichier de destination de sortie.

  * `-h`, `--help`:
    Afficher l'écran d'aide.

## EXAMPLES

Exécuter l'outil sur tous les fichiers markdown :

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

## SEE ALSO

man(1), ronn(7)

Commandes de compilation (Compilation Commands)

# Convertir en page de manuel UNIX roff standard (tool.1)
ronn --roff tool.1.ronn

# Convertir au format HTML (tool.1.html)
ronn --html tool.1.ronn

# Visualiser directement dans le terminal sans écrire de fichier
ronn --man tool.1.ronn

Références

Sujets associés