getopt - En ligne dans le Cloud

PROGRAMME:

Nom

getopt - options de commande d'analyse (amélioré)

SYNOPSIS

obtenir chaîne d'options paramètres
obtenir [options] [--] chaîne d'options paramètres
obtenir [choix] -o|--options chaîne d'options [options] [--] paramètres

DESCRIPTION

obtenir est utilisé pour rompre (analyser) options dans les lignes de commande pour une analyse facile par shell
procédures et de vérifier les options légales. Il utilise le GNU obtenir(3) routines à faire
ce.

Les paramètres obtenir est appelé avec peut être divisé en deux parties : les options qui modifient
Guide obtenir fera l'analyse (le Options et la chaîne d'options dans le SYNOPSIS), Et
les paramètres à analyser (paramètres dans le SYNOPSIS). La deuxième partie sera
commencer au premier paramètre non optionnel qui n'est pas un argument d'option, ou après le premier
apparition de '--'. Sinon '-o' ou '--options' se trouve dans la première partie, le
Le premier paramètre de la deuxième partie est utilisé comme chaîne d'options courte.

Si la variable d'environnement GETOPT_COMPATIBLE est défini, ou si le premier paramètre n'est pas un
option (ne commence pas par un '-', le premier format du SYNOPSIS), obtenir va générer
sortie compatible avec celle des autres versions de obtenir(1). ça ira quand même
le brassage des paramètres et reconnaître les arguments facultatifs (voir la section COMPATIBILITÉ pour plus d'
information).

Implémentations traditionnelles de obtenir(1) sont incapables de gérer les espaces et autres
caractères spéciaux (spécifiques au shell) dans les arguments et les paramètres non optionnels. Pour résoudre ce
problème, cette implémentation peut générer une sortie cotée qui doit à nouveau être
interprété par le shell (généralement en utilisant le eval commander). Cela a pour effet de
en préservant ces caractères, mais vous devez appeler obtenir d'une manière qui n'est plus
compatible avec d'autres versions (le deuxième ou le troisième format dans le SYNOPSIS). Déterminer
si cette version améliorée de obtenir(1) est installé, une option de test spéciale (-T) peut être
utilisé.

OPTIONS

-a, --alternative
Autoriser les options longues à commencer par un seul '-'.

-h, --Aidez-moi
Affichez le texte d'aide et quittez. Aucune autre sortie n'est générée.

-l, --optionslongues longopt
Les options longues (multi-caractères) à reconnaître. Plus d'un nom d'option peut
être spécifié à la fois, en séparant les noms par des virgules. Cette option peut être
donné plus d'une fois, le longopt sont cumulatifs. Chaque nom d'option long dans
longopt peut être suivi d'un deux-points pour indiquer qu'il a un argument requis, et
par deux deux-points pour indiquer qu'il a un argument facultatif.

-n, --Nom nom de programme
Le nom qui sera utilisé par le obtenir(3) routines lorsqu'il signale des erreurs. Noter
que les erreurs de obtenir(1) sont toujours signalés comme provenant de getopt.

-o, --options shortops
Les options courtes (à un caractère) à reconnaître. Si cette option n'est pas trouvée,
le premier paramètre de obtenir qui ne commence pas par un '-' (et n'est pas une option
argument) est utilisé comme chaîne d'options courte. Chaque caractère d'option courte dans
shortops peut être suivi d'un deux-points pour indiquer qu'il a un argument requis, et
par deux deux-points pour indiquer qu'il a un argument facultatif. Le premier personnage de
les raccourcis peuvent être '+' ou '-' pour influencer la façon dont les options sont analysées et la sortie est
généré (voir section BALAYAGE MODES pour plus de détails).

-q, --silencieux
Désactiver le rapport d'erreurs par obtenir (3).

-Q, --silencieux-sortie
Ne génère pas de sortie normale. Les erreurs sont toujours signalées par obtenir(3), sauf si vous
utiliser aussi -q.

-s, --coquille coquille
Fixez les conventions de citation à celles de coquille. Si l' -s l'option n'est pas donnée, le BASH
des conventions sont utilisées. Les arguments valides sont actuellement 'sh''bash','csh', et
'tcsh'.

-T, --test
Testez si votre obtenir(1) est cette version améliorée ou une ancienne version. Cela génère
pas de sortie et définit l'état d'erreur sur 4. Autres implémentations de obtenir(1), et
cette version si la variable d'environnement GETOPT_COMPATIBLE est défini, renverra '--'
et état d'erreur 0.

-u, --sans guillemets
Ne citez pas la sortie. Notez que les espaces et spéciaux (dépendant du shell)
les personnages peuvent causer des ravages dans ce mode (comme ils le font avec d'autres obtenir(1)
implémentations).

