getopt(3)

NOM
getopt, getopt_long, getopt_long_only, optarg, optind, opterr, optopt — Analyser les options de la ligne de commande

BIBLIOTHÈQUE
Bibliothèque C standard (libc, -lc)

SYNOPSIS
#include <unistd.h>

int getopt(int argc, char *argv[],
           const char *chaine_options);

extern char *optarg;
extern int optind, opterr, optopt;

#include <getopt.h>

int getopt_long(int argc, char *argv[],
           const char *chaine_options,
           const struct option *longopts, int *longindex);
int getopt_long_only(int argc, char *argv[],
           const char *chaine_options,
           const struct option *longopts, int *longindex);

    Exigences de macros de test de fonctionnalités pour la glibc (consulter feature_test_macros(7)) :

getopt() :
    _POSIX_C_SOURCE >= 2 || _XOPEN_SOURCE

getopt_long(), getopt_long_only() :
    _GNU_SOURCE

DESCRIPTION
La fonction getopt() analyse les arguments de la ligne de commande. Ses arguments argc et argv correspondent au nombre et à la table d'éléments qui sont transmis à la fonction main() lors du lancement du programme. Un élément de argv qui commence par « - » (et qui n'est pas uniquement « -- » ou « - ») est considéré comme une option. Les caractères à la suite du ou des « - » initiaux sont les caractères de l'option. Si getopt() est appelée à plusieurs reprises, elle renverra successivement chaque caractère de chaque option.

La variable optind est l'index de l'élément suivant à analyser dans argv. Le système initialise cette valeur à 1. L'appelant peut la remettre à 1 pour recommencer l'analyse du même tableau de paramètres argv ou pour en analyser un nouveau.

Si getopt() trouve un autre caractère d'option, elle renvoie ce caractère en mettant à jour la variable externe optind et la variable statique nextchar, de façon à ce que l'appel suivant à getopt() puisse continuer l'analyse avec le caractère d'option suivant ou l'élément suivant de argv.

S'il n'y a plus de caractères d'option, getopt() renvoie -1. Alors, optind devient l'index du premier élément de argv qui n'est pas une option.

chaine_options est une chaîne contenant l'ensemble des caractères d'option autorisés. Un caractère d'option autorisé est un caractère ascii(7) imprimable sur 1 octet (pour lequel isgraph(3) renverrait une valeur différente de zéro) autre que « - », « : » ou « ; ». Si un de ces caractères est suivi par un deux-points (« : »), l'option nécessite un argument, donc getopt() placera dans optarg un pointeur sur le texte suivant dans le même élément de argv ou sur le texte de l'élément de argv suivant. Un double deux-points (« :: ») signifie qu'une option prend un argument facultatif. S'il existe un texte dans le même élément de argv (c'est-à-dire dans le même mot que le nom de l'option elle-même comme « -oarg »), il est renvoyé dans optarg, sinon optarg est défini à zéro. Il s'agit d'une extension GNU. Si chaine_options contient W suivi d'un point-virgule, -W foo est traité comme l'option longue --foo (l'option -W est réservée par POSIX.2 pour des extensions spécifiques à l'implémentation). Ce comportement, spécifique à la version GNU, est pris en charge à partir de la version 2 de la bibliothèque glibc.

Par défaut, getopt() permute les éléments de argv au fur et à mesure de son analyse, de façon à ce qu'en fin de compte, les arguments ne constituant pas des options se trouvent à la fin. Deux autres modes d'analyse sont également implémentés : si le premier caractère de chaine_options vaut « + » ou si la variable d'environnement POSIXLY_CORRECT est définie, l'analyse s'arrête dès qu'un argument ne constituant pas une option est rencontré. Si le premier caractère de chaine_options est autre que « + », il est traité comme une option normale. Si le comportement induit par la définition de POSIXLY_CORRECT est requis, chaine_options contiendra deux symboles « + ». Si le premier caractère de chaine_options vaut « - », les arguments ne correspondant pas à une option sont manipulés comme s'ils étaient des arguments d'une option avec le code de caractère 1 (cela est utilisé par les programmes conçus pour recevoir des options et d'autres éléments de argv dans n'importe quel ordre mais qui prennent en compte l'ordre de ces deux types d'élément). L'argument spécial « -- » arrête l'analyse des options, quel que soit le mode d'analyse en cours.

