man (Unix)
man
est une commande disponible sur les systèmes d'exploitation de type Unix. Elle permet de visionner les contenus d'une documentation formatée pour être exploitable par man
; à l'origine, elle sert à accéder aux manuels des commandes d'un shell Unix et à la description des fonctions du langage C.
Utilisation
modifierElle doit être utilisée sous la forme suivante :
man [-s<section>] <nom_de_commande>
Par exemple, pour voir le manuel de la commande ftp, il faut taper
$> man ftp
Pour naviguer dans une page, il faut généralement utiliser les flèches vers le haut et vers le bas ou les touches page down et page up, ou encore la touche d'espacement, selon le pager utilisé. On sort généralement d'une page avec la touche Q, mais, avec certaines versions, il faut appuyer sur la touche d'espacement jusqu'à ce qu'on arrive à la fin de la page de manuel.
Sections
modifierLes pages du manuel Unix sont divisées en plusieurs sections. Par exemple, sous Linux, on retrouve les sections suivantes :
- Commandes utilisateur
- Appels système
- Fonctions de bibliothèque
- Fichiers spéciaux
- Formats de fichier
- Jeux
- Divers
- Administration système
- Interface du noyau Linux
Chaque section possède une page d'introduction qui présente la section, disponible en tapant man <section> intro
.
Les pages de manuel sont stockées dans les fichiers sources roff. La plupart des versions de man cache les versions formatées des dernières pages affichées pour accélérer les prochains affichages.
Pour plus d'information sur man, il est possible de regarder la page man de man, avec la commande man man
.
Historique
modifierLe Manuel du programmeur UNIX (UNIX Programmer's Manual) a été publié le . Cette première page de manuel a été écrite par Dennis Ritchie et Ken Dolotta sous les demandes répétées de Doug McIlroy. Les macros troff utilisées furent celles créés pour une utilisation générale par Ted Dolotta, ainsi que quelques ajouts pour les pages de manuel.
À l'époque, la disponibilité d'une documentation en ligne à l'aide des pages de manuel était considérée comme une avance importante. Depuis ce jour, presque toutes les applications en ligne de commande pour Unix ont leur propre page de manuel. Beaucoup d'utilisateurs d'Unix ressentent le manque de page de manuel comme un signe de mauvaise qualité. En fait, certains projets, tel que Debian, écrivent leur propre pages de manuel pour les commandes qui en sont dépourvues.
Peu d'alternative à man
ont eu le même succès, avec l'exception possible du projet GNU « info
», un système simple et précurseur de hypertexte.
Cependant, le format d'une page unique par application, le manque de classification dans les sections, et les fonctionnalités relativement peu sophistiquées de mise en page, ont motivé le développement de systèmes de documentation alternatifs tels que le système info
déjà mentionné.
La plupart des applications graphiques pour UNIX (particulièrement celles construites pour les environnements GNOME et KDE) proposent maintenant de la documentation en HTML et incluent un outil pour lire ces pages directement dans l'application.
Les pages de manuel sont généralement disponibles en anglais. Des traductions dans d'autres langues sont disponibles pour certaines pages, quelquefois moins à jour que la version anglaise.
Le format par défaut des pages de manuel est troff, avec soit les macros man (orientés présentation), soit les macros mdoc (orientés sémantique). Ces formats rendent possible la conversion des pages de manuel dans d'autres formats comme HTML, PostScript, etc.
Liens externes
modifierIl existe plusieurs sites Web qui publient les pages man. En voici quelques-uns :
- (fr) Projet Perkamon : Version française des pages de manuel Linux du projet man-pages (L'ancien projet de traduction manpagesfr.free.fr reste disponible mais n'est plus actif).
- (fr) www.delafond.org/traducmanfr : Toutes les autres pages de manuel Linux en version française.
- (fr) Man page HOWTO en français
- (en + fr) flashnux : Pages de manuel par distribution et par version — plus de 186 000 pages au
- (en) Pages de manuel de FreeBSD - Inclut les pages de manuel de nombreuses versions d'UNIX, BSD, HP-UX et Solaris.