%
Puffy image/svg+xml Puffy 2019-06-14 Stéphane HUC OpenBSD Team Inkscape Puffy OpenBSD https://www.openbsd.org/art4.html English "Puffy", it's a symbol of OpenBSD

Mandoc : ouvrir les manpages aux formats html, markdown, pdf, ps (OpenBSD)

Article publié, le et modifié le
2 minutes de lecture

Cet article contient 329 mots.
Source brute de l'article :
Commit version : 698e16e

Description

Lire les manpages n’est pas forcément agréable, voire aisé - heureusement il est possible avec des outils natifs à OpenBSD de les agrémenter pour en faire une sortie html, markdown, pdf, postscript puis de les lire dans un lecteur adéquat.

De petites fonctions pertinentes à se rajouter dans son ~/.kshrc qui utilisent principalement l’outil mandoc.

Astuce

Dans tous les cas, il est possible de modifier à souhait la variable editor :

Fonction man2html

Testé avec firefox, links+.

Code : sh

Utilisation

man2html nom-manpage numero-section-manpage - s’il n’y a pas de numéro de section, alors la fonction essaye d’appeler le manpage de la section 1.

Exemple : $ man2html man

Fonction man2md

Testé avec geany

Code : sh

Utilisation

man2md nom-manpage numero-section-manpage - s’il n’y a pas de numéro de section, alors la fonction essaye d’appeler le manpage de la section 1.

Exemple : $ man2md hostname.if 5

Fonction man2pdf

Testé avec evince.

Code : sh

Utilisation

man2pdf nom-manpage numero-section-manpage - s’il n’y a pas de numéro de section, alors la fonction essaye d’appeler le manpage de la section 1.

Exemple : $ man2pdf man.conf 5

Fonction man2ps

Testé avec gs, ghostview

Code : sh

Utilisation

man2ps nom-manpage numero-section-manpage - s’il n’y a pas de numéro de section, alors la fonction essaye d’appeler le manpage de la section 1.

Exemple : $ man2ps dhclient 8

Fonction man2doc

LA fonction qui réunit toutes les précédentes !!!

Code : sh

Utilisation

À la différence des précédentes fonctions, cette dernière cherchera tous les manpages correspondants, et les incluera les uns à la suite des autres…

man2doc format-fichier nom-manpage numero-section-manpage.

  • format-fichier : html, md, pdf, ou ps
  • Toujours si le numéro de section n’est pas spécifié, la fonction cherchera dans la section 1.

Exemples :

  • $ man2doc html man
  • $ man2doc pdf doas.conf 5
  • $ man2doc md makewhatis 8
  • $ man2doc ps vmm 4

Inspiré par Mi@mondo