getsubopt - parse suboption arguments from a string


   #include <stdlib.h>

   int getsubopt(char **optionp, char * const *tokens, char **valuep);

   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

       _XOPEN_SOURCE >= 500
           || /* Since glibc 2.12: */ _POSIX_C_SOURCE >= 200809L


   getsubopt()  parses  the list of comma-separated suboptions provided in
   optionp.  (Such a suboption list is typically produced  when  getopt(3)
   is  used  to  parse  a  command  line; see for example the -o option of
   mount(8).)  Each suboption may include an associated  value,  which  is
   separated  from  the suboption name by an equal sign.  The following is
   an example of the kind of string that might be passed in optionp:


   The tokens argument is a pointer to a NULL-terminated array of pointers
   to  the  tokens  that getsubopt() will look for in optionp.  The tokens
   should be distinct, null-terminated strings  containing  at  least  one
   character, with no embedded equal signs or commas.

   Each call to getsubopt() returns information about the next unprocessed
   suboption in optionp.  The first equal sign in a suboption (if any)  is
   interpreted  as  a  separator  between  the  name and the value of that
   suboption.  The value extends to the  next  comma,  or  (for  the  last
   suboption)  to  the  end  of  the string.  If the name of the suboption
   matches a known name  from  tokens,  and  a  value  string  was  found,
   getsubopt()  sets  *valuep  to  the  address of that string.  The first
   comma in optionp is  overwritten  with  a  null  byte,  so  *valuep  is
   precisely the "value string" for that suboption.

   If  the suboption is recognized, but no value string was found, *valuep
   is set to NULL.

   When getsubopt() returns, optionp points to the next suboption,  or  to
   the null byte ('\0') at the end of the string if the last suboption was
   just processed.


   If the first suboption in optionp is  recognized,  getsubopt()  returns
   the  index  of the matching suboption element in tokens.  Otherwise, -1
   is returned and *valuep is the entire name[=value] string.

   Since *optionp is changed, the  first  suboption  before  the  call  to
   getsubopt()  is not (necessarily) the same as the first suboption after


   For  an  explanation  of  the  terms  used   in   this   section,   see

   Interface    Attribute      Value   
   getsubopt()  Thread safety  MT-Safe 


   POSIX.1-2001, POSIX.1-2008.


   Since  getsubopt()  overwrites  any  commas  it  finds  in  the  string
   *optionp, that string must be writable; it cannot be a string constant.


   The following program expects suboptions following a "-o" option.

   #define _XOPEN_SOURCE 500
   #include <stdlib.h>
   #include <assert.h>
   #include <stdio.h>

   main(int argc, char **argv)
       enum {
           RO_OPT = 0,
       char *const token[] = {
           [RO_OPT]   = "ro",
           [RW_OPT]   = "rw",
           [NAME_OPT] = "name",
       char *subopts;
       char *value;
       int opt;

       int readonly = 0;
       int readwrite = 0;
       char *name = NULL;
       int errfnd = 0;

       while ((opt = getopt(argc, argv, "o:")) != -1) {
           switch (opt) {
           case 'o':
               subopts = optarg;
               while (*subopts != '\0' && !errfnd) {

               switch (getsubopt(&subopts, token, &value)) {
               case RO_OPT:
                   readonly = 1;

               case RW_OPT:
                   readwrite = 1;

               case NAME_OPT:
                   if (value == NULL) {
                       fprintf(stderr, "Missing value for "
                               "suboption '%s'\n", token[NAME_OPT]);
                       errfnd = 1;

                   name = value;

                   fprintf(stderr, "No match found "
                           "for token: /%s/\n", value);
                   errfnd = 1;
           if (readwrite && readonly) {
               fprintf(stderr, "Only one of '%s' and '%s' can be "
                       "specified\n", token[RO_OPT], token[RW_OPT]);
               errfnd = 1;

               errfnd = 1;

       if (errfnd || argc == 1) {
           fprintf(stderr, "\nUsage: %s -o <suboptstring>\n", argv[0]);
           fprintf(stderr, "suboptions are 'ro', 'rw', "
                   "and 'name=<value>'\n");

       /* Remainder of program... */





   This page is part of release 4.09 of the Linux  man-pages  project.   A
   description  of  the project, information about reporting bugs, and the
   latest    version    of    this    page,    can     be     found     at


Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.