blob: e7f62b1ed89545cd5885f5eaff26d3666ceba1ce [file] [log] [blame]
Junio C Hamano944ce252018-05-30 22:25:261<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano3dac5042007-12-15 08:40:542<!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 Hamano9d971152012-12-19 00:43:116<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoa85030a2022-07-27 16:48:217<meta name="generator" content="AsciiDoc 10.2.0" />
Junio C Hamano97bcb482010-11-25 03:16:078<title>parse-options API</title>
Junio C Hamano3dac5042007-12-15 08:40:549<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:1110/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano3dac5042007-12-15 08:40:5425}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamano4604fe52008-09-19 06:37:1031a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano3dac5042007-12-15 08:40:5438
39em {
40 font-style: italic;
Junio C Hamano97bcb482010-11-25 03:16:0741 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:5442}
43
44strong {
45 font-weight: bold;
Junio C Hamano97bcb482010-11-25 03:16:0746 color: #083194;
Junio C Hamano3dac5042007-12-15 08:40:5447}
48
Junio C Hamano3dac5042007-12-15 08:40:5449h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:5451 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamano4604fe52008-09-19 06:37:1056h1, h2, h3 {
Junio C Hamano3dac5042007-12-15 08:40:5457 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano3dac5042007-12-15 08:40:5460 padding-top: 0.5em;
61}
Junio C Hamano4604fe52008-09-19 06:37:1062h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:1168h5 {
69 font-size: 1.0em;
70}
Junio C Hamano3dac5042007-12-15 08:40:5471
72div.sectionbody {
Junio C Hamano3dac5042007-12-15 08:40:5473 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano97bcb482010-11-25 03:16:0785ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:1188ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano97bcb482010-11-25 03:16:0790
Junio C Hamanoc14e6ad2014-10-31 20:25:5391.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:5495 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:5398pre {
99 white-space: pre-wrap;
100}
Junio C Hamano3dac5042007-12-15 08:40:54101
Junio C Hamano9d971152012-12-19 00:43:11102#author {
Junio C Hamano3dac5042007-12-15 08:40:54103 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54104 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10105 font-size: 1.1em;
Junio C Hamano3dac5042007-12-15 08:40:54106}
Junio C Hamano9d971152012-12-19 00:43:11107#email {
Junio C Hamano3dac5042007-12-15 08:40:54108}
Junio C Hamano9d971152012-12-19 00:43:11109#revnumber, #revdate, #revremark {
Junio C Hamano3dac5042007-12-15 08:40:54110}
111
Junio C Hamano9d971152012-12-19 00:43:11112#footer {
Junio C Hamano3dac5042007-12-15 08:40:54113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11118#footer-text {
Junio C Hamano3dac5042007-12-15 08:40:54119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11122#footer-badges {
Junio C Hamano3dac5042007-12-15 08:40:54123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11127#preamble {
Junio C Hamano97bcb482010-11-25 03:16:07128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano3dac5042007-12-15 08:40:54132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22134 margin-top: 1.0em;
Junio C Hamano3dac5042007-12-15 08:40:54135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano3dac5042007-12-15 08:40:54142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano97bcb482010-11-25 03:16:07150 color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano3dac5042007-12-15 08:40:54174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano3dac5042007-12-15 08:40:54181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano97bcb482010-11-25 03:16:07187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano3dac5042007-12-15 08:40:54190}
Junio C Hamano7bd050f2011-09-22 06:32:22191
Junio C Hamano97bcb482010-11-25 03:16:07192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54194 text-align: right;
195}
Junio C Hamano97bcb482010-11-25 03:16:07196
Junio C Hamano9d971152012-12-19 00:43:11197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano97bcb482010-11-25 03:16:07200}
201div.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 Hamano4604fe52008-09-19 06:37:10206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano3dac5042007-12-15 08:40:54209
210div.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}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22220 border-left: 3px solid #dddddd;
Junio C Hamano3dac5042007-12-15 08:40:54221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano3dac5042007-12-15 08:40:54226}
227
Junio C Hamano3dac5042007-12-15 08:40:54228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano97bcb482010-11-25 03:16:07230a.image:visited { color: white; }
Junio C Hamano3dac5042007-12-15 08:40:54231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano97bcb482010-11-25 03:16:07239 font-style: normal;
240 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54241}
242dd > *:first-child {
Junio C Hamano97bcb482010-11-25 03:16:07243 margin-top: 0.1em;
Junio C Hamano3dac5042007-12-15 08:40:54244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano97bcb482010-11-25 03:16:07249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano3dac5042007-12-15 08:40:54253 list-style-type: lower-alpha;
254}
Junio C Hamano97bcb482010-11-25 03:16:07255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano3dac5042007-12-15 08:40:54271
Junio C Hamano3dac5042007-12-15 08:40:54272tfoot {
273 font-weight: bold;
274}
Junio C Hamano97bcb482010-11-25 03:16:07275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano97bcb482010-11-25 03:16:07278
279div.hdlist {
Junio C Hamano3dac5042007-12-15 08:40:54280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano97bcb482010-11-25 03:16:07283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamano4604fe52008-09-19 06:37:10285}
Junio C Hamano97bcb482010-11-25 03:16:07286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano3dac5042007-12-15 08:40:54290 vertical-align: top;
Junio C Hamano97bcb482010-11-25 03:16:07291 font-style: normal;
Junio C Hamano3dac5042007-12-15 08:40:54292 padding-right: 0.8em;
Junio C Hamano97bcb482010-11-25 03:16:07293 color: navy;
Junio C Hamano3dac5042007-12-15 08:40:54294}
Junio C Hamano97bcb482010-11-25 03:16:07295td.hdlist2 {
Junio C Hamano3dac5042007-12-15 08:40:54296 vertical-align: top;
297}
Junio C Hamano97bcb482010-11-25 03:16:07298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano3dac5042007-12-15 08:40:54306
Junio C Hamano7bd050f2011-09-22 06:32:22307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.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 Hamano9d971152012-12-19 00:43:11334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano3dac5042007-12-15 08:40:54341}
Junio C Hamano4604fe52008-09-19 06:37:10342
Junio C Hamano9d971152012-12-19 00:43:11343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11351#toctitle {
Junio C Hamano4604fe52008-09-19 06:37:10352 color: #527bbd;
Junio C Hamano4604fe52008-09-19 06:37:10353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano4604fe52008-09-19 06:37:10360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano3dac5042007-12-15 08:40:54375
Junio C Hamano9d971152012-12-19 00:43:11376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
Junio C Hamano3dac5042007-12-15 08:40:54428}
Junio C Hamano9d971152012-12-19 00:43:11429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
Junio C Hamano3dac5042007-12-15 08:40:54433 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
Junio C Hamano3dac5042007-12-15 08:40:54450}
451
Junio C Hamano9d971152012-12-19 00:43:11452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
Junio C Hamano3dac5042007-12-15 08:40:54481}
482
Junio C Hamano9d971152012-12-19 00:43:11483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
Junio C Hamano97bcb482010-11-25 03:16:07502 text-align: right;
503}
504
Junio C Hamano9d971152012-12-19 00:43:11505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
Junio C Hamano97bcb482010-11-25 03:16:07507}
Junio C Hamano9d971152012-12-19 00:43:11508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
Junio C Hamano3dac5042007-12-15 08:40:54513}
514
Junio C Hamano9d971152012-12-19 00:43:11515
516/*
517 * manpage specific
518 *
519 * */
520
521body.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}
527body.manpage h2 {
528 border-style: none;
529}
530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano3dac5042007-12-15 08:40:54532}
Junio C Hamano4604fe52008-09-19 06:37:10533
Junio C Hamano9d971152012-12-19 00:43:11534@media print {
535 body.manpage div#toc { display: none; }
536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53537
538
Junio C Hamano3dac5042007-12-15 08:40:54539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano2b153182021-12-15 21:00:31542var 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.
562toc: 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
648footnotes: 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
708install: 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 Hamano9d971152012-12-19 00:43:11731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22732/*]]>*/
733</script>
Junio C Hamano3dac5042007-12-15 08:40:54734</head>
Junio C Hamano9d971152012-12-19 00:43:11735<body class="article">
Junio C Hamano3dac5042007-12-15 08:40:54736<div id="header">
737<h1>parse-options API</h1>
Junio C Hamanoaedeeae2023-07-18 15:55:30738<span id="revdate">2023-07-18</span>
Junio C Hamano3dac5042007-12-15 08:40:54739</div>
Junio C Hamano7bd050f2011-09-22 06:32:22740<div id="content">
Junio C Hamano3dac5042007-12-15 08:40:54741<div id="preamble">
742<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21743<div class="paragraph"><p>The parse-options API is used to parse and massage options in Git
Junio C Hamano4604fe52008-09-19 06:37:10744and to provide a usage help with consistent look.</p></div>
Junio C Hamano3dac5042007-12-15 08:40:54745</div>
746</div>
Junio C Hamano9d971152012-12-19 00:43:11747<div class="sect1">
Junio C Hamano4604fe52008-09-19 06:37:10748<h2 id="_basics">Basics</h2>
Junio C Hamano4224f992008-06-23 07:14:08749<div class="sectionbody">
Junio C Hamanoc14e6ad2014-10-31 20:25:53750<div class="paragraph"><p>The argument vector <code>argv[]</code> may usually contain mandatory or optional
Junio C Hamanof7f8f212022-09-01 20:57:29751<em>non-option arguments</em>, e.g. a filename or a branch, <em>options</em>, and
752<em>subcommands</em>.
Junio C Hamano4224f992008-06-23 07:14:08753Options are optional arguments that start with a dash and
Junio C Hamano4604fe52008-09-19 06:37:10754that allow to change the behavior of a command.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07755<div class="ulist"><ul>
Junio C Hamano4224f992008-06-23 07:14:08756<li>
757<p>
758There 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>
767There are basically two forms of options:
Junio C Hamanoc14e6ad2014-10-31 20:25:53768 <em>Short options</em> consist of one dash (<code>-</code>) and one alphanumeric
Junio C Hamano4224f992008-06-23 07:14:08769 character.
Junio C Hamanoc14e6ad2014-10-31 20:25:53770 <em>Long options</em> begin with two dashes (<code>--</code>) and some
Junio C Hamano4224f992008-06-23 07:14:08771 alphanumeric characters.
772</p>
773</li>
774<li>
775<p>
776Options are case-sensitive.
777 Please define <em>lower-case long options</em> only.
778</p>
779</li>
Junio C Hamano4604fe52008-09-19 06:37:10780</ul></div>
Junio C Hamano97bcb482010-11-25 03:16:07781<div class="paragraph"><p>The parse-options API allows:</p></div>
782<div class="ulist"><ul>
Junio C Hamano4224f992008-06-23 07:14:08783<li>
784<p>
Junio C Hamanof079f702013-12-06 23:43:18785<em>stuck</em> and <em>separate form</em> of options with arguments.
Junio C Hamanoc14e6ad2014-10-31 20:25:53786 <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 Hamano4224f992008-06-23 07:14:08788</p>
789</li>
790<li>
791<p>
792Long options may be <em>abbreviated</em>, as long as the abbreviation
793 is unambiguous.
794</p>
795</li>
796<li>
797<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53798Short options may be bundled, e.g. <code>-a -b</code> can be specified as <code>-ab</code>.
Junio C Hamano4224f992008-06-23 07:14:08799</p>
800</li>
801<li>
802<p>
803Boolean long options can be <em>negated</em> (or <em>unset</em>) by prepending
Junio C Hamanoc14e6ad2014-10-31 20:25:53804 <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 Hamanoc7102962013-05-29 23:57:17806 Other long options can be unset (e.g., set string to NULL, set
Junio C Hamanoc14e6ad2014-10-31 20:25:53807 integer to 0) by prepending <code>no-</code>.
Junio C Hamano4224f992008-06-23 07:14:08808</p>
809</li>
810<li>
811<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53812Options 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 Hamano4224f992008-06-23 07:14:08815</p>
816</li>
Junio C Hamano4604fe52008-09-19 06:37:10817</ul></div>
Junio C Hamanof7f8f212022-09-01 20:57:29818<div class="paragraph"><p>Subcommands are special in a couple of ways:</p></div>
819<div class="ulist"><ul>
820<li>
821<p>
822Subcommands only have long form, and they have no double dash prefix, no
823 negated form, and no description, and they don&#8217;t take any arguments, and
824 can&#8217;t be abbreviated.
825</p>
826</li>
827<li>
828<p>
829There 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>
835All arguments following the subcommand are considered to be arguments of
836 the subcommand, and, conversely, arguments meant for the subcommand may
Junio C Hamanoa1ee1292022-09-21 22:47:52837 not precede the subcommand.
Junio C Hamanof7f8f212022-09-01 20:57:29838</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>
846stop 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>
854stop and return, if it was invoked with the <code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code>
855 flag and that dashless argument doesn&#8217;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>
861show error and usage, and abort.
862</p>
863</li>
864</ul></div>
Junio C Hamano4224f992008-06-23 07:14:08865</div>
Junio C Hamano9d971152012-12-19 00:43:11866</div>
867<div class="sect1">
Junio C Hamano4604fe52008-09-19 06:37:10868<h2 id="_steps_to_parse_options">Steps to parse options</h2>
Junio C Hamano4224f992008-06-23 07:14:08869<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07870<div class="olist arabic"><ol class="arabic">
Junio C Hamano4224f992008-06-23 07:14:08871<li>
872<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53873<code>#include "parse-options.h"</code>
Junio C Hamano4224f992008-06-23 07:14:08874</p>
875</li>
876<li>
877<p>
878define a NULL-terminated
Junio C Hamanoc14e6ad2014-10-31 20:25:53879 <code>static const char * const builtin_foo_usage[]</code> array
Junio C Hamano4224f992008-06-23 07:14:08880 containing alternative usage strings
881</p>
882</li>
883<li>
884<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53885define <code>builtin_foo_options</code> array as described below
Junio C Hamano4224f992008-06-23 07:14:08886 in section <em>Data Structure</em>.
887</p>
888</li>
889<li>
890<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53891in <code>cmd_foo(int argc, const char **argv, const char *prefix)</code>
Junio C Hamano4224f992008-06-23 07:14:08892 call
893</p>
894<div class="literalblock">
895<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53896<pre><code>argc = parse_options(argc, argv, prefix, builtin_foo_options, builtin_foo_usage, flags);</code></pre>
Junio C Hamano4224f992008-06-23 07:14:08897</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53898<div class="paragraph"><p><code>parse_options()</code> will filter out the processed options of <code>argv[]</code> and leave the
899non-option arguments in <code>argv[]</code>.
900<code>argc</code> is updated appropriately because of the assignment.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07901<div class="paragraph"><p>You can also pass NULL instead of a usage array as the fifth parameter of
Junio C Hamano18f51402009-03-10 16:39:13902parse_options(), to avoid displaying a help screen with usage info and
903option list. This should only be done if necessary, e.g. to implement
904a limited parser for only a subset of the options that needs to be run
905before the full parser, which in turn shows the full help message.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07906<div class="paragraph"><p>Flags are the bitwise-or of:</p></div>
907<div class="dlist"><dl>
908<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53909<code>PARSE_OPT_KEEP_DASHDASH</code>
Junio C Hamano4224f992008-06-23 07:14:08910</dt>
911<dd>
912<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53913 Keep the <code>--</code> that usually separates options from
Junio C Hamano4224f992008-06-23 07:14:08914 non-option arguments.
915</p>
916</dd>
Junio C Hamano97bcb482010-11-25 03:16:07917<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53918<code>PARSE_OPT_STOP_AT_NON_OPTION</code>
Junio C Hamano4224f992008-06-23 07:14:08919</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 Hamano97bcb482010-11-25 03:16:07927<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53928<code>PARSE_OPT_KEEP_ARGV0</code>
Junio C Hamano18f51402009-03-10 16:39:13929</dt>
930<dd>
931<p>
Junio C Hamano97bcb482010-11-25 03:16:07932 Keep the first argument, which contains the program name. It&#8217;s
Junio C Hamano18f51402009-03-10 16:39:13933 removed from argv[] by default.
934</p>
935</dd>
Junio C Hamano97bcb482010-11-25 03:16:07936<dt class="hdlist1">
Junio C Hamanof7f8f212022-09-01 20:57:29937<code>PARSE_OPT_KEEP_UNKNOWN_OPT</code>
Junio C Hamano18f51402009-03-10 16:39:13938</dt>
939<dd>
940<p>
Junio C Hamanof7f8f212022-09-01 20:57:29941 Keep unknown options instead of erroring out. This doesn&#8217;t
Junio C Hamano18f51402009-03-10 16:39:13942 work for all combinations of arguments as users might expect
Junio C Hamanoc14e6ad2014-10-31 20:25:53943 it to do. E.g. if the first argument in <code>--unknown --known</code>
Junio C Hamano97bcb482010-11-25 03:16:07944 takes a value (which we can&#8217;t know), the second one is
Junio C Hamano18f51402009-03-10 16:39:13945 mistakenly interpreted as a known option. Similarly, if
Junio C Hamanoc14e6ad2014-10-31 20:25:53946 <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 Hamano18f51402009-03-10 16:39:13948 non-option, not as a value belonging to the unknown option,
Junio C Hamano97bcb482010-11-25 03:16:07949 the parser early. That&#8217;s why parse_options() errors out if
Junio C Hamano18f51402009-03-10 16:39:13950 both options are set.
Junio C Hamanof7f8f212022-09-01 20:57:29951 Note that non-option arguments are always kept, even without
952 this flag.
Junio C Hamano18f51402009-03-10 16:39:13953</p>
954</dd>
Junio C Hamano97bcb482010-11-25 03:16:07955<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53956<code>PARSE_OPT_NO_INTERNAL_HELP</code>
Junio C Hamano18f51402009-03-10 16:39:13957</dt>
958<dd>
959<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53960 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 Hamano18f51402009-03-10 16:39:13962 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 Hamanof7f8f212022-09-01 20:57:29966<dt class="hdlist1">
967<code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code>
968</dt>
969<dd>
970<p>
971 Don&#8217;t error out when no subcommand is specified.
972</p>
973</dd>
Junio C Hamano4604fe52008-09-19 06:37:10974</dl></div>
Junio C Hamano4224f992008-06-23 07:14:08975</li>
Junio C Hamano4604fe52008-09-19 06:37:10976</ol></div>
Junio C Hamanof7f8f212022-09-01 20:57:29977<div class="paragraph"><p>Note that <code>PARSE_OPT_STOP_AT_NON_OPTION</code> is incompatible with subcommands;
978while <code>PARSE_OPT_KEEP_DASHDASH</code> and <code>PARSE_OPT_KEEP_UNKNOWN_OPT</code> can only be
979used with subcommands when combined with <code>PARSE_OPT_SUBCOMMAND_OPTIONAL</code>.</p></div>
Junio C Hamano4224f992008-06-23 07:14:08980</div>
Junio C Hamano9d971152012-12-19 00:43:11981</div>
982<div class="sect1">
Junio C Hamano4604fe52008-09-19 06:37:10983<h2 id="_data_structure">Data Structure</h2>
Junio C Hamano4224f992008-06-23 07:14:08984<div class="sectionbody">
Junio C Hamanoc14e6ad2014-10-31 20:25:53985<div class="paragraph"><p>The main data structure is an array of the <code>option</code> struct,
986say <code>static struct option builtin_add_options[]</code>.
Junio C Hamano4604fe52008-09-19 06:37:10987There are some macros to easily define options:</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07988<div class="dlist"><dl>
989<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53990<code>OPT__ABBREV(&amp;int_var)</code>
Junio C Hamano4224f992008-06-23 07:14:08991</dt>
992<dd>
993<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53994 Add <code>--abbrev[=&lt;n&gt;]</code>.
Junio C Hamano4224f992008-06-23 07:14:08995</p>
996</dd>
Junio C Hamano97bcb482010-11-25 03:16:07997<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53998<code>OPT__COLOR(&amp;int_var, description)</code>
Junio C Hamano4aa0bcc2010-03-03 05:13:12999</dt>
1000<dd>
1001<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531002 Add <code>--color[=&lt;when&gt;]</code> and <code>--no-color</code>.
Junio C Hamano4aa0bcc2010-03-03 05:13:121003</p>
1004</dd>
Junio C Hamano97bcb482010-11-25 03:16:071005<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531006<code>OPT__DRY_RUN(&amp;int_var, description)</code>
Junio C Hamano4224f992008-06-23 07:14:081007</dt>
1008<dd>
1009<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531010 Add <code>-n, --dry-run</code>.
Junio C Hamano4224f992008-06-23 07:14:081011</p>
1012</dd>
Junio C Hamano97bcb482010-11-25 03:16:071013<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531014<code>OPT__FORCE(&amp;int_var, description)</code>
Junio C Hamano97bcb482010-11-25 03:16:071015</dt>
1016<dd>
1017<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531018 Add <code>-f, --force</code>.
Junio C Hamano97bcb482010-11-25 03:16:071019</p>
1020</dd>
1021<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531022<code>OPT__QUIET(&amp;int_var, description)</code>
Junio C Hamano4224f992008-06-23 07:14:081023</dt>
1024<dd>
1025<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531026 Add <code>-q, --quiet</code>.
Junio C Hamano4224f992008-06-23 07:14:081027</p>
1028</dd>
Junio C Hamano97bcb482010-11-25 03:16:071029<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531030<code>OPT__VERBOSE(&amp;int_var, description)</code>
Junio C Hamano4224f992008-06-23 07:14:081031</dt>
1032<dd>
1033<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531034 Add <code>-v, --verbose</code>.
Junio C Hamano4224f992008-06-23 07:14:081035</p>
1036</dd>
Junio C Hamano97bcb482010-11-25 03:16:071037<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531038<code>OPT_GROUP(description)</code>
Junio C Hamano4224f992008-06-23 07:14:081039</dt>
1040<dd>
1041<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531042 Start an option group. <code>description</code> is a short string that
Junio C Hamano4224f992008-06-23 07:14:081043 describes the group or an empty string.
1044 Start the description with an upper-case letter.
1045</p>
1046</dd>
Junio C Hamano97bcb482010-11-25 03:16:071047<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531048<code>OPT_BOOL(short, long, &amp;int_var, description)</code>
Junio C Hamano4224f992008-06-23 07:14:081049</dt>
1050<dd>
1051<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531052 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 Hamano4c6612f2011-10-12 23:54:211054</p>
1055</dd>
1056<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531057<code>OPT_COUNTUP(short, long, &amp;int_var, description)</code>
Junio C Hamano4c6612f2011-10-12 23:54:211058</dt>
1059<dd>
1060<p>
1061 Introduce a count-up option.
Junio C Hamanof2a3a752016-05-23 22:54:391062 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 Hamano4224f992008-06-23 07:14:081068</p>
1069</dd>
Junio C Hamano97bcb482010-11-25 03:16:071070<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531071<code>OPT_BIT(short, long, &amp;int_var, description, mask)</code>
Junio C Hamano4224f992008-06-23 07:14:081072</dt>
1073<dd>
1074<p>
1075 Introduce a boolean option.
Junio C Hamanoc14e6ad2014-10-31 20:25:531076 If used, <code>int_var</code> is bitwise-ored with <code>mask</code>.
Junio C Hamano4224f992008-06-23 07:14:081077</p>
1078</dd>
Junio C Hamano97bcb482010-11-25 03:16:071079<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531080<code>OPT_NEGBIT(short, long, &amp;int_var, description, mask)</code>
Junio C Hamano7ae18252009-05-23 09:53:321081</dt>
1082<dd>
1083<p>
1084 Introduce a boolean option.
Junio C Hamanoc14e6ad2014-10-31 20:25:531085 If used, <code>int_var</code> is bitwise-anded with the inverted <code>mask</code>.
Junio C Hamano7ae18252009-05-23 09:53:321086</p>
1087</dd>
Junio C Hamano97bcb482010-11-25 03:16:071088<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531089<code>OPT_SET_INT(short, long, &amp;int_var, description, integer)</code>
Junio C Hamano4224f992008-06-23 07:14:081090</dt>
1091<dd>
1092<p>
Junio C Hamano4c6612f2011-10-12 23:54:211093 Introduce an integer option.
Junio C Hamanoc14e6ad2014-10-31 20:25:531094 <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 Hamano4224f992008-06-23 07:14:081096</p>
1097</dd>
Junio C Hamano97bcb482010-11-25 03:16:071098<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531099<code>OPT_STRING(short, long, &amp;str_var, arg_str, description)</code>
Junio C Hamano4224f992008-06-23 07:14:081100</dt>
1101<dd>
1102<p>
1103 Introduce an option with string argument.
Junio C Hamanoc14e6ad2014-10-31 20:25:531104 The string argument is put into <code>str_var</code>.
Junio C Hamano4224f992008-06-23 07:14:081105</p>
1106</dd>
Junio C Hamano97bcb482010-11-25 03:16:071107<dt class="hdlist1">
Junio C Hamanocbe0eb22017-02-27 23:37:491108<code>OPT_STRING_LIST(short, long, &amp;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 Hamanoc14e6ad2014-10-31 20:25:531118<code>OPT_INTEGER(short, long, &amp;int_var, description)</code>
Junio C Hamano4224f992008-06-23 07:14:081119</dt>
1120<dd>
1121<p>
1122 Introduce an option with integer argument.
Junio C Hamanoc14e6ad2014-10-31 20:25:531123 The integer is put into <code>int_var</code>.
Junio C Hamano4224f992008-06-23 07:14:081124</p>
1125</dd>
Junio C Hamano97bcb482010-11-25 03:16:071126<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:001127<code>OPT_MAGNITUDE(short, long, &amp;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 Hamanod5176902017-05-16 04:30:561138<code>OPT_EXPIRY_DATE(short, long, &amp;timestamp_t_var, description)</code>
Junio C Hamanoc7102962013-05-29 23:57:171139</dt>
1140<dd>
1141<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531142 Introduce an option with expiry date argument, see <code>parse_expiry_date()</code>.
Junio C Hamanod5176902017-05-16 04:30:561143 The timestamp is put into <code>timestamp_t_var</code>.
Junio C Hamanoc7102962013-05-29 23:57:171144</p>
1145</dd>
1146<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531147<code>OPT_CALLBACK(short, long, &amp;var, arg_str, description, func_ptr)</code>
Junio C Hamano4224f992008-06-23 07:14:081148</dt>
1149<dd>
1150<p>
1151 Introduce an option with argument.
Junio C Hamanoc14e6ad2014-10-31 20:25:531152 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 Hamano4224f992008-06-23 07:14:081154 See <em>Option Callbacks</em> below for a more elaborate description.
1155</p>
1156</dd>
Junio C Hamano97bcb482010-11-25 03:16:071157<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531158<code>OPT_FILENAME(short, long, &amp;var, description)</code>
Junio C Hamano3d141512009-06-01 01:22:401159</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 Hamanoc14e6ad2014-10-31 20:25:531164 the prefix argument of <code>parse_options()</code> to <code>prefix_filename()</code>.
Junio C Hamano3d141512009-06-01 01:22:401165</p>
1166</dd>
Junio C Hamano97bcb482010-11-25 03:16:071167<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531168<code>OPT_NUMBER_CALLBACK(&amp;var, description, func_ptr)</code>
Junio C Hamano7ae18252009-05-23 09:53:321169</dt>
1170<dd>
1171<p>
1172 Recognize numerical options like -123 and feed the integer as
Junio C Hamanoc14e6ad2014-10-31 20:25:531173 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 Hamano7ae18252009-05-23 09:53:321175 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 Hamano97bcb482010-11-25 03:16:071180<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531181<code>OPT_COLOR_FLAG(short, long, &amp;int_var, description)</code>
Junio C Hamano4aa0bcc2010-03-03 05:13:121182</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 Hamanoc14e6ad2014-10-31 20:25:531187 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 Hamano4aa0bcc2010-03-03 05:13:121191 0 otherwise.
1192</p>
1193</dd>
Junio C Hamano4c6612f2011-10-12 23:54:211194<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531195<code>OPT_NOOP_NOARG(short, long)</code>
Junio C Hamano4c6612f2011-10-12 23:54:211196</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 Hamanod7ed4042015-08-03 19:43:001204<dt class="hdlist1">
1205<code>OPT_PASSTHRU(short, long, &amp;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 Hamanoc9dd6422020-08-10 23:32:551217<code>OPT_PASSTHRU_ARGV(short, long, &amp;strvec_var, arg_str, description, flags)</code>
Junio C Hamanod7ed4042015-08-03 19:43:001218</dt>
1219<dd>
1220<p>
1221 Introduce an option where all instances of it on the command-line will
Junio C Hamanoc9dd6422020-08-10 23:32:551222 be reconstructed into a strvec. This is useful when you need to
Junio C Hamanod7ed4042015-08-03 19:43:001223 pass the command-line option, which can be specified multiple times,
1224 to another command.
1225</p>
1226</dd>
Junio C Hamano84ea1e42016-04-08 21:53:481227<dt class="hdlist1">
1228<code>OPT_CMDMODE(short, long, &amp;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 Hamanof7f8f212022-09-01 20:57:291234 can be given by the user. <code>int_var</code> is set to <code>enum_val</code> when the
Junio C Hamano84ea1e42016-04-08 21:53:481235 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 Hamanof7f8f212022-09-01 20:57:291237 In new commands consider using subcommands instead.
1238</p>
1239</dd>
1240<dt class="hdlist1">
1241<code>OPT_SUBCOMMAND(long, &amp;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 Hamano84ea1e42016-04-08 21:53:481247</p>
1248</dd>
Junio C Hamano4604fe52008-09-19 06:37:101249</dl></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:531250<div class="paragraph"><p>The last element of the array must be <code>OPT_END()</code>.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:071251<div class="paragraph"><p>If not stated otherwise, interpret the arguments as follows:</p></div>
1252<div class="ulist"><ul>
Junio C Hamano4224f992008-06-23 07:14:081253<li>
1254<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531255<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 Hamano4224f992008-06-23 07:14:081257</p>
1258</li>
1259<li>
1260<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531261<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 Hamano4224f992008-06-23 07:14:081263</p>
1264</li>
1265<li>
1266<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531267<code>int_var</code> is an integer variable,
Junio C Hamano4224f992008-06-23 07:14:081268</p>
1269</li>
1270<li>
1271<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531272<code>str_var</code> is a string variable (<code>char *</code>),
Junio C Hamano4224f992008-06-23 07:14:081273</p>
1274</li>
1275<li>
1276<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531277<code>arg_str</code> is the string that is shown as argument
1278 (e.g. <code>"branch"</code> will result in <code>&lt;branch&gt;</code>).
1279 If set to <code>NULL</code>, three dots (<code>...</code>) will be displayed.
Junio C Hamano4224f992008-06-23 07:14:081280</p>
1281</li>
1282<li>
1283<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531284<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 Hamano4224f992008-06-23 07:14:081286 omitted at the end.
1287</p>
1288</li>
Junio C Hamano4604fe52008-09-19 06:37:101289</ul></div>
Junio C Hamano4224f992008-06-23 07:14:081290</div>
Junio C Hamano9d971152012-12-19 00:43:111291</div>
1292<div class="sect1">
Junio C Hamano4604fe52008-09-19 06:37:101293<h2 id="_option_callbacks">Option Callbacks</h2>
Junio C Hamano4224f992008-06-23 07:14:081294<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:071295<div class="paragraph"><p>The function must be defined in this form:</p></div>
Junio C Hamano4224f992008-06-23 07:14:081296<div class="literalblock">
1297<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531298<pre><code>int func(const struct option *opt, const char *arg, int unset)</code></pre>
Junio C Hamano4224f992008-06-23 07:14:081299</div></div>
Junio C Hamano97bcb482010-11-25 03:16:071300<div class="paragraph"><p>The callback mechanism is as follows:</p></div>
1301<div class="ulist"><ul>
Junio C Hamano4224f992008-06-23 07:14:081302<li>
1303<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531304Inside <code>func</code>, the only interesting member of the structure
1305 given by <code>opt</code> is the void pointer <code>opt-&gt;value</code>.
1306 <code>*opt-&gt;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-&gt;value = 42;</code> to get 42
1309 into an <code>unsigned long</code> variable.
Junio C Hamano4224f992008-06-23 07:14:081310</p>
1311</li>
1312<li>
1313<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531314Return value <code>0</code> indicates success and non-zero return
1315 value will invoke <code>usage_with_options()</code> and, thus, die.
Junio C Hamano4224f992008-06-23 07:14:081316</p>
1317</li>
1318<li>
1319<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531320If the user negates the option, <code>arg</code> is <code>NULL</code> and <code>unset</code> is 1.
Junio C Hamano4224f992008-06-23 07:14:081321</p>
1322</li>
Junio C Hamano4604fe52008-09-19 06:37:101323</ul></div>
Junio C Hamano4224f992008-06-23 07:14:081324</div>
Junio C Hamano9d971152012-12-19 00:43:111325</div>
1326<div class="sect1">
Junio C Hamano4604fe52008-09-19 06:37:101327<h2 id="_sophisticated_option_parsing">Sophisticated option parsing</h2>
Junio C Hamano4224f992008-06-23 07:14:081328<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:071329<div class="paragraph"><p>If you need, for example, option callbacks with optional arguments
Junio C Hamano4224f992008-06-23 07:14:081330or without arguments at all, or if you need other special cases,
1331that are not handled by the macros above, you need to specify the
Junio C Hamanoc14e6ad2014-10-31 20:25:531332members of the <code>option</code> structure manually.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:071333<div class="paragraph"><p>This is not covered in this document, but well documented
Junio C Hamanoc14e6ad2014-10-31 20:25:531334in <code>parse-options.h</code> itself.</p></div>
Junio C Hamano4224f992008-06-23 07:14:081335</div>
Junio C Hamano9d971152012-12-19 00:43:111336</div>
1337<div class="sect1">
Junio C Hamano4604fe52008-09-19 06:37:101338<h2 id="_examples">Examples</h2>
Junio C Hamano4224f992008-06-23 07:14:081339<div class="sectionbody">
Junio C Hamanoc14e6ad2014-10-31 20:25:531340<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 Hamano4604fe52008-09-19 06:37:101347for real-world examples.</p></div>
Junio C Hamano4224f992008-06-23 07:14:081348</div>
Junio C Hamano7bd050f2011-09-22 06:32:221349</div>
Junio C Hamano9d971152012-12-19 00:43:111350</div>
Junio C Hamano7bd050f2011-09-22 06:32:221351<div id="footnotes"><hr /></div>
Junio C Hamano3dac5042007-12-15 08:40:541352<div id="footer">
1353<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:531354Last updated
Junio C Hamanoa7b2c102023-06-13 21:00:151355 2022-09-21 15:44:34 PDT
Junio C Hamano3dac5042007-12-15 08:40:541356</div>
1357</div>
1358</body>
1359</html>