3. Conventions et commandes CLI
Le tableau suivant décrit les conventions typographiques utilisées dans la documentation.
Convention
[]
{}
|
<>
Le tableau suivant couvre toutes les commandes CLI disponibles. Chaque rubrique de commande comprend
au moins trois des sections suivantes.
Section
Description
Commande
Syntaxe
Paramètres
Exemples
Accès aux appareils
Les commandes CLI de cette section sont liées à l'accès aux périphériques.
Aide
Description
Affichez toutes les commandes disponibles.
Commande
help
Cette convention indique des valeurs facultatives.
Exemple : [a | b] indique que vous pouvez choisir a, b ou aucun.
Cette convention indique les valeurs requises.
Exemple : {a | b} indique que vous devez choisir a ou b.
Cette convention indique que vous avez le choix entre deux ou
plusieurs choix.
Cette convention indique un texte d'espace réservé qui est remplacé
par l'utilisateur ou le système.
Cette section décrit le but de la commande.
Cette section est la commande principale ou complète que vous entrez
dans la CLI.
Cette section affiche tous les paramètres obligatoires ou facultatifs que
vous ajoutez à la commande principale.
Pour plus d'informations sur la distinction entre les paramètres
facultatifs et obligatoires, voir Conventions.
Cette section contient tout argument ou argument obligatoire ou
facultatif et leurs valeurs possibles que vous entrez dans l'interface de
ligne de commande.
Cette section montre un exemple ou des exemples de la commande
dans la CLI.
Guide de l'utilisateur de l'interface de ligne de commande
Description
Description
Conventions et commandes CLI
5