1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Cmdliner" rel="Chapter" href="Cmdliner.html"><link title="Interface" rel="Section" href="#top">
<link title="Basics" rel="Section" href="#basics">
<link title="Command line syntax" rel="Section" href="#cmdline">
<link title="Examples" rel="Section" href="#examples">
<link title="Multiple terms" rel="Subsection" href="#2_Multipleterms">
<link title="Manual" rel="Subsection" href="#2_Manual">
<link title="Miscellaneous" rel="Subsection" href="#2_Miscellaneous">
<link title="Optional arguments" rel="Subsection" href="#optargs">
<link title="Positional arguments" rel="Subsection" href="#posargs">
<link title="A rm command" rel="Subsection" href="#exrm">
<link title="A cp command" rel="Subsection" href="#excp">
<link title="A tail command" rel="Subsection" href="#extail">
<link title="A darcs command" rel="Subsection" href="#exdarcs">
<title>Cmdliner</title>
</head>
<body>
<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Module <a href="type_Cmdliner.html">Cmdliner</a></h1>
<pre><span class="keyword">module</span> Cmdliner: <code class="code"><span class="keyword">sig</span></code> <a href="Cmdliner.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
Declarative definition of command line interfaces.
<p>
<code class="code"><span class="constructor">Cmdliner</span></code> provides a simple and compositional mechanism
to convert command line arguments to OCaml values and pass them to
your functions. The module automatically handles syntax errors,
help messages and UNIX man page generation. It supports programs
with single or multiple commands
(like <code class="code">darcs</code> or <code class="code">git</code>) and respect most of the
<a href="http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html">
POSIX</a> and
<a href="http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html">
GNU</a> conventions.
<p>
Consult the <a href="Cmdliner.html#basics">basics</a>, details about the supported
<a href="Cmdliner.html#cmdline">command line syntax</a> and <a href="Cmdliner.html#examples"> examples</a> of
use. Open the module to use it, it defines only three modules in
your scope.
<p>
<em>Release 0.9.4 - Daniel Bünzli <daniel.buenzl i@erratique.ch> </em><br>
</div>
<hr width="100%">
<br>
<h1 id="top">Interface</h1><br>
<pre><span class="keyword">module</span> <a href="Cmdliner.Manpage.html">Manpage</a>: <code class="code"><span class="keyword">sig</span></code> <a href="Cmdliner.Manpage.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Man page specification.
</div>
<pre><span class="keyword">module</span> <a href="Cmdliner.Term.html">Term</a>: <code class="code"><span class="keyword">sig</span></code> <a href="Cmdliner.Term.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Terms.
</div>
<pre><span class="keyword">module</span> <a href="Cmdliner.Arg.html">Arg</a>: <code class="code"><span class="keyword">sig</span></code> <a href="Cmdliner.Arg.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Terms for command line arguments.
</div>
<br>
<h1 id="basics">Basics</h1>
<p>
With <code class="code"><span class="constructor">Cmdliner</span></code> your program evaluates a term. A <em>term</em>
is a value of type <a href="Cmdliner.Term.html#TYPEt"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.t</code></a>. The type parameter indicates
the type of the result of the evaluation.
<p>
One way to create terms is by lifting regular OCaml values with
<a href="Cmdliner.Term.html#VALpure"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.pure</code></a>. Terms can be applied to terms evaluating to
functional values with <a href="Cmdliner.Term.html#VAL($)"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.($)</code></a> (the type for terms is an
<a href="http://dx.doi.org/10.1017/S0956796807006326">applicative
functor</a>). For example for the function:
<pre class="codepre"><code class="code"><span class="keyword">let</span> revolt () = print_endline <span class="string">"Revolt!"</span></code></pre>
the term :
<pre class="codepre"><code class="code"><span class="keyword">open</span> <span class="constructor">Cmdliner</span>;;<br>
<br>
<span class="keyword">let</span> revolt_t = <span class="constructor">Term</span>.(pure revolt $ pure ())</code></pre>
is a term that evaluates to the result (and effect) of the <code class="code">revolt</code>
function.
Terms are evaluated with <a href="Cmdliner.Term.html#VALeval"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.eval</code></a>:
<pre class="codepre"><code class="code"><span class="keyword">let</span> () = <span class="keyword">match</span> <span class="constructor">Term</span>.eval (revolt_t, <span class="constructor">Term</span>.info <span class="string">"revolt"</span>) <span class="keyword">with</span> <br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Error</span> _ <span class="keywordsign">-></span> exit 1 <span class="keywordsign">|</span> _ <span class="keywordsign">-></span> exit 0</code></pre>
This defines a command line program named <code class="code"><span class="string">"revolt"</span></code>, without command line
arguments arguments, that just prints <code class="code"><span class="string">"Revolt!"</span></code> on <code class="code">stdout</code>.
<pre class="codepre"><code class="code">> ./revolt <br>
<span class="constructor">Revolt</span>!</code></pre>
The combinators in the <a href="Cmdliner.Arg.html"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span></code></a> module allow to extract command
line argument data as terms. These terms can then be applied to
lifted OCaml functions to be evaluated by the program.
<p>
Terms corresponding to command line argument data that are part of
a term evaluation implicitly define a command line syntax. We
show this on an concrete example.
<p>
Consider the <code class="code">chorus</code> function that prints repeatedly a
given message :
<pre class="codepre"><code class="code"><span class="keyword">let</span> chorus count msg = <br>
<span class="keyword">for</span> i = 1 <span class="keyword">to</span> count <span class="keyword">do</span> print_endline msg <span class="keyword">done</span></code></pre>
we want to make it available from the command line
with the synopsis:
<pre class="codepre"><code class="code">chorus [-c <span class="constructor">COUNT</span> <span class="keywordsign">|</span> --count=<span class="constructor">COUNT</span>] [<span class="constructor">MSG</span>]</code></pre>
where <code class="code"><span class="constructor">COUNT</span></code> defaults to <code class="code">10</code> and <code class="code"><span class="constructor">MSG</span></code> defaults to <code class="code"><span class="string">"Revolt!"</span></code>.
We first define a term corresponding to the <code class="code">--count</code>
option:
<pre class="codepre"><code class="code"><span class="keyword">let</span> count = <br>
<span class="keyword">let</span> doc = <span class="string">"Repeat the message $(docv) times."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> opt int 10 <span class="keywordsign">&</span> info [<span class="string">"c"</span>; <span class="string">"count"</span>] ~docv:<span class="string">"COUNT"</span> ~doc)<br>
</code></pre>
This says that <code class="code">count</code> is a term that evaluates to the
value of an optional argument of type <code class="code">int</code> that
defaults to <code class="code">10</code> if unspecified and whose option name is
either <code class="code">-c</code> or <code class="code">--count</code>. The arguments <code class="code">doc</code> and <code class="code">docv</code> are used to
generate the option's man page information.
<p>
The term for the positional argument <code class="code"><span class="constructor">MSG</span></code> is:
<pre class="codepre"><code class="code"><span class="keyword">let</span> msg = <br>
<span class="keyword">let</span> doc = <span class="string">"The message to print."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> pos 0 string <span class="string">"Revolt!"</span> <span class="keywordsign">&</span> info [] ~docv:<span class="string">"MSG"</span> ~doc)<br>
</code></pre>
which says that <code class="code">msg</code> is a term whose value is
the positional argument at index <code class="code">0</code> of type <code class="code">string</code> and
defaults to <code class="code"><span class="string">"Revolt!"</span></code> if unspecified. Here again
<code class="code">doc</code> and <code class="code">docv</code> are used for the man page information.
<p>
The term for executing <code class="code">chorus</code> with these command line arguments
is :
<pre class="codepre"><code class="code"><span class="keyword">let</span> chorus_t = <span class="constructor">Term</span>.(pure chorus $ count $ msg)<br>
</code></pre>
and we are now ready to define our program:
<pre class="codepre"><code class="code"><span class="keyword">let</span> info = <br>
<span class="keyword">let</span> doc = <span class="string">"print a customizable message repeatedly"</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> man = [ <span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"BUGS"</span>; <span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Email bug reports to <hehey at example.org>."</span>;] <span class="keyword">in</span><br>
<span class="constructor">Term</span>.info <span class="string">"chorus"</span> ~version:<span class="string">"1.6.1"</span> ~doc ~man<br>
<br>
<span class="keyword">let</span> () = <span class="keyword">match</span> <span class="constructor">Term</span>.eval (chorus_t, info) <span class="keyword">with</span> <span class="keywordsign">`</span><span class="constructor">Error</span> _ <span class="keywordsign">-></span> exit 1 <span class="keywordsign">|</span> _ <span class="keywordsign">-></span> exit 0<br>
</code></pre>
The <code class="code">info</code> value created with <a href="Cmdliner.Term.html#VALinfo"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info</code></a> gives more information
about the term we execute and is used to generate the program's
man page. Since we provided a <code class="code">~version</code> string, the program will
automatically respond to the <code class="code">--version</code> option by printing this
string.
<p>
A program using <a href="Cmdliner.Term.html#VALeval"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.eval</code></a> always responds to the
<code class="code">--help</code> option by showing the man page about the program generated
using the information you provided with <a href="Cmdliner.Term.html#VALinfo"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info</code></a> and <a href="Cmdliner.Arg.html#VALinfo"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.info</code></a>.
Here is the output generated by our example :
<pre class="verbatim">> ./chorus --help
NAME
chorus - print a customizable message repeatedly
SYNOPSIS
chorus [OPTION]... [MSG]
ARGUMENTS
MSG (absent=Revolt!)
The message to print.
OPTIONS
-c COUNT, --count=COUNT (absent=10)
Repeat the message COUNT times.
--help[=FMT] (default=pager)
Show this help in format FMT (pager, plain or groff).
--version
Show version information.
BUGS
Email bug reports to <hehey at example.org>.</pre>
<p>
If a pager is available, this output is written to a pager.
This help is also available in plain text or in the
<a href="http://www.gnu.org/software/groff/groff.html">groff</a> man page format by
invoking the program with the option <code class="code">--help=plain</code> or <code class="code">--help=groff</code>.
<p>
For examples of more complex command line definitions look and
run the <a href="Cmdliner.html#examples">examples</a>.
<p>
<h2 id="2_Multipleterms">Multiple terms</h2>
<p>
<code class="code"><span class="constructor">Cmdliner</span></code> also provides support for programs like <code class="code">darcs</code> or
<code class="code">git</code> that have multiple commands each with their own syntax:
<pre class="codepre"><code class="code">prog <span class="constructor">COMMAND</span> [<span class="constructor">OPTION</span>]... <span class="constructor">ARG</span>...</code></pre>
A command is defined by coupling a term with
<a href="Cmdliner.Term.html#tinfo">term information</a>. The term information defines the
command name and its man page. Given a list of commands the function
<a href="Cmdliner.Term.html#VALeval_choice"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.eval_choice</code></a> will execute the term corresponding to the
<code class="code"><span class="constructor">COMMAND</span></code> argument or or a specific "main" term if there is
no <code class="code"><span class="constructor">COMMAND</span></code> argument.
<p>
<h2 id="2_Manual">Manual</h2>
<p>
Man page sections are printed in the order specified by
<a href="Cmdliner.Term.html#VALinfo"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info</code></a>. The man page information of an argument is listed in
alphabetical order at the end of the text of the section specified
by its <a href="Cmdliner.Arg.html#VALinfo">argument information</a>. Positional arguments are
also listed iff both the <code class="code">docv</code> and <code class="code">doc</code> string is specified in
their argument information.
<p>
If an argument information mentions a section not specified in
<a href="Cmdliner.Term.html#VALinfo"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info</code></a>, an empty section is created for it. This section is
inserted just after the <code class="code"><span class="string">"SYNOPSIS"</span></code> section or after a section
named <code class="code"><span class="string">"DESCRIPTION"</span></code> if there is one.
<p>
The <code class="code"><span class="string">"SYNOPSIS"</span></code> section of a man page is generated automatically
from a term's information and its arguments. To substitute your
own instead, start the term's information man page with
a <code class="code"><span class="string">"SYNOPSIS"</span></code> section.
<p>
Ideally all manual strings should be UTF-8 encoded. However at the
moment Groff (at least <code class="code">1.19.2</code>) doesn't seem to cope with UTF-8
input and UTF-8 characters beyond the ASCII set will look garbled.
Regarding UTF-8 output, generating the man page with <code class="code">-<span class="constructor">Tutf8</span></code> maps
the hyphen-minus <code class="code"><span class="constructor">U</span>+002<span class="constructor">D</span></code> to the minus sign <code class="code"><span class="constructor">U</span>+2212</code> which makes it
difficult to search it in the pager, so <code class="code">-<span class="constructor">Tascii</span></code> is used for now.
Conclusion is that it may be better to stick to the ASCII set for now.
Please contact the author if something seems wrong in this reasoning
or if you know a work around this.
<p>
<h2 id="2_Miscellaneous">Miscellaneous</h2>
<p>
<ul>
<li>The option name <code class="code">--help</code>, (and <code class="code">--version</code> if you specify a
version string) is reserved by the module. Using it as a term or
option name may result in undefined behaviour.</li>
<li>The evaluation of a term in which the same option name is defined
by more than one argument is undefined.</li>
</ul>
<p>
<h1 id="cmdline">Command line syntax</h1>
<p>
For programs evaluating a single term the most general form of invocation
is:
<ul>
<li><code class="code">prog [<span class="constructor">OPTION</span>]... [<span class="constructor">ARG</span>]...</code></li>
</ul>
The program automatically reponds to the <code class="code">--help</code> option by
printing the help. If a version string is provided in
the <a href="Cmdliner.Term.html#tinfo">term information</a>, it also automatically responds
to the <code class="code">--version</code> option by printing this string.
<p>
Command line arguments are either <a href="Cmdliner.html#optargs"><em>optional</em></a> or
<a href="Cmdliner.html#posargs"><em>positional</em></a>. Both can be freely interleaved but
since <code class="code"><span class="constructor">Cmdliner</span></code> accepts many optional forms this may result in
ambiguities. The special <a href="Cmdliner.html#posargs"> token <code class="code">--</code></a> can be used to resolve
them.
<p>
Programs evaluating multiple terms also add this form of invocation:
<ul>
<li><code class="code">prog <span class="constructor">COMMAND</span> [<span class="constructor">OPTION</span>]... [<span class="constructor">ARG</span>]...</code></li>
</ul>
Commands automatically respond to the <code class="code">--help</code> option
by printing their help. The <code class="code"><span class="constructor">COMMAND</span></code> string must
be the first string following the program name and may be specified
by a prefix as long as it is not ambiguous.
<p>
<h2 id="optargs">Optional arguments</h2>
<p>
An optional argument is specified on the command line by a <em> name</em> possibly followed by a <em>value</em>.
<p>
The name of an option can be short or long.
<ul>
<li>A <em>short</em> name is a dash followed by a single alphanumeric
character: <code class="code"><span class="string">"-h"</span></code>, <code class="code"><span class="string">"-q"</span></code>, <code class="code"><span class="string">"-I"</span></code>.</li>
<li>A <em>long</em> name is two dashes followed by alphanumeric
characters and dashes: <code class="code"><span class="string">"--help"</span></code>, <code class="code"><span class="string">"--silent"</span></code>, <code class="code"><span class="string">"--ignore-case"</span></code>.</li>
</ul>
<p>
More than one name may refer to the same optional argument. For
example in a given program the names <code class="code"><span class="string">"-q"</span></code>, <code class="code"><span class="string">"--quiet"</span></code> and
<code class="code"><span class="string">"--silent"</span></code> may all stand for the same boolean argument
indicating the program to be quiet. Long names
can be specified by any non ambiguous prefix.
<p>
The value of an option can be specified in three different ways.
<ul>
<li>As the next token on the command line: <code class="code"><span class="string">"-o a.out"</span></code>,
<code class="code"><span class="string">"--output a.out"</span></code>.</li>
<li>Glued to a short name: <code class="code"><span class="string">"-oa.out"</span></code>.</li>
<li>Glued to a long name after an equal character:
<code class="code"><span class="string">"--output=a.out"</span></code>.</li>
</ul>
Glued forms are especially useful if
the value itself starts with a dash as is the case for negative numbers,
<code class="code"><span class="string">"--min=-10"</span></code>.
<p>
An optional argument without a value is either a <em>flag</em>
(see <a href="Cmdliner.Arg.html#VALflag"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.flag</code></a>, <a href="Cmdliner.Arg.html#VALvflag"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.vflag</code></a>) or an optional argument with an optional
value (see the <code class="code">~vopt</code> argument of <a href="Cmdliner.Arg.html#VALopt"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.opt</code></a>).
<p>
<h2 id="posargs">Positional arguments</h2>
<p>
Positional arguments are tokens on the command line that are not
option names and are not the value of an optional argument. They
are numbered from left to right starting with zero.
<p>
Since positional arguments may be mistaken as the optional value
of an optional argument or they may need to look like option
names, anything that follows the special token <code class="code"><span class="string">"--"</span></code> on the command
line is considered to be a positional argument.
<p>
<h1 id="examples">Examples</h1>
<p>
These examples are in the <code class="code">test</code> directory of the distribution.
<p>
<h2 id="exrm">A <code class="code">rm</code> command</h2>
<p>
We define the command line interface of a
<code class="code">rm</code> command with the synopsis:
<pre class="codepre"><code class="code">rm [<span class="constructor">OPTION</span>]... <span class="constructor">FILE</span>...<br>
</code></pre>
The <code class="code">-f</code>, <code class="code">-i</code> and <code class="code">-<span class="constructor">I</span></code> flags define the prompt behaviour of <code class="code">rm</code>,
represented in our program by the <code class="code">prompt</code> type. If more than one
of these flags is present on the command line the last one takes
precedence.
<p>
To implement this behaviour we map the presence of these flags
to values of the <code class="code">prompt</code> type by using <a href="Cmdliner.Arg.html#VALvflag_all"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.vflag_all</code></a>. This
argument will contain all occurences of the flag on the command
line and we just take the <a href="Cmdliner.Arg.html#VALlast"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.last</code></a> one to define our term value
(if there's no occurence the last value of the default list <code class="code">[<span class="constructor">Always</span>]</code> is
taken, i.e. the default is <code class="code"><span class="constructor">Always</span></code>).
<pre class="codepre"><code class="code"><span class="comment">(* Implementation of the command, we just print the args. *)</span><br>
<br>
<span class="keyword">type</span> prompt = <span class="constructor">Always</span> <span class="keywordsign">|</span> <span class="constructor">Once</span> <span class="keywordsign">|</span> <span class="constructor">Never</span><br>
<span class="keyword">let</span> prompt_str = <span class="keyword">function</span> <br>
<span class="keywordsign">|</span> <span class="constructor">Always</span> <span class="keywordsign">-></span> <span class="string">"always"</span> <span class="keywordsign">|</span> <span class="constructor">Once</span> <span class="keywordsign">-></span> <span class="string">"once"</span> <span class="keywordsign">|</span> <span class="constructor">Never</span> <span class="keywordsign">-></span> <span class="string">"never"</span><br>
<br>
<span class="keyword">let</span> rm prompt recurse files =<br>
<span class="constructor">Printf</span>.printf <span class="string">"prompt = %s\nrecurse = %b\nfiles = %s\n"</span><br>
(prompt_str prompt) recurse (<span class="constructor">String</span>.concat <span class="string">", "</span> files)<br>
<br>
<span class="comment">(* Command line interface *)</span><br>
<br>
<span class="keyword">open</span> <span class="constructor">Cmdliner</span>;;<br>
<br>
<span class="keyword">let</span> files = <span class="constructor">Arg</span>.(non_empty <span class="keywordsign">&</span> pos_all file [] <span class="keywordsign">&</span> info [] ~docv:<span class="string">"FILE"</span>)<br>
<span class="keyword">let</span> prompt =<br>
<span class="keyword">let</span> doc = <span class="string">"Prompt before every removal."</span> <span class="keyword">in</span> <br>
<span class="keyword">let</span> always = <span class="constructor">Always</span>, <span class="constructor">Arg</span>.info [<span class="string">"i"</span>] ~doc <span class="keyword">in</span><br>
<span class="keyword">let</span> doc = <span class="string">"Ignore nonexistent files and never prompt."</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> never = <span class="constructor">Never</span>, <span class="constructor">Arg</span>.info [<span class="string">"f"</span>; <span class="string">"force"</span>] ~doc <span class="keyword">in</span><br>
<span class="keyword">let</span> doc = <span class="string">"Prompt once before removing more than three files, or when<br>
removing recursively. Less intrusive than $(b,-i), while <br>
still giving protection against most mistakes."</span> <br>
<span class="keyword">in</span><br>
<span class="keyword">let</span> once = <span class="constructor">Once</span>, <span class="constructor">Arg</span>.info [<span class="string">"I"</span>] ~doc <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(last <span class="keywordsign">&</span> vflag_all [<span class="constructor">Always</span>] [always; never; once])<br>
<br>
<span class="keyword">let</span> recursive = <br>
<span class="keyword">let</span> doc = <span class="string">"Remove directories and their contents recursively."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> flag <span class="keywordsign">&</span> info [<span class="string">"r"</span>; <span class="string">"R"</span>; <span class="string">"recursive"</span>] ~doc)<br>
<br>
<span class="keyword">let</span> cmd = <br>
<span class="keyword">let</span> doc = <span class="string">"remove files or directories"</span> <span class="keyword">in</span> <br>
<span class="keyword">let</span> man = [<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"DESCRIPTION"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"$(tname) removes each specified $(i,FILE). By default it does not <br>
remove directories, to also remove them and their contents, use the<br>
option $(b,--recursive) ($(b,-r) or $(b,-R))."</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"To remove a file whose name starts with a `-', for example<br>
`-foo', use one of these commands:"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"rm -- -foo"</span>; <span class="keywordsign">`</span><span class="constructor">Noblank</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"rm ./-foo"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"$(tname) removes symbolic links, not the files referenced by the <br>
links."</span>;<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"BUGS"</span>; <span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Report bugs to <hehey at example.org>."</span>;<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"SEE ALSO"</span>; <span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"$(b,rmdir)(1), $(b,unlink)(2)"</span> ] <br>
<span class="keyword">in</span><br>
<span class="constructor">Term</span>.(pure rm $ prompt $ recursive $ files),<br>
<span class="constructor">Term</span>.info <span class="string">"rm"</span> ~version:<span class="string">"1.6.1"</span> ~doc ~man<br>
<br>
<span class="keyword">let</span> () = <span class="keyword">match</span> <span class="constructor">Term</span>.eval cmd <span class="keyword">with</span> <span class="keywordsign">`</span><span class="constructor">Error</span> _ <span class="keywordsign">-></span> exit 1 <span class="keywordsign">|</span> _ <span class="keywordsign">-></span> exit 0<br>
</code></pre>
<h2 id="excp">A <code class="code">cp</code> command</h2>
<p>
We define the command line interface of a
<code class="code">cp</code> command with the synopsis:
<pre class="codepre"><code class="code">cp [<span class="constructor">OPTION</span>]... <span class="constructor">SOURCE</span>... <span class="constructor">DEST</span> </code></pre>
The <code class="code"><span class="constructor">DEST</span></code> argument must be a directory if there is more than
one <code class="code"><span class="constructor">SOURCE</span></code>. This constraint is too complex to be expressed by the
combinators of <a href="Cmdliner.Arg.html"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span></code></a>. Hence we just give it the <a href="Cmdliner.Arg.html#VALstring"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.string</code></a> type
and verify the constraint at the beginning of the <code class="code">cp</code>
implementation. If unsatisfied we return an <code class="code"><span class="keywordsign">`</span><span class="constructor">Error</span></code> and
by using <a href="Cmdliner.Term.html#VALret"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.ret</code></a> on the lifted result <code class="code">cp_t</code> of <code class="code">cp</code>,
<code class="code"><span class="constructor">Cmdliner</span></code> handles the error reporting.
<pre class="codepre"><code class="code"><span class="comment">(* Implementation, we check the dest argument and print the args *)</span><br>
<br>
<span class="keyword">let</span> cp verbose recurse force srcs dest =<br>
<span class="keyword">if</span> <span class="constructor">List</span>.length srcs > 1 <span class="keywordsign">&&</span> <br>
(not (<span class="constructor">Sys</span>.file_exists dest) <span class="keywordsign">||</span> not (<span class="constructor">Sys</span>.is_directory dest)) <br>
<span class="keyword">then</span> <br>
<span class="keywordsign">`</span><span class="constructor">Error</span> (<span class="keyword">false</span>, dest ^ <span class="string">" is not a directory"</span>) <br>
<span class="keyword">else</span> <br>
<span class="keywordsign">`</span><span class="constructor">Ok</span> (<span class="constructor">Printf</span>.printf <br>
<span class="string">"verbose = %b\nrecurse = %b\nforce = %b\nsrcs = %s\ndest = %s\n"</span> <br>
verbose recurse force (<span class="constructor">String</span>.concat <span class="string">", "</span> srcs) dest)<br>
<br>
<span class="comment">(* Command line interface *)</span><br>
<br>
<span class="keyword">open</span> <span class="constructor">Cmdliner</span>;;<br>
<br>
<span class="keyword">let</span> verbose = <br>
<span class="keyword">let</span> doc = <span class="string">"Print file names as they are copied."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> flag <span class="keywordsign">&</span> info [<span class="string">"v"</span>; <span class="string">"verbose"</span>] ~doc) <br>
<br>
<span class="keyword">let</span> recurse = <br>
<span class="keyword">let</span> doc = <span class="string">"Copy directories recursively."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> flag <span class="keywordsign">&</span> info [<span class="string">"r"</span>; <span class="string">"R"</span>; <span class="string">"recursive"</span>] ~doc)<br>
<br>
<span class="keyword">let</span> force = <br>
<span class="keyword">let</span> doc = <span class="string">"If a destination file cannot be opened, remove it and try again."</span><span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> flag <span class="keywordsign">&</span> info [<span class="string">"f"</span>; <span class="string">"force"</span>] ~doc)<br>
<br>
<span class="keyword">let</span> srcs = <br>
<span class="keyword">let</span> doc = <span class="string">"Source file(s) to copy."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(non_empty <span class="keywordsign">&</span> pos_left ~rev:<span class="keyword">true</span> 0 file [] <span class="keywordsign">&</span> info [] ~docv:<span class="string">"SOURCE"</span> ~doc) <br>
<br>
<span class="keyword">let</span> dest = <br>
<span class="keyword">let</span> doc = <span class="string">"Destination of the copy. Must be a directory if there is more <br>
than one $(i,SOURCE)."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(required <span class="keywordsign">&</span> pos ~rev:<span class="keyword">true</span> 0 (some string) <span class="constructor">None</span> <span class="keywordsign">&</span> info [] ~docv:<span class="string">"DEST"</span> <br>
~doc)<br>
<br>
<span class="keyword">let</span> cmd = <br>
<span class="keyword">let</span> doc = <span class="string">"copy files"</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> man = [<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"BUGS"</span>; <br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Email them to <hehey at example.org>."</span>; <br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"SEE ALSO"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"$(b,mv)(1), $(b,scp)(1), $(b,umask)(2), $(b,symlink)(7)"</span> ]<br>
<span class="keyword">in</span><br>
<span class="constructor">Term</span>.(ret (pure cp $ verbose $ recurse $ force $ srcs $ dest)), <br>
<span class="constructor">Term</span>.info <span class="string">"cp"</span> ~version:<span class="string">"1.6.1"</span> ~doc ~man<br>
<br>
<span class="keyword">let</span> () = <span class="keyword">match</span> <span class="constructor">Term</span>.eval cmd <span class="keyword">with</span> <span class="keywordsign">`</span><span class="constructor">Error</span> _ <span class="keywordsign">-></span> exit 1 <span class="keywordsign">|</span> _ <span class="keywordsign">-></span> exit 0<br>
</code></pre>
<p>
<h2 id="extail">A <code class="code">tail</code> command</h2>
<p>
We define the command line interface of a <code class="code">tail</code> command with the
synopsis:
<pre class="codepre"><code class="code">tail [<span class="constructor">OPTION</span>]... [<span class="constructor">FILE</span>]...</code></pre>
<p>
The <code class="code">--lines</code> option whose value specifies the number of last lines to
print has a special syntax where a <code class="code">+</code> prefix indicates to start
printing from that line number. In the program this is represented by
the <code class="code">loc</code> type. We define a custom <code class="code">loc</code> <a href="Cmdliner.Arg.html#argconv">argument converter</a>
for this option.
<p>
The <code class="code">--follow</code> option has an optional enumerated value. The argument
converter <code class="code">follow</code>, created with <a href="Cmdliner.Arg.html#VALenum"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.enum</code></a> parses the option value
into the enumeration. By using <a href="Cmdliner.Arg.html#VALsome"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.some</code></a> and the <code class="code">~vopt</code> argument of
<a href="Cmdliner.Arg.html#VALopt"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.opt</code></a>, the term corresponding to the option <code class="code">--follow</code> evaluates to
<code class="code"><span class="constructor">None</span></code> if <code class="code">--follow</code> is absent from the command line, to <code class="code"><span class="constructor">Some</span> <span class="constructor">Descriptor</span></code>
if present but without a value and to <code class="code"><span class="constructor">Some</span> v</code> if present with a value
<code class="code">v</code> specified.
<p>
<pre class="codepre"><code class="code"><span class="comment">(* Implementation of the command, we just print the args. *)</span><br>
<br>
<span class="keyword">type</span> loc = bool * int<br>
<span class="keyword">type</span> verb = <span class="constructor">Verbose</span> <span class="keywordsign">|</span> <span class="constructor">Quiet</span> <br>
<span class="keyword">type</span> follow = <span class="constructor">Name</span> <span class="keywordsign">|</span> <span class="constructor">Descriptor</span><br>
<br>
<span class="keyword">let</span> str = <span class="constructor">Printf</span>.sprintf <br>
<span class="keyword">let</span> opt_str sv = <span class="keyword">function</span> <span class="constructor">None</span> <span class="keywordsign">-></span> <span class="string">"None"</span> <span class="keywordsign">|</span> <span class="constructor">Some</span> v <span class="keywordsign">-></span> str <span class="string">"Some(%s)"</span> (sv v)<br>
<span class="keyword">let</span> loc_str (rev, k) = <span class="keyword">if</span> rev <span class="keyword">then</span> str <span class="string">"%d"</span> k <span class="keyword">else</span> str <span class="string">"+%d"</span> k<br>
<span class="keyword">let</span> follow_str = <span class="keyword">function</span> <span class="constructor">Name</span> <span class="keywordsign">-></span> <span class="string">"name"</span> <span class="keywordsign">|</span> <span class="constructor">Descriptor</span> <span class="keywordsign">-></span> <span class="string">"descriptor"</span><br>
<span class="keyword">let</span> verb_str = <span class="keyword">function</span> <span class="constructor">Verbose</span> <span class="keywordsign">-></span> <span class="string">"verbose"</span> <span class="keywordsign">|</span> <span class="constructor">Quiet</span> <span class="keywordsign">-></span> <span class="string">"quiet"</span><br>
<br>
<span class="keyword">let</span> tail lines follow verb pid files = <br>
<span class="constructor">Printf</span>.printf <span class="string">"lines = %s\nfollow = %s\nverb = %s\npid = %s\nfiles = %s\n"</span><br>
(loc_str lines) (opt_str follow_str follow) (verb_str verb) <br>
(opt_str string_of_int pid) (<span class="constructor">String</span>.concat <span class="string">", "</span> files)<br>
<br>
<span class="comment">(* Command line interface *)</span><br>
<br>
<span class="keyword">open</span> <span class="constructor">Cmdliner</span>;;<br>
<br>
<span class="keyword">let</span> lines = <br>
<span class="keyword">let</span> loc =<br>
<span class="keyword">let</span> parse s = <span class="keyword">try</span><br>
<span class="keyword">if</span> s <> <span class="string">""</span> <span class="keywordsign">&&</span> s.[0] <> <span class="string">'+'</span> <span class="keyword">then</span> <span class="keywordsign">`</span><span class="constructor">Ok</span> (<span class="keyword">true</span>, int_of_string s) <span class="keyword">else</span><br>
<span class="keywordsign">`</span><span class="constructor">Ok</span> (<span class="keyword">false</span>, int_of_string (<span class="constructor">String</span>.sub s 1 (<span class="constructor">String</span>.length s - 1))) <br>
<span class="keyword">with</span> <span class="constructor">Failure</span> _ <span class="keywordsign">-></span> <span class="keywordsign">`</span><span class="constructor">Error</span> <span class="string">"unable to parse integer"</span><br>
<span class="keyword">in</span><br>
parse, <span class="keyword">fun</span> ppf p <span class="keywordsign">-></span> <span class="constructor">Format</span>.fprintf ppf <span class="string">"%s"</span> (loc_str p)<br>
<span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> opt loc (<span class="keyword">true</span>, 10) <span class="keywordsign">&</span> info [<span class="string">"n"</span>; <span class="string">"lines"</span>] ~docv:<span class="string">"N"</span> <br>
~doc:<span class="string">"Output the last $(docv) lines or use $(i,+)$(docv) to start <br>
output after the $(i,N)-1th line."</span>) <br>
<span class="keyword">let</span> follow = <br>
<span class="keyword">let</span> doc = <span class="string">"Output appended data as the file grows. $(docv) specifies how the<br>
file should be tracked, by its `name' or by its `descriptor'."</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> follow = <span class="constructor">Arg</span>.enum [<span class="string">"name"</span>, <span class="constructor">Name</span>; <span class="string">"descriptor"</span>, <span class="constructor">Descriptor</span>] <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> opt (some follow) ~vopt:(<span class="constructor">Some</span> <span class="constructor">Descriptor</span>) <span class="constructor">None</span> <span class="keywordsign">&</span> <br>
info [<span class="string">"f"</span>; <span class="string">"follow"</span>] ~docv:<span class="string">"ID"</span> ~doc) <br>
<br>
<span class="keyword">let</span> verb = <br>
<span class="keyword">let</span> doc = <span class="string">"Never output headers giving file names."</span> <span class="keyword">in</span> <br>
<span class="keyword">let</span> quiet = <span class="constructor">Quiet</span>, <span class="constructor">Arg</span>.info [<span class="string">"q"</span>; <span class="string">"quiet"</span>; <span class="string">"silent"</span>] ~doc <span class="keyword">in</span> <br>
<span class="keyword">let</span> doc = <span class="string">"Always output headers giving file names."</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> verbose = <span class="constructor">Verbose</span>, <span class="constructor">Arg</span>.info [<span class="string">"v"</span>; <span class="string">"verbose"</span>] ~doc <span class="keyword">in</span> <br>
<span class="constructor">Arg</span>.(last <span class="keywordsign">&</span> vflag_all [<span class="constructor">Quiet</span>] [quiet; verbose])<br>
<br>
<span class="keyword">let</span> pid = <br>
<span class="keyword">let</span> doc = <span class="string">"With -f, terminate after process $(docv) dies."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> opt (some int) <span class="constructor">None</span> <span class="keywordsign">&</span> info [<span class="string">"pid"</span>] ~docv:<span class="string">"PID"</span> ~doc)<br>
<br>
<span class="keyword">let</span> files = <span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> (pos_all non_dir_file []) <span class="keywordsign">&</span> info [] ~docv:<span class="string">"FILE"</span>)<br>
<br>
<span class="keyword">let</span> cmd = <br>
<span class="keyword">let</span> doc = <span class="string">"display the last part of a file"</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> man = [<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"DESCRIPTION"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"$(tname) prints the last lines of each $(i,FILE) to standard output. If<br>
no file is specified reads standard input. The number of printed<br>
lines can be specified with the $(b,-n) option."</span>;<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"BUGS"</span>; <br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Report them to <hehey at example.org>."</span>;<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"SEE ALSO"</span>; <br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"$(b,cat)(1), $(b,head)(1)"</span> ]<br>
<span class="keyword">in</span><br>
<span class="constructor">Term</span>.(pure tail $ lines $ follow $ verb $ pid $ files),<br>
<span class="constructor">Term</span>.info <span class="string">"tail"</span> ~version:<span class="string">"1.6.1"</span> ~doc ~man<br>
<br>
<span class="keyword">let</span> () = <span class="keyword">match</span> <span class="constructor">Term</span>.eval cmd <span class="keyword">with</span> <span class="keywordsign">`</span><span class="constructor">Error</span> _ <span class="keywordsign">-></span> exit 1 <span class="keywordsign">|</span> _ <span class="keywordsign">-></span> exit 0<br>
</code></pre>
<p>
<h2 id="exdarcs">A <code class="code">darcs</code> command</h2>
<p>
We define the command line interface of a <code class="code">darcs</code> command with the synopsis:
<pre class="codepre"><code class="code">darcs [<span class="constructor">COMMAND</span>] ...</code></pre>
<p>
The <code class="code">--debug</code>, <code class="code">-q</code>, <code class="code">-v</code> and <code class="code">--prehook</code> options are available in
each command. To avoid having to pass them individually to each
command we gather them in a record of type <code class="code">copts</code>. By lifting the
record constructor <code class="code">copts</code> into the term <code class="code">copts_t</code> we now have a term
that we can pass to the commands to stand for an argument of type
<code class="code">copts</code>. These options are documented in a section called <code class="code"><span class="constructor">COMMON</span>
<span class="constructor">OPTIONS</span></code>, since we also want to put <code class="code">--help</code> and <code class="code">--version</code> in this
section, the term information of commands makes a judicious use of the
<code class="code">sdocs</code> parameter of <a href="Cmdliner.Term.html#VALinfo"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.info</code></a>.
<p>
The <code class="code">help</code> command shows help about commands or other topics. The help
shown for commands is generated by <code class="code"><span class="constructor">Cmdliner</span></code> by making an approriate
use of <a href="Cmdliner.Term.html#VALret"><code class="code"><span class="constructor">Cmdliner</span>.<span class="constructor">Term</span>.ret</code></a> on the lifted <code class="code">help</code> function.
<p>
If the program is invoked without a command we just want to show the
help of the program as printed by <code class="code"><span class="constructor">Cmdliner</span></code> with <code class="code">--help</code>. This is
done by the <code class="code">no_cmd</code> term.
<p>
<pre class="codepre"><code class="code"><span class="comment">(* Implementations, just print the args. *)</span><br>
<br>
<span class="keyword">type</span> verb = <span class="constructor">Normal</span> <span class="keywordsign">|</span> <span class="constructor">Quiet</span> <span class="keywordsign">|</span> <span class="constructor">Verbose</span><br>
<span class="keyword">type</span> copts = { debug : bool; verb : verb; prehook : string option }<br>
<br>
<span class="keyword">let</span> str = <span class="constructor">Printf</span>.sprintf <br>
<span class="keyword">let</span> opt_str sv = <span class="keyword">function</span> <span class="constructor">None</span> <span class="keywordsign">-></span> <span class="string">"None"</span> <span class="keywordsign">|</span> <span class="constructor">Some</span> v <span class="keywordsign">-></span> str <span class="string">"Some(%s)"</span> (sv v)<br>
<span class="keyword">let</span> opt_str_str = opt_str (<span class="keyword">fun</span> s <span class="keywordsign">-></span> s)<br>
<span class="keyword">let</span> verb_str = <span class="keyword">function</span> <br>
<span class="keywordsign">|</span> <span class="constructor">Normal</span> <span class="keywordsign">-></span> <span class="string">"normal"</span> <span class="keywordsign">|</span> <span class="constructor">Quiet</span> <span class="keywordsign">-></span> <span class="string">"quiet"</span> <span class="keywordsign">|</span> <span class="constructor">Verbose</span> <span class="keywordsign">-></span> <span class="string">"verbose"</span><br>
<br>
<span class="keyword">let</span> pr_copts oc copts = <span class="constructor">Printf</span>.fprintf oc <br>
<span class="string">"debug = %b\nverbosity = %s\nprehook = %s\n"</span> <br>
copts.debug (verb_str copts.verb) (opt_str_str copts.prehook)<br>
<br>
<span class="keyword">let</span> initialize copts repodir = <span class="constructor">Printf</span>.printf<br>
<span class="string">"%arepodir = %s\n"</span> pr_copts copts repodir<br>
<br>
<span class="keyword">let</span> record copts name email all ask_deps files = <span class="constructor">Printf</span>.printf<br>
<span class="string">"%aname = %s\nemail = %s\nall = %b\nask-deps = %b\nfiles = %s\n"</span> <br>
pr_copts copts (opt_str_str name) (opt_str_str email) all ask_deps <br>
(<span class="constructor">String</span>.concat <span class="string">", "</span> files)<br>
<br>
<span class="keyword">let</span> help copts man_format cmds topic = <span class="keyword">match</span> topic <span class="keyword">with</span><br>
<span class="keywordsign">|</span> <span class="constructor">None</span> <span class="keywordsign">-></span> <span class="keywordsign">`</span><span class="constructor">Help</span> (<span class="keywordsign">`</span><span class="constructor">Pager</span>, <span class="constructor">None</span>) <span class="comment">(* help about the program. *)</span><br>
<span class="keywordsign">|</span> <span class="constructor">Some</span> topic <span class="keywordsign">-></span> <br>
<span class="keyword">let</span> topics = <span class="string">"topics"</span> :: <span class="string">"patterns"</span> :: <span class="string">"environment"</span> :: cmds <span class="keyword">in</span> <br>
<span class="keyword">let</span> conv, _ = <span class="constructor">Cmdliner</span>.<span class="constructor">Arg</span>.enum (<span class="constructor">List</span>.rev_map (<span class="keyword">fun</span> s <span class="keywordsign">-></span> (s, s)) topics) <span class="keyword">in</span><br>
<span class="keyword">match</span> conv topic <span class="keyword">with</span> <br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Error</span> e <span class="keywordsign">-></span> <span class="keywordsign">`</span><span class="constructor">Error</span> (<span class="keyword">false</span>, e)<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ok</span> t <span class="keyword">when</span> t = <span class="string">"topics"</span> <span class="keywordsign">-></span> <span class="constructor">List</span>.iter print_endline topics; <span class="keywordsign">`</span><span class="constructor">Ok</span> ()<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ok</span> t <span class="keyword">when</span> <span class="constructor">List</span>.mem t cmds <span class="keywordsign">-></span> <span class="keywordsign">`</span><span class="constructor">Help</span> (man_format, <span class="constructor">Some</span> t)<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ok</span> t <span class="keywordsign">-></span> <br>
<span class="keyword">let</span> page = (topic, 7, <span class="string">""</span>, <span class="string">""</span>, <span class="string">""</span>), [<span class="keywordsign">`</span><span class="constructor">S</span> topic; <span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Say something"</span>;] <span class="keyword">in</span><br>
<span class="keywordsign">`</span><span class="constructor">Ok</span> (<span class="constructor">Cmdliner</span>.<span class="constructor">Manpage</span>.print man_format <span class="constructor">Format</span>.std_formatter page)<br>
<br>
<span class="keyword">open</span> <span class="constructor">Cmdliner</span>;;<br>
<br>
<span class="comment">(* Help sections common to all commands *)</span><br>
<br>
<span class="keyword">let</span> copts_sect = <span class="string">"COMMON OPTIONS"</span><br>
<span class="keyword">let</span> help_secs = [ <br>
<span class="keywordsign">`</span><span class="constructor">S</span> copts_sect; <br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"These options are common to all commands."</span>;<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"MORE HELP"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Use `$(mname) $(i,COMMAND) --help' for help on a single command."</span>;<span class="keywordsign">`</span><span class="constructor">Noblank</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Use `$(mname) help patterns' for help on patch matching."</span>; <span class="keywordsign">`</span><span class="constructor">Noblank</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Use `$(mname) help environment' for help on environment variables."</span>;<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"BUGS"</span>; <span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Check bug reports at http://bugs.example.org."</span>;]<br>
<br>
<span class="comment">(* Options common to all commands *)</span><br>
<br>
<span class="keyword">let</span> copts debug verb prehook = { debug; verb; prehook }<br>
<span class="keyword">let</span> copts_t = <br>
<span class="keyword">let</span> docs = copts_sect <span class="keyword">in</span> <br>
<span class="keyword">let</span> debug = <br>
<span class="keyword">let</span> doc = <span class="string">"Give only debug output."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> flag <span class="keywordsign">&</span> info [<span class="string">"debug"</span>] ~docs ~doc)<br>
<span class="keyword">in</span><br>
<span class="keyword">let</span> verb =<br>
<span class="keyword">let</span> doc = <span class="string">"Suppress informational output."</span> <span class="keyword">in</span> <br>
<span class="keyword">let</span> quiet = <span class="constructor">Quiet</span>, <span class="constructor">Arg</span>.info [<span class="string">"q"</span>; <span class="string">"quiet"</span>] ~docs ~doc <span class="keyword">in</span><br>
<span class="keyword">let</span> doc = <span class="string">"Give verbose output."</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> verbose = <span class="constructor">Verbose</span>, <span class="constructor">Arg</span>.info [<span class="string">"v"</span>; <span class="string">"verbose"</span>] ~docs ~doc <span class="keyword">in</span> <br>
<span class="constructor">Arg</span>.(last <span class="keywordsign">&</span> vflag_all [<span class="constructor">Normal</span>] [quiet; verbose]) <br>
<span class="keyword">in</span> <br>
<span class="keyword">let</span> prehook = <br>
<span class="keyword">let</span> doc = <span class="string">"Specify command to run before this $(mname) command."</span> <span class="keyword">in</span> <br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> opt (some string) <span class="constructor">None</span> <span class="keywordsign">&</span> info [<span class="string">"prehook"</span>] ~docs ~doc)<br>
<span class="keyword">in</span><br>
<span class="constructor">Term</span>.(pure copts $ debug $ verb $ prehook)<br>
<br>
<span class="comment">(* Commands *)</span><br>
<br>
<span class="keyword">let</span> initialize_cmd = <br>
<span class="keyword">let</span> repodir = <br>
<span class="keyword">let</span> doc = <span class="string">"Run the program in repository directory $(docv)."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> opt file <span class="constructor">Filename</span>.current_dir_name <span class="keywordsign">&</span> info [<span class="string">"repodir"</span>]<br>
~docv:<span class="string">"DIR"</span> ~doc)<br>
<span class="keyword">in</span><br>
<span class="keyword">let</span> doc = <span class="string">"make the current directory a repository"</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> man = [<br>
<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"DESCRIPTION"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Turns the current directory into a Darcs repository. Any<br>
existing files and subdirectories become ..."</span>] @ help_secs<br>
<span class="keyword">in</span><br>
<span class="constructor">Term</span>.(pure initialize $ copts_t $ repodir),<br>
<span class="constructor">Term</span>.info <span class="string">"initialize"</span> ~sdocs:copts_sect ~doc ~man<br>
<br>
<span class="keyword">let</span> record_cmd =<br>
<span class="keyword">let</span> pname = <br>
<span class="keyword">let</span> doc = <span class="string">"Name of the patch."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> opt (some string) <span class="constructor">None</span> <span class="keywordsign">&</span> info [<span class="string">"m"</span>; <span class="string">"patch-name"</span>] ~docv:<span class="string">"NAME"</span> <br>
~doc)<br>
<span class="keyword">in</span><br>
<span class="keyword">let</span> author = <br>
<span class="keyword">let</span> doc = <span class="string">"Specifies the author's identity."</span> <span class="keyword">in</span><br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> opt (some string) <span class="constructor">None</span> <span class="keywordsign">&</span> info [<span class="string">"A"</span>; <span class="string">"author"</span>] ~docv:<span class="string">"EMAIL"</span><br>
~doc)<br>
<span class="keyword">in</span><br>
<span class="keyword">let</span> all = <br>
<span class="keyword">let</span> doc = <span class="string">"Answer yes to all patches."</span> <span class="keyword">in</span> <br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> flag <span class="keywordsign">&</span> info [<span class="string">"a"</span>; <span class="string">"all"</span>] ~doc)<br>
<span class="keyword">in</span><br>
<span class="keyword">let</span> ask_deps = <br>
<span class="keyword">let</span> doc = <span class="string">"Ask for extra dependencies."</span> <span class="keyword">in</span> <br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> flag <span class="keywordsign">&</span> info [<span class="string">"ask-deps"</span>] ~doc)<br>
<span class="keyword">in</span><br>
<span class="keyword">let</span> files = <span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> (pos_all file) [] <span class="keywordsign">&</span> info [] ~docv:<span class="string">"FILE or DIR"</span>) <span class="keyword">in</span><br>
<span class="keyword">let</span> doc = <span class="string">"create a patch from unrecorded changes"</span> <span class="keyword">in</span> <br>
<span class="keyword">let</span> man = <br>
[<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"DESCRIPTION"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Creates a patch from changes in the working tree. If you specify <br>
a set of files ..."</span>] @ help_secs<br>
<span class="keyword">in</span> <br>
<span class="constructor">Term</span>.(pure record $ copts_t $ pname $ author $ all $ ask_deps $ files),<br>
<span class="constructor">Term</span>.info <span class="string">"record"</span> ~doc ~sdocs:copts_sect ~man<br>
<br>
<span class="keyword">let</span> help_cmd = <br>
<span class="keyword">let</span> topic = <br>
<span class="keyword">let</span> doc = <span class="string">"The topic to get help on. `topics' lists the topics."</span> <span class="keyword">in</span> <br>
<span class="constructor">Arg</span>.(value <span class="keywordsign">&</span> pos 0 (some string) <span class="constructor">None</span> <span class="keywordsign">&</span> info [] ~docv:<span class="string">"TOPIC"</span> ~doc)<br>
<span class="keyword">in</span><br>
<span class="keyword">let</span> doc = <span class="string">"display help about darcs and darcs commands"</span> <span class="keyword">in</span><br>
<span class="keyword">let</span> man = <br>
[<span class="keywordsign">`</span><span class="constructor">S</span> <span class="string">"DESCRIPTION"</span>;<br>
<span class="keywordsign">`</span><span class="constructor">P</span> <span class="string">"Prints help about darcs commands and other subjects..."</span>] @ help_secs<br>
<span class="keyword">in</span><br>
<span class="constructor">Term</span>.(ret (pure help $ copts_t $ <span class="constructor">Term</span>.man_format $ <span class="constructor">Term</span>.choice_names $topic)),<br>
<span class="constructor">Term</span>.info <span class="string">"help"</span> ~doc ~man<br>
<br>
<span class="keyword">let</span> default_cmd = <br>
<span class="keyword">let</span> doc = <span class="string">"a revision control system"</span> <span class="keyword">in</span> <br>
<span class="keyword">let</span> man = help_secs <span class="keyword">in</span><br>
<span class="constructor">Term</span>.(ret (pure (<span class="keyword">fun</span> _ <span class="keywordsign">-></span> <span class="keywordsign">`</span><span class="constructor">Help</span> (<span class="keywordsign">`</span><span class="constructor">Pager</span>, <span class="constructor">None</span>)) $ copts_t)),<br>
<span class="constructor">Term</span>.info <span class="string">"darcs"</span> ~version:<span class="string">"1.6.1"</span> ~sdocs:copts_sect ~doc ~man<br>
<br>
<span class="keyword">let</span> cmds = [initialize_cmd; record_cmd; help_cmd]<br>
<br>
<span class="keyword">let</span> () = <span class="keyword">match</span> <span class="constructor">Term</span>.eval_choice default_cmd cmds <span class="keyword">with</span> <br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Error</span> _ <span class="keywordsign">-></span> exit 1 <span class="keywordsign">|</span> _ <span class="keywordsign">-></span> exit 0<br>
</code></pre><br>
</body></html>
|