man

Affiche une page de référence en ligne.

Conditions d'utilisation

Produit Type de commande
MultiSite

Sous-commande multitool

sous-commande multiutil

Plateforme
UNIX
Windows

Syntaxe

  • Affiche une page de référence (UNIX) :
    man [ –g/raphical ] [ nom_commande ]

Description

Cette commande affiche une page de référence. La documentation affichée dépend du contexte dans lequel la commande est utilisée. Cette dernière ne requiert aucune licence.

Affichage des pages de référence

La commande man affiche une page de référence en ligne au format HTML ou ASCII (sous UNIX uniquement). Pour les sous-commandes multiutil, vous pouvez utiliser tout alias ou abréviation valide. Exemple :

cmd-context man lsreplica

Nom complet de la commande

cmd-context man lsrep

Abréviation

cmd-context man lsrp

Alias

UNIX : Utilisation de la commande MANPATH

Les pages de référence se trouvent dans des sous-répertoires de cquest–home–dir/doc/man. La sous-commande man modifie l'environnement pour y inclure une variable MANPATH pointant vers ce répertoire, puis exécute la commande UNIX man(1) dans un sous-processus. Par conséquent, il n'est pas nécessaire que la variable MANPATH soit définie dans l'interpréteur de commandes utilisé pour appeler la commande cleartool.

Si vous souhaitez toutefois utiliser la commande UNIX man directement (sans passer par multitool), ajoutez le chemin cquest–home–dir/doc/man à la définition de MANPATH. Exemple :

setenv MANPATH /usr/catman:/usr/man:/opt/rational/clearquest/doc/man

La commande UNIX man doit être accompagnée du nom de fichier de la page de références voulue. Les noms de fichiers des sous-commandes multiutil contiennent le préfixe mu_.

% man mu+describe

Correct

% man describe

Incorrect (sous-commande cleartool)

UNIX : Définition d'un autre navigateur HTML par défaut

Pour changer le navigateur HTML par défaut, utilisez les variables d'environnement CCASE_WEBSCRIPT, CCASE_NETSCAPE et CCASE_NETSCAPE_OPT. Pour plus d'informations, voir xcleardiff.

Restrictions

Aucune.

Options et arguments

Format d'affichage de la page de référence

Valeur par défaut
ASCII (UNIX) ; HTML (Windows).
–g/raphical
Ouvre un navigateur HTML pour afficher la page de référence.

Indication de la page de référence

Valeur par défaut
Présentation de la page de référence générale du produit.
nom_commande
Nom (abréviation ou alias) d'une sous-commande multiutil ou d'une autre page de référence du produit.

Exemples

  • Pour afficher la page de référence de la commande mkreplica :

    cmd-context man mkreplica

  • Pour afficher la page de référence de la commande describe sous UNIX, au format HTML :

    cmd-context man –graphical describe



Commentaires en retour