commande manuelle

Objectif

Affiche les entrées manuelles en ligne.

Syntaxe

man [ [ [ -c ] [ -t ] [ section ] ] | [ -k | -f ] ] [ -F ] [ -m ] [ -Mchemin ] [ -r ] [ -a ] titre ...

Descriptif

La commande man fournit des informations de référence sur les rubriques, telles que les commandes, les sous-routines et les fichiers. La commande man fournit une description sur une ligne des commandes spécifiées par leur nom. La commande man fournit également des informations sur toutes les commandes dont les descriptions contiennent un ensemble de mots clés définis par l'utilisateur.

La commande man formate un ensemble spécifié de pages manuelles. Si vous spécifiez une section pour le paramètre section , la commande man recherche dans cette section des pages manuelles le titre spécifié par le paramètre title. La valeur du paramètre section peut être un nombre arabe compris entre 1 et 8 ou une lettre.

Les lettres de section sont:

Article	Descriptif
C	Indique les commandes (y compris les commandes de gestion du système).
F	Indique les pages manuelles de type fichier.
I	Indique les fonctions de bibliothèque.
n	Indique le nouveau.
l	Indique local.
o	Indique l'ancien.
p	Indique public.

Remarque: les spécificateurs de section n, l, oet p ne sont pas valides pour la lecture des bases d'informations hypertexte, qui contiennent la documentation du système d'exploitation.

Les numéros de section sont les suivants:

Article	Descriptif
1 seul	Indique les commandes utilisateur et les démons.
2	Indique les appels système et les services de noyau.
3	Indique les sous-routines.
4	Indique les fichiers spéciaux, les pilotes de périphérique et le matériel.
5,00	Indique les fichiers de configuration.
6	Indique les jeux.
7	Indique les commandes diverses.
8	Indique les commandes d'administration et les démons.

Remarque: La documentation du système d'exploitation dans les bases de données d'informations hypertexte est regroupée en trois sections uniquement: les pages de manuel de commande (dans la section 1, équivalent à la section C), les pages de manuel de sous-programme (dans la section 3, équivalent à la section L) et les pages de manuel de fichier (dans la section 4, équivalent à la section F). Lors de la recherche d'informations hypertexte, les sections 1, 6, 7 ou 8 sont définies par défaut sur les pages du manuel de la commande, les sections 2 ou 3 sont définies par défaut sur les pages du manuel de la sous-routine et les sections 4 ou 5 sont définies par défaut sur les pages du manuel du fichier.

Si le paramètre section est omis, la commande man recherche toutes les sections du manuel.

Le chemin de recherche utilisé par la commande man est une liste de répertoires séparés par un signe deux-points (:) dans laquelle se trouvent les sous-répertoires manuels.

La commande man affiche les pages de manuel comme suit:

La commande man recherche les répertoires nroff (man?) sous le répertoire /usr/share/man .
La commande man recherche les répertoires de version formatés (cat?) sous le répertoire /usr/share/man . Si la version formatée est disponible et qu'elle a une heure de modification plus récente que la source de la commande nroff , la commande man affiche la version formatée. Sinon, la page de manuel est formatée avec la commande nroff et affichée. Si l'utilisateur dispose de droits d'accès, la page manuelle formatée est déposée à l'emplacement approprié, de sorte que les appels ultérieurs de la commande man ne formatent pas à nouveau la page.
Remarque: il n'existe pas de source nroff pour les pages de manuel fournies. Toutefois, vous pouvez placer la source nroff pour les pages manuelles dans les répertoires man et la commande man peut localiser et traiter la source nroff .
Si la commande man ne trouve pas de page manuelle dans le répertoire /usr/share/man/man ou /usr/share/man/cat , la commande man recherche les chemins spécifiés via l'option -M ou la variable d'environnement MANPATH pour les répertoires nroff (man?) et les répertoires de version formatés (cat?).
Si la commande homme ne trouve pas de page de manuel dans le répertoire /usr/share/man/man ou /usr/share/man/cat ou dans le répertoire homme / chat spécifié par l'utilisateur, la commande homme est lue à partir des bases d'informations hypertexte. Les bases d'informations hypertexte se trouvent dans la structure de répertoire /usr/share/man/info et contiennent la documentation du système d'exploitation. Lors de la lecture à partir des bases de données hypertexte, la commande man ne place aucune page manuelle dans la structure de répertoire /usr/share/man/cat . La commande man convertit le fichier HTML en fichier texte formaté pour tenir sur l'écran et affiche la page manuelle à l'aide de la commande décrite par la variable d'environnement PAGER.
Si la commande man ne trouve pas de page manuelle dans les bases d'informations hypertexte se trouvant dans la structure de répertoires /usr/share/man/info , il recherche la base d'informations hypertexte spécifiée par l'utilisateur (via -M ou MANPATH). La base d'informations hypertexte définie par l'utilisateur doit suivre la structure de répertoire suivante:
```
BasePath[/%{ L | l }]/DocLibraryname/Section/command_or_routine_or_filename.htm
```
Où :
- %L représente la notation de langue ISO spécifiée à l'aide de LC_MESSAGES, %l représente les 2 premiers caractères de la notation de langue ISO spécifiée à l'aide de LC_MESSAGES. Par exemple, pour LC_MESSAGES=en_US , les documents peuvent être placés dans Path/en_US ou Path/en.
- DocLibraryname représente le nom de la bibliothèque de documentation.
- Section représente le nom de la section, qui doit être l'un des suivants:
  - cmds -Section des commandes des représentations
  - libs -Représente la section de la bibliothèque
  - files -Représente la section Fichiers