-V, --version
Affichez les informations de version et quittez. Aucune autre sortie n'est générée.

PARSAGE

Cette section précise le format de la deuxième partie des paramètres de obtenir (les
paramètres dans le SYNOPSIS). La section suivante (SORTIE) décrit la sortie qui est
généré. Ces paramètres étaient généralement les paramètres qu'une fonction shell était appelée
avec. Il faut veiller à ce que chaque paramètre avec lequel la fonction shell a été appelée
correspond à exactement un paramètre dans la liste des paramètres de obtenir (voir le EXEMPLES).
Toute l'analyse est effectuée par le GNU obtenir(3) routines.

Les paramètres sont analysés de gauche à droite. Chaque paramètre est classé comme un court
option, une option longue, un argument d'une option ou un paramètre non optionnel.

Une simple option courte est un '-' suivi d'un caractère d'option court. Si l'option a un
argument requis, il peut être écrit directement après le caractère d'option ou comme le prochain
paramètre (c'est-à-dire séparés par des espaces sur la ligne de commande). Si l'option a un
argument facultatif, il doit être écrit directement après le caractère d'option s'il est présent.

Il est possible de spécifier plusieurs options courtes après un '-', tant que tous (sauf
éventuellement le dernier) n'ont pas d'arguments obligatoires ou facultatifs.

Une option longue commence normalement par '--' suivi du nom long de l'option. Si l'option
a un argument obligatoire, il peut être écrit directement après le long nom de l'option, séparé
par '=', ou comme argument suivant (c'est-à-dire séparés par des espaces sur la ligne de commande). Si
l'option a un argument optionnel, il doit être écrit directement après l'option longue
nom, séparé par '=', si présent (si vous ajoutez le '=' mais rien derrière, c'est
interprété comme si aucun argument n'était présent ; c'est un léger bug, voir le BOGUES). Longue
options peuvent être abrégées, tant que l'abréviation n'est pas ambiguë.

Chaque paramètre ne commençant pas par un '-', et non un argument obligatoire d'une option précédente,
est un paramètre non optionnel. Chaque paramètre après un '--' paramètre est toujours interprété comme
un paramètre non optionnel. Si la variable d'environnement POSIXLY_CORRECT est défini, ou si le
chaîne d'option courte commençant par un '+', tous les paramètres restants sont interprétés comme
paramètres non optionnels dès que le premier paramètre non optionnel est trouvé.

SORTIE

Une sortie est générée pour chaque élément décrit dans la section précédente. La sortie se fait en
le même ordre que les éléments sont spécifiés dans l'entrée, sauf pour non-option
paramètres. La sortie peut être effectuée en compatible (non cité) ou de telle manière que
les espaces et autres caractères spéciaux dans les arguments et les paramètres non optionnels sont
conservé (voir CITATION). Lorsque la sortie est traitée dans le script shell, il semblera
être composé d'éléments distincts pouvant être traités un par un (en utilisant le décalage
commande dans la plupart des langages shell). Ceci est imparfait en mode sans guillemets, car les éléments peuvent être
divisés à des endroits inattendus s'ils contiennent des espaces ou des caractères spéciaux.

S'il y a des problèmes d'analyse des paramètres, par exemple parce qu'un argument requis est
introuvable ou une option n'est pas reconnue, une erreur sera signalée sur stderr, il y aura
pas de sortie pour l'élément incriminé et un état d'erreur différent de zéro est renvoyé.

Pour une option courte, un seul '-' et le caractère d'option sont générés comme un seul paramètre.
Si l'option a un argument, le paramètre suivant sera l'argument. Si l'option
prend un argument facultatif, mais aucun n'a été trouvé, le paramètre suivant sera généré mais
être vide en mode guillemet, mais aucun deuxième paramètre ne sera généré en mode non guillemet
mode (compatible). Notez que beaucoup d'autres obtenir(1) les implémentations ne prennent pas en charge l'option
arguments.

Si plusieurs options courtes ont été spécifiées après un seul '-', chacun sera présent dans le
sortie en tant que paramètre séparé.

Pour une option longue, '--' et le nom complet de l'option sont générés en tant que paramètre. C'est
fait indépendamment du fait que l'option a été abrégée ou spécifiée avec un seul '-' dans le
saisir. Les arguments sont traités comme avec les options courtes.

Normalement, aucune sortie de paramètres non optionnels n'est générée tant que toutes les options et leurs
des arguments ont été générés. Puis '--' est généré en tant que paramètre unique, et après
les paramètres non optionnels dans l'ordre dans lequel ils ont été trouvés, chacun en tant que paramètre distinct.
Uniquement si le premier caractère de la chaîne d'options courte était un '-', paramètre non optionnel
la sortie est générée à l'endroit où elle se trouve dans l'entrée (ceci n'est pas pris en charge si le
premier format de la SYNOPSIS est utilisé; dans ce cas, toutes les occurrences précédentes de '-' et
'+' sont ignorés).

CITATION

En mode compatible, espaces ou caractères 'spéciaux' dans les arguments ou non-option
les paramètres ne sont pas gérés correctement. Lorsque la sortie est transmise au script shell, le
le script ne sait pas comment il est censé diviser la sortie en paramètres séparés. À
contourner ce problème, cette implémentation propose le devis. L'idée est que la sortie est
généré avec des guillemets autour de chaque paramètre. Lorsque cette sortie est à nouveau transmise au
shell (généralement par un shell eval commande), il est correctement divisé en paramètres distincts.

Les guillemets ne sont pas activés si la variable d'environnement GETOPT_COMPATIBLE est défini, si le premier
forme de la SYNOPSIS est utilisé, ou si l'option '-u' est trouvé.

Différents shells utilisent différentes conventions de citation. Vous pouvez utiliser le '-s' option pour sélectionner
le shell que vous utilisez. Les shells suivants sont actuellement pris en charge : 'sh','bash',
'csh»Et«tcsh'. En fait, seules deux « saveurs » sont distinguées :
conventions et conventions de citation de type csh. Il y a de fortes chances que si vous utilisez un autre shell
langage de script, l'une de ces variantes peut toujours être utilisée.

BALAYAGE MODES

Le premier caractère de la chaîne d'options courte peut être un '-' ou un '+' pour indiquer un
mode de balayage spécial. Si le premier formulaire d'appel dans le SYNOPSIS est utilisé ils sont
ignoré; la variable d'environnement POSIXLY_CORRECT est encore examiné, cependant.

Si le premier caractère est '+', ou si la variable d'environnement POSIXLY_CORRECT est réglé,
l'analyse s'arrête dès que le premier paramètre non optionnel (c'est-à-dire un paramètre qui ne
commencer par un '-') est trouvé qui n'est pas un argument d'option. Les paramètres restants sont
tous interprétés comme des paramètres non optionnels.

Si le premier caractère est un '-', les paramètres non optionnels sont sortis à l'endroit où
on les trouve ; en fonctionnement normal, ils sont tous récupérés en fin de sortie après un
'--' Le paramètre a été généré. Notez que ce '--' est toujours généré, mais
ce sera toujours le dernier paramètre dans ce mode.

COMPATIBILITÉ

Cette version de obtenir(1) est écrit pour être aussi compatible que possible avec les autres versions.
Habituellement, vous pouvez simplement les remplacer par cette version sans aucune modification, et avec
quelques avantages.

Si le premier caractère du premier paramètre de getopt n'est pas un '-', obtenir va dans
le mode de compatibilité. Il interprétera son premier paramètre comme la chaîne d'options courtes,
et tous les autres arguments seront analysés. Il fera toujours le brassage des paramètres (c'est-à-dire tous
les paramètres non optionnels sont affichés à la fin), à moins que la variable d'environnement
POSIXLY_CORRECT est réglé.

La variable d'environnement GETOPT_COMPATIBLE les forces obtenir en mode de compatibilité. Réglage
à la fois cette variable d'environnement et POSIXLY_CORRECT offre une compatibilité à 100 % pour
programmes « difficiles ». Habituellement, cependant, ni l'un ni l'autre n'est nécessaire.

En mode de compatibilité, en tête '-»Et«+' les caractères dans la chaîne d'options courte sont
ignoré.

RETOUR CODES

obtenir renvoie le code d'erreur 0 pour une analyse réussie, 1 if obtenir(3) renvoie des erreurs, 2 si ça
ne comprend pas ses propres paramètres, 3 si une erreur interne se produit comme un manque de mémoire,
et 4 s'il est appelé avec -T.

EXEMPLES

Des exemples de scripts pour (ba)sh et (t)csh sont fournis avec le obtenir(1) distribution, et
sont installés en option dans /usr/share/getopt/ or / usr / share / doc / dans util-linux
sous-répertoire.

ENVIRONNEMENT

POSIXLY_CORRECT
Cette variable d'environnement est examinée par le obtenir(3) routines. S'il est défini,
l'analyse s'arrête dès qu'un paramètre qui n'est pas une option ou une option est trouvé
argument. Tous les paramètres restants sont également interprétés comme des paramètres non optionnels,
indépendamment du fait qu'ils commencent par un '-'.

GETOPT_COMPATIBLE
Forces obtenir d'utiliser le premier format d'appel comme spécifié dans le SYNOPSIS.

Utilisez getopt en ligne en utilisant les services onworks.net