La GUI du Jeudi: ManEdit - Editeur des pages Man

slobberbone — Thu, 14 Feb 2008 13:59:00 +0100

Ce billet est une traduction de l'article «GUI Thursday: ManEdit - manpage editor» écrit par Chris Tyler.

Pendant beaucoup d'années les systèmes Unix et Linux ont offert une documentation en ligne sous forme de page-manuels appelées : "manpages". Ces documents fournissent des informations concises sur des commandes, des applications, des formats de dossier, des APIs et des interfaces. Ils peuvent être facilement traités pour l'affichage dans un terminal ou une application d'aide en ligne, être convertis en pdf, être imprimés en utilisant le post-scriptum, ou être consultables sur internet comme une simple page HTML.

ManEdit est une interface graphique prévue pour simplifier la création, ainsi que la maintenance de ces "manpages". Cette interface utilisateur est composée de deux parties : celle de gauche présente une liste des sections dans le "manpages" courant (clic droit pour avoir les options), et celle de roite fournit un espace pour éditer le titre et le texte d'une section choisie. La syntaxe utilisée est une variation de XML, et des commandes sont données pour ajouter du formatage de texte tel que "bold" et le soulignement des étiquettes. Le bouton prévisualisation montrera une vue de base de la "manpage".

Bien que ManEdit soit toujours un peu exigeant quand à la syntaxe, il permet une écriture rapide d'une page "manpage", particulièrement si vous êtes peu familiarisé avec la syntaxe des "manpages".

Utilisation des "manpages" :

Pour regarder une "manpage" en utilisant une visionneuse graphique : Sous GNOME et KDE, utiliser l'aide (yelp ou khelpviewer).
Avec Konqueror sous KDE, dans la barre d'adresse : "man:mot-clé", par exemple "man:mplayer"

Pour regarder une "manpage" depuis un terminal : utilisez la commande : man (man -k mot-clé, pour la rechre du mot-clé dans les "manpages")

Pour imprimer une "manpage" : man -t command | lpr

Pour convertir une "manpage" en format pdf : man -t command | ps2pdf - > outputfile.pdf

Pour préparer une version HTML d'une "manpage" : gunzip <$(man --path command) | man2html >outputfile.html

Installation en ligne de commande : yum install manedit

Installation en utilisant l'installeur graphique : Development > Development tools > manedit

Localisation dans le menu après installation : Applications > Programmation > ManEdit

Commande : /usr/bin/manedit

Site web : http://wolfpack.twu.net/ManEdit/

Note : ''La version en cours de ManEdit se crash sur l'action du bouton "nouveau". Le bogue 356171 est ouvert concernant cette issue.

Comme astuce, ouvrez un "manpage" existant (/usr/share/man), éditez-le, et réenregistrez-le dans un nouveau dossier.''

Paquet Fedora du jour - man

La GUI du Jeudi: ManEdit - Editeur des pages Man