getopts (beépített Bash parancs)

Tartalom

 

Adatok

Licenc: GNU GPLv3+
Verziószám: GNU Bash 5
Fejlesztő/tulajdonos: Free Software Foundation Inc.

Rövid leírás:

A getopts beépített Bash parancs manual oldala és súgója. A getopts-ot shell-eljárások használják a pozicionális paraméterek elemzésére.

 

 

Man oldal kimenet

man bash
[...]
       getopts optstring name [args]
              getopts is used by shell procedures to parse positional parameters.  optstring con-
              tains the option characters to be recognized; if  a  character  is  followed  by  a
              colon,  the  option is expected to have an argument, which should be separated from
              it by white space.  The colon and question mark characters may not be used  as  op-
              tion  characters.   Each  time it is invoked, getopts places the next option in the
              shell variable name, initializing name if it does not exist, and the index  of  the
              next argument to be processed into the variable OPTIND.  OPTIND is initialized to 1
              each time the shell or a shell script is invoked.  When an option requires an argu-
              ment,  getopts  places  that argument into the variable OPTARG.  The shell does not
              reset OPTIND automatically; it must be manually reset  between  multiple  calls  to
              getopts within the same shell invocation if a new set of parameters is to be used.

              When  the  end of options is encountered, getopts exits with a return value greater
              than zero.  OPTIND is set to the index of the first non-option argument,  and  name
              is set to ?.

              getopts  normally parses the positional parameters, but if more arguments are given
              in args, getopts parses those instead.

              getopts can report errors in two ways.  If the first character of  optstring  is  a
              colon,  silent  error  reporting is used.  In normal operation, diagnostic messages
              are printed when invalid options or missing option arguments are  encountered.   If
              the  variable  OPTERR is set to 0, no error messages will be displayed, even if the
              first character of optstring is not a colon.

              If an invalid option is seen, getopts places ? into name and, if not silent, prints
              an  error  message  and  unsets OPTARG.  If getopts is silent, the option character
              found is placed in OPTARG and no diagnostic message is printed.

              If a required argument is not found, and getopts is not silent, a question mark (?)
              is  placed  in  name,  OPTARG  is  unset,  and a diagnostic message is printed.  If
              getopts is silent, then a colon (:) is placed in name and OPTARG is set to the  op-
              tion character found.

              getopts  returns true if an option, specified or unspecified, is found.  It returns
              false if the end of options is encountered or an error occurs.
[...]

 

 

Súgó kimenet

getopts --help
getopts: getopts opciók név [arg]
    Kapcsolók értelmezése.
    
    A getopts parancsot arra használják az eljárások, hogy pozicionális
    paramétereket kapcsolókként értelmezzenek.
    
    A KAPCSOLÓK azokat a betűket tartalmazza, amelyeket fel kell ismerni.
    Ha egy kapcsolót kettőspont követ, a kapcsoló kötelező paramétert vár.
    Ezt a paramétert szóközzel kell elválasztani a kapcsolótól.
    
    Minden végrehajtáskor a getopts a $név változóba helyezi a következő
    kapcsolót (szükség esetén inicializálva a változót). A kapcsoló indexe
    az OPTIND változóba kerül. Az OPTIND változót a parancsértelmező induláskor
    1-re inicializálja. Ha a kapcsolónak paramétere van, ennek értéke
    az OPTARG változóba kerül.
    
    A getopts két módon tud hibát jelezni. Elnémítható a hibajelzés az OPCIÓK
    kettősponttal való kezdésével. Ebben a módban nem kerül kiírásra
    hibaüzenet. Ha a getopts érvénytelen opciót talál, ezt az OPTARG
    változóba írja. Ha hiányzik egy kötelező paraméter, a $név változóba egy
    kettőspont kerül, és a talált karakter az OPTARG-ba kerül.
    Ha a getopts nincs néma módban, és érvénytelen kapcsolót talál, $NÉV-be
    egy kérdőjel kerül, az OPTARG törlésre kerül, és hibaüzenetet ír ki.
    
    Ha az OPTERR változó 0-ra van állítva, a getopts letiltja a hibaüzenetet,
    akkor is, ha nem kettősponttal kezdődik az OPCIÓK. Az OPTERR alapértéke 1.
    
    A getopts alapvetően a pozicionális paramétereket értelmezi ($0–$9), de
    több argumentum esetén mindet kezeli.
    
    Kilépési kód:
    Sikerrel tér vissza, ha kapcsolót talált, sikertelenül, ha elfogytak a
    kapcsolók, vagy hiba történt.

 

Kapcsolódó tartalom