[Unix] Lire le synopsis d'un man

Dernière mise à jour le 23 septembre 2005 à 17:18 par kilian
Publié par kilian
Le synopsis d'un man, c'est la partie d'une page de manuel appelée avec la commande man qui décrit l'usage d'une ligne de commande sur un shell.

Ce n'est pas toujours évident de lire le synopsis d'un man. Tous n'expliquent pas de la même façon l'organisation des options.
Heureusement, on leur trouve des points communs majeurs.

Généralement, les pages de man utilisent les crochets pour délimiter un bloc optionnel.

Exemple avec le synopsis de "man lynx" :
Lynx [options] [path or URL]

Au moins, celui-ci est clair et intuitif, et vous épargnera des grognements devant l'écran ... En fait, ce synopsis s'apparente plutôt à la partie "usage" d'un man.
On indique donc d'abord les options (qui sont signalées plus loin dans le man), puis le chemin vers un fichier ou répertoire, ou bien une url. Par exemple:
lynx -color www.commentcamarche.net

pour afficher la page d'acceuil de CCM en couleur.

A priori, jusque là, tout va bien.
Maintenant, on retrouve souvent les options possibles dans le synopsis. Et on a souvent le choix entre plusieurs alternatives pour un même argument :
_Une option courte de type -f ou -a etc...
_Une option longue de type "--force"

Donc dans un même bloc, vous pourrez trouver ces deux alternatives séparées par un "pipe", c'est à dire le caractère | qui signifie "ou".
Donc par exemple :
commande [-f | --force] [filename]

Pour dire que vous pouvez taper -f ou --force, au choix car ces deux arguments auront le même sens. Puis vous pouvez faire suivre cette option par un espace puis le chemin vers un fichier.

Avec ça, le synopsis de "man mysql" devrait être clair par exemple :
http://www.hmug.org/man/1/mysql.php

Vous remarquerez quelques exceptions :
Pour [-p[pwd]] vous avez un bloc à l'intérieur d'un bloc, et sans espace pour les séparer.
Ca signifie que vous pouvez taper le mot de passe (optionnel, vous pouvez ne pas en avoir) juste après l'argument -p (optionnel lui aussi) sans espace.
Exemple pour une connexion à une base mysql locale avec l'utilisateur root, et le password bidule :
mysql -u root -pbidule -h localhost

Puis il y'a des synopsis un peu plus compliqués comme celui de tar.
http://unixhelp.ed.ac.uk/CGI/man-cgi?tar

Là, les | pour signifier "ou" sont parfois remplacés par des virgules.
Les commandes majeures sont signalées au début, commençant par un [-] pour préciser que les arguments courts peuvent (optionnel) prendre un tiret, puis vient le gros bloc.
Vous avez le choix entre -A (que vous pouvez remplacer par --catenate ou --concatenate) ou -c ou -x etc.... Ce sont les commandes majeures de tar qui sont "extraire", "créer une archive" ... Donc vous devez choisir une seule commande majeure, c'est pourquoi il ya un | entre chaque.

Ensuite vous êtes libre d'ajouter une option, puis vous devez mettre un fichier (ou plusieurs) ou bien un repertoire.
Grossièrement ça ressemble à ceci pour extraire un fichier .tar.gz:
tar -zxvf machin.tar.gz

x est l'option majeure (extraire), les options sont z, v et f, respectivement: compressé avec gzip, verbal (afficher les détails), et f pour fichier (le flux à extraire sera un fichier).

Source et informations plus complètes
http://lea-linux.org/intro/aide.html
Meilleures réponses pour « Lire le synopsis d'un man » dans :
Lire les sous-titres VoirCertains films possèdent des sous-titres dans un fichier à part, possédant généralement l'extension .srt, .ssa ou .sub. Le plus simple pour lire les sous-titres est de renommer le fichier de sous-titres comme le fichier vidéo (à l'exception de...
Lire et écrire les partitions Windows (NTFS) VoirUbuntu est parfaitement capable de lire et écrire les partitions Windows, qu'elles soient FAT32 ou NTFS. Cela inclut les partitions de Windows 95, 98, ME, NT, 2000, XP, 2003 et Vista. Mais par défaut, Ubuntu (et Linux en général) peut lire et...
Lire les flux audio/vidéo en streaming VoirCette astuce s´adresse a toute personne fatiguée de ne pas pouvoir lire ou lire avec difficulté les fichiers en "streaming" disponible sur le net. MediaPlayerConnectivity Cette solution s'appelle MediaPlayerConnectivity. Fonctionnalités ...
Vidéo : synopsis, scénario et storyboard VoirSynopsis (résumé de l'histoire) Définition Contenu Le rôle du synopsis Longueur Rédiger un scénario Le séquencier Dans le scénario Story-board ou scénarimage C’est au départ l’idée qui constitue l’envie de monter un projet : un fait...
MAN (Metropolitan Area Network) - Réseau métropolitain VoirRéseau métropolitain (MAN) Les MAN (Metropolitan Area Network, réseaux métropolitains) interconnectent plusieurs LAN géographiquement proches (au maximum quelques dizaines de kilomètres) à des débits importants. Ainsi, un MAN permet à deux noeuds...
Attaque man in the middle (« homme au milieu ») VoirAttaque du protocole ARP Une des attaques man in the middle les plus célèbres consiste à exploiter une faiblesse du protocole ARP (Address Resolution Protocol) dont l'objectif est de permettre de retrouver l'adresse IP d'une machine...
Collection CommentÇaMarche.net