getopt(3) Library Functions Manual getopt(3) NOM getopt, getopt_long, getopt_long_only, optarg, optind, opterr, optopt -- Analyser les options de la ligne de commande BIBLIOTHEQUE Bibliotheque C standard (libc, -lc) SYNOPSIS #include int getopt(int argc, char *argv[], const char *chaine_options); extern char *optarg; extern int optind, opterr, optopt; #include 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 fonctionnalites 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 a la table d'elements qui sont transmis a la fonction main() lors du lancement du programme. Un element de argv qui commence par << - >> (et qui n'est pas uniquement << -- >> ou << - >>) est considere comme une option. Les caracteres a la suite du ou des << - >> initiaux sont les caracteres de l'option. Si getopt() est appelee a plusieurs reprises, elle renverra successivement chaque caractere de chaque option. La variable optind est l'index de l'element suivant a analyser dans argv. Le systeme initialise cette valeur a 1. L'appelant peut la remettre a 1 pour recommencer l'analyse du meme tableau de parametres argv ou pour en analyser un nouveau. Si getopt() trouve un autre caractere d'option, elle renvoie ce caractere en mettant a jour la variable externe optind et la variable statique nextchar, de facon a ce que l'appel suivant a getopt() puisse continuer l'analyse avec le caractere d'option suivant ou l'element suivant de argv. S'il n'y a plus de caracteres d'option, getopt() renvoie -1. Alors, optind devient l'index du premier element de argv qui n'est pas une option. chaine_options est une chaine contenant l'ensemble des caracteres d'option autorises. Un caractere d'option autorise est un caractere ascii(7) imprimable sur 1 octet (pour lequel isgraph(3) renverrait une valeur differente de zero) autre que << - >>, << : >> ou << ; >>. Si un de ces caracteres est suivi par un deux-points (<< : >>), l'option necessite un argument, donc getopt() placera dans optarg un pointeur sur le texte suivant dans le meme element de argv ou sur le texte de l'element de argv suivant. Un double deux-points (<< :: >>) signifie qu'une option prend un argument facultatif. S'il existe un texte dans le meme element de argv (c'est-a-dire dans le meme mot que le nom de l'option elle-meme comme << -oarg >>), il est renvoye dans optarg, sinon optarg est defini a zero. Il s'agit d'une extension GNU. Si chaine_options contient W suivi d'un point-virgule, -W foo est traite comme l'option longue --foo (l'option -W est reservee par POSIX.2 pour des extensions specifiques a l'implementation). Ce comportement, specifique a la version GNU, est pris en charge a partir de la version 2 de la bibliotheque glibc. Par defaut, getopt() permute les elements de argv au fur et a mesure de son analyse, de facon a ce qu'en fin de compte, les arguments ne constituant pas des options se trouvent a la fin. Deux autres modes d'analyse sont egalement implementes : si le premier caractere de chaine_options vaut << + >> ou si la variable d'environnement POSIXLY_CORRECT est definie, l'analyse s'arrete des qu'un argument ne constituant pas une option est rencontre. Si le premier caractere de chaine_options est autre que << + >>, il est traite comme une option normale. Si le comportement induit par la definition de POSIXLY_CORRECT est requis, chaine_options contiendra deux symboles << + >>. Si le premier caractere de chaine_options vaut << - >>, les arguments ne correspondant pas a une option sont manipules comme s'ils etaient des arguments d'une option avec le code de caractere 1 (cela est utilise par les programmes concus pour recevoir des options et d'autres elements de argv dans n'importe quel ordre mais qui prennent en compte l'ordre de ces deux types d'element). L'argument special << -- >> arrete l'analyse des options, quel que soit le mode d'analyse en cours. getopt() peut detecter deux types d'erreur lors du traitement de la liste d'options : (1) un caractere d'option non specifie dans chaine_options et (2) un argument d'option manquant (c'est-a-dire une option sans son argument attendu a la fin de la ligne de commande). Les erreurs de ce type sont traitees et signalees comme suit : - Par defaut, getopt() affiche un message d'erreur sur la sortie d'erreur standard, place le caractere d'option errone dans optopt et renvoie << ? >> comme resultat. - Si l'appelant a defini la variable globale opterr a zero, getopt() n'affiche pas de message d'erreur. L'appelant peut detecter la presence d'une erreur en verifiant si la fonction a renvoye << ? >> (par defaut, opterr possede une valeur differente de zero). - Si le premier caractere de chaine_options (suivant un des caracteres facultatifs << + >> ou << - >> decrits ci-dessus) est un << : >>, la 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 a 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 egalement des noms longs d'option, commencant par deux tirets (si le programme accepte seulement les options longues, chaine_options doit etre indiquee avec une chaine vide << "" >> et non avec NULL). Les noms longs d'option peuvent etre abreges si l'abreviation est unique ou si elle correspond exactement a une option definie. Une option longue peut prendre un argument, de la forme --arg=param ou --arg param. longopts est un pointeur sur le premier element d'un tableau de structures struct option declarees dans ainsi : struct option { const char *name; int has_arg; int *flag; int val; }; La signification des differents 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 maniere de renvoyer les resultats pour une option longue. Si flag vaut NULL, getopt_long() renvoie val (par exemple, le programme appelant peut remplir val avec le caractere de l'option courte correspondante). Sinon, getopt_long() renvoie 0, et flag pointe sur une variable definie a val si l'option est trouvee, mais reste inchange si l'option est absente. val est la valeur a renvoyer ou a affecter a la variable pointee par flag. Le dernier element de la table doit etre rempli avec des zeros. Si longindex est different de NULL, il pointe sur une variable qui est definie avec l'index de l'option longue correspondant a longopts. getopt_long_only() fonctionne comme getopt_long(), mais << - >> tout comme << -- >> peut indiquer une option longue. Si une option commencant par << - >> (et non << -- >>) ne correspond pas a une option longue, mais correspond a une option courte, elle est analysee en tant qu'option courte. VALEUR RENVOYEE Si une option a ete trouvee, getopt() renvoie le caractere de l'option. Si toutes les options de la ligne de commande ont ete lues, getopt() renvoie -1. Si getopt() rencontre un caractere d'option qui n'est pas dans chaine_options, << ? >> est renvoye. Si getopt() rencontre une option avec un argument manquant, la valeur renvoyee depend du premier caractere de chaine_options : si c'est << : >>, ce caractere est renvoye, sinon << ? >> est renvoye. getopt_long() et getopt_long_only() renvoient egalement le caractere 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 gerees comme avec getopt(), en renvoyant de surcroit << ? >> pour une correspondance ambigue ou un parametre en trop. ENVIRONNEMENT POSIXLY_CORRECT Si cette variable est definie, l'analyse s'arrete des qu'un argument ne constituant pas une option est rencontre. __GNU_nonoption_argv_flags_ Cette variable est utilisee par bash(1) 2.0 pour communiquer a la glibc les arguments resultant de l'expansion des caracteres generiques et ne devant donc pas etre consideres comme des options. Ce comportement a ete supprime de bash(1) 2.01, mais il est toujours pris en charge par la glibc. ATTRIBUTS Pour une explication des termes utilises dans cette section, consulter attributes(7). +-------------------+--------------------------+-----------------------+ |Interface | Attribut | Valeur | +-------------------+--------------------------+-----------------------+ |getopt(), | Securite des threads | MT-Unsafe race:getopt | |getopt_long(), | | env | |getopt_long_only() | | | +-------------------+--------------------------+-----------------------+ VERSIONS POSIX specifie que l'argument du tableau argv doit etre const, mais ces fonctions permutent ses elements si la variable d'environnement POSIXLY_CORRECT n'est pas definie. Le prototype effectif utilise const pour etre compatible avec les autres systemes ; cette page, cependant, ne montre pas le qualificateur pour eviter 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 implementations, getopt() etait declaree dans . SUSv1 permettait que la declaration apparaisse soit dans , soit dans . POSIX.1-1996 considere la declaration dans comme << LEGACY >> (obsolete), et POSIX.1-2001 n'exige pas que la declaration soit dans . NOTES Un programme qui analyse plusieurs tableaux de parametres ou analyse plusieurs fois le meme tableau et qui veut utiliser les extensions GNU telles que << + >> et << - >> au debut de chaine_options, ou changer la valeur de POSIXLY_CORRECT entre les analyses, doit reinitialiser getopt() en remettant optind a 0, plutot qu'a la valeur traditionnelle de 1. La remise a 0 force l'appel d'une routine d'initialisation interne qui reverifie la definition de POSIXLY_CORRECT et recherche les extensions GNU dans chaine_options. Les arguments de la ligne de commande sont analyses selon leur ordre strict, ce qui signifie qu'une option necessitant un argument va consommer l'argument suivant, qu'il s'agisse de son argument correctement specifie ou de l'option suivante (auquel cas l'utilisateur aura mal redige la ligne de commande). Par exemple, si chaine_options contient << 1n: >> et si l'utilisateur fournit une ligne de commande incorrecte en specifiant prog -n -1, l'option -n se verra affecter la valeur de optarg << -1 >>, et l'option -1 sera consideree comme non specifiee. EXEMPLES getopt() Le programme d'exemple trivial suivant utilise getopt() avec deux options : -n sans valeur associee et -t val qui necessite une valeur. #include #include #include 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] nom\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, "Argument requis apres les options\n"); exit(EXIT_FAILURE); } printf("argument nom = %s\n", argv[optind]); /* Le reste du code n'est pas mentionne */ exit(EXIT_SUCCESS); } getopt_long() Le programme suivant montre l'utilisation de getopt_long() en illustrant la plupart de ses fonctionnalites. #include #include /* pour printf */ #include /* pour 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", argument_requis, 0, 0 }, {"append", aucun_argument, 0, 0 }, {"delete", argument_requis, 0, 0 }, {"verbose", aucun_argument, 0, 0 }, {"create", argument_requis, 0, 'c'}, {"file", argument_requis, 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(" avec l'argument %s", optarg); printf("\n"); break; case '0': case '1': case '2': if (digit_optind != 0 && digit_optind != this_option_optind) printf("des chiffres apparaissent dans deux elements differents de argv.\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 ayant pour valeur '%s'\n", optarg); break; case 'd': printf("option d ayant pour valeur '%s'\n", optarg); break; case '?': break; default: printf("?? getopt a renvoye le caractere de code 0%o ??\n", c); } } if (optind < argc) { printf("elements de argv autres que des options : "); while (optind < argc) printf("%s ", argv[optind++]); printf("\n"); } exit(EXIT_SUCCESS); } VOIR AUSSI getopt(1), getsubopt(3) TRADUCTION La traduction francaise de cette page de manuel a ete creee par Christophe Blaess , Stephan Rafin , Thierry Vignaud , Francois Micaux, Alain Portal , Jean-Philippe Guerard , Jean-Luc Coulon (f5ibh) , Julien Cristau , Thomas Huriaux , Nicolas Francois , Florentin Duneau , Simon Paillard , Denis Barbier , David Prevot et Lucien Gentis Cette traduction est une documentation libre ; veuillez vous reporter a la GNU General Public License version 3 concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITE LEGALE. Si vous decouvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message a . Pages du manuel de Linux 6.06 31 octobre 2023 getopt(3)