web-dev-qa-db-fra.com

Comment lire la syntaxe d'exemple de commande dans les sections de synopsis de MAN pages?

J'essaie de mieux utiliser la documentation pour comprendre la syntaxe de commande, mais je me suis rendu compte que je ne comprenais pas bien les symboles utilisés, qui montrent toutes les options et tous les paramètres pouvant être passés à commande.

Par exemple, man Zip:

SYNOPSIS

   Zip  [-aABcdDeEfFghjklLmoqrRSTuvVwXyz!@$] [--longoption ...]  [-b path]
   [-n suffixes] [-t date] [-tt date] [zipfile [file ...]]  [-xi list]

Ou man bzip2:

SYNOPSIS
       bzip2 [ -cdfkqstvzVL123456789 ] [ filenames ...  ]
       bzip2 [ -h|--help ]
       bunzip2 [ -fkvsVL ] [ filenames ...  ]
       bunzip2 [ -h|--help ]
       bzcat [ -s ] [ filenames ...  ]
       bzcat [ -h|--help ]
       bzip2recover filename

Existe-t-il une ressource qui explique comment lire cette syntaxe et peut me dire ce que chaque symbole signifie?

command-linebashmanpage
4
timbram

Une bonne ressource est this (j'ai copié sans vergogne)

L'une des parties les plus difficiles d'Unix pour les débutants est la recherche de documentation. Lorsque vous entendez que le système est livré avec un manuel en ligne, il provoque généralement un soupir de soulagement. Ce que vous ignorez, c'est que les pages de manuel sont des références techniques. Bien que cela puisse paraître vraiment mauvais - ce n'est pas! Une fois que vous aurez appris les bases des pages de manuel, vous comprendrez comment elles sont écrites. Si vous avez besoin d’informations et que vous n’avez pas de temps à perdre, c’est à vous de vous adresser.

Ce document tente de vous apprendre à lire le manuel Unix, communément appelé les pages de manuel. Citations communes

Avant de passer à notre première page de manuel, examinons quelques symboles couramment utilisés. Ces symboles sont parfois appelés des guillemets.

L’utilisation principale d’une page de manuel est de rechercher les paramètres d’un programme. Comme la plupart des paramètres sont facultatifs, ils seront placés entre crochets.

[optional]
[-abcgln]

Certaines options auront une liste de choix limitée. Une liste de choix sera séparée par une virgule et placée entre accolades.

{choice1,choice2}
{yes,no}

De nombreuses sources de documentation d'aide incluent des paramètres obligatoires entre les symboles inférieur à/supérieur à.

<manditory>
<program_name>

Bien que les citations obligatoires ci-dessus ne soient généralement pas utilisées dans les pages de manuel, il est bon de le savoir.

2
A.B.

De la page de manuel man:

Les conventions suivantes s'appliquent à la section SYNOPSIS et peuvent être utilisées à titre de guide dans d'autres sections. man synopsis description

Le rendu exact peut varier en fonction du périphérique de sortie. Par exemple, man ne sera généralement pas en mesure de rendre l'italique lors de l'exécution dans un terminal et utilisera généralement du texte souligné ou coloré.

L’illustration de la commande ou de la fonction est un motif qui doit correspondre à tous les appels possibles. Dans certains cas, il est conseillé d’illustrer plusieurs invocations exclusives, comme indiqué dans la section SYNOPSIS de cette page de manuel.

0
Jules Randolph