Provided by: manpages-fr-extra_20101103_all bug

NOM

       getopt   -  Analyser  des  options  de  lignes  de  commandes  (version
       amelioree)

SYNOPSIS

       getopt cha^ine_options param`etres
       getopt [options] [--] cha^ine_options param`etres
       getopt [options] -o|--options cha^ine_options [options] [--] param`etres

DESCRIPTION

       getopt permet d'analyser les options  d'une  ligne  de  commande  d'une
       facon  simple  pour  des  scripts  shell  et  de  verifier  les options
       autorisees. Les routines GNU getopt(3) sont utilisees pour cela.

       Les parametres fournis a getopt sont de deux types : le premier type de
       parametres est constitue des options qui modifient la facon dont getopt
       fera  l'analyse  (options  et  -o|--options  cha^ine_options   dans   le
       SYNOPSIS).  Le  second  type  de  parametres  commence  des  le premier
       parametre n'etant pas une option ou apres  la  premiere  apparition  de
       << -- >>.  Si  aucune option << -o >> ou << --options >> n'est presente
       dans la premiere partie, le premier parametre de la seconde partie sera
       utilise comme chaine de description des options courtes.

       Si la variable d'environnement GETOPT_COMPATIBLE est positionnee, ou si
       son premier parametre n'est pas une option (c'est-a-dire ne  commencant
       pas par un << - >>, le premier format du SYNOPSIS), getopt produira une
       sortie compatible avec d'autres versions de getopt(1). Il  reorganisera
       encore les parametres et reconnaitra les parametres optionnels (voir la
       section COMPATIBILIT'E pour plus d'informations).

       Les implementations traditionnelles de  getopt(1)  ne  gerent  pas  les
       espaces   ou   autres   caracteres   speciaux   (specifiques  a  chaque
       interpreteur de commandes) dans les parametres (options ou  non).  Pour
       resoudre  ce  probleme,  cette implementation peut produire une sortie,
       avec  guillemets,  qui   doit   etre   interpretee   de   nouveau   par
       l'interpreteur  de  commandes  (en general avec la commande eval). Ceci
       permet de preserver ces caracteres,  mais  vous  devez  appeler  getopt
       d'une  facon  non  compatible  avec les autres versions (la deuxieme ou
       troisieme forme dans le SYNOPSIS). Pour  determiner  si  cette  version
       amelioree  de  getopt(1)  est  installee, vous pouvez utiliser l'option
       speciale de test (-T).

OPTIONS

       -a, --alternative
              Permet aux options longues de  ne  commencer  que  par  un  seul
              << - >>.

       -h, --help
              Affiche  un  petit  guide d'utilisation puis quitte sans erreur.
              Rien d'autre ne sera affiche.

       -l, --longoptions options longues
              Les  options  longues  (plusieurs  caracteres)  a   reconnaitre.
              Plusieurs noms d'options peuvent etre fournis en une seule fois,
              en separant les noms par des virgules. Cette  option  peut  etre
              fournie  plusieurs fois, les options_longues se cumulent. Chaque
              nom  d'option  dans  options_longues  peut   etre   suivi   d'un
              deux-points  pour  indiquer que l'option attend un parametre, et
              par deux signes deux-points pour indiquer qu'elle a un parametre
              optionnel.

       -n, --name nom-de-programme
              Le nom qui sera utilise par getopt(3) pour signaler les erreurs.
              Notez  que  les  erreurs  de  getopt(1)  sont  signalees   comme
              provenant de getopt.

       -o, --options options courtes
              Les  options courtes (un seul caractere) a reconnaitre. Si cette
              option n'est pas trouvee, le premier parametre de getopt qui  ne
              commence pas par un << - >> (et qui n'est pas un parametre d'une
              option) est utilise comme  chaine  de  description  des  options
              courtes.  Chaque  caractere  d'option  courte de options_courtes
              peut  etre  suivi  d'un  signe  deux-points  pour  indiquer  que
              l'option  attend un parametre ou de deux signes deux-points pour
              indiquer qu'elle a un parametre optionnel. Le premier  caractere
              de  options_courtes  peut  etre  un  << + >>  ou un << - >> pour
              modifier la facon dont les options sont  analysees  et  dont  la
              sortie  est  produite (voir la section MODES D'ANALYSE pour plus
              de details).

       -q, --quiet
              Desactive le signalement des erreurs par getopt(3).

       -Q, --quiet-output
              Ne genere pas la  sortie  normale.  Les  erreurs  sont  toujours
              remontees  par  getopt(3), a moins que vous n'utilisiez l'option
              -q.

       -s, --shell shell
              Fixe les regles de protection (avec des guillemets) a celles des
              interpreteurs  de  commandes. En l'absence de parametre pour -s,
              les conventions de BASH sont utilisees.  Les  valeurs  acceptees
              sont << sh >>, << bash >>, << csh >> et << tcsh >>.

       -u, --unquoted
              Ne  place  pas la sortie entre guillemets. Notez que les espaces
              et  caracteres  speciaux  (pour  l'interpreteur   de   commandes
              utilise)  peuvent  poser  des problemes dans ce mode (comme pour
              les autres implementations de getopt(1)).

       -T, --test
              Teste si votre version de getopt(1) correspond a  cette  version
              amelioree  ou  a  une version plus ancienne. Aucune sortie n'est
              creee et la valeur de retour est 4. Les  autres  implementations
              de   getopt(1)  (ou  celle-ci  si  la  variable  d'environnement
              GETOPT_COMPATIBLE est positionnee) renverront << -- >>, avec une
              valeur de retour de 0.

       -V, --version
              Affiche  le  numero  de version puis quitte. Aucune autre sortie
              n'est creee.

ANALYSE

       Cette section specifie le format de la seconde partie des parametres de
       getopt  (param`etres  dans  le  SYNOPSIS).  La section suivante (SORTIE)
       decrit la  sortie  renvoyee.  Ces  parametres  sont  generalement  ceux
       fournis  a  une fonction shell. Il faut faire attention a ce que chaque
       parametre fourni a la fonction corresponde bien a un  parametre  de  la
       liste  des  parametres  de  getopt (voir EXEMPLES). Toutes les analyses
       sont faites en utilisant les routines getopt(3).

       Les parametres sont analyses  de  la  gauche  vers  la  droite.  Chaque
       parametre  est  classe  en option courte, option longue, argument d'une
       option ou parametre n'etant pas une option.

       Une option courte est un << - >> suivi par le caractere de l'option. Si
       l'option  a  un parametre obligatoire, il peut etre indique juste apres
       le caractere de l'option ou comme parametre  suivant  (c'est-a-dire  en
       les  separant par une espace). Si l'option a un parametre optionnel, il
       doit etre  ecrit  juste  apres  le  caractere  de  l'option  (quand  le
       parametre est present).

       Il  est possible d'indiquer plusieurs options courtes apres un << - >>,
       tant que toutes les options (sauf peut-etre la derniere) n'ont  pas  de
       parametre obligatoire ou optionnel.

       Une  option  longue commence normalement par << -- >>, suivi par le nom
       de l'option longue. Si l'option necessite un parametre,  celui-ci  peut
       etre  indique  juste apres le nom de l'option, en inserant le caractere
       << = >> entre, ou il  peut  etre  indique  dans  le  parametre  suivant
       (c'est-a-dire  en le separant par un blanc). Si l'option a un parametre
       optionnel, il doit etre indique juste apres  le  nom  de  l'option,  en
       inserant le caractere << = >> entre, si le parametre est present (quand
       vous ajoutez le caractere << = >> sans rien derriere, c'est comme si le
       parametre  n'etait  pas  present ;  ceci  est  un bogue mineur, voir la
       section BOGUES). Les options longues peuvent etre  abregees,  tant  que
       l'abreviation n'est pas ambigue.

       Chaque  parametre  ne  commencant  pas par un << - >> et n'etant pas un
       parametre obligatoire est un << parametre n'etant  pas  une  option >>.
       Chaque  parametre situe apres un << -- >> est toujours interprete comme
       un  << parametre  n'etant   pas   une   option >>.   Si   la   variable
       d'environnement  POSIXLY_CORRECT  est  positionnee, ou si la chaine des
       options courtes commence par un << + >>, tous les parametres suivant le
       premier  parametre  n'etant  pas  une option sont interpretes comme des
       parametres n'etant pas une option.

SORTIE

       La sortie est generee  pour  chaque  element  decrit  dans  la  section
       precedente.  Elle  reprend  l'ordre  des elements indiques en entree, a
       l'exception des parametres n'etant pas une option. La sortie peut  etre
       faite  dans  un  mode  compatible  (non prot'eg'e : sans guillemet) ou de
       telle  sorte  que  les  espaces  ou  autres  caracteres  speciaux   des
       parametres  soient  preserves  (voir  PROTECTION).  Quand la sortie est
       utilisee dans  un  script  shell,  elle  paraitra  composee  d'elements
       distincts  qui peuvent etre traites un par un (en utilisant la commande
       shift de la plupart des langages de script). Ce n'est pas parfait  dans
       le  mode  non  prot'eg'e parce que les elements peuvent etre coupes a des
       endroits  non  prevus  s'ils  contiennent  des  espaces  ou  caracteres
       speciaux.

       S'il  y  a  des problemes lors de l'analyse des parametres, par exemple
       parce qu'un parametre obligatoire n'est pas  trouve  ou  qu'une  option
       n'est pas reconnue, une erreur est rapportee sur la sortie d'erreur. Il
       n'y aura aucune sortie pour les elements incrimines et un code d'erreur
       non nul est renvoye.

       Pour  une  option  courte,  un seul << - >> et le caractere de l'option
       sont generes  comme  un  parametre.  Si  l'option  est  suivie  de  son
       parametre,  le  parametre  suivant  de  la  sortie sera le parametre de
       l'option. Si l'option accepte un parametre optionnel, mais qu'aucun n'a
       ete  trouve,  un  parametre vide sera genere dans le mode protege, mais
       aucun dans le mode non protege (ou mode compatible). Notez que beaucoup
       d'autres  implementations  de  getopt(1)  ne  gerent pas les parametres
       optionnels.

       Si plusieurs option courtes ont ete precisees apres un unique  << - >>,
       chacune sera presente dans la sortie dans un parametre distinct.

       Pour  une  option  longue,  << -- >> et le nom complet de l'option sont
       generes en un seul parametre. C'est le cas que l'option soit abregee ou
       qu'elle   soit  indiquee  avec  un  seul  << - >>  dans  l'entree.  Les
       parametres sont traites comme pour les options courtes.

       Normalement, aucun parametre n'etant pas une option n'est genere sur la
       sortie  tant  que  toutes les options et leurs parametres n'ont pas ete
       traites. Ensuite, << -- >> est genere separement comme un parametre, et
       est  suivi  des parametres n'etant pas des options, dans l'ordre ou ils
       ont ete trouves, chacun dans  un  parametre  distinct.  Si  le  premier
       caractere  de la chaine des options courte est un << - >>, et seulement
       dans ce cas, les parametres n'etant pas des options sont generes  quand
       ils  sont trouves dans l'entree (ce n'est pas gere si la premiere forme
       du SYNOPSIS est utilisee ; dans ce cas, les << - >> et << + >> de  tete
       sont ignores).