Remarque: Si l'option -m est spécifiée, la recherche des pages manuelles s'effectue uniquement dans l'ordre des chemins spécifiés via -M ou la variable d'environnement MANPATH.

Lors de l'accès aux bases de données HTML, man recherche la bibliothèque du système d'exploitation avant de passer à d'autres bibliothèques LPP. Dans ces bibliothèques, il traite les informations dans l'ordre suivant:

Article	Descriptif
cmds	Référence des commandes
libs	Sous-routines, appels système
Fichiers	Files Reference

Si la sortie standard est une unité tty, la commande homme transmet sa sortie à l'aide de la commande plus avec les indicateurs -s et -v . L'indicateur -s élimine plusieurs lignes vides et s'arrête après chaque page de l'écran. L'indicateur -v supprime l'affichage des caractères non imprimables à l'écran. Pour continuer le défilement, appuyez sur la barre d'espace. Pour faire défiler 11 lignes supplémentaires lorsque la sortie s'arrête, appuyez sur la touche Ctrl-D.

La variable d'environnement PAGER peut être définie sur le pager de votre choix. La valeur par défaut est la commande more . Pour modifier le pager par défaut, entrez:

PAGER=Somepager
export PAGER

Par exemple, si des pages manuelles personnalisées sont formatées avec des sauts de ligne inversés ou fractionnés, la variable d'environnement PAGER peut être définie sur /usr/bin/pg de sorte que les sauts de ligne ne soient pas imprimés en tant que caractères de contrôle. Cette procédure n'est pas nécessaire pour les pages manuelles.

Lorsque la commande man utilise une base de données hypertexte, elle peut extraire plusieurs articles. Par exemple :man openaffiche plusieurs articles. L'utilisation de SIGINT (Ctrl-C) permet de quitter complètement la commande man . D'autre part,man open closeaffiche également plusieurs articles, mais l'utilisation de SIGINT (Ctrl-C) oblige man à afficher les informations de la commande close au lieu de quitter. L'utilisation de SIGINT (Ctrl-C) permet à nouveau de quitter complètement la commande man .

Lorsque vous spécifiez l'une des routines de la bibliothèque Network Computing System dont le nom contient un $ (symbole du dollar), entrez une barre oblique inversée (\) devant $.

Indicateurs

