Junio C Hamano | 944ce25 | 2018-05-30 22:25:26 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| 3 | "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| 5 | <head> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 6 | <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> |
Junio C Hamano | a85030a | 2022-07-27 16:48:21 | [diff] [blame] | 7 | <meta name="generator" content="AsciiDoc 10.2.0" /> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 8 | <title>parse-options API</title> |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 9 | <style type="text/css"> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 10 | /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ |
| 11 | |
| 12 | /* Default font. */ |
| 13 | body { |
| 14 | font-family: Georgia,serif; |
| 15 | } |
| 16 | |
| 17 | /* Title font. */ |
| 18 | h1, h2, h3, h4, h5, h6, |
| 19 | div.title, caption.title, |
| 20 | thead, p.table.header, |
| 21 | #toctitle, |
| 22 | #author, #revnumber, #revdate, #revremark, |
| 23 | #footer { |
| 24 | font-family: Arial,Helvetica,sans-serif; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 25 | } |
| 26 | |
| 27 | body { |
| 28 | margin: 1em 5% 1em 5%; |
| 29 | } |
| 30 | |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 31 | a { |
| 32 | color: blue; |
| 33 | text-decoration: underline; |
| 34 | } |
| 35 | a:visited { |
| 36 | color: fuchsia; |
| 37 | } |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 38 | |
| 39 | em { |
| 40 | font-style: italic; |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 41 | color: navy; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 42 | } |
| 43 | |
| 44 | strong { |
| 45 | font-weight: bold; |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 46 | color: #083194; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 47 | } |
| 48 | |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 49 | h1, h2, h3, h4, h5, h6 { |
| 50 | color: #527bbd; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 51 | margin-top: 1.2em; |
| 52 | margin-bottom: 0.5em; |
| 53 | line-height: 1.3; |
| 54 | } |
| 55 | |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 56 | h1, h2, h3 { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 57 | border-bottom: 2px solid silver; |
| 58 | } |
| 59 | h2 { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 60 | padding-top: 0.5em; |
| 61 | } |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 62 | h3 { |
| 63 | float: left; |
| 64 | } |
| 65 | h3 + * { |
| 66 | clear: left; |
| 67 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 68 | h5 { |
| 69 | font-size: 1.0em; |
| 70 | } |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 71 | |
| 72 | div.sectionbody { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 73 | margin-left: 0; |
| 74 | } |
| 75 | |
| 76 | hr { |
| 77 | border: 1px solid silver; |
| 78 | } |
| 79 | |
| 80 | p { |
| 81 | margin-top: 0.5em; |
| 82 | margin-bottom: 0.5em; |
| 83 | } |
| 84 | |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 85 | ul, ol, li > p { |
| 86 | margin-top: 0; |
| 87 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 88 | ul > li { color: #aaa; } |
| 89 | ul > li > * { color: black; } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 90 | |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 91 | .monospaced, code, pre { |
| 92 | font-family: "Courier New", Courier, monospace; |
| 93 | font-size: inherit; |
| 94 | color: navy; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 95 | padding: 0; |
| 96 | margin: 0; |
| 97 | } |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 98 | pre { |
| 99 | white-space: pre-wrap; |
| 100 | } |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 101 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 102 | #author { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 103 | color: #527bbd; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 104 | font-weight: bold; |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 105 | font-size: 1.1em; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 106 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 107 | #email { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 108 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 109 | #revnumber, #revdate, #revremark { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 110 | } |
| 111 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 112 | #footer { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 113 | font-size: small; |
| 114 | border-top: 2px solid silver; |
| 115 | padding-top: 0.5em; |
| 116 | margin-top: 4.0em; |
| 117 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 118 | #footer-text { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 119 | float: left; |
| 120 | padding-bottom: 0.5em; |
| 121 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 122 | #footer-badges { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 123 | float: right; |
| 124 | padding-bottom: 0.5em; |
| 125 | } |
| 126 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 127 | #preamble { |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 128 | margin-top: 1.5em; |
| 129 | margin-bottom: 1.5em; |
| 130 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 131 | div.imageblock, div.exampleblock, div.verseblock, |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 132 | div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, |
| 133 | div.admonitionblock { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 134 | margin-top: 1.0em; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 135 | margin-bottom: 1.5em; |
| 136 | } |
| 137 | div.admonitionblock { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 138 | margin-top: 2.0em; |
| 139 | margin-bottom: 2.0em; |
| 140 | margin-right: 10%; |
| 141 | color: #606060; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | div.content { /* Block element content. */ |
| 145 | padding: 0; |
| 146 | } |
| 147 | |
| 148 | /* Block element titles. */ |
| 149 | div.title, caption.title { |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 150 | color: #527bbd; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 151 | font-weight: bold; |
| 152 | text-align: left; |
| 153 | margin-top: 1.0em; |
| 154 | margin-bottom: 0.5em; |
| 155 | } |
| 156 | div.title + * { |
| 157 | margin-top: 0; |
| 158 | } |
| 159 | |
| 160 | td div.title:first-child { |
| 161 | margin-top: 0.0em; |
| 162 | } |
| 163 | div.content div.title:first-child { |
| 164 | margin-top: 0.0em; |
| 165 | } |
| 166 | div.content + div.title { |
| 167 | margin-top: 0.0em; |
| 168 | } |
| 169 | |
| 170 | div.sidebarblock > div.content { |
| 171 | background: #ffffee; |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 172 | border: 1px solid #dddddd; |
| 173 | border-left: 4px solid #f0f0f0; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 174 | padding: 0.5em; |
| 175 | } |
| 176 | |
| 177 | div.listingblock > div.content { |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 178 | border: 1px solid #dddddd; |
| 179 | border-left: 5px solid #f0f0f0; |
| 180 | background: #f8f8f8; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 181 | padding: 0.5em; |
| 182 | } |
| 183 | |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 184 | div.quoteblock, div.verseblock { |
| 185 | padding-left: 1.0em; |
| 186 | margin-left: 1.0em; |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 187 | margin-right: 10%; |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 188 | border-left: 5px solid #f0f0f0; |
| 189 | color: #888; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 190 | } |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 191 | |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 192 | div.quoteblock > div.attribution { |
| 193 | padding-top: 0.5em; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 194 | text-align: right; |
| 195 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 196 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 197 | div.verseblock > pre.content { |
| 198 | font-family: inherit; |
| 199 | font-size: inherit; |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 200 | } |
| 201 | div.verseblock > div.attribution { |
| 202 | padding-top: 0.75em; |
| 203 | text-align: left; |
| 204 | } |
| 205 | /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 206 | div.verseblock + div.attribution { |
| 207 | text-align: left; |
| 208 | } |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 209 | |
| 210 | div.admonitionblock .icon { |
| 211 | vertical-align: top; |
| 212 | font-size: 1.1em; |
| 213 | font-weight: bold; |
| 214 | text-decoration: underline; |
| 215 | color: #527bbd; |
| 216 | padding-right: 0.5em; |
| 217 | } |
| 218 | div.admonitionblock td.content { |
| 219 | padding-left: 0.5em; |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 220 | border-left: 3px solid #dddddd; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 221 | } |
| 222 | |
| 223 | div.exampleblock > div.content { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 224 | border-left: 3px solid #dddddd; |
| 225 | padding-left: 0.5em; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 226 | } |
| 227 | |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 228 | div.imageblock div.content { padding-left: 0; } |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 229 | span.image img { border-style: none; vertical-align: text-bottom; } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 230 | a.image:visited { color: white; } |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 231 | |
| 232 | dl { |
| 233 | margin-top: 0.8em; |
| 234 | margin-bottom: 0.8em; |
| 235 | } |
| 236 | dt { |
| 237 | margin-top: 0.5em; |
| 238 | margin-bottom: 0; |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 239 | font-style: normal; |
| 240 | color: navy; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 241 | } |
| 242 | dd > *:first-child { |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 243 | margin-top: 0.1em; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 244 | } |
| 245 | |
| 246 | ul, ol { |
| 247 | list-style-position: outside; |
| 248 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 249 | ol.arabic { |
| 250 | list-style-type: decimal; |
| 251 | } |
| 252 | ol.loweralpha { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 253 | list-style-type: lower-alpha; |
| 254 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 255 | ol.upperalpha { |
| 256 | list-style-type: upper-alpha; |
| 257 | } |
| 258 | ol.lowerroman { |
| 259 | list-style-type: lower-roman; |
| 260 | } |
| 261 | ol.upperroman { |
| 262 | list-style-type: upper-roman; |
| 263 | } |
| 264 | |
| 265 | div.compact ul, div.compact ol, |
| 266 | div.compact p, div.compact p, |
| 267 | div.compact div, div.compact div { |
| 268 | margin-top: 0.1em; |
| 269 | margin-bottom: 0.1em; |
| 270 | } |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 271 | |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 272 | tfoot { |
| 273 | font-weight: bold; |
| 274 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 275 | td > div.verse { |
| 276 | white-space: pre; |
| 277 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 278 | |
| 279 | div.hdlist { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 280 | margin-top: 0.8em; |
| 281 | margin-bottom: 0.8em; |
| 282 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 283 | div.hdlist tr { |
| 284 | padding-bottom: 15px; |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 285 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 286 | dt.hdlist1.strong, td.hdlist1.strong { |
| 287 | font-weight: bold; |
| 288 | } |
| 289 | td.hdlist1 { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 290 | vertical-align: top; |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 291 | font-style: normal; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 292 | padding-right: 0.8em; |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 293 | color: navy; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 294 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 295 | td.hdlist2 { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 296 | vertical-align: top; |
| 297 | } |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 298 | div.hdlist.compact tr { |
| 299 | margin: 0; |
| 300 | padding-bottom: 0; |
| 301 | } |
| 302 | |
| 303 | .comment { |
| 304 | background: yellow; |
| 305 | } |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 306 | |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 307 | .footnote, .footnoteref { |
| 308 | font-size: 0.8em; |
| 309 | } |
| 310 | |
| 311 | span.footnote, span.footnoteref { |
| 312 | vertical-align: super; |
| 313 | } |
| 314 | |
| 315 | #footnotes { |
| 316 | margin: 20px 0 20px 0; |
| 317 | padding: 7px 0 0 0; |
| 318 | } |
| 319 | |
| 320 | #footnotes div.footnote { |
| 321 | margin: 0 0 5px 0; |
| 322 | } |
| 323 | |
| 324 | #footnotes hr { |
| 325 | border: none; |
| 326 | border-top: 1px solid silver; |
| 327 | height: 1px; |
| 328 | text-align: left; |
| 329 | margin-left: 0; |
| 330 | width: 20%; |
| 331 | min-width: 100px; |
| 332 | } |
| 333 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 334 | div.colist td { |
| 335 | padding-right: 0.5em; |
| 336 | padding-bottom: 0.3em; |
| 337 | vertical-align: top; |
| 338 | } |
| 339 | div.colist td img { |
| 340 | margin-top: 0.3em; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 341 | } |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 342 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 343 | @media print { |
| 344 | #footer-badges { display: none; } |
| 345 | } |
| 346 | |
| 347 | #toc { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 348 | margin-bottom: 2.5em; |
| 349 | } |
| 350 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 351 | #toctitle { |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 352 | color: #527bbd; |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 353 | font-size: 1.1em; |
| 354 | font-weight: bold; |
| 355 | margin-top: 1.0em; |
| 356 | margin-bottom: 0.1em; |
| 357 | } |
| 358 | |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 359 | div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 360 | margin-top: 0; |
| 361 | margin-bottom: 0; |
| 362 | } |
| 363 | div.toclevel2 { |
| 364 | margin-left: 2em; |
| 365 | font-size: 0.9em; |
| 366 | } |
| 367 | div.toclevel3 { |
| 368 | margin-left: 4em; |
| 369 | font-size: 0.9em; |
| 370 | } |
| 371 | div.toclevel4 { |
| 372 | margin-left: 6em; |
| 373 | font-size: 0.9em; |
| 374 | } |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 375 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 376 | span.aqua { color: aqua; } |
| 377 | span.black { color: black; } |
| 378 | span.blue { color: blue; } |
| 379 | span.fuchsia { color: fuchsia; } |
| 380 | span.gray { color: gray; } |
| 381 | span.green { color: green; } |
| 382 | span.lime { color: lime; } |
| 383 | span.maroon { color: maroon; } |
| 384 | span.navy { color: navy; } |
| 385 | span.olive { color: olive; } |
| 386 | span.purple { color: purple; } |
| 387 | span.red { color: red; } |
| 388 | span.silver { color: silver; } |
| 389 | span.teal { color: teal; } |
| 390 | span.white { color: white; } |
| 391 | span.yellow { color: yellow; } |
| 392 | |
| 393 | span.aqua-background { background: aqua; } |
| 394 | span.black-background { background: black; } |
| 395 | span.blue-background { background: blue; } |
| 396 | span.fuchsia-background { background: fuchsia; } |
| 397 | span.gray-background { background: gray; } |
| 398 | span.green-background { background: green; } |
| 399 | span.lime-background { background: lime; } |
| 400 | span.maroon-background { background: maroon; } |
| 401 | span.navy-background { background: navy; } |
| 402 | span.olive-background { background: olive; } |
| 403 | span.purple-background { background: purple; } |
| 404 | span.red-background { background: red; } |
| 405 | span.silver-background { background: silver; } |
| 406 | span.teal-background { background: teal; } |
| 407 | span.white-background { background: white; } |
| 408 | span.yellow-background { background: yellow; } |
| 409 | |
| 410 | span.big { font-size: 2em; } |
| 411 | span.small { font-size: 0.6em; } |
| 412 | |
| 413 | span.underline { text-decoration: underline; } |
| 414 | span.overline { text-decoration: overline; } |
| 415 | span.line-through { text-decoration: line-through; } |
| 416 | |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 417 | div.unbreakable { page-break-inside: avoid; } |
| 418 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 419 | |
| 420 | /* |
| 421 | * xhtml11 specific |
| 422 | * |
| 423 | * */ |
| 424 | |
| 425 | div.tableblock { |
| 426 | margin-top: 1.0em; |
| 427 | margin-bottom: 1.5em; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 428 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 429 | div.tableblock > table { |
| 430 | border: 3px solid #527bbd; |
| 431 | } |
| 432 | thead, p.table.header { |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 433 | font-weight: bold; |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 434 | color: #527bbd; |
| 435 | } |
| 436 | p.table { |
| 437 | margin-top: 0; |
| 438 | } |
Junio C Hamano | 725b0da | 2020-01-22 22:02:40 | [diff] [blame] | 439 | /* Because the table frame attribute is overridden by CSS in most browsers. */ |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 440 | div.tableblock > table[frame="void"] { |
| 441 | border-style: none; |
| 442 | } |
| 443 | div.tableblock > table[frame="hsides"] { |
| 444 | border-left-style: none; |
| 445 | border-right-style: none; |
| 446 | } |
| 447 | div.tableblock > table[frame="vsides"] { |
| 448 | border-top-style: none; |
| 449 | border-bottom-style: none; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 450 | } |
| 451 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 452 | |
| 453 | /* |
| 454 | * html5 specific |
| 455 | * |
| 456 | * */ |
| 457 | |
| 458 | table.tableblock { |
| 459 | margin-top: 1.0em; |
| 460 | margin-bottom: 1.5em; |
| 461 | } |
| 462 | thead, p.tableblock.header { |
| 463 | font-weight: bold; |
| 464 | color: #527bbd; |
| 465 | } |
| 466 | p.tableblock { |
| 467 | margin-top: 0; |
| 468 | } |
| 469 | table.tableblock { |
| 470 | border-width: 3px; |
| 471 | border-spacing: 0px; |
| 472 | border-style: solid; |
| 473 | border-color: #527bbd; |
| 474 | border-collapse: collapse; |
| 475 | } |
| 476 | th.tableblock, td.tableblock { |
| 477 | border-width: 1px; |
| 478 | padding: 4px; |
| 479 | border-style: solid; |
| 480 | border-color: #527bbd; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 481 | } |
| 482 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 483 | table.tableblock.frame-topbot { |
| 484 | border-left-style: hidden; |
| 485 | border-right-style: hidden; |
| 486 | } |
| 487 | table.tableblock.frame-sides { |
| 488 | border-top-style: hidden; |
| 489 | border-bottom-style: hidden; |
| 490 | } |
| 491 | table.tableblock.frame-none { |
| 492 | border-style: hidden; |
| 493 | } |
| 494 | |
| 495 | th.tableblock.halign-left, td.tableblock.halign-left { |
| 496 | text-align: left; |
| 497 | } |
| 498 | th.tableblock.halign-center, td.tableblock.halign-center { |
| 499 | text-align: center; |
| 500 | } |
| 501 | th.tableblock.halign-right, td.tableblock.halign-right { |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 502 | text-align: right; |
| 503 | } |
| 504 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 505 | th.tableblock.valign-top, td.tableblock.valign-top { |
| 506 | vertical-align: top; |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 507 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 508 | th.tableblock.valign-middle, td.tableblock.valign-middle { |
| 509 | vertical-align: middle; |
| 510 | } |
| 511 | th.tableblock.valign-bottom, td.tableblock.valign-bottom { |
| 512 | vertical-align: bottom; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 513 | } |
| 514 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 515 | |
| 516 | /* |
| 517 | * manpage specific |
| 518 | * |
| 519 | * */ |
| 520 | |
| 521 | body.manpage h1 { |
| 522 | padding-top: 0.5em; |
| 523 | padding-bottom: 0.5em; |
| 524 | border-top: 2px solid silver; |
| 525 | border-bottom: 2px solid silver; |
| 526 | } |
| 527 | body.manpage h2 { |
| 528 | border-style: none; |
| 529 | } |
| 530 | body.manpage div.sectionbody { |
| 531 | margin-left: 3em; |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 532 | } |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 533 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 534 | @media print { |
| 535 | body.manpage div#toc { display: none; } |
| 536 | } |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 537 | |
| 538 | |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 539 | </style> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 540 | <script type="text/javascript"> |
| 541 | /*<![CDATA[*/ |
Junio C Hamano | 2b15318 | 2021-12-15 21:00:31 | [diff] [blame] | 542 | var asciidoc = { // Namespace. |
| 543 | |
| 544 | ///////////////////////////////////////////////////////////////////// |
| 545 | // Table Of Contents generator |
| 546 | ///////////////////////////////////////////////////////////////////// |
| 547 | |
| 548 | /* Author: Mihai Bazon, September 2002 |
| 549 | * http://students.infoiasi.ro/~mishoo |
| 550 | * |
| 551 | * Table Of Content generator |
| 552 | * Version: 0.4 |
| 553 | * |
| 554 | * Feel free to use this script under the terms of the GNU General Public |
| 555 | * License, as long as you do not remove or alter this notice. |
| 556 | */ |
| 557 | |
| 558 | /* modified by Troy D. Hanson, September 2006. License: GPL */ |
| 559 | /* modified by Stuart Rackham, 2006, 2009. License: GPL */ |
| 560 | |
| 561 | // toclevels = 1..4. |
| 562 | toc: function (toclevels) { |
| 563 | |
| 564 | function getText(el) { |
| 565 | var text = ""; |
| 566 | for (var i = el.firstChild; i != null; i = i.nextSibling) { |
| 567 | if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants. |
| 568 | text += i.data; |
| 569 | else if (i.firstChild != null) |
| 570 | text += getText(i); |
| 571 | } |
| 572 | return text; |
| 573 | } |
| 574 | |
| 575 | function TocEntry(el, text, toclevel) { |
| 576 | this.element = el; |
| 577 | this.text = text; |
| 578 | this.toclevel = toclevel; |
| 579 | } |
| 580 | |
| 581 | function tocEntries(el, toclevels) { |
| 582 | var result = new Array; |
| 583 | var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); |
| 584 | // Function that scans the DOM tree for header elements (the DOM2 |
| 585 | // nodeIterator API would be a better technique but not supported by all |
| 586 | // browsers). |
| 587 | var iterate = function (el) { |
| 588 | for (var i = el.firstChild; i != null; i = i.nextSibling) { |
| 589 | if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { |
| 590 | var mo = re.exec(i.tagName); |
| 591 | if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { |
| 592 | result[result.length] = new TocEntry(i, getText(i), mo[1]-1); |
| 593 | } |
| 594 | iterate(i); |
| 595 | } |
| 596 | } |
| 597 | } |
| 598 | iterate(el); |
| 599 | return result; |
| 600 | } |
| 601 | |
| 602 | var toc = document.getElementById("toc"); |
| 603 | if (!toc) { |
| 604 | return; |
| 605 | } |
| 606 | |
| 607 | // Delete existing TOC entries in case we're reloading the TOC. |
| 608 | var tocEntriesToRemove = []; |
| 609 | var i; |
| 610 | for (i = 0; i < toc.childNodes.length; i++) { |
| 611 | var entry = toc.childNodes[i]; |
| 612 | if (entry.nodeName.toLowerCase() == 'div' |
| 613 | && entry.getAttribute("class") |
| 614 | && entry.getAttribute("class").match(/^toclevel/)) |
| 615 | tocEntriesToRemove.push(entry); |
| 616 | } |
| 617 | for (i = 0; i < tocEntriesToRemove.length; i++) { |
| 618 | toc.removeChild(tocEntriesToRemove[i]); |
| 619 | } |
| 620 | |
| 621 | // Rebuild TOC entries. |
| 622 | var entries = tocEntries(document.getElementById("content"), toclevels); |
| 623 | for (var i = 0; i < entries.length; ++i) { |
| 624 | var entry = entries[i]; |
| 625 | if (entry.element.id == "") |
| 626 | entry.element.id = "_toc_" + i; |
| 627 | var a = document.createElement("a"); |
| 628 | a.href = "#" + entry.element.id; |
| 629 | a.appendChild(document.createTextNode(entry.text)); |
| 630 | var div = document.createElement("div"); |
| 631 | div.appendChild(a); |
| 632 | div.className = "toclevel" + entry.toclevel; |
| 633 | toc.appendChild(div); |
| 634 | } |
| 635 | if (entries.length == 0) |
| 636 | toc.parentNode.removeChild(toc); |
| 637 | }, |
| 638 | |
| 639 | |
| 640 | ///////////////////////////////////////////////////////////////////// |
| 641 | // Footnotes generator |
| 642 | ///////////////////////////////////////////////////////////////////// |
| 643 | |
| 644 | /* Based on footnote generation code from: |
| 645 | * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html |
| 646 | */ |
| 647 | |
| 648 | footnotes: function () { |
| 649 | // Delete existing footnote entries in case we're reloading the footnodes. |
| 650 | var i; |
| 651 | var noteholder = document.getElementById("footnotes"); |
| 652 | if (!noteholder) { |
| 653 | return; |
| 654 | } |
| 655 | var entriesToRemove = []; |
| 656 | for (i = 0; i < noteholder.childNodes.length; i++) { |
| 657 | var entry = noteholder.childNodes[i]; |
| 658 | if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") |
| 659 | entriesToRemove.push(entry); |
| 660 | } |
| 661 | for (i = 0; i < entriesToRemove.length; i++) { |
| 662 | noteholder.removeChild(entriesToRemove[i]); |
| 663 | } |
| 664 | |
| 665 | // Rebuild footnote entries. |
| 666 | var cont = document.getElementById("content"); |
| 667 | var spans = cont.getElementsByTagName("span"); |
| 668 | var refs = {}; |
| 669 | var n = 0; |
| 670 | for (i=0; i<spans.length; i++) { |
| 671 | if (spans[i].className == "footnote") { |
| 672 | n++; |
| 673 | var note = spans[i].getAttribute("data-note"); |
| 674 | if (!note) { |
| 675 | // Use [\s\S] in place of . so multi-line matches work. |
| 676 | // Because JavaScript has no s (dotall) regex flag. |
| 677 | note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; |
| 678 | spans[i].innerHTML = |
| 679 | "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + |
| 680 | "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 681 | spans[i].setAttribute("data-note", note); |
| 682 | } |
| 683 | noteholder.innerHTML += |
| 684 | "<div class='footnote' id='_footnote_" + n + "'>" + |
| 685 | "<a href='#_footnoteref_" + n + "' title='Return to text'>" + |
| 686 | n + "</a>. " + note + "</div>"; |
| 687 | var id =spans[i].getAttribute("id"); |
| 688 | if (id != null) refs["#"+id] = n; |
| 689 | } |
| 690 | } |
| 691 | if (n == 0) |
| 692 | noteholder.parentNode.removeChild(noteholder); |
| 693 | else { |
| 694 | // Process footnoterefs. |
| 695 | for (i=0; i<spans.length; i++) { |
| 696 | if (spans[i].className == "footnoteref") { |
| 697 | var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); |
| 698 | href = href.match(/#.*/)[0]; // Because IE return full URL. |
| 699 | n = refs[href]; |
| 700 | spans[i].innerHTML = |
| 701 | "[<a href='#_footnote_" + n + |
| 702 | "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 703 | } |
| 704 | } |
| 705 | } |
| 706 | }, |
| 707 | |
| 708 | install: function(toclevels) { |
| 709 | var timerId; |
| 710 | |
| 711 | function reinstall() { |
| 712 | asciidoc.footnotes(); |
| 713 | if (toclevels) { |
| 714 | asciidoc.toc(toclevels); |
| 715 | } |
| 716 | } |
| 717 | |
| 718 | function reinstallAndRemoveTimer() { |
| 719 | clearInterval(timerId); |
| 720 | reinstall(); |
| 721 | } |
| 722 | |
| 723 | timerId = setInterval(reinstall, 500); |
| 724 | if (document.addEventListener) |
| 725 | document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); |
| 726 | else |
| 727 | window.onload = reinstallAndRemoveTimer; |
| 728 | } |
| 729 | |
| 730 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 731 | asciidoc.install(); |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 732 | /*]]>*/ |
| 733 | </script> |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 734 | </head> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 735 | <body class="article"> |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 736 | <div id="header"> |
| 737 | <h1>parse-options API</h1> |
Junio C Hamano | aedeeae | 2023-07-18 15:55:30 | [diff] [blame^] | 738 | <span id="revdate">2023-07-18</span> |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 739 | </div> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 740 | <div id="content"> |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 741 | <div id="preamble"> |
| 742 | <div class="sectionbody"> |
Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 743 | <div class="paragraph"><p>The parse-options API is used to parse and massage options in Git |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 744 | and to provide a usage help with consistent look.</p></div> |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 745 | </div> |
| 746 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 747 | <div class="sect1"> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 748 | <h2 id="_basics">Basics</h2> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 749 | <div class="sectionbody"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 750 | <div class="paragraph"><p>The argument vector <code>argv[]</code> may usually contain mandatory or optional |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 751 | <em>non-option arguments</em>, e.g. a filename or a branch, <em>options</em>, and |
| 752 | <em>subcommands</em>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 753 | Options are optional arguments that start with a dash and |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 754 | that allow to change the behavior of a command.</p></div> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 755 | <div class="ulist"><ul> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 756 | <li> |
| 757 | <p> |
| 758 | There are basically three types of options: |
| 759 | <em>boolean</em> options, |
| 760 | options with (mandatory) <em>arguments</em> and |
| 761 | options with <em>optional arguments</em> |
| 762 | (i.e. a boolean option that can be adjusted). |
| 763 | </p> |
| 764 | </li> |
| 765 | <li> |
| 766 | <p> |
| 767 | There are basically two forms of options: |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 768 | <em>Short options</em> consist of one dash (<code>-</code>) and one alphanumeric |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 769 | character. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 770 | <em>Long options</em> begin with two dashes (<code>--</code>) and some |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 771 | alphanumeric characters. |
| 772 | </p> |
| 773 | </li> |
| 774 | <li> |
| 775 | <p> |
| 776 | Options are case-sensitive. |
| 777 | Please define <em>lower-case long options</em> only. |
| 778 | </p> |
| 779 | </li> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 780 | </ul></div> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 781 | <div class="paragraph"><p>The parse-options API allows:</p></div> |
| 782 | <div class="ulist"><ul> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 783 | <li> |
| 784 | <p> |
Junio C Hamano | f079f70 | 2013-12-06 23:43:18 | [diff] [blame] | 785 | <em>stuck</em> and <em>separate form</em> of options with arguments. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 786 | <code>-oArg</code> is stuck, <code>-o Arg</code> is separate form. |
| 787 | <code>--option=Arg</code> is stuck, <code>--option Arg</code> is separate form. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 788 | </p> |
| 789 | </li> |
| 790 | <li> |
| 791 | <p> |
| 792 | Long options may be <em>abbreviated</em>, as long as the abbreviation |
| 793 | is unambiguous. |
| 794 | </p> |
| 795 | </li> |
| 796 | <li> |
| 797 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 798 | Short options may be bundled, e.g. <code>-a -b</code> can be specified as <code>-ab</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 799 | </p> |
| 800 | </li> |
| 801 | <li> |
| 802 | <p> |
| 803 | Boolean long options can be <em>negated</em> (or <em>unset</em>) by prepending |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 804 | <code>no-</code>, e.g. <code>--no-abbrev</code> instead of <code>--abbrev</code>. Conversely, |
| 805 | options that begin with <code>no-</code> can be <em>negated</em> by removing it. |
Junio C Hamano | c710296 | 2013-05-29 23:57:17 | [diff] [blame] | 806 | Other long options can be unset (e.g., set string to NULL, set |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 807 | integer to 0) by prepending <code>no-</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 808 | </p> |
| 809 | </li> |
| 810 | <li> |
| 811 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 812 | Options and non-option arguments can clearly be separated using the <code>--</code> |
| 813 | option, e.g. <code>-a -b --option -- --this-is-a-file</code> indicates that |
| 814 | <code>--this-is-a-file</code> must not be processed as an option. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 815 | </p> |
| 816 | </li> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 817 | </ul></div> |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 818 | <div class="paragraph"><p>Subcommands are special in a couple of ways:</p></div> |
| 819 | <div class="ulist"><ul> |
| 820 | <li> |
| 821 | <p> |
| 822 | Subcommands only have long form, and they have no double dash prefix, no |
| 823 | negated form, and no description, and they don’t take any arguments, and |
| 824 | can’t be abbreviated. |
| 825 | </p> |
| 826 | </li> |
| 827 | <li> |
| 828 | <p> |
| 829 | There must be exactly one subcommand among the arguments, or zero if the |
| 830 | command has a default operation mode. |
| 831 | </p> |
| 832 | </li> |
| 833 | <li> |
| 834 | <p> |
| 835 | All arguments following the subcommand are considered to be arguments of |
| 836 | the subcommand, and, conversely, arguments meant for the subcommand may |
Junio C Hamano | a1ee129 | 2022-09-21 22:47:52 | [diff] [blame] | 837 | not precede the subcommand. |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 838 | </p> |
| 839 | </li> |
| 840 | </ul></div> |
| 841 | <div class="paragraph"><p>Therefore, if the options array contains at least one subcommand and |
| 842 | <code>parse_options()</code> encounters the first dashless argument, it will either:</p></div> |
| 843 | <div class="ulist"><ul> |
| 844 | <li> |
| 845 | <p> |
| 846 | stop and return, if that dashless argument is a known subcommand, setting |
| 847 | <code>value</code> to the function pointer associated with that subcommand, storing |
| 848 | the name of the subcommand in argv[0], and leaving the rest of the |
| 849 | arguments unprocessed, or |
| 850 | </p> |
| 851 | </li> |
| 852 | <li> |
| 853 | <p> |
| 854 | stop and return, if it was invoked with the <code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code> |
| 855 | flag and that dashless argument doesn’t match any subcommands, leaving |
| 856 | <code>value</code> unchanged and the rest of the arguments unprocessed, or |
| 857 | </p> |
| 858 | </li> |
| 859 | <li> |
| 860 | <p> |
| 861 | show error and usage, and abort. |
| 862 | </p> |
| 863 | </li> |
| 864 | </ul></div> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 865 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 866 | </div> |
| 867 | <div class="sect1"> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 868 | <h2 id="_steps_to_parse_options">Steps to parse options</h2> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 869 | <div class="sectionbody"> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 870 | <div class="olist arabic"><ol class="arabic"> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 871 | <li> |
| 872 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 873 | <code>#include "parse-options.h"</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 874 | </p> |
| 875 | </li> |
| 876 | <li> |
| 877 | <p> |
| 878 | define a NULL-terminated |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 879 | <code>static const char * const builtin_foo_usage[]</code> array |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 880 | containing alternative usage strings |
| 881 | </p> |
| 882 | </li> |
| 883 | <li> |
| 884 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 885 | define <code>builtin_foo_options</code> array as described below |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 886 | in section <em>Data Structure</em>. |
| 887 | </p> |
| 888 | </li> |
| 889 | <li> |
| 890 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 891 | in <code>cmd_foo(int argc, const char **argv, const char *prefix)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 892 | call |
| 893 | </p> |
| 894 | <div class="literalblock"> |
| 895 | <div class="content"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 896 | <pre><code>argc = parse_options(argc, argv, prefix, builtin_foo_options, builtin_foo_usage, flags);</code></pre> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 897 | </div></div> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 898 | <div class="paragraph"><p><code>parse_options()</code> will filter out the processed options of <code>argv[]</code> and leave the |
| 899 | non-option arguments in <code>argv[]</code>. |
| 900 | <code>argc</code> is updated appropriately because of the assignment.</p></div> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 901 | <div class="paragraph"><p>You can also pass NULL instead of a usage array as the fifth parameter of |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 902 | parse_options(), to avoid displaying a help screen with usage info and |
| 903 | option list. This should only be done if necessary, e.g. to implement |
| 904 | a limited parser for only a subset of the options that needs to be run |
| 905 | before the full parser, which in turn shows the full help message.</p></div> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 906 | <div class="paragraph"><p>Flags are the bitwise-or of:</p></div> |
| 907 | <div class="dlist"><dl> |
| 908 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 909 | <code>PARSE_OPT_KEEP_DASHDASH</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 910 | </dt> |
| 911 | <dd> |
| 912 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 913 | Keep the <code>--</code> that usually separates options from |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 914 | non-option arguments. |
| 915 | </p> |
| 916 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 917 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 918 | <code>PARSE_OPT_STOP_AT_NON_OPTION</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 919 | </dt> |
| 920 | <dd> |
| 921 | <p> |
| 922 | Usually the whole argument vector is massaged and reordered. |
| 923 | Using this flag, processing is stopped at the first non-option |
| 924 | argument. |
| 925 | </p> |
| 926 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 927 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 928 | <code>PARSE_OPT_KEEP_ARGV0</code> |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 929 | </dt> |
| 930 | <dd> |
| 931 | <p> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 932 | Keep the first argument, which contains the program name. It’s |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 933 | removed from argv[] by default. |
| 934 | </p> |
| 935 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 936 | <dt class="hdlist1"> |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 937 | <code>PARSE_OPT_KEEP_UNKNOWN_OPT</code> |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 938 | </dt> |
| 939 | <dd> |
| 940 | <p> |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 941 | Keep unknown options instead of erroring out. This doesn’t |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 942 | work for all combinations of arguments as users might expect |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 943 | it to do. E.g. if the first argument in <code>--unknown --known</code> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 944 | takes a value (which we can’t know), the second one is |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 945 | mistakenly interpreted as a known option. Similarly, if |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 946 | <code>PARSE_OPT_STOP_AT_NON_OPTION</code> is set, the second argument in |
| 947 | <code>--unknown value</code> will be mistakenly interpreted as a |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 948 | non-option, not as a value belonging to the unknown option, |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 949 | the parser early. That’s why parse_options() errors out if |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 950 | both options are set. |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 951 | Note that non-option arguments are always kept, even without |
| 952 | this flag. |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 953 | </p> |
| 954 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 955 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 956 | <code>PARSE_OPT_NO_INTERNAL_HELP</code> |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 957 | </dt> |
| 958 | <dd> |
| 959 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 960 | By default, parse_options() handles <code>-h</code>, <code>--help</code> and |
| 961 | <code>--help-all</code> internally, by showing a help screen. This option |
Junio C Hamano | 18f5140 | 2009-03-10 16:39:13 | [diff] [blame] | 962 | turns it off and allows one to add custom handlers for these |
| 963 | options, or to just leave them unknown. |
| 964 | </p> |
| 965 | </dd> |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 966 | <dt class="hdlist1"> |
| 967 | <code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code> |
| 968 | </dt> |
| 969 | <dd> |
| 970 | <p> |
| 971 | Don’t error out when no subcommand is specified. |
| 972 | </p> |
| 973 | </dd> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 974 | </dl></div> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 975 | </li> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 976 | </ol></div> |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 977 | <div class="paragraph"><p>Note that <code>PARSE_OPT_STOP_AT_NON_OPTION</code> is incompatible with subcommands; |
| 978 | while <code>PARSE_OPT_KEEP_DASHDASH</code> and <code>PARSE_OPT_KEEP_UNKNOWN_OPT</code> can only be |
| 979 | used with subcommands when combined with <code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code>.</p></div> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 980 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 981 | </div> |
| 982 | <div class="sect1"> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 983 | <h2 id="_data_structure">Data Structure</h2> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 984 | <div class="sectionbody"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 985 | <div class="paragraph"><p>The main data structure is an array of the <code>option</code> struct, |
| 986 | say <code>static struct option builtin_add_options[]</code>. |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 987 | There are some macros to easily define options:</p></div> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 988 | <div class="dlist"><dl> |
| 989 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 990 | <code>OPT__ABBREV(&int_var)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 991 | </dt> |
| 992 | <dd> |
| 993 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 994 | Add <code>--abbrev[=<n>]</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 995 | </p> |
| 996 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 997 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 998 | <code>OPT__COLOR(&int_var, description)</code> |
Junio C Hamano | 4aa0bcc | 2010-03-03 05:13:12 | [diff] [blame] | 999 | </dt> |
| 1000 | <dd> |
| 1001 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1002 | Add <code>--color[=<when>]</code> and <code>--no-color</code>. |
Junio C Hamano | 4aa0bcc | 2010-03-03 05:13:12 | [diff] [blame] | 1003 | </p> |
| 1004 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1005 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1006 | <code>OPT__DRY_RUN(&int_var, description)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1007 | </dt> |
| 1008 | <dd> |
| 1009 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1010 | Add <code>-n, --dry-run</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1011 | </p> |
| 1012 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1013 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1014 | <code>OPT__FORCE(&int_var, description)</code> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1015 | </dt> |
| 1016 | <dd> |
| 1017 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1018 | Add <code>-f, --force</code>. |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1019 | </p> |
| 1020 | </dd> |
| 1021 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1022 | <code>OPT__QUIET(&int_var, description)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1023 | </dt> |
| 1024 | <dd> |
| 1025 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1026 | Add <code>-q, --quiet</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1027 | </p> |
| 1028 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1029 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1030 | <code>OPT__VERBOSE(&int_var, description)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1031 | </dt> |
| 1032 | <dd> |
| 1033 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1034 | Add <code>-v, --verbose</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1035 | </p> |
| 1036 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1037 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1038 | <code>OPT_GROUP(description)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1039 | </dt> |
| 1040 | <dd> |
| 1041 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1042 | Start an option group. <code>description</code> is a short string that |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1043 | describes the group or an empty string. |
| 1044 | Start the description with an upper-case letter. |
| 1045 | </p> |
| 1046 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1047 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1048 | <code>OPT_BOOL(short, long, &int_var, description)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1049 | </dt> |
| 1050 | <dd> |
| 1051 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1052 | Introduce a boolean option. <code>int_var</code> is set to one with |
| 1053 | <code>--option</code> and set to zero with <code>--no-option</code>. |
Junio C Hamano | 4c6612f | 2011-10-12 23:54:21 | [diff] [blame] | 1054 | </p> |
| 1055 | </dd> |
| 1056 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1057 | <code>OPT_COUNTUP(short, long, &int_var, description)</code> |
Junio C Hamano | 4c6612f | 2011-10-12 23:54:21 | [diff] [blame] | 1058 | </dt> |
| 1059 | <dd> |
| 1060 | <p> |
| 1061 | Introduce a count-up option. |
Junio C Hamano | f2a3a75 | 2016-05-23 22:54:39 | [diff] [blame] | 1062 | Each use of <code>--option</code> increments <code>int_var</code>, starting from zero |
| 1063 | (even if initially negative), and <code>--no-option</code> resets it to |
| 1064 | zero. To determine if <code>--option</code> or <code>--no-option</code> was encountered at |
| 1065 | all, initialize <code>int_var</code> to a negative value, and if it is still |
| 1066 | negative after parse_options(), then neither <code>--option</code> nor |
| 1067 | <code>--no-option</code> was seen. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1068 | </p> |
| 1069 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1070 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1071 | <code>OPT_BIT(short, long, &int_var, description, mask)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1072 | </dt> |
| 1073 | <dd> |
| 1074 | <p> |
| 1075 | Introduce a boolean option. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1076 | If used, <code>int_var</code> is bitwise-ored with <code>mask</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1077 | </p> |
| 1078 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1079 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1080 | <code>OPT_NEGBIT(short, long, &int_var, description, mask)</code> |
Junio C Hamano | 7ae1825 | 2009-05-23 09:53:32 | [diff] [blame] | 1081 | </dt> |
| 1082 | <dd> |
| 1083 | <p> |
| 1084 | Introduce a boolean option. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1085 | If used, <code>int_var</code> is bitwise-anded with the inverted <code>mask</code>. |
Junio C Hamano | 7ae1825 | 2009-05-23 09:53:32 | [diff] [blame] | 1086 | </p> |
| 1087 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1088 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1089 | <code>OPT_SET_INT(short, long, &int_var, description, integer)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1090 | </dt> |
| 1091 | <dd> |
| 1092 | <p> |
Junio C Hamano | 4c6612f | 2011-10-12 23:54:21 | [diff] [blame] | 1093 | Introduce an integer option. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1094 | <code>int_var</code> is set to <code>integer</code> with <code>--option</code>, and |
| 1095 | reset to zero with <code>--no-option</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1096 | </p> |
| 1097 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1098 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1099 | <code>OPT_STRING(short, long, &str_var, arg_str, description)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1100 | </dt> |
| 1101 | <dd> |
| 1102 | <p> |
| 1103 | Introduce an option with string argument. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1104 | The string argument is put into <code>str_var</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1105 | </p> |
| 1106 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1107 | <dt class="hdlist1"> |
Junio C Hamano | cbe0eb2 | 2017-02-27 23:37:49 | [diff] [blame] | 1108 | <code>OPT_STRING_LIST(short, long, &struct string_list, arg_str, description)</code> |
| 1109 | </dt> |
| 1110 | <dd> |
| 1111 | <p> |
| 1112 | Introduce an option with string argument. |
| 1113 | The string argument is stored as an element in <code>string_list</code>. |
| 1114 | Use of <code>--no-option</code> will clear the list of preceding values. |
| 1115 | </p> |
| 1116 | </dd> |
| 1117 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1118 | <code>OPT_INTEGER(short, long, &int_var, description)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1119 | </dt> |
| 1120 | <dd> |
| 1121 | <p> |
| 1122 | Introduce an option with integer argument. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1123 | The integer is put into <code>int_var</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1124 | </p> |
| 1125 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1126 | <dt class="hdlist1"> |
Junio C Hamano | d7ed404 | 2015-08-03 19:43:00 | [diff] [blame] | 1127 | <code>OPT_MAGNITUDE(short, long, &unsigned_long_var, description)</code> |
| 1128 | </dt> |
| 1129 | <dd> |
| 1130 | <p> |
| 1131 | Introduce an option with a size argument. The argument must be a |
| 1132 | non-negative integer and may include a suffix of <em>k</em>, <em>m</em> or <em>g</em> to |
| 1133 | scale the provided value by 1024, 1024<sup>2 or 1024</sup>3 respectively. |
| 1134 | The scaled value is put into <code>unsigned_long_var</code>. |
| 1135 | </p> |
| 1136 | </dd> |
| 1137 | <dt class="hdlist1"> |
Junio C Hamano | d517690 | 2017-05-16 04:30:56 | [diff] [blame] | 1138 | <code>OPT_EXPIRY_DATE(short, long, &timestamp_t_var, description)</code> |
Junio C Hamano | c710296 | 2013-05-29 23:57:17 | [diff] [blame] | 1139 | </dt> |
| 1140 | <dd> |
| 1141 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1142 | Introduce an option with expiry date argument, see <code>parse_expiry_date()</code>. |
Junio C Hamano | d517690 | 2017-05-16 04:30:56 | [diff] [blame] | 1143 | The timestamp is put into <code>timestamp_t_var</code>. |
Junio C Hamano | c710296 | 2013-05-29 23:57:17 | [diff] [blame] | 1144 | </p> |
| 1145 | </dd> |
| 1146 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1147 | <code>OPT_CALLBACK(short, long, &var, arg_str, description, func_ptr)</code> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1148 | </dt> |
| 1149 | <dd> |
| 1150 | <p> |
| 1151 | Introduce an option with argument. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1152 | The argument will be fed into the function given by <code>func_ptr</code> |
| 1153 | and the result will be put into <code>var</code>. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1154 | See <em>Option Callbacks</em> below for a more elaborate description. |
| 1155 | </p> |
| 1156 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1157 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1158 | <code>OPT_FILENAME(short, long, &var, description)</code> |
Junio C Hamano | 3d14151 | 2009-06-01 01:22:40 | [diff] [blame] | 1159 | </dt> |
| 1160 | <dd> |
| 1161 | <p> |
| 1162 | Introduce an option with a filename argument. |
| 1163 | The filename will be prefixed by passing the filename along with |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1164 | the prefix argument of <code>parse_options()</code> to <code>prefix_filename()</code>. |
Junio C Hamano | 3d14151 | 2009-06-01 01:22:40 | [diff] [blame] | 1165 | </p> |
| 1166 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1167 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1168 | <code>OPT_NUMBER_CALLBACK(&var, description, func_ptr)</code> |
Junio C Hamano | 7ae1825 | 2009-05-23 09:53:32 | [diff] [blame] | 1169 | </dt> |
| 1170 | <dd> |
| 1171 | <p> |
| 1172 | Recognize numerical options like -123 and feed the integer as |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1173 | if it was an argument to the function given by <code>func_ptr</code>. |
| 1174 | The result will be put into <code>var</code>. There can be only one such |
Junio C Hamano | 7ae1825 | 2009-05-23 09:53:32 | [diff] [blame] | 1175 | option definition. It cannot be negated and it takes no |
| 1176 | arguments. Short options that happen to be digits take |
| 1177 | precedence over it. |
| 1178 | </p> |
| 1179 | </dd> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1180 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1181 | <code>OPT_COLOR_FLAG(short, long, &int_var, description)</code> |
Junio C Hamano | 4aa0bcc | 2010-03-03 05:13:12 | [diff] [blame] | 1182 | </dt> |
| 1183 | <dd> |
| 1184 | <p> |
| 1185 | Introduce an option that takes an optional argument that can |
| 1186 | have one of three values: "always", "never", or "auto". If the |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1187 | argument is not given, it defaults to "always". The <code>--no-</code> form |
| 1188 | works like <code>--long=never</code>; it cannot take an argument. If |
| 1189 | "always", set <code>int_var</code> to 1; if "never", set <code>int_var</code> to 0; if |
| 1190 | "auto", set <code>int_var</code> to 1 if stdout is a tty or a pager, |
Junio C Hamano | 4aa0bcc | 2010-03-03 05:13:12 | [diff] [blame] | 1191 | 0 otherwise. |
| 1192 | </p> |
| 1193 | </dd> |
Junio C Hamano | 4c6612f | 2011-10-12 23:54:21 | [diff] [blame] | 1194 | <dt class="hdlist1"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1195 | <code>OPT_NOOP_NOARG(short, long)</code> |
Junio C Hamano | 4c6612f | 2011-10-12 23:54:21 | [diff] [blame] | 1196 | </dt> |
| 1197 | <dd> |
| 1198 | <p> |
| 1199 | Introduce an option that has no effect and takes no arguments. |
| 1200 | Use it to hide deprecated options that are still to be recognized |
| 1201 | and ignored silently. |
| 1202 | </p> |
| 1203 | </dd> |
Junio C Hamano | d7ed404 | 2015-08-03 19:43:00 | [diff] [blame] | 1204 | <dt class="hdlist1"> |
| 1205 | <code>OPT_PASSTHRU(short, long, &char_var, arg_str, description, flags)</code> |
| 1206 | </dt> |
| 1207 | <dd> |
| 1208 | <p> |
| 1209 | Introduce an option that will be reconstructed into a char* string, |
| 1210 | which must be initialized to NULL. This is useful when you need to |
| 1211 | pass the command-line option to another command. Any previous value |
| 1212 | will be overwritten, so this should only be used for options where |
| 1213 | the last one specified on the command line wins. |
| 1214 | </p> |
| 1215 | </dd> |
| 1216 | <dt class="hdlist1"> |
Junio C Hamano | c9dd642 | 2020-08-10 23:32:55 | [diff] [blame] | 1217 | <code>OPT_PASSTHRU_ARGV(short, long, &strvec_var, arg_str, description, flags)</code> |
Junio C Hamano | d7ed404 | 2015-08-03 19:43:00 | [diff] [blame] | 1218 | </dt> |
| 1219 | <dd> |
| 1220 | <p> |
| 1221 | Introduce an option where all instances of it on the command-line will |
Junio C Hamano | c9dd642 | 2020-08-10 23:32:55 | [diff] [blame] | 1222 | be reconstructed into a strvec. This is useful when you need to |
Junio C Hamano | d7ed404 | 2015-08-03 19:43:00 | [diff] [blame] | 1223 | pass the command-line option, which can be specified multiple times, |
| 1224 | to another command. |
| 1225 | </p> |
| 1226 | </dd> |
Junio C Hamano | 84ea1e4 | 2016-04-08 21:53:48 | [diff] [blame] | 1227 | <dt class="hdlist1"> |
| 1228 | <code>OPT_CMDMODE(short, long, &int_var, description, enum_val)</code> |
| 1229 | </dt> |
| 1230 | <dd> |
| 1231 | <p> |
| 1232 | Define an "operation mode" option, only one of which in the same |
| 1233 | group of "operating mode" options that share the same <code>int_var</code> |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 1234 | can be given by the user. <code>int_var</code> is set to <code>enum_val</code> when the |
Junio C Hamano | 84ea1e4 | 2016-04-08 21:53:48 | [diff] [blame] | 1235 | option is used, but an error is reported if other "operating mode" |
| 1236 | option has already set its value to the same <code>int_var</code>. |
Junio C Hamano | f7f8f21 | 2022-09-01 20:57:29 | [diff] [blame] | 1237 | In new commands consider using subcommands instead. |
| 1238 | </p> |
| 1239 | </dd> |
| 1240 | <dt class="hdlist1"> |
| 1241 | <code>OPT_SUBCOMMAND(long, &fn_ptr, subcommand_fn)</code> |
| 1242 | </dt> |
| 1243 | <dd> |
| 1244 | <p> |
| 1245 | Define a subcommand. <code>subcommand_fn</code> is put into <code>fn_ptr</code> when |
| 1246 | this subcommand is used. |
Junio C Hamano | 84ea1e4 | 2016-04-08 21:53:48 | [diff] [blame] | 1247 | </p> |
| 1248 | </dd> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 1249 | </dl></div> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1250 | <div class="paragraph"><p>The last element of the array must be <code>OPT_END()</code>.</p></div> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1251 | <div class="paragraph"><p>If not stated otherwise, interpret the arguments as follows:</p></div> |
| 1252 | <div class="ulist"><ul> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1253 | <li> |
| 1254 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1255 | <code>short</code> is a character for the short option |
| 1256 | (e.g. <code>'e'</code> for <code>-e</code>, use <code>0</code> to omit), |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1257 | </p> |
| 1258 | </li> |
| 1259 | <li> |
| 1260 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1261 | <code>long</code> is a string for the long option |
| 1262 | (e.g. <code>"example"</code> for <code>--example</code>, use <code>NULL</code> to omit), |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1263 | </p> |
| 1264 | </li> |
| 1265 | <li> |
| 1266 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1267 | <code>int_var</code> is an integer variable, |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1268 | </p> |
| 1269 | </li> |
| 1270 | <li> |
| 1271 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1272 | <code>str_var</code> is a string variable (<code>char *</code>), |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1273 | </p> |
| 1274 | </li> |
| 1275 | <li> |
| 1276 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1277 | <code>arg_str</code> is the string that is shown as argument |
| 1278 | (e.g. <code>"branch"</code> will result in <code><branch></code>). |
| 1279 | If set to <code>NULL</code>, three dots (<code>...</code>) will be displayed. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1280 | </p> |
| 1281 | </li> |
| 1282 | <li> |
| 1283 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1284 | <code>description</code> is a short string to describe the effect of the option. |
| 1285 | It shall begin with a lower-case letter and a full stop (<code>.</code>) shall be |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1286 | omitted at the end. |
| 1287 | </p> |
| 1288 | </li> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 1289 | </ul></div> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1290 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1291 | </div> |
| 1292 | <div class="sect1"> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 1293 | <h2 id="_option_callbacks">Option Callbacks</h2> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1294 | <div class="sectionbody"> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1295 | <div class="paragraph"><p>The function must be defined in this form:</p></div> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1296 | <div class="literalblock"> |
| 1297 | <div class="content"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1298 | <pre><code>int func(const struct option *opt, const char *arg, int unset)</code></pre> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1299 | </div></div> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1300 | <div class="paragraph"><p>The callback mechanism is as follows:</p></div> |
| 1301 | <div class="ulist"><ul> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1302 | <li> |
| 1303 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1304 | Inside <code>func</code>, the only interesting member of the structure |
| 1305 | given by <code>opt</code> is the void pointer <code>opt->value</code>. |
| 1306 | <code>*opt->value</code> will be the value that is saved into <code>var</code>, if you |
| 1307 | use <code>OPT_CALLBACK()</code>. |
| 1308 | For example, do <code>*(unsigned long *)opt->value = 42;</code> to get 42 |
| 1309 | into an <code>unsigned long</code> variable. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1310 | </p> |
| 1311 | </li> |
| 1312 | <li> |
| 1313 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1314 | Return value <code>0</code> indicates success and non-zero return |
| 1315 | value will invoke <code>usage_with_options()</code> and, thus, die. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1316 | </p> |
| 1317 | </li> |
| 1318 | <li> |
| 1319 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1320 | If the user negates the option, <code>arg</code> is <code>NULL</code> and <code>unset</code> is 1. |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1321 | </p> |
| 1322 | </li> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 1323 | </ul></div> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1324 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1325 | </div> |
| 1326 | <div class="sect1"> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 1327 | <h2 id="_sophisticated_option_parsing">Sophisticated option parsing</h2> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1328 | <div class="sectionbody"> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1329 | <div class="paragraph"><p>If you need, for example, option callbacks with optional arguments |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1330 | or without arguments at all, or if you need other special cases, |
| 1331 | that are not handled by the macros above, you need to specify the |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1332 | members of the <code>option</code> structure manually.</p></div> |
Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1333 | <div class="paragraph"><p>This is not covered in this document, but well documented |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1334 | in <code>parse-options.h</code> itself.</p></div> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1335 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1336 | </div> |
| 1337 | <div class="sect1"> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 1338 | <h2 id="_examples">Examples</h2> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1339 | <div class="sectionbody"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1340 | <div class="paragraph"><p>See <code>test-parse-options.c</code> and |
| 1341 | <code>builtin/add.c</code>, |
| 1342 | <code>builtin/clone.c</code>, |
| 1343 | <code>builtin/commit.c</code>, |
| 1344 | <code>builtin/fetch.c</code>, |
| 1345 | <code>builtin/fsck.c</code>, |
| 1346 | <code>builtin/rm.c</code> |
Junio C Hamano | 4604fe5 | 2008-09-19 06:37:10 | [diff] [blame] | 1347 | for real-world examples.</p></div> |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1348 | </div> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 1349 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1350 | </div> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 1351 | <div id="footnotes"><hr /></div> |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 1352 | <div id="footer"> |
| 1353 | <div id="footer-text"> |
Junio C Hamano | 2ef0ba3 | 2018-01-26 23:13:53 | [diff] [blame] | 1354 | Last updated |
Junio C Hamano | a7b2c10 | 2023-06-13 21:00:15 | [diff] [blame] | 1355 | 2022-09-21 15:44:34 PDT |
Junio C Hamano | 3dac504 | 2007-12-15 08:40:54 | [diff] [blame] | 1356 | </div> |
| 1357 | </div> |
| 1358 | </body> |
| 1359 | </html> |