getopt() peut détecter deux types d'erreur lors du traitement de la liste d'options : (1) un caractère d'option non spécifié dans chaine_options et (2) un argument d'option manquant (c'est-à-dire une option sans son argument attendu à la fin de la ligne de commande). Les erreurs de ce type sont traitées et signalées comme suit :

-   Par défaut, getopt() affiche un message d'erreur sur la sortie d'erreur standard, place le caractère d'option erroné dans optopt et renvoie « ? » comme résultat.

-   Si l'appelant a défini la variable globale opterr à zéro, getopt() n'affiche pas de message d'erreur. L'appelant peut détecter la présence d'une erreur en vérifiant si la fonction a renvoyé « ? » (par défaut, opterr possède une valeur différente de zéro).

-   Si le premier caractère de chaine_options (suivant un des caractères facultatifs « + » ou « - » décrits ci-dessus) est un « : », là non plus, getopt() n'affiche pas de message d'erreur. En outre, elle renvoie « : » au lieu de « ? » pour indiquer un argument d'option manquant, ce qui permet à l'appelant de distinguer les deux types d'erreur.

  getopt_long() et getopt_long_only()
La fonction getopt_long() fonctionne comme getopt() sauf qu'elle accepte également des noms longs d'option, commençant par deux tirets (si le programme accepte seulement les options longues, chaine_options doit être indiquée avec une chaîne vide « "" » et non avec NULL). Les noms longs d'option peuvent être abrégés si l'abréviation est unique ou si elle correspond exactement à une option définie. Une option longue peut prendre un argument, de la forme --arg=param ou --arg param.

longopts est un pointeur sur le premier élément d'un tableau de structures struct option déclarées dans <getopt.h> ainsi :

    struct option {
        const char *name;
        int         has_arg;
        int        *flag;
        int         val;
    };

La signification des différents champs est la suivante :

nom est le nom de l'option longue.

has_arg
    vaut : aucun_argument (ou 0), si l'option ne prend pas d'argument, argument_requis (ou 1) si l'option prend un argument, ou argument_facultatif (ou 2) si l'option prend un argument optionnel.

flag
    indique la manière de renvoyer les résultats pour une option longue. Si flag vaut NULL, getopt_long() renvoie val (par exemple, le programme appelant peut remplir val avec le caractère de l'option courte correspondante). Sinon, getopt_long() renvoie 0, et flag pointe sur une variable définie à val si l'option est trouvée, mais reste inchangé si l'option est absente.

val est la valeur à renvoyer ou à affecter à la variable pointée par flag.

Le dernier élément de la table doit être rempli avec des zéros.

Si longindex est différent de NULL, il pointe sur une variable qui est définie avec l'index de l'option longue correspondant à longopts.

getopt_long_only() fonctionne comme getopt_long(), mais « - » tout comme « -- » peut indiquer une option longue. Si une option commençant par « - » (et non « -- ») ne correspond pas à une option longue, mais correspond à une option courte, elle est analysée en tant qu'option courte.

VALEUR RENVOYÉE
Si une option a été trouvée, getopt() renvoie le caractère de l'option. Si toutes les options de la ligne de commande ont été lues, getopt() renvoie -1. Si getopt() rencontre un caractère d'option qui n'est pas dans chaine_options, « ? » est renvoyé. Si getopt() rencontre une option avec un argument manquant, la valeur renvoyée dépend du premier caractère de chaine_options : si c'est « : », ce caractère est renvoyé, sinon « ? » est renvoyé.

getopt_long() et getopt_long_only() renvoient également le caractère d'option courte si elles en trouvent une. Pour les options longues, elles renvoient val si flag vaut NULL, et 0 sinon. Les erreurs et la fin des options sont gérées comme avec getopt(), en renvoyant de surcroît « ? » pour une correspondance ambiguë ou un paramètre en trop.

ENVIRONNEMENT

POSIXLY_CORRECT
    Si cette variable est définie, l'analyse s'arrête dès qu'un argument ne constituant pas une option est rencontré.

ATTRIBUTS
Pour une explication des termes utilisés dans cette section, consulter attributes(7).
Interface | Attribut | Valeur
getopt(), getopt_long(), getopt_long_only() | Sécurité des threads | MT-Unsafe race:getopt env

VERSIONS
POSIX spécifie que l'argument du tableau argv doit être const, mais ces fonctions permutent ses éléments si la variable d'environnement POSIXLY_CORRECT n'est pas définie. Le prototype effectif utilise const pour être compatible avec les autres systèmes ; cette page, cependant, ne montre pas le qualificateur pour éviter de perturber les lecteurs.

STANDARDS

getopt()
    POSIX.1-2008.

getopt_long()
getopt_long_only()
    GNU.

    L'utilisation de « + » et « - » dans chaine_options est une extension GNU.

HISTORIQUE

getopt()
    POSIX.1-2001 et POSIX.2.

Sur certaines anciennes implémentations, getopt() était déclarée dans <stdio.h>. SUSv1 permettait que la déclaration apparaisse soit dans <unistd.h>, soit dans <stdio.h>. POSIX.1-1996 considère la déclaration dans <stdio.h> comme « LEGACY » (obsolète), et POSIX.1-2001 n'exige pas que la déclaration soit dans <stdio.h>.

Very old versions of glibc were affected by a _PID_GNU_nonoption_argv_flags_ environment variable (https://sourceware.org/git/?p=glibc.git;a=commitdiff;h=bf079e19f50d64aa5e05).

NOTES
Un programme qui analyse plusieurs tableaux de paramètres ou analyse plusieurs fois le même tableau et qui veut utiliser les extensions GNU telles que « + » et « - » au début de chaine_options, ou changer la valeur de POSIXLY_CORRECT entre les analyses, doit réinitialiser getopt() en remettant optind à 0, plutôt qu'à la valeur traditionnelle de 1. La remise à 0 force l'appel d'une routine d'initialisation interne qui revérifie la définition de POSIXLY_CORRECT et recherche les extensions GNU dans chaine_options.

Les arguments de la ligne de commande sont analysés selon leur ordre strict, ce qui signifie qu'une option nécessitant un argument va consommer l'argument suivant, qu'il s'agisse de son argument correctement spécifié ou de l'option suivante (auquel cas l'utilisateur aura mal rédigé la ligne de commande). Par exemple, si chaine_options contient « 1n: » et si l'utilisateur fournit une ligne de commande incorrecte en spécifiant prog -n -1, l'option -n se verra affecter la valeur de optarg « -1 », et l'option -1 sera considérée comme non spécifiée.

EXEMPLES

  getopt()
Le programme d'exemple trivial suivant utilise getopt() avec deux options : -n sans valeur associée et -t val qui nécessite une valeur.

    #include <stdio.h>
    #include <stdlib.h>
    #include <unistd.h>

    int
    main(int argc, char *argv[])
    {
        int flags, opt;
        int nsecs, tfnd;

        nsecs = 0;
        tfnd = 0;
        flags = 0;
        while ((opt = getopt(argc, argv, "nt:")) != -1) {
            switch (opt) {
            case 'n':
                flags = 1;
                break;
            case 't':
                nsecs = atoi(optarg);
                tfnd = 1;
                break;
            default: /* '?' */
                fprintf(stderr, "Usage: %s [-t nsecs] [-n] name\n",
                        argv[0]);
                exit(EXIT_FAILURE);
            }
        }

        printf("flags=%d; tfnd=%d; nsecs=%d; optind=%d\n",
               flags, tfnd, nsecs, optind);

        if (optind >= argc) {
            fprintf(stderr, "Expected argument after options\n");
            exit(EXIT_FAILURE);
        }

        printf("name argument = %s\n", argv[optind]);

        /* Other code omitted */

        exit(EXIT_SUCCESS);
    }

  getopt_long()
Le programme suivant montre l'utilisation de getopt_long() en illustrant la plupart de ses fonctionnalités.

    #include <getopt.h>
    #include <stdio.h>     /* for printf */
    #include <stdlib.h>    /* for exit */

    int
    main(int argc, char *argv[])
    {
        int c;
        int digit_optind = 0;

        while (1) {
            int this_option_optind = optind ? optind : 1;
            int option_index = 0;
            static struct option long_options[] = {
                {"add",     required_argument, 0,  0 },
                {"append",  no_argument,       0,  0 },
                {"delete",  required_argument, 0,  0 },
                {"verbose", no_argument,       0,  0 },
                {"create",  required_argument, 0, 'c'},
                {"file",    required_argument, 0,  0 },
                {0,         0,                 0,  0 }
            };

            c = getopt_long(argc, argv, "abc:d:012",
                            long_options, &option_index);
            if (c == -1)
                break;

            switch (c) {
            case 0:
                printf("option %s", long_options[option_index].name);
                if (optarg)
                    printf(" with arg %s", optarg);
                printf("\n");
                break;

            case '0':
            case '1':
            case '2':
                if (digit_optind != 0 && digit_optind != this_option_optind)
                  printf("digits occur in two different argv-elements.\n");
                digit_optind = this_option_optind;
                printf("option %c\n", c);
                break;

            case 'a':
                printf("option a\n");
                break;

            case 'b':
                printf("option b\n");
                break;

            case 'c':
                printf("option c with value '%s'\n", optarg);
                break;

            case 'd':
                printf("option d with value '%s'\n", optarg);
                break;

            case '?':
                break;

            default:
                printf("?? getopt returned character code 0%o ??\n", c);
            }
        }

        if (optind < argc) {
            printf("non-option ARGV-elements: ");
            while (optind < argc)
                printf("%s ", argv[optind++]);
            printf("\n");
        }

        exit(EXIT_SUCCESS);
    }

VOIR AUSSI
getopt(1), getsubopt(3)

TRADUCTION
La traduction française de cette page de manuel a été créée par Christophe Blaess <https://www.blaess.fr/christophe/>, Stéphan Rafin <stephan.rafin@laposte.net>, Thierry Vignaud <tvignaud@mandriva.com>, François Micaux, Alain Portal <aportal@univ-montp2.fr>, Jean-Philippe Guérard <fevrier@tigreraye.org>, Jean-Luc Coulon (f5ibh) <jean-luc.coulon@wanadoo.fr>, Julien Cristau <jcristau@debian.org>, Thomas Huriaux <thomas.huriaux@gmail.com>, Nicolas François <nicolas.francois@centraliens.net>, Florentin Duneau <fduneau@gmail.com>, Simon Paillard <simon.paillard@resel.enst-bretagne.fr>, Denis Barbier <barbier@debian.org>, David Prévot <david@tilapin.org> et Lucien Gentis <lucien.gentis@waika9.com>

Cette traduction est une documentation libre ; veuillez vous reporter à la GNU General Public License version 3 (https://www.gnu.org/licenses/gpl-3.0.html) concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE.

Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à debian-l10n-french@lists.debian.org.