Article	Descriptif
-a	Affiche toutes les entrées correspondantes.
-c	Affiche les informations manuelles à l'aide de la commande cat .
-f	Affiche les entrées de la base de données de mots clés associées uniquement au nom de commande indiqué comme paramètre final. Vous pouvez entrer plusieurs noms de commande, chacun étant séparé par un espace. Utilisez cet indicateur pour rechercher uniquement des articles de commande. Pour utiliser l'indicateur -f , un utilisateur root doit avoir précédemment entré `catman` `-w` pour créer le fichier /usr/share/man/whatis .
-F	Affiche uniquement la première entrée correspondante.
-k	Affiche chaque ligne de la base de données de mots clés qui contient une chaîne de caractères correspondant au titre indiqué comme paramètre final. Vous pouvez entrer plusieurs titres, chacun étant séparé par un espace. Pour utiliser l'indicateur -k , un utilisateur root doit avoir précédemment entré `catman` `-w` pour créer le fichier /usr/share/man/whatis .
-m	Recherche uniquement dans les chemins spécifiés dans MANPATH ou -M.
-Mchemin	Modifie l'emplacement standard où la commande man recherche des informations manuelles. Le chemin est une liste de chemins séparés par un signe deux-points, dans laquelle les symboles spéciaux suivants peuvent être utilisés: %D- Chemins d'accès par défaut des pages de manuel sous AIX. %L-Emplacement du répertoire spécifique à l'environnement local correspondant à la catégorie LC_MESSAGES de l'environnement local en cours. %l-Emplacement du répertoire spécifique à l'environnement local correspondant aux 2 premiers caractères de la catégorie LC_MESSAGES de l'utilisateur en cours.
-r	Recherche à distance les informations manuelles. Si, pour une raison quelconque, la recherche à distance échoue, man effectue une recherche locale pour la page d'aide demandée. L'une des conditions suivantes peut entraîner l'échec de la recherche à distance: La machine distante n'est pas accessible. Il y a un problème de lecture du site URL. Une applet Java™ n'est pas installée ou est introuvable dans le chemin de recherche de l'utilisateur, spécifié dans la variable d'environnement PATH . Remarque: La variable d'environnement DOCUMENT_SERVER_MACHINE_NAME doit être définie sur le nom de la machine du serveur de recherche de documentation que l'utilisateur souhaite utiliser. Si la documentation de base AIX n'est pas prise en charge par la locale de l'hôte, la commande man recherche la documentation pour une autre locale. Si la recherche aboutit, la page de documentation s'affiche après la conversion à l'environnement local de l'hôte local. Si l'autre environnement local n'est pas installé sur l'hôte local, la commande man ne parvient pas à afficher la page de documentation.
-t	Formate les informations manuelles à l'aide de la commande troff . Cet indicateur est ignoré si la page manuelle se trouve dans une base d'informations hypertexte.

Statut de sortie

Cette commande renvoie les valeurs de sortie suivantes :

Article	Descriptif
0 %	L'opération a abouti.
>0	Une erreur s'est produite.

Exemples

Pour afficher des informations sur la commande grep , entrez la commande suivante:
```
man grep
```
Pour afficher des informations sur la routine de bibliothèque rpc_$register , entrez la commande suivante:
```
man rpc_\$register
```
Pour afficher toutes les entrées de la base de données de mots clés /usr/share/man/whatis qui contiennent la chaîne "mkdir", entrez la commande suivante:
```
man -k mkdir
```
La sortie est équivalente à la commande apropos . Vous recevez la sortie de l'indicateur -k uniquement lorsque la base de données de mots clés /usr/share/man/whatis existe déjà.
Pour afficher toutes les entrées de la base de données de mots clés associées aux commandes nroff et troff , entrez la commande suivante:
```
man -f nroff troff
```
La sortie est équivalente à la commande whatis . Vous recevez une sortie de l'indicateur -f uniquement lorsque la base de données de mots clés /usr/share/man/whatis existe déjà.
Pour afficher tous les articles relatifs à la commande Ftp dans le chemin /usr/share/man ou /usr/share/man/local , entrez la commande suivante:
```
man -M/usr/share/man:/usr/share/man/local ftp
```
Pour afficher toutes les entrées correspondantes, entrez la commande suivante:
```
man -a title
```
Pour afficher uniquement la première entrée correspondante, entrez la commande suivante:
```
man -F title
```
Pour effectuer la recherche uniquement dans les chemins spécifiés dans MANPATH ou -M, entrez la commande suivante:
```
man -m -M PATH title
```
Pour effectuer une recherche dans la variable PATH définie par l'utilisateur, entrez la commande suivante:
```
man -M PATH title
```

Fichiers

Article	Descriptif
/usr/bin/man	Contient la commande man .
/usr/share/man	Structure de répertoire manuelle standard.
/usr/share/man/cat?/*	Répertoire contenant les pages préformatées.
/usr/share/man/whatis	Contient la base de données de mots clés.
/usr/share/man/man?/*	Répertoire contenant les pages de manuel au format nroff .