Qu'est-ce que le format de fichier MAN ?
Les fichiers avec l'extension .man contiennent des manuels d'utilisation Unix écrits en balisage source roff. Les pages de manuel sont accessibles en lançant la commande man suivie du nom d'un programme, d'une fonction ou d'un sujet. La source utilise le paquet de macros *man* - un ensemble de directives préfixées par un point (.TH, .SH, .B, .TP) que man restitue à la demande via groff ou mandoc. L'ouverture d'un fichier .man dans un éditeur de texte affiche ce balisage brut plutôt qu'une page formatée ; les fichiers .man prennent en charge des macros de formatage d'affichage pour contrôler le gras, l'italique, l'indentation et la mise en page des tableaux.
.man est un fichier texte brut et peut être ouvert à l'aide de n'importe quel éditeur de texte, mais les manuels d'utilisation sont plus couramment consultés à l'aide de l'outil système man invoqué depuis la ligne de commande. De nombreux environnements système graphiques proposent divers outils pour visualiser les documents man. Les pages de manuel peuvent être divisées en sections suivantes :
- NAME - nom du programme, de l'outil, de la bibliothèque ou de la fonction, suivi d'une courte description
- SYNOPSIS - paramètres et options de la commande, et éventuellement une signature de fonction C
- DESCRIPTION - description détaillée de la commande et de ses fonctions
- EXAMPLES - exemples d'utilisation de la commande
- SEE ALSO - une liste de fonctions ou de commandes liées
Les manuels d'utilisation Unix/Linux ne sont pas couramment enregistrés sous forme de fichiers .man sur le disque. Habituellement, les manuels sont stockés avec un suffixe indiquant à quelle section du manuel le fichier appartient - par exemple ls.1 ou printf.3 - et les pages installées sont généralement compressées avec gzip sous la forme nom.section.gz, décompressées de manière transparente par man. Les pages de manuel sont généralement en anglais, bien que certains manuels soient localisés sur diverses distributions.
Les documents man sont divisés en sections numérotées. La commande man affiche par défaut la première entrée correspondante parmi 7 sections (Unix System V) ou 8 (Linux/BSD), qui sont :
- Commandes générales
- Appels système
- Fonctions de la bibliothèque C
- Fichiers spéciaux et pilotes de périphériques
- Formats de fichiers et fichiers de configuration
- Jeux et économiseurs d'écran
- Divers / pages de présentation
- Administration système et démons (Linux/BSD uniquement)
L'accès à une section donnée nécessite de lancer man numéro_section nom - par exemple, man 5 passwd. La sortie du manuel peut être redirigée vers une autre application pour une lecture plus facile, par exemple vers cat ou less.
Sécurité et sûreté
RISQUE : LOWUne source de page man est du texte brut et ne s'exécute pas lors de la visualisation. La seule précaution théorique est que roff est un langage de macros complet au sens de Turing et que groff a historiquement eu des bogues d'analyse, donc le rendu d'un .man provenant d'une source totalement non fiable est préférable avec mandoc, plus sûr et sandboxé, plutôt qu'avec le groff complet. En utilisation normale (lecture de docs de paquets et de projets), un fichier .man est inoffensif ; l'ouvrir dans un éditeur de texte est totalement sûr. Ne le confondez pas avec un profil obligatoire Windows .man, qui est une ruche de registre et non un document.
Détails du format
en bref- Profil utilisateur obligatoire Windows 2000/XP - Le fichier .man hérité de Windows est un profil utilisateur itinérant en lecture seule (une ruche de registre NTUSER.DAT renommée) - sans rapport avec les pages man Unix ; la signification originale du nom de la base de données.
- Fichier mémoire/menu FoxPro / dBASE - Certains anciens outils de base de données DOS utilisaient .man pour les données de menu ou de mémo compilées ; obsolète.
Programmes qui ouvrent les fichiers MAN
Détails techniques
spécifications approfondies| Encodage du fichier | Texte brut ASCII ou UTF-8 ; aucun contenu binaire ou marque d'ordre d'octets requis |
| Type MIME | text/troff (principal) ; également reconnu comme application/x-troff-man ou text/plain |
| Langage de balisage | roff/troff utilisant le paquet de macros man (macros an-old) ; les appels de macros préfixés par un point doivent apparaître au début d'une ligne |
| Macro de titre | .TH (title header) - généralement la première ligne sans commentaire ; déclare le nom de la page, le numéro de section, la date et le paquet source |
| Sections standard | NAME, SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES, FILES, ENVIRONMENT, BUGS, SEE ALSO - chacune introduite par une macro .SH |
| Numérotation des sections de page man | 7 sections sur Unix traditionnel (System V) ; 8 sur Linux et BSD - la section 8 couvre les commandes d'administration système |
| Taille de fichier typique | 1 Ko - 100 Ko ; la plupart des pages se situent entre 5 Ko et 30 Ko |
| Compression sur disque | Les pages installées sont couramment compressées avec gzip (ex: ls.1.gz) et décompressées de manière transparente par man au moment de la lecture |
| Moteur de rendu | groff (GNU troff) sur Linux ; mandoc sur BSD et macOS moderne, qui a remplacé groff comme moteur de rendu man par défaut |
| Nommage de fichier courant | L'extension par numéro de section est la norme sur disque (ls.1, printf.3, passwd.5) ; l'extension .man est principalement utilisée par des documentations tierces ou groupées |
| Chemin d'installation | /usr/share/man/manN/ sur Linux et BSD, où N est le numéro de section ; macOS utilise /usr/share/man/ avec la même structure de répertoires |
| Formats de sortie | Texte terminal via un afficheur (less), PostScript, PDF, HTML et texte brut - tous produits à la demande par groff -T |
| Formats sources associés | mdoc (ensemble de macros alternatif BSD), pod2man (Perl POD vers man), Sphinx man builder, et ronn (convertisseur Markdown vers man) |
| Développeur / origine | Bell Labs (système man Unix original, 1971) ; macros man et groff maintenus par le Projet GNU |
| Publié | 1971 (Unix Programmer's Manual, V1); man macros standardized through the 1970s-80s |
| Dernière version | N/A (roff/man-macro convention; groff is the active implementation) |
| Standard ouvert | Oui · libre de droits |
| Spécification | man7.org |
Conversions MAN
Q&R de la communauté
posées par les utilisateursPas encore de questions - soyez le premier à poser une question sur les fichiers MAN.