PROTECTION

       Dans  le  mode  compatible, les espaces et caracteres speciaux dans les
       parametres des options ou les parametres n'etant  pas  des  options  ne
       sont  pas  geres  correctement. Comme la sortie est envoyee a un script
       shell, le script ne sait pas comment il doit  separer  les  parametres.
       Pour  eviter ce probleme, cette implementation propose un mode protege.
       L'idee est de generer la sortie  avec  des  protections  (a  l'aide  de
       guillemets)  autour  des  parametres. Quand cette sortie est envoyee de
       nouveau a un interpreteur de commandes (generalement  en  utilisant  la
       commande  eval  de  l'interpreteur),  le  decoupage  en  parametres est
       correct.

       La  protection  n'est  pas  activee  si  la  variable   d'environnement
       GETOPT_COMPATIBLE est positionnee, si la premiere forme du SYNOPSIS est
       utilisee ou si l'option << -u >> est trouvee.

       Les conventions de protections different suivant les  interpreteurs  de
       commandes.  Vous  pouvez  preciser l'interpreteur de commandes que vous
       utilisez  avec  l'option  << -s >>.  Les  interpreteurs  de   commandes
       suivants sont geres : << sh >>, << bash >>, << csh >> et << tcsh >>. En
       fait,  seuls  deux  types  sont  differencies :  ceux   utilisant   les
       conventions  de  sh et ceux utilisant les conventions de csh. Il y a de
       grandes chances que si vous utilisez un autre  langage  de  script,  il
       utilise une de ces conventions.

MODES D'ANALYSE

       Le  premier  caractere  de la chaine de description des options courtes
       peut etre un << - >> ou  un  << + >>  pour  utiliser  un  mode  special
       d'analyse.  Si  la  premiere  forme  du  SYNOPSIS est appelee, ils sont
       ignores ; mais la variable d'environnement POSIXLY_CORRECT est toujours
       examinee.

       Si   le   premier   caractere   est  un  << + >>,  ou  si  la  variable
       d'environnement POSIXLY_CORRECT est positionnee, l'analyse s'arrete des
       qu'un  parametre  n'etant pas une option est rencontre (c'est-a-dire un
       parametre qui ne  commence  pas  par  << - >>).  Aucun  des  parametres
       suivants ne sera considere comme une option.

       Si  le premier caractere est un << - >>, les parametres qui ne sont pas
       des options sont places dans la sortie a la position  ou  ils  ont  ete
       trouves ;  normalement,  ils  sont  tous  places a la fin de la sortie,
       juste apres le parametre << -- >> qui a ete genere. Notez que  dans  ce
       mode,  le  parametre  << -- >>  est  toujours  genere,  mais il sera le
       dernier parametre.

COMPATIBILIT'E

       Cette version de getopt(1) a ete ecrite pour etre aussi compatible  que
       possible  avec  les  autres  versions.  En  general,  vous  pouvez vous
       contenter des les remplacer par cette version sans aucune modification,
       avec meme certains avantages.

       Si  le  premier  caractere  du premier parametre de getopt n'est pas un
       << - >>, getopt passe en mode  compatible.  Il  interprete  ce  premier
       parametre  comme une chaine de description des options courtes, et tous
       les autres parametres  seront  analyses.  Il  reorganisera  encore  les
       parametres  (c'est-a-dire  que  les  parametres n'etant pas des options
       sont places a la fin), a moins que  la  variable  POSIXLY_CORRECT  soit
       positionnee.

       La variable d'environnement GETOPT_COMPATIBLE force getopt dans un mode
       de compatibilite. Avec a la  fois  cette  variable  d'environnement  et
       POSIXLY_CORRECT,   il   sera   100 %  compatible  pour  les  programmes
       << difficiles >>. Meme si d'habitude aucun n'est necessaire.

       Dans ce mode, les << - >> ou << + >> de tete des options  courtes  sont
       ignores.

CODES DE RETOUR

       Le  code  de  retour de getopt est 0 en cas de succes lors de l'analyse
       des options, 1 si getopt(3) signale  des  erreurs,  2  si  ses  propres
       parametres  ne  sont  pas  compris,  3 dans le cas d'une erreur interne
       (comme un manque de memoire) et 4 lorsque l'option -T est utilisee.

EXEMPLES

       Des scripts d'exemple pour (ba)sh et (t)csh sont fournis avec getopt(1)
       et installes sous /usr/share/doc/util-linux/examples.

ENVIRONNEMENT

       POSIXLY_CORRECT
              Cette  variable  d'environnement  est  utilisee  par  getopt(3).
              Lorsqu'elle  est  positionnee,  l'analyse  s'arrete  au  premier
              parametre  n'etant  ni  une option ni le parametre d'une option.
              Tous les parametres restants sont  egalement  interpretes  comme
              parametre n'etant pas une option, qu'ils commence par un << - >>
              ou non.

       GETOPT_COMPATIBLE
              Force getopt a utiliser le premier format d'appel, comme indique
              dans le SYNOPSIS.

BOGUES

       getopt(3)  peut  analyser  des  options  longues  avec  des  parametres
       optionnels vides (ce n'est pas  possible  pour  les  options  courtes).
       Cette  version de getopt(1) traite les arguments optionnels vides comme
       s'ils n'etaient pas presents.

       La syntaxe n'est pas tres intuitive si  vous  ne  voulez  pas  d'option
       courte : vous devez explicitement les definir comme des chaines vides.

AUTEUR

       Frodo Looijaard <frodo@frodo.looijaard.name>

VOIR AUSSI

       getopt(3), bash(1), tcsh(1).

DISPONIBILIT'E

       La  commande  getopt  fait  partie  du  paquet  util-linux-ng, elle est
       disponible sur ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.

TRADUCTION

       Cette  traduction  est  maintenue  par  les   membres   de   la   liste
       <debian-l10n-french  AT  lists  DOT debian DOT org>.  Veuillez signaler
       toute erreur de traduction par  un  rapport  de  bogue  sur  le  paquet
       manpages-fr-extra.