technical/api-parse-options.html

   1 <!DOCTYPE html>
   2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   3 <head>
   4 <meta charset="UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
   7 <meta name="generator" content="Asciidoctor 2.0.20"/>
   8 <title>parse-options API</title>
   9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
  10 <style>
  11 /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
  12 /* Uncomment the following line when using as a custom stylesheet */
  13 /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
  14 html{font-family:sans-serif;-webkit-text-size-adjust:100%}
  15 a{background:none}
  16 a:focus{outline:thin dotted}
  17 a:active,a:hover{outline:0}
  18 h1{font-size:2em;margin:.67em 0}
  19 b,strong{font-weight:bold}
  20 abbr{font-size:.9em}
  21 abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
  22 dfn{font-style:italic}
  23 hr{height:0}
  24 mark{background:#ff0;color:#000}
  25 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  26 pre{white-space:pre-wrap}
  27 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  28 small{font-size:80%}
  29 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  30 sup{top:-.5em}
  31 sub{bottom:-.25em}
  32 img{border:0}
  33 svg:not(:root){overflow:hidden}
  34 figure{margin:0}
  35 audio,video{display:inline-block}
  36 audio:not([controls]){display:none;height:0}
  37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  38 legend{border:0;padding:0}
  39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  40 button,input{line-height:normal}
  41 button,select{text-transform:none}
  42 button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
  43 button[disabled],html input[disabled]{cursor:default}
  44 input[type=checkbox],input[type=radio]{padding:0}
  45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  46 textarea{overflow:auto;vertical-align:top}
  47 table{border-collapse:collapse;border-spacing:0}
  48 *,::before,::after{box-sizing:border-box}
  49 html,body{font-size:100%}
  50 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  51 a:hover{cursor:pointer}
  52 img,object,embed{max-width:100%;height:auto}
  53 object,embed{height:100%}
  54 img{-ms-interpolation-mode:bicubic}
  55 .left{float:left!important}
  56 .right{float:right!important}
  57 .text-left{text-align:left!important}
  58 .text-right{text-align:right!important}
  59 .text-center{text-align:center!important}
  60 .text-justify{text-align:justify!important}
  61 .hide{display:none}
  62 img,object,svg{display:inline-block;vertical-align:middle}
  63 textarea{height:auto;min-height:50px}
  64 select{width:100%}
  65 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  66 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
  67 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  68 a:hover,a:focus{color:#1d4b8f}
  69 a img{border:0}
  70 p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  71 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  72 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  73 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  74 h1{font-size:2.125em}
  75 h2{font-size:1.6875em}
  76 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  77 h4,h5{font-size:1.125em}
  78 h6{font-size:1em}
  79 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
  80 em,i{font-style:italic;line-height:inherit}
  81 strong,b{font-weight:bold;line-height:inherit}
  82 small{font-size:60%;line-height:inherit}
  83 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  84 ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  85 ul,ol{margin-left:1.5em}
  86 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
  87 ul.circle{list-style-type:circle}
  88 ul.disc{list-style-type:disc}
  89 ul.square{list-style-type:square}
  90 ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
  91 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  92 dl dt{margin-bottom:.3125em;font-weight:bold}
  93 dl dd{margin-bottom:1.25em}
  94 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
  95 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
  96 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
  97 h1{font-size:2.75em}
  98 h2{font-size:2.3125em}
  99 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 100 h4{font-size:1.4375em}}
 101 table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
 102 table thead,table tfoot{background:#f7f8f7}
 103 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
 104 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 105 table tr.even,table tr.alt{background:#f8f8f7}
 106 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
 107 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 108 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
 109 .center{margin-left:auto;margin-right:auto}
 110 .stretch{width:100%}
 111 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
 112 .clearfix::after,.float-group::after{clear:both}
 113 :not(pre).nobreak{word-wrap:normal}
 114 :not(pre).nowrap{white-space:nowrap}
 115 :not(pre).pre-wrap{white-space:pre-wrap}
 116 :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
 117 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
 118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
 119 pre>code{display:block}
 120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
 121 em em{font-style:normal}
 122 strong strong{font-weight:400}
 123 .keyseq{color:rgba(51,51,51,.8)}
 124 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
 125 .keyseq kbd:first-child{margin-left:0}
 126 .keyseq kbd:last-child{margin-right:0}
 127 .menuseq,.menuref{color:#000}
 128 .menuseq b:not(.caret),.menuref{font-weight:inherit}
 129 .menuseq{word-spacing:-.02em}
 130 .menuseq b.caret{font-size:1.25em;line-height:.8}
 131 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
 132 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
 133 b.button::before{content:"[";padding:0 3px 0 2px}
 134 b.button::after{content:"]";padding:0 2px 0 3px}
 135 p a>code:hover{color:rgba(0,0,0,.9)}
 136 #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
 137 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
 138 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
 139 #content{margin-top:1.25em}
 140 #content::before{content:none}
 141 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 142 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
 143 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
 144 #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
 145 #header .details span:first-child{margin-left:-.125em}
 146 #header .details span.email a{color:rgba(0,0,0,.85)}
 147 #header .details br{display:none}
 148 #header .details br+span::before{content:"\00a0\2013\00a0"}
 149 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
 150 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
 151 #header #revnumber{text-transform:capitalize}
 152 #header #revnumber::after{content:"\00a0"}
 153 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
 154 #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
 155 #toc>ul{margin-left:.125em}
 156 #toc ul.sectlevel0>li>a{font-style:italic}
 157 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
 158 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
 159 #toc li{line-height:1.3334;margin-top:.3334em}
 160 #toc a{text-decoration:none}
 161 #toc a:active{text-decoration:underline}
 162 #toctitle{color:#7a2518;font-size:1.2em}
 163 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
 164 body.toc2{padding-left:15em;padding-right:0}
 165 #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 166 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 167 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 168 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 169 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 170 body.toc2.toc-right{padding-left:0;padding-right:15em}
 171 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
 172 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 173 #toc.toc2{width:20em}
 174 #toc.toc2 #toctitle{font-size:1.375em}
 175 #toc.toc2>ul{font-size:.95em}
 176 #toc.toc2 ul ul{padding-left:1.25em}
 177 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 178 #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
 179 #content #toc>:first-child{margin-top:0}
 180 #content #toc>:last-child{margin-bottom:0}
 181 #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
 182 #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
 183 #content{margin-bottom:.625em}
 184 .sect1{padding-bottom:.625em}
 185 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
 186 .sect1{padding-bottom:1.25em}}
 187 .sect1:last-child{padding-bottom:0}
 188 .sect1+.sect1{border-top:1px solid #e7e7e9}
 189 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
 190 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
 191 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
 192 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
 193 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
 194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 195 details{margin-left:1.25rem}
 196 details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
 197 details>summary::-webkit-details-marker{display:none}
 198 details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
 199 details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
 200 details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
 201 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
 202 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
 203 .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
 204 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 205 .admonitionblock>table td.icon{text-align:center;width:80px}
 206 .admonitionblock>table td.icon img{max-width:none}
 207 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 208 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
 209 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 210 .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
 211 .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
 212 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 213 .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
 214 .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
 215 .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
 216 @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
 217 @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
 218 .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
 219 .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
 220 .listingblock>.content{position:relative}
 221 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
 222 .listingblock:hover code[data-lang]::before{display:block}
 223 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
 224 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
 225 .listingblock pre.highlightjs{padding:0}
 226 .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
 227 .listingblock pre.prettyprint{border-width:0}
 228 .prettyprint{background:#f7f7f8}
 229 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
 230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
 231 pre.prettyprint li code[data-lang]::before{opacity:1}
 232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
 233 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
 235 table.linenotable td.code{padding-left:.75em}
 236 table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
 237 pre.pygments span.linenos{display:inline-block;margin-right:.75em}
 238 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 239 .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
 240 .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
 241 .quoteblock blockquote{margin:0;padding:0;border:0}
 242 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
 243 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 244 .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
 245 .verseblock{margin:0 1em 1.25em}
 246 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
 247 .verseblock pre strong{font-weight:400}
 248 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 249 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 250 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 251 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 252 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
 253 .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
 254 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
 255 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
 256 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
 257 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
 258 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
 259 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
 260 p.tableblock:last-child{margin-bottom:0}
 261 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
 262 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
 263 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 264 table.grid-all>*>tr>*{border-width:1px}
 265 table.grid-cols>*>tr>*{border-width:0 1px}
 266 table.grid-rows>*>tr>*{border-width:1px 0}
 267 table.frame-all{border-width:1px}
 268 table.frame-ends{border-width:1px 0}
 269 table.frame-sides{border-width:0 1px}
 270 table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
 271 table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
 272 table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
 273 table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
 274 table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
 275 th.halign-left,td.halign-left{text-align:left}
 276 th.halign-right,td.halign-right{text-align:right}
 277 th.halign-center,td.halign-center{text-align:center}
 278 th.valign-top,td.valign-top{vertical-align:top}
 279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 280 th.valign-middle,td.valign-middle{vertical-align:middle}
 281 table thead th,table tfoot th{font-weight:bold}
 282 tbody tr th{background:#f7f8f7}
 283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 284 p.tableblock>code:only-child{background:none;padding:0}
 285 p.tableblock{font-size:1em}
 286 ol{margin-left:1.75em}
 287 ul li ol{margin-left:1.5em}
 288 dl dd{margin-left:1.125em}
 289 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 293 ul.unstyled,ol.unstyled{margin-left:0}
 294 li>p:empty:only-child::before{content:"";display:inline-block}
 295 ul.checklist>li>p:first-child{margin-left:-1em}
 296 ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
 297 ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
 298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
 299 ul.inline>li{margin-left:1.25em}
 300 .unstyled dl dt{font-weight:400;font-style:normal}
 301 ol.arabic{list-style-type:decimal}
 302 ol.decimal{list-style-type:decimal-leading-zero}
 303 ol.loweralpha{list-style-type:lower-alpha}
 304 ol.upperalpha{list-style-type:upper-alpha}
 305 ol.lowerroman{list-style-type:lower-roman}
 306 ol.upperroman{list-style-type:upper-roman}
 307 ol.lowergreek{list-style-type:lower-greek}
 308 .hdlist>table,.colist>table{border:0;background:none}
 309 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 310 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 311 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 312 td.hdlist2{word-wrap:anywhere}
 313 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 314 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
 315 .colist td:not([class]):first-child img{max-width:none}
 316 .colist td:not([class]):last-child{padding:.25em 0}
 317 .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
 318 .imageblock.left{margin:.25em .625em 1.25em 0}
 319 .imageblock.right{margin:.25em 0 1.25em .625em}
 320 .imageblock>.title{margin-bottom:0}
 321 .imageblock.thumb,.imageblock.th{border-width:6px}
 322 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 323 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 324 .image.left{margin-right:.625em}
 325 .image.right{margin-left:.625em}
 326 a.image{text-decoration:none;display:inline-block}
 327 a.image object{pointer-events:none}
 328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 329 sup.footnote a,sup.footnoteref a{text-decoration:none}
 330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 331 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 332 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
 333 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
 334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
 335 #footnotes .footnote:last-of-type{margin-bottom:0}
 336 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 337 div.unbreakable{page-break-inside:avoid}
 338 .big{font-size:larger}
 339 .small{font-size:smaller}
 340 .underline{text-decoration:underline}
 341 .overline{text-decoration:overline}
 342 .line-through{text-decoration:line-through}
 343 .aqua{color:#00bfbf}
 344 .aqua-background{background:#00fafa}
 345 .black{color:#000}
 346 .black-background{background:#000}
 347 .blue{color:#0000bf}
 348 .blue-background{background:#0000fa}
 349 .fuchsia{color:#bf00bf}
 350 .fuchsia-background{background:#fa00fa}
 351 .gray{color:#606060}
 352 .gray-background{background:#7d7d7d}
 353 .green{color:#006000}
 354 .green-background{background:#007d00}
 355 .lime{color:#00bf00}
 356 .lime-background{background:#00fa00}
 357 .maroon{color:#600000}
 358 .maroon-background{background:#7d0000}
 359 .navy{color:#000060}
 360 .navy-background{background:#00007d}
 361 .olive{color:#606000}
 362 .olive-background{background:#7d7d00}
 363 .purple{color:#600060}
 364 .purple-background{background:#7d007d}
 365 .red{color:#bf0000}
 366 .red-background{background:#fa0000}
 367 .silver{color:#909090}
 368 .silver-background{background:#bcbcbc}
 369 .teal{color:#006060}
 370 .teal-background{background:#007d7d}
 371 .white{color:#bfbfbf}
 372 .white-background{background:#fafafa}
 373 .yellow{color:#bfbf00}
 374 .yellow-background{background:#fafa00}
 375 span.icon>.fa{cursor:default}
 376 a span.icon>.fa{cursor:inherit}
 377 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 378 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
 379 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 380 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
 381 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
 382 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
 383 .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
 384 .conum[data-value] *{color:#fff!important}
 385 .conum[data-value]+b{display:none}
 386 .conum[data-value]::after{content:attr(data-value)}
 387 pre .conum[data-value]{position:relative;top:-.125em}
 388 b.conum *{color:inherit!important}
 389 .conum:not([data-value]):empty{display:none}
 390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
 392 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
 394 p{margin-bottom:1.25rem}
 395 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 396 .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 397 .print-only{display:none!important}
 398 @page{margin:1.25cm .75cm}
 399 @media print{*{box-shadow:none!important;text-shadow:none!important}
 400 html{font-size:80%}
 401 a{color:inherit!important;text-decoration:underline!important}
 402 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 403 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 404 abbr[title]{border-bottom:1px dotted}
 405 abbr[title]::after{content:" (" attr(title) ")"}
 406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 407 thead{display:table-header-group}
 408 svg{max-width:100%}
 409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 410 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 411 #header,#content,#footnotes,#footer{max-width:none}
 412 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 413 #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
 414 body.book #header{text-align:center}
 415 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
 416 body.book #header .details{border:0!important;display:block;padding:0!important}
 417 body.book #header .details span:first-child{margin-left:0!important}
 418 body.book #header .details br{display:block}
 419 body.book #header .details br+span::before{content:none!important}
 420 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 421 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 422 .listingblock code[data-lang]::before{display:block}
 423 #footer{padding:0 .9375em}
 424 .hide-on-print{display:none!important}
 425 .print-only{display:block!important}
 426 .hide-for-print{display:none!important}
 427 .show-for-print{display:inherit!important}}
 428 @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
 429 .sect1{padding:0!important}
 430 .sect1+.sect1{border:0}
 431 #footer{background:none}
 432 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
 433 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
 434 </style>
 435 </head>
 436 <body class="article">
 437 <div id="header">
 438 <h1>parse-options API</h1>
 439 <div class="details">
 440 <span id="revdate">2024-09-10</span>
 441 </div>
 442 </div>
 443 <div id="content">
 444 <div id="preamble">
 445 <div class="sectionbody">
 446 <div class="paragraph">
 447 <p>The parse-options API is used to parse and massage options in Git
 448 and to provide a usage help with consistent look.</p>
 449 </div>
 450 </div>
 451 </div>
 452 <div class="sect1">
 453 <h2 id="_basics">Basics</h2>
 454 <div class="sectionbody">
 455 <div class="paragraph">
 456 <p>The argument vector <code>argv[]</code> may usually contain mandatory or optional
 457 <em>non-option arguments</em>, e.g. a filename or a branch, <em>options</em>, and
 458 <em>subcommands</em>.
 459 Options are optional arguments that start with a dash and
 460 that allow to change the behavior of a command.</p>
 461 </div>
 462 <div class="ulist">
 463 <ul>
 464 <li>
 465 <p>There are basically three types of options:
 466 <em>boolean</em> options,
 467 options with (mandatory) <em>arguments</em> and
 468 options with <em>optional arguments</em>
 469 (i.e. a boolean option that can be adjusted).</p>
 470 </li>
 471 <li>
 472 <p>There are basically two forms of options:
 473 <em>Short options</em> consist of one dash (<code>-</code>) and one alphanumeric
 474 character.
 475 <em>Long options</em> begin with two dashes (<code>--</code>) and some
 476 alphanumeric characters.</p>
 477 </li>
 478 <li>
 479 <p>Options are case-sensitive.
 480 Please define <em>lower-case long options</em> only.</p>
 481 </li>
 482 </ul>
 483 </div>
 484 <div class="paragraph">
 485 <p>The parse-options API allows:</p>
 486 </div>
 487 <div class="ulist">
 488 <ul>
 489 <li>
 490 <p><em>stuck</em> and <em>separate form</em> of options with arguments.
 491 <code>-oArg</code> is stuck, <code>-o Arg</code> is separate form.
 492 <code>--option=Arg</code> is stuck, <code>--option Arg</code> is separate form.</p>
 493 </li>
 494 <li>
 495 <p>Long options may be <em>abbreviated</em>, as long as the abbreviation
 496 is unambiguous.</p>
 497 </li>
 498 <li>
 499 <p>Short options may be bundled, e.g. <code>-a -b</code> can be specified as <code>-ab</code>.</p>
 500 </li>
 501 <li>
 502 <p>Boolean long options can be <em>negated</em> (or <em>unset</em>) by prepending
 503 <code>no-</code>, e.g. <code>--no-abbrev</code> instead of <code>--abbrev</code>. Conversely,
 504 options that begin with <code>no-</code> can be <em>negated</em> by removing it.
 505 Other long options can be unset (e.g., set string to NULL, set
 506 integer to 0) by prepending <code>no-</code>.</p>
 507 </li>
 508 <li>
 509 <p>Options and non-option arguments can clearly be separated using the <code>--</code>
 510 option, e.g. <code>-a -b --option -- --this-is-a-file</code> indicates that
 511 <code>--this-is-a-file</code> must not be processed as an option.</p>
 512 </li>
 513 </ul>
 514 </div>
 515 <div class="paragraph">
 516 <p>Subcommands are special in a couple of ways:</p>
 517 </div>
 518 <div class="ulist">
 519 <ul>
 520 <li>
 521 <p>Subcommands only have long form, and they have no double dash prefix, no
 522 negated form, and no description, and they don&#8217;t take any arguments, and
 523 can&#8217;t be abbreviated.</p>
 524 </li>
 525 <li>
 526 <p>There must be exactly one subcommand among the arguments, or zero if the
 527 command has a default operation mode.</p>
 528 </li>
 529 <li>
 530 <p>All arguments following the subcommand are considered to be arguments of
 531 the subcommand, and, conversely, arguments meant for the subcommand may
 532 not precede the subcommand.</p>
 533 </li>
 534 </ul>
 535 </div>
 536 <div class="paragraph">
 537 <p>Therefore, if the options array contains at least one subcommand and
 538 <code>parse_options()</code> encounters the first dashless argument, it will either:</p>
 539 </div>
 540 <div class="ulist">
 541 <ul>
 542 <li>
 543 <p>stop and return, if that dashless argument is a known subcommand, setting
 544 <code>value</code> to the function pointer associated with that subcommand, storing
 545 the name of the subcommand in argv[0], and leaving the rest of the
 546 arguments unprocessed, or</p>
 547 </li>
 548 <li>
 549 <p>stop and return, if it was invoked with the <code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code>
 550 flag and that dashless argument doesn&#8217;t match any subcommands, leaving
 551 <code>value</code> unchanged and the rest of the arguments unprocessed, or</p>
 552 </li>
 553 <li>
 554 <p>show error and usage, and abort.</p>
 555 </li>
 556 </ul>
 557 </div>
 558 </div>
 559 </div>
 560 <div class="sect1">
 561 <h2 id="_steps_to_parse_options">Steps to parse options</h2>
 562 <div class="sectionbody">
 563 <div class="olist arabic">
 564 <ol class="arabic">
 565 <li>
 566 <p><code>#include "parse-options.h"</code></p>
 567 </li>
 568 <li>
 569 <p>define a NULL-terminated
 570 <code>static const char * const builtin_foo_usage[]</code> array
 571 containing alternative usage strings</p>
 572 </li>
 573 <li>
 574 <p>define <code>builtin_foo_options</code> array as described below
 575 in section <em>Data Structure</em>.</p>
 576 </li>
 577 <li>
 578 <p>in <code>cmd_foo(int argc, const char **argv, const char *prefix)</code>
 579 call</p>
 580 <div class="literalblock">
 581 <div class="content">
 582 <pre>argc = parse_options(argc, argv, prefix, builtin_foo_options, builtin_foo_usage, flags);</pre>
 583 </div>
 584 </div>
 585 <div class="paragraph">
 586 <p><code>parse_options()</code> will filter out the processed options of <code>argv[]</code> and leave the
 587 non-option arguments in <code>argv[]</code>.
 588 <code>argc</code> is updated appropriately because of the assignment.</p>
 589 </div>
 590 <div class="paragraph">
 591 <p>You can also pass NULL instead of a usage array as the fifth parameter of
 592 parse_options(), to avoid displaying a help screen with usage info and
 593 option list.  This should only be done if necessary, e.g. to implement
 594 a limited parser for only a subset of the options that needs to be run
 595 before the full parser, which in turn shows the full help message.</p>
 596 </div>
 597 <div class="paragraph">
 598 <p>Flags are the bitwise-or of:</p>
 599 </div>
 600 <div class="dlist">
 601 <dl>
 602 <dt class="hdlist1"><code>PARSE_OPT_KEEP_DASHDASH</code></dt>
 603 <dd>
 604 <p>Keep the <code>--</code> that usually separates options from
 605 non-option arguments.</p>
 606 </dd>
 607 <dt class="hdlist1"><code>PARSE_OPT_STOP_AT_NON_OPTION</code></dt>
 608 <dd>
 609 <p>Usually the whole argument vector is massaged and reordered.
 610 Using this flag, processing is stopped at the first non-option
 611 argument.</p>
 612 </dd>
 613 <dt class="hdlist1"><code>PARSE_OPT_KEEP_ARGV0</code></dt>
 614 <dd>
 615 <p>Keep the first argument, which contains the program name.  It&#8217;s
 616 removed from argv[] by default.</p>
 617 </dd>
 618 <dt class="hdlist1"><code>PARSE_OPT_KEEP_UNKNOWN_OPT</code></dt>
 619 <dd>
 620 <p>Keep unknown options instead of erroring out.  This doesn&#8217;t
 621 work for all combinations of arguments as users might expect
 622 it to do.  E.g. if the first argument in <code>--unknown --known</code>
 623 takes a value (which we can&#8217;t know), the second one is
 624 mistakenly interpreted as a known option.  Similarly, if
 625 <code>PARSE_OPT_STOP_AT_NON_OPTION</code> is set, the second argument in
 626 <code>--unknown value</code> will be mistakenly interpreted as a
 627 non-option, not as a value belonging to the unknown option,
 628 the parser early.  That&#8217;s why parse_options() errors out if
 629 both options are set.
 630 Note that non-option arguments are always kept, even without
 631 this flag.</p>
 632 </dd>
 633 <dt class="hdlist1"><code>PARSE_OPT_NO_INTERNAL_HELP</code></dt>
 634 <dd>
 635 <p>By default, parse_options() handles <code>-h</code>, <code>--help</code> and
 636 <code>--help-all</code> internally, by showing a help screen.  This option
 637 turns it off and allows one to add custom handlers for these
 638 options, or to just leave them unknown.</p>
 639 </dd>
 640 <dt class="hdlist1"><code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code></dt>
 641 <dd>
 642 <p>Don&#8217;t error out when no subcommand is specified.</p>
 643 </dd>
 644 </dl>
 645 </div>
 646 </li>
 647 </ol>
 648 </div>
 649 <div class="paragraph">
 650 <p>Note that <code>PARSE_OPT_STOP_AT_NON_OPTION</code> is incompatible with subcommands;
 651 while <code>PARSE_OPT_KEEP_DASHDASH</code> and <code>PARSE_OPT_KEEP_UNKNOWN_OPT</code> can only be
 652 used with subcommands when combined with <code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code>.</p>
 653 </div>
 654 </div>
 655 </div>
 656 <div class="sect1">
 657 <h2 id="_data_structure">Data Structure</h2>
 658 <div class="sectionbody">
 659 <div class="paragraph">
 660 <p>The main data structure is an array of the <code>option</code> struct,
 661 say <code>static struct option builtin_add_options[]</code>.
 662 There are some macros to easily define options:</p>
 663 </div>
 664 <div class="dlist">
 665 <dl>
 666 <dt class="hdlist1"><code>OPT__ABBREV(&amp;int_var)</code></dt>
 667 <dd>
 668 <p>Add <code>--abbrev[=&lt;n&gt;]</code>.</p>
 669 </dd>
 670 <dt class="hdlist1"><code>OPT__COLOR(&amp;int_var, description)</code></dt>
 671 <dd>
 672 <p>Add <code>--color[=&lt;when&gt;]</code> and <code>--no-color</code>.</p>
 673 </dd>
 674 <dt class="hdlist1"><code>OPT__DRY_RUN(&amp;int_var, description)</code></dt>
 675 <dd>
 676 <p>Add <code>-n, --dry-run</code>.</p>
 677 </dd>
 678 <dt class="hdlist1"><code>OPT__FORCE(&amp;int_var, description)</code></dt>
 679 <dd>
 680 <p>Add <code>-f, --force</code>.</p>
 681 </dd>
 682 <dt class="hdlist1"><code>OPT__QUIET(&amp;int_var, description)</code></dt>
 683 <dd>
 684 <p>Add <code>-q, --quiet</code>.</p>
 685 </dd>
 686 <dt class="hdlist1"><code>OPT__VERBOSE(&amp;int_var, description)</code></dt>
 687 <dd>
 688 <p>Add <code>-v, --verbose</code>.</p>
 689 </dd>
 690 <dt class="hdlist1"><code>OPT_GROUP(description)</code></dt>
 691 <dd>
 692 <p>Start an option group. <code>description</code> is a short string that
 693 describes the group or an empty string.
 694 Start the description with an upper-case letter.</p>
 695 </dd>
 696 <dt class="hdlist1"><code>OPT_BOOL(short, long, &amp;int_var, description)</code></dt>
 697 <dd>
 698 <p>Introduce a boolean option. <code>int_var</code> is set to one with
 699 <code>--option</code> and set to zero with <code>--no-option</code>.</p>
 700 </dd>
 701 <dt class="hdlist1"><code>OPT_COUNTUP(short, long, &amp;int_var, description)</code></dt>
 702 <dd>
 703 <p>Introduce a count-up option.
 704 Each use of <code>--option</code> increments <code>int_var</code>, starting from zero
 705 (even if initially negative), and <code>--no-option</code> resets it to
 706 zero. To determine if <code>--option</code> or <code>--no-option</code> was encountered at
 707 all, initialize <code>int_var</code> to a negative value, and if it is still
 708 negative after parse_options(), then neither <code>--option</code> nor
 709 <code>--no-option</code> was seen.</p>
 710 </dd>
 711 <dt class="hdlist1"><code>OPT_BIT(short, long, &amp;int_var, description, mask)</code></dt>
 712 <dd>
 713 <p>Introduce a boolean option.
 714 If used, <code>int_var</code> is bitwise-ored with <code>mask</code>.</p>
 715 </dd>
 716 <dt class="hdlist1"><code>OPT_NEGBIT(short, long, &amp;int_var, description, mask)</code></dt>
 717 <dd>
 718 <p>Introduce a boolean option.
 719 If used, <code>int_var</code> is bitwise-anded with the inverted <code>mask</code>.</p>
 720 </dd>
 721 <dt class="hdlist1"><code>OPT_SET_INT(short, long, &amp;int_var, description, integer)</code></dt>
 722 <dd>
 723 <p>Introduce an integer option.
 724 <code>int_var</code> is set to <code>integer</code> with <code>--option</code>, and
 725 reset to zero with <code>--no-option</code>.</p>
 726 </dd>
 727 <dt class="hdlist1"><code>OPT_STRING(short, long, &amp;str_var, arg_str, description)</code></dt>
 728 <dd>
 729 <p>Introduce an option with string argument.
 730 The string argument is put into <code>str_var</code>.</p>
 731 </dd>
 732 <dt class="hdlist1"><code>OPT_STRING_LIST(short, long, &amp;struct string_list, arg_str, description)</code></dt>
 733 <dd>
 734 <p>Introduce an option with string argument.
 735 The string argument is stored as an element in <code>string_list</code>.
 736 Use of <code>--no-option</code> will clear the list of preceding values.</p>
 737 </dd>
 738 <dt class="hdlist1"><code>OPT_INTEGER(short, long, &amp;int_var, description)</code></dt>
 739 <dd>
 740 <p>Introduce an option with integer argument.
 741 The integer is put into <code>int_var</code>.</p>
 742 </dd>
 743 <dt class="hdlist1"><code>OPT_MAGNITUDE(short, long, &amp;unsigned_long_var, description)</code></dt>
 744 <dd>
 745 <p>Introduce an option with a size argument. The argument must be a
 746 non-negative integer and may include a suffix of <em>k</em>, <em>m</em> or <em>g</em> to
 747 scale the provided value by 1024, 1024^2 or 1024^3 respectively.
 748 The scaled value is put into <code>unsigned_long_var</code>.</p>
 749 </dd>
 750 <dt class="hdlist1"><code>OPT_EXPIRY_DATE(short, long, &amp;timestamp_t_var, description)</code></dt>
 751 <dd>
 752 <p>Introduce an option with expiry date argument, see <code>parse_expiry_date()</code>.
 753 The timestamp is put into <code>timestamp_t_var</code>.</p>
 754 </dd>
 755 <dt class="hdlist1"><code>OPT_CALLBACK(short, long, &amp;var, arg_str, description, func_ptr)</code></dt>
 756 <dd>
 757 <p>Introduce an option with argument.
 758 The argument will be fed into the function given by <code>func_ptr</code>
 759 and the result will be put into <code>var</code>.
 760 See <em>Option Callbacks</em> below for a more elaborate description.</p>
 761 </dd>
 762 <dt class="hdlist1"><code>OPT_FILENAME(short, long, &amp;var, description)</code></dt>
 763 <dd>
 764 <p>Introduce an option with a filename argument.
 765 The filename will be prefixed by passing the filename along with
 766 the prefix argument of <code>parse_options()</code> to <code>prefix_filename()</code>.</p>
 767 </dd>
 768 <dt class="hdlist1"><code>OPT_NUMBER_CALLBACK(&amp;var, description, func_ptr)</code></dt>
 769 <dd>
 770 <p>Recognize numerical options like -123 and feed the integer as
 771 if it was an argument to the function given by <code>func_ptr</code>.
 772 The result will be put into <code>var</code>.  There can be only one such
 773 option definition.  It cannot be negated and it takes no
 774 arguments.  Short options that happen to be digits take
 775 precedence over it.</p>
 776 </dd>
 777 <dt class="hdlist1"><code>OPT_COLOR_FLAG(short, long, &amp;int_var, description)</code></dt>
 778 <dd>
 779 <p>Introduce an option that takes an optional argument that can
 780 have one of three values: "always", "never", or "auto".  If the
 781 argument is not given, it defaults to "always".  The <code>--no-</code> form
 782 works like <code>--long=never</code>; it cannot take an argument.  If
 783 "always", set <code>int_var</code> to 1; if "never", set <code>int_var</code> to 0; if
 784 "auto", set <code>int_var</code> to 1 if stdout is a tty or a pager,
 785 0 otherwise.</p>
 786 </dd>
 787 <dt class="hdlist1"><code>OPT_NOOP_NOARG(short, long)</code></dt>
 788 <dd>
 789 <p>Introduce an option that has no effect and takes no arguments.
 790 Use it to hide deprecated options that are still to be recognized
 791 and ignored silently.</p>
 792 </dd>
 793 <dt class="hdlist1"><code>OPT_PASSTHRU(short, long, &amp;char_var, arg_str, description, flags)</code></dt>
 794 <dd>
 795 <p>Introduce an option that will be reconstructed into a char* string,
 796 which must be initialized to NULL. This is useful when you need to
 797 pass the command-line option to another command. Any previous value
 798 will be overwritten, so this should only be used for options where
 799 the last one specified on the command line wins.</p>
 800 </dd>
 801 <dt class="hdlist1"><code>OPT_PASSTHRU_ARGV(short, long, &amp;strvec_var, arg_str, description, flags)</code></dt>
 802 <dd>
 803 <p>Introduce an option where all instances of it on the command-line will
 804 be reconstructed into a strvec. This is useful when you need to
 805 pass the command-line option, which can be specified multiple times,
 806 to another command.</p>
 807 </dd>
 808 <dt class="hdlist1"><code>OPT_CMDMODE(short, long, &amp;int_var, description, enum_val)</code></dt>
 809 <dd>
 810 <p>Define an "operation mode" option, only one of which in the same
 811 group of "operating mode" options that share the same <code>int_var</code>
 812 can be given by the user. <code>int_var</code> is set to <code>enum_val</code> when the
 813 option is used, but an error is reported if other "operating mode"
 814 option has already set its value to the same <code>int_var</code>.
 815 In new commands consider using subcommands instead.</p>
 816 </dd>
 817 <dt class="hdlist1"><code>OPT_SUBCOMMAND(long, &amp;fn_ptr, subcommand_fn)</code></dt>
 818 <dd>
 819 <p>Define a subcommand.  <code>subcommand_fn</code> is put into <code>fn_ptr</code> when
 820 this subcommand is used.</p>
 821 </dd>
 822 </dl>
 823 </div>
 824 <div class="paragraph">
 825 <p>The last element of the array must be <code>OPT_END()</code>.</p>
 826 </div>
 827 <div class="paragraph">
 828 <p>If not stated otherwise, interpret the arguments as follows:</p>
 829 </div>
 830 <div class="ulist">
 831 <ul>
 832 <li>
 833 <p><code>short</code> is a character for the short option
 834 (e.g. <code>'e'</code> for <code>-e</code>, use <code>0</code> to omit),</p>
 835 </li>
 836 <li>
 837 <p><code>long</code> is a string for the long option
 838 (e.g. <code>"example"</code> for <code>--example</code>, use <code>NULL</code> to omit),</p>
 839 </li>
 840 <li>
 841 <p><code>int_var</code> is an integer variable,</p>
 842 </li>
 843 <li>
 844 <p><code>str_var</code> is a string variable (<code>char *</code>),</p>
 845 </li>
 846 <li>
 847 <p><code>arg_str</code> is the string that is shown as argument
 848 (e.g. <code>"branch"</code> will result in <code>&lt;branch&gt;</code>).
 849 If set to <code>NULL</code>, three dots (<code>...</code>) will be displayed.</p>
 850 </li>
 851 <li>
 852 <p><code>description</code> is a short string to describe the effect of the option.
 853 It shall begin with a lower-case letter and a full stop (<code>.</code>) shall be
 854 omitted at the end.</p>
 855 </li>
 856 </ul>
 857 </div>
 858 </div>
 859 </div>
 860 <div class="sect1">
 861 <h2 id="_option_callbacks">Option Callbacks</h2>
 862 <div class="sectionbody">
 863 <div class="paragraph">
 864 <p>The function must be defined in this form:</p>
 865 </div>
 866 <div class="literalblock">
 867 <div class="content">
 868 <pre>int func(const struct option *opt, const char *arg, int unset)</pre>
 869 </div>
 870 </div>
 871 <div class="paragraph">
 872 <p>The callback mechanism is as follows:</p>
 873 </div>
 874 <div class="ulist">
 875 <ul>
 876 <li>
 877 <p>Inside <code>func</code>, the only interesting member of the structure
 878 given by <code>opt</code> is the void pointer <code>opt-&gt;value</code>.
 879 <code>*opt-&gt;value</code> will be the value that is saved into <code>var</code>, if you
 880 use <code>OPT_CALLBACK()</code>.
 881 For example, do <code>*(unsigned long *)opt-&gt;value = 42;</code> to get 42
 882 into an <code>unsigned long</code> variable.</p>
 883 </li>
 884 <li>
 885 <p>Return value <code>0</code> indicates success and non-zero return
 886 value will invoke <code>usage_with_options()</code> and, thus, die.</p>
 887 </li>
 888 <li>
 889 <p>If the user negates the option, <code>arg</code> is <code>NULL</code> and <code>unset</code> is 1.</p>
 890 </li>
 891 </ul>
 892 </div>
 893 </div>
 894 </div>
 895 <div class="sect1">
 896 <h2 id="_sophisticated_option_parsing">Sophisticated option parsing</h2>
 897 <div class="sectionbody">
 898 <div class="paragraph">
 899 <p>If you need, for example, option callbacks with optional arguments
 900 or without arguments at all, or if you need other special cases,
 901 that are not handled by the macros above, you need to specify the
 902 members of the <code>option</code> structure manually.</p>
 903 </div>
 904 <div class="paragraph">
 905 <p>This is not covered in this document, but well documented
 906 in <code>parse-options.h</code> itself.</p>
 907 </div>
 908 </div>
 909 </div>
 910 <div class="sect1">
 911 <h2 id="_examples">Examples</h2>
 912 <div class="sectionbody">
 913 <div class="paragraph">
 914 <p>See <code>test-parse-options.c</code> and
 915 <code>builtin/add.c</code>,
 916 <code>builtin/clone.c</code>,
 917 <code>builtin/commit.c</code>,
 918 <code>builtin/fetch.c</code>,
 919 <code>builtin/fsck.c</code>,
 920 <code>builtin/rm.c</code>
 921 for real-world examples.</p>
 922 </div>
 923 </div>
 924 </div>
 925 </div>
 926 <div id="footer">
 927 <div id="footer-text">
 928 Last updated 2022-09-21 15:44:34 -0700
 929 </div>
 930 </div>
 931 </body>
 932 </html>