The OpenNET Project / Index page

[ новости /+++ | форум | теги | ]

Интерактивная система просмотра системных руководств (man-ов)

 ТемаНаборКатегория 
 
 [Cписок руководств | Печать]

getopt (3)
  • getopt (1) ( Solaris man: Команды и прикладные программы пользовательского уровня )
  • getopt (1) ( FreeBSD man: Команды и прикладные программы пользовательского уровня )
  • getopt (1) ( Linux man: Команды и прикладные программы пользовательского уровня )
  • getopt (3) ( Solaris man: Библиотечные вызовы )
  • >> getopt (3) ( FreeBSD man: Библиотечные вызовы )
  • getopt (3) ( Русские man: Библиотечные вызовы )
  • getopt (3) ( Linux man: Библиотечные вызовы )
  • getopt (3) ( POSIX man: Библиотечные вызовы )

  • BSD mandoc
     

    NAME

    
    
    getopt
    
     - get option character from command line argument list
    
     
    

    LIBRARY

    Lb libc
    
     
    

    SYNOPSIS

       #include <unistd.h>
    Vt extern char *optarg ; Vt extern int optind ; Vt extern int optopt ; Vt extern int opterr ; Vt extern int optreset ; int getopt (int argc char * const argv[] const char *optstring);
     

    DESCRIPTION

    The getopt ();
    function incrementally parses a command line argument list Fa argv and returns the next known option character. An option character is known if it has been specified in the string of accepted option characters, Fa optstring .

    The option string Fa optstring may contain the following elements: individual characters, and characters followed by a colon to indicate an option argument is to follow. For example, an option string x recognizes an option ``-x '' and an option string x: recognizes an option and argument ``-x argument '' It does not matter to getopt ();
    if a following argument has leading white space.

    On return from getopt (,);
    optarg points to an option argument, if it is anticipated, and the variable optind contains the index to the next Fa argv argument for a subsequent call to getopt (.);
    The variable optopt saves the last known option character returned by getopt (.);

    The variables opterr and optind are both initialized to 1. The optind variable may be set to another value before a set of calls to getopt ();
    in order to skip over more or less argv entries.

    In order to use getopt ();
    to evaluate multiple sets of arguments, or to evaluate a single set of arguments multiple times, the variable optreset must be set to 1 before the second and each additional set of calls to getopt (,);
    and the variable optind must be reinitialized.

    The getopt ();
    function returns -1 when the argument list is exhausted. The interpretation of options in the argument list may be cancelled by the option `--' (double dash) which causes getopt ();
    to signal the end of argument processing and return -1. When all options have been processed (i.e., up to the first non-option argument), getopt ();
    returns -1.  

    RETURN VALUES

    The getopt ();
    function returns the next known option character in Fa optstring . If getopt ();
    encounters a character not found in Fa optstring or if it detects a missing option argument, it returns `?' (question mark). If Fa optstring has a leading `:' then a missing option argument causes `:' to be returned instead of `?' In either case, the variable optopt is set to the character that caused the error. The getopt ();
    function returns -1 when the argument list is exhausted.  

    EXAMPLES

    #include <unistd.h>
    int bflag, ch, fd;
    
    bflag = 0;
    while ((ch = getopt(argc, argv, "bf:")) != -1) {
            switch (ch) {
            case 'b':
                    bflag = 1;
                    break;
            case 'f':
                    if ((fd = open(optarg, O_RDONLY, 0)) Lt] 0) {
                            (void)fprintf(stderr,
                                "myname: %s: %s\n", optarg, strerror(errno));
                            exit(1);
                    }
                    break;
            case '?':
            default:
                    usage();
            }
    }
    argc -= optind;
    argv += optind;
    
     

    DIAGNOSTICS

    If the getopt ();
    function encounters a character not found in the string Fa optstring or detects a missing option argument it writes an error message to the stderr and returns `?' Setting opterr to a zero will disable these error messages. If Fa optstring has a leading `:' then a missing option argument causes a `:' to be returned in addition to suppressing any error messages.

    Option arguments are allowed to begin with ``- '' this is reasonable but reduces the amount of error checking possible.  

    SEE ALSO

    getopt(1), getopt_long3, getsubopt(3)  

    STANDARDS

    The optreset variable was added to make it possible to call the getopt ();
    function multiple times. This is an extension to the St -p1003.2 specification.  

    HISTORY

    The getopt ();
    function appeared in BSD 4.3  

    BUGS

    The getopt ();
    function was once specified to return EOF instead of -1. This was changed by St -p1003.2-92 to decouple getopt ();
    from In stdio.h .

    A single dash ``- '' may be specified as a character in Fa optstring , however it should never have an argument associated with it. This allows getopt ();
    to be used with programs that expect ``- '' as an option flag. This practice is wrong, and should not be used in any current development. It is provided for backward compatibility only Care should be taken not to use `-' as the first character in Fa optstring to avoid a semantic conflict with GNU getopt (,);
    which assigns different meaning to an Fa optstring that begins with a `-' By default, a single dash causes getopt ();
    to return -1.

    It is also possible to handle digits as option letters. This allows getopt ();
    to be used with programs that expect a number (``-3 '' ) as an option. This practice is wrong, and should not be used in any current development. It is provided for backward compatibility only The following code fragment works in most cases.

    int ch;
    long length;
    char *p, *ep;
    
    while ((ch = getopt(argc, argv, "0123456789")) != -1)
            switch (ch) {
            case '0': case '1': case '2': case '3': case '4':
            case '5': case '6': case '7': case '8': case '9':
                    p = argv[optind - 1];
                    if (p[0] == '-' Am]Am] p[1] == ch Am]Am] !p[2]) {
                            length = ch - '0';
                            ep = "";
                    } else if (argv[optind] Am]Am] argv[optind][1] == ch) {
                            length = strtol((p = argv[optind] + 1),
                                Am]ep, 10);
                            optind++;
                            optreset = 1;
                    } else
                            usage();
                    if (*ep != '\0')
                            errx(EX_USAGE, "illegal number -- %s", p);
                    break;
            }
    


     

    Index

    NAME
    LIBRARY
    SYNOPSIS
    DESCRIPTION
    RETURN VALUES
    EXAMPLES
    DIAGNOSTICS
    SEE ALSO
    STANDARDS
    HISTORY
    BUGS


    Поиск по тексту MAN-ов: 




    Партнёры:
    PostgresPro
    Inferno Solutions
    Hosting by Hoster.ru
    Хостинг:

    Закладки на сайте
    Проследить за страницей
    Created 1996-2024 by Maxim Chirkov
    Добавить, Поддержать, Вебмастеру