158f0484fSRodney W. Grimes.\" Copyright (c) 1990, 1991, 1993 258f0484fSRodney W. Grimes.\" The Regents of the University of California. All rights reserved. 358f0484fSRodney W. Grimes.\" 458f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without 558f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions 658f0484fSRodney W. Grimes.\" are met: 758f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright 858f0484fSRodney W. Grimes.\" notice, this list of conditions and the following disclaimer. 958f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright 1058f0484fSRodney W. Grimes.\" notice, this list of conditions and the following disclaimer in the 1158f0484fSRodney W. Grimes.\" documentation and/or other materials provided with the distribution. 1258f0484fSRodney W. Grimes.\" 3. All advertising materials mentioning features or use of this software 1358f0484fSRodney W. Grimes.\" must display the following acknowledgement: 1458f0484fSRodney W. Grimes.\" This product includes software developed by the University of 1558f0484fSRodney W. Grimes.\" California, Berkeley and its contributors. 1658f0484fSRodney W. Grimes.\" 4. Neither the name of the University nor the names of its contributors 1758f0484fSRodney W. Grimes.\" may be used to endorse or promote products derived from this software 1858f0484fSRodney W. Grimes.\" without specific prior written permission. 1958f0484fSRodney W. Grimes.\" 2058f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2158f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2258f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2358f0484fSRodney W. Grimes.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2458f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2558f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2658f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2758f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2858f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2958f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3058f0484fSRodney W. Grimes.\" SUCH DAMAGE. 3158f0484fSRodney W. Grimes.\" 3258f0484fSRodney W. Grimes.\" @(#)getsubopt.3 8.1 (Berkeley) 6/9/93 3358f0484fSRodney W. Grimes.\" 3458f0484fSRodney W. Grimes.Dd June 9, 1993 3558f0484fSRodney W. Grimes.Dt GETSUBOPT 3 3658f0484fSRodney W. Grimes.Os 3758f0484fSRodney W. Grimes.Sh NAME 3858f0484fSRodney W. Grimes.Nm getsubopt 3958f0484fSRodney W. Grimes.Nd get sub options from an argument 4058f0484fSRodney W. Grimes.Sh SYNOPSIS 4158f0484fSRodney W. Grimes.Fd #include <stdlib.h> 4258f0484fSRodney W. Grimes.Vt extern char *suboptarg 4358f0484fSRodney W. Grimes.Ft int 4458f0484fSRodney W. Grimes.Fn getsubopt "char **optionp" "char * const *tokens" "char **valuep" 4558f0484fSRodney W. Grimes.Sh DESCRIPTION 4658f0484fSRodney W. GrimesThe 4758f0484fSRodney W. Grimes.Fn getsubopt 4858f0484fSRodney W. Grimesfunction 4958f0484fSRodney W. Grimesparses a string containing tokens delimited by one or more tab, space or 5058f0484fSRodney W. Grimescomma 5158f0484fSRodney W. Grimes.Pq Ql \&, 5258f0484fSRodney W. Grimescharacters. 5358f0484fSRodney W. GrimesIt is intended for use in parsing groups of option arguments provided 5458f0484fSRodney W. Grimesas part of a utility command line. 5558f0484fSRodney W. Grimes.Pp 5658f0484fSRodney W. GrimesThe argument 5758f0484fSRodney W. Grimes.Fa optionp 5858f0484fSRodney W. Grimesis a pointer to a pointer to the string. 5958f0484fSRodney W. GrimesThe argument 6058f0484fSRodney W. Grimes.Fa tokens 6158f0484fSRodney W. Grimesis a pointer to a 6258f0484fSRodney W. Grimes.Dv NULL Ns -terminated 6358f0484fSRodney W. Grimesarray of pointers to strings. 6458f0484fSRodney W. Grimes.Pp 6558f0484fSRodney W. GrimesThe 6658f0484fSRodney W. Grimes.Fn getsubopt 6758f0484fSRodney W. Grimesfunction 6858f0484fSRodney W. Grimesreturns the zero-based offset of the pointer in the 6958f0484fSRodney W. Grimes.Fa tokens 7058f0484fSRodney W. Grimesarray referencing a string which matches the first token 7158f0484fSRodney W. Grimesin the string, or, \-1 if the string contains no tokens or 7258f0484fSRodney W. Grimes.Fa tokens 7358f0484fSRodney W. Grimesdoes not contain a matching string. 7458f0484fSRodney W. Grimes.Pp 7558f0484fSRodney W. GrimesIf the token is of the form ``name=value'', the location referenced by 7658f0484fSRodney W. Grimes.Fa valuep 7758f0484fSRodney W. Grimeswill be set to point to the start of the ``value'' portion of the token. 7858f0484fSRodney W. Grimes.Pp 7958f0484fSRodney W. GrimesOn return from 8058f0484fSRodney W. Grimes.Fn getsubopt , 8158f0484fSRodney W. Grimes.Fa optionp 8258f0484fSRodney W. Grimeswill be set to point to the start of the next token in the string, 8358f0484fSRodney W. Grimesor the null at the end of the string if no more tokens are present. 8458f0484fSRodney W. GrimesThe external variable 8558f0484fSRodney W. Grimes.Fa suboptarg 8658f0484fSRodney W. Grimeswill be set to point to the start of the current token, or 8758f0484fSRodney W. Grimes.Dv NULL 8858f0484fSRodney W. Grimesif no 8958f0484fSRodney W. Grimestokens were present. 9058f0484fSRodney W. GrimesThe argument 9158f0484fSRodney W. Grimes.Fa valuep 9258f0484fSRodney W. Grimeswill be set to point to the ``value'' portion of the token, or 9358f0484fSRodney W. Grimes.Dv NULL 9458f0484fSRodney W. Grimesif no ``value'' portion was present. 9558f0484fSRodney W. Grimes.Sh EXAMPLE 9658f0484fSRodney W. Grimes.Bd -literal -compact 9758f0484fSRodney W. Grimeschar *tokens[] = { 9858f0484fSRodney W. Grimes #define ONE 0 9958f0484fSRodney W. Grimes "one", 10058f0484fSRodney W. Grimes #define TWO 1 10158f0484fSRodney W. Grimes "two", 10258f0484fSRodney W. Grimes NULL 10358f0484fSRodney W. Grimes}; 10458f0484fSRodney W. Grimes 10558f0484fSRodney W. Grimes\&... 10658f0484fSRodney W. Grimes 10758f0484fSRodney W. Grimesextern char *optarg, *suboptarg; 10858f0484fSRodney W. Grimeschar *options, *value; 10958f0484fSRodney W. Grimes 11058f0484fSRodney W. Grimeswhile ((ch = getopt(argc, argv, "ab:")) != \-1) { 11158f0484fSRodney W. Grimes switch(ch) { 11258f0484fSRodney W. Grimes case 'a': 11358f0484fSRodney W. Grimes /* process ``a'' option */ 11458f0484fSRodney W. Grimes break; 11558f0484fSRodney W. Grimes case 'b': 11658f0484fSRodney W. Grimes options = optarg; 11758f0484fSRodney W. Grimes while (*options) { 11858f0484fSRodney W. Grimes switch(getsubopt(&options, tokens, &value)) { 11958f0484fSRodney W. Grimes case ONE: 12058f0484fSRodney W. Grimes /* process ``one'' sub option */ 12158f0484fSRodney W. Grimes break; 12258f0484fSRodney W. Grimes case TWO: 12358f0484fSRodney W. Grimes /* process ``two'' sub option */ 12458f0484fSRodney W. Grimes if (!value) 12558f0484fSRodney W. Grimes error("no value for two"); 12658f0484fSRodney W. Grimes i = atoi(value); 12758f0484fSRodney W. Grimes break; 12858f0484fSRodney W. Grimes case \-1: 12958f0484fSRodney W. Grimes if (suboptarg) 13058f0484fSRodney W. Grimes error("illegal sub option %s", 13158f0484fSRodney W. Grimes suboptarg); 13258f0484fSRodney W. Grimes else 13358f0484fSRodney W. Grimes error("missing sub option"); 13458f0484fSRodney W. Grimes break; 13558f0484fSRodney W. Grimes } 13658f0484fSRodney W. Grimes break; 13758f0484fSRodney W. Grimes } 13858f0484fSRodney W. Grimes.Ed 13958f0484fSRodney W. Grimes.Sh SEE ALSO 14058f0484fSRodney W. Grimes.Xr getopt 3 , 14158f0484fSRodney W. Grimes.Xr strsep 3 14258f0484fSRodney W. Grimes.Sh HISTORY 14358f0484fSRodney W. GrimesThe 14458f0484fSRodney W. Grimes.Fn getsubopt 1457bdf80e5SMike Pritchardfunction first appeared in 1467bdf80e5SMike Pritchard.Bx 4.4 . 147