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
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
|
<?xml version="1.0" ?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>OptionParser for Ruby</title>
<link href="rd.css" type="text/css" rel="stylesheet"/>
</head>
<body>
<h1><a name="label:0" id="label:0">Summary</a></h1><!-- RDLabel: "Summary" -->
<p>Library for command line option analysis.</p>
<p>features:</p>
<ol>
<li>It is possible <option switch of a short form and a long form> to
exist together. It is also possible in one to bring the switch of
a short form together.</li>
<li>It is possible to write bringing specification and the handler of
the switch together respectively in one place.</li>
<li>The argument of the switch is converted into the class which
automatically specifies it.</li>
<li>The option summary can be made.</li>
<li>The option can be added on the way later.</li>
</ol>
<h2><a name="label:1" id="label:1">Class tree</a></h2><!-- RDLabel: "Class tree" -->
<ul>
<li><a href="#label:41">OptionParser</a> front end</li>
<li><a href="#label:4">OptionParser::Switch</a> each switches</li>
<li><a href="#label:12">OptionParser::List</a> options list</li>
<li><p><a href="#label:150">OptionParser::ParseError</a> errors on parsing</p>
<ul>
<li><a href="#label:161">OptionParser::AmbiguousOption</a></li>
<li><a href="#label:163">OptionParser::NeedlessArgument</a></li>
<li><a href="#label:165">OptionParser::MissingArgument</a></li>
<li><a href="#label:167">OptionParser::InvalidOption</a></li>
<li><p><a href="#label:169">OptionParser::InvalidArgument</a></p>
<ul>
<li><a href="#label:171">OptionParser::AmbiguousArgument</a></li>
</ul></li>
</ul></li>
</ul>
<h2><a name="label:2" id="label:2">Object relations</a></h2><!-- RDLabel: "Object relations" -->
<pre>+--------------+
| OptionParser |<>-----+
+--------------+ | +--------+
| ,-| Switch |
on_head -------->+---------------+ / +--------+
accept/reject -->| List |<|>-
| |<|>- +----------+
on ------------->+---------------+ `-| argument |
: : | class |
+---------------+ |==========|
on_tail -------->| | |pattern |
+---------------+ |----------|
OptionParser.accept ->| DefaultList | |converter |
reject |(shared between| +----------+
| all instances)|
+---------------+</pre>
<h1><a name="label:3" id="label:3">Classes & Modules</a></h1><!-- RDLabel: "Classes & Modules" -->
<h2><a name="label:4" id="label:4"><a name="index:0" id="index:0">OptionParser::Switch</a></a></h2><!-- RDLabel: "OptionParser::Switch" -->
<p>Individual switch class.</p>
<h3><a name="label:5" id="label:5">Instance methods</a></h3><!-- RDLabel: "Instance methods" -->
<dl>
<dt><a name="label:6" id="label:6"><code>OptionParser::Switch#parse(<var>arg</var>, <var>val</var>) {<var>semi</var>-<var>error</var> <var>handler</var>}</code></a></dt><!-- RDLabel: "OptionParser::Switch#parse" -->
<dd>
<p>Parses argument, convert and returns <var>arg</var>, <var>block</var> and
result of conversion.</p>
<dl>
<dt><a name="label:7" id="label:7">Arguments to <var>@conv</var>
</a></dt><!-- RDLabel: "Arguments to @conv
" -->
<dd>
<p>substrings matched to <var>@pattern</var>, <var>$&</var>, <var>$1</var>,
<var>$2</var> and so on.</p>
</dd>
<dt><a name="label:8" id="label:8">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:9" id="label:9"><var>arg</var>
</a></dt><!-- RDLabel: "arg
" -->
<dd>
<p>argument string follows the switch.</p>
</dd>
<dt><a name="label:10" id="label:10"><var>val</var>
</a></dt><!-- RDLabel: "val
" -->
<dd>
<p>following argument.</p>
</dd>
<dt><a name="label:11" id="label:11"><code>block</code>
</a></dt><!-- RDLabel: "block
" -->
<dd>
<p><code>yields</code> at semi-error condition, instead of raises exception.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<h2><a name="label:12" id="label:12"><!-- Index, but conflict -->OptionParser::List<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::List" -->
<p>Simple option list providing mapping from short and/or long option
string to <a href="#label:4">OptionParser::Switch</a>, and mapping from acceptable
argument to matching pattern and converter pair. Also provides
summary feature.</p>
<h3><a name="label:13" id="label:13">Class methods</a></h3><!-- RDLabel: "Class methods" -->
<h3><a name="label:14" id="label:14">Instance methods</a></h3><!-- RDLabel: "Instance methods" -->
<dl>
<dt><a name="label:15" id="label:15"><code>OptionParser::List#atype</code></a></dt><!-- RDLabel: "OptionParser::List#atype" -->
<dd>
<p>Map from acceptable argument types to pattern and converter pairs.</p></dd>
<dt><a name="label:16" id="label:16"><code>OptionParser::List#short</code></a></dt><!-- RDLabel: "OptionParser::List#short" -->
<dd>
<p>Map from short style option switches to actual switch objects.</p></dd>
<dt><a name="label:17" id="label:17"><code>OptionParser::List#long</code></a></dt><!-- RDLabel: "OptionParser::List#long" -->
<dd>
<p>Map from long style option switches to actual switch objects.</p></dd>
<dt><a name="label:18" id="label:18"><code>OptionParser::List#list</code></a></dt><!-- RDLabel: "OptionParser::List#list" -->
<dd>
<p>List of all switches and summary string.</p></dd>
</dl>
<dl>
<dt><a name="label:19" id="label:19"><code>OptionParser::List#prepend(<var>switch</var>, <var>short_opts</var>, <var>long_opts</var>, <var>nolong_opts</var>)</code></a></dt><!-- RDLabel: "OptionParser::List#prepend" -->
<dd>
<p>Inserts <var>switch</var> at head of the list, and associates short,
long and negated long options.</p></dd>
<dt><a name="label:20" id="label:20"><code>OptionParser::List#append(<var>switch</var>, <var>short_opts</var>, <var>long_opts</var>, <var>nolong_opts</var>)</code></a></dt><!-- RDLabel: "OptionParser::List#append" -->
<dd>
<p>Appends <var>switch</var> at tail of the list, and associates short,
long and negated long options.</p>
<dl>
<dt><a name="label:21" id="label:21">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:22" id="label:22"><var>switch</var>
</a></dt><!-- RDLabel: "switch
" -->
<dd>
<p><a href="#label:4">OptionParser::Switch</a> instance to be inserted.</p>
</dd>
<dt><a name="label:23" id="label:23"><var>short_opts</var>
</a></dt><!-- RDLabel: "short_opts
" -->
<dd>
<p>list of short style options.</p>
</dd>
<dt><a name="label:24" id="label:24"><var>long_opts</var>
</a></dt><!-- RDLabel: "long_opts
" -->
<dd>
<p>list of long style options.</p>
</dd>
<dt><a name="label:25" id="label:25"><var>nolong_opts</var>
</a></dt><!-- RDLabel: "nolong_opts
" -->
<dd>
<p>list of long style options with <code>"no-"</code> prefix.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:26" id="label:26"><code>OptionParser::List#search(<var>id</var>, <var>key</var>) [{<var>block</var>}]</code></a></dt><!-- RDLabel: "OptionParser::List#search" -->
<dd>
<p>Searches <var>key</var> in <var>id</var> list.</p>
<dl>
<dt><a name="label:27" id="label:27">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:28" id="label:28"><var>id</var>
</a></dt><!-- RDLabel: "id
" -->
<dd>
<p>searching list.</p>
</dd>
<dt><a name="label:29" id="label:29"><var>k</var>
</a></dt><!-- RDLabel: "k
" -->
<dd>
<p>searching key.</p>
</dd>
<dt><a name="label:30" id="label:30"><code>Block</code>
</a></dt><!-- RDLabel: "Block
" -->
<dd>
<p>yielded with the found value when succeeded.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:31" id="label:31"><code>OptionParser::List#complete(<var>id</var>, <var>opt</var>, *<var>pat</var>, &<var>block</var>)</code></a></dt><!-- RDLabel: "OptionParser::List#complete" -->
<dd>
<p>Searches list <var>id</var> for <var>opt</var> and <var>*pat</var>.</p>
<dl>
<dt><a name="label:32" id="label:32">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:33" id="label:33"><var>id</var>
</a></dt><!-- RDLabel: "id
" -->
<dd>
<p>searching list.</p>
</dd>
<dt><a name="label:34" id="label:34"><var>opt</var>
</a></dt><!-- RDLabel: "opt
" -->
<dd>
<p>searching key.</p>
</dd>
<dt><a name="label:35" id="label:35"><var>*pat</var>
</a></dt><!-- RDLabel: "*pat
" -->
<dd>
<p>optional pattern for completion.</p>
</dd>
<dt><a name="label:36" id="label:36"><code>Block</code>
</a></dt><!-- RDLabel: "Block
" -->
<dd>
<p>yielded with the found value when succeeded.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:37" id="label:37"><code>OptionParser::List#summarize(*<var>args</var>) {...}</code></a></dt><!-- RDLabel: "OptionParser::List#summarize" -->
<dd>
<p>Making summary table, yields the <code>block</code> with each lines.
Each elements of <code>@list</code> should be able to <code>summarize</code>.</p>
<dl>
<dt><a name="label:38" id="label:38">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:39" id="label:39"><var>args</var>
</a></dt><!-- RDLabel: "args
" -->
<dd>
<p>passed to elements#summarize through.</p>
</dd>
<dt><a name="label:40" id="label:40"><code>block</code>
</a></dt><!-- RDLabel: "block
" -->
<dd>
<p>to be passed each lines(without newline).</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<h2><a name="label:41" id="label:41"><!-- Index, but conflict -->OptionParser<!-- Index end --></a></h2><!-- RDLabel: "OptionParser" -->
<p>The front-end of <code>OptionParser</code>.</p>
<h3><a name="label:42" id="label:42">Constants</a></h3><!-- RDLabel: "Constants" -->
<dl>
<dt><a name="label:43" id="label:43"><code>OptionParser::ArgumentStyle</code></a></dt><!-- RDLabel: "OptionParser::ArgumentStyle" -->
<dd>
<p>Enumeration of acceptable argument styles; possible values are:</p>
<dl>
<dt><a name="label:44" id="label:44">OptionParser::NO_ARGUMENT
</a></dt><!-- RDLabel: "OptionParser::NO_ARGUMENT
" -->
<dd>
<p>the switch takes no arguments. (<code>:NONE</code>) </p>
</dd>
<dt><a name="label:45" id="label:45">OptionParser::REQUIRED_ARGUMENT
</a></dt><!-- RDLabel: "OptionParser::REQUIRED_ARGUMENT
" -->
<dd>
<p>the switch requires an argument. (<code>:REQUIRED</code>)</p>
</dd>
<dt><a name="label:46" id="label:46">OptionParser::OPTIONAL_ARGUMENT
</a></dt><!-- RDLabel: "OptionParser::OPTIONAL_ARGUMENT
" -->
<dd>
<p>the switch requires an optional argument, that is, may take or
not. (<code>:OPTIONAL</code>)</p>
</dd>
</dl>
<p>Use like <code>--switch=argument</code>(long style) or
<code>-Xargument</code>(short style). For short style, only portion
matched to <!-- Reference, RDLabel "argument pattern" doesn't exist --><em class="label-not-found">argument pattern</em><!-- Reference end --> is dealed as argument.</p></dd>
</dl>
<h3><a name="label:47" id="label:47">Class methods</a></h3><!-- RDLabel: "Class methods" -->
<dl>
<dt><a name="label:48" id="label:48"><code>OptionParser.with([<var>banner</var>[, <var>width</var>[, <var>indent</var>]]]) [{...}]</code></a></dt><!-- RDLabel: "OptionParser.with" -->
<dd>
<p>Initializes new instance, and evaluates the block in context of
the instance if called as iterator. This behavior is equivalent
to older <code>new</code>. This is <em>deprecated</em> method.</p>
<p>cf. <a href="#label:56">OptionParser.new</a></p>
<dl>
<dt><a name="label:49" id="label:49">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:50" id="label:50"><var>banner</var>
</a></dt><!-- RDLabel: "banner
" -->
<dd>
<p>banner message.</p>
</dd>
<dt><a name="label:51" id="label:51"><var>width</var>
</a></dt><!-- RDLabel: "width
" -->
<dd>
<p>summary width.</p>
</dd>
<dt><a name="label:52" id="label:52"><var>indent</var>
</a></dt><!-- RDLabel: "indent
" -->
<dd>
<p>summary indent.</p>
</dd>
<dt><a name="label:53" id="label:53"><code>Block</code>
</a></dt><!-- RDLabel: "Block
" -->
<dd>
<p>to be evaluated in the new instance context.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:54" id="label:54"><code>OptionParser.inc(<var>arg</var>[, <var>default</var>])</code></a><!-- RDLabel: "OptionParser.inc" -->
<dt><a name="label:55" id="label:55"><code>OptionParser#inc(<var>arg</var>[, <var>default</var>])</code></a></dt><!-- RDLabel: "OptionParser#inc" -->
<dd>
<p>Returns incremented value of <var>default</var> according to <var>arg</var>.</p></dd>
</dl>
<dl>
<dt><a name="label:56" id="label:56"><code>OptionParser.new([<var>banner</var>[, <var>width</var>[, <var>indent</var>]]]) [{...}]</code></a></dt><!-- RDLabel: "OptionParser.new" -->
<dd>
<p>Initializes the instance, and yields itself if called as iterator.</p>
<dl>
<dt><a name="label:57" id="label:57">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:58" id="label:58"><var>banner</var>
</a></dt><!-- RDLabel: "banner
" -->
<dd>
<p>banner message.</p>
</dd>
<dt><a name="label:59" id="label:59"><var>width</var>
</a></dt><!-- RDLabel: "width
" -->
<dd>
<p>summary width.</p>
</dd>
<dt><a name="label:60" id="label:60"><var>indent</var>
</a></dt><!-- RDLabel: "indent
" -->
<dd>
<p>summary indent.</p>
</dd>
<dt><a name="label:61" id="label:61"><code>Block</code>
</a></dt><!-- RDLabel: "Block
" -->
<dd>
<p>to be evaluated in the new instance context.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:62" id="label:62"><code>OptionParser.terminate([<var>arg</var>])</code></a></dt><!-- RDLabel: "OptionParser.terminate" -->
<dd>
<p>Terminates option parsing. Optional parameter <var>arg</var> would be
pushed back if given.</p>
<dl>
<dt><a name="label:63" id="label:63">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:64" id="label:64"><var>arg</var>
</a></dt><!-- RDLabel: "arg
" -->
<dd>
<p>string pushed back to be first non-option argument</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:65" id="label:65"><code>OptionParser.accept(<var>t</var>, [<var>pat</var>]) {...}</code></a><!-- RDLabel: "OptionParser.accept" -->
<dt><a name="label:66" id="label:66"><code>OptionParser#accept(<var>t</var>, [<var>pat</var>]) {...}</code></a></dt><!-- RDLabel: "OptionParser#accept" -->
<dd>
<p>Directs to accept specified class argument.</p>
<dl>
<dt><a name="label:67" id="label:67">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:68" id="label:68"><var>t</var>
</a></dt><!-- RDLabel: "t
" -->
<dd>
<p>argument class specifier, any object including Class.</p>
</dd>
<dt><a name="label:69" id="label:69"><var>pat</var>
</a></dt><!-- RDLabel: "pat
" -->
<dd>
<p>pattern for argument, defaulted to <var>t</var> if it respond to <code>match</code>.</p>
</dd>
<dt><a name="label:70" id="label:70"><code>Block</code>
</a></dt><!-- RDLabel: "Block
" -->
<dd>
<p>receives argument string and should be convert to desired class.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:71" id="label:71"><code>OptionParser.reject(<var>t</var>)</code></a><!-- RDLabel: "OptionParser.reject" -->
<dt><a name="label:72" id="label:72"><code>OptionParser#reject(<var>t</var>)</code></a></dt><!-- RDLabel: "OptionParser#reject" -->
<dd>
<p>Directs to reject specified class argument.</p>
<dl>
<dt><a name="label:73" id="label:73">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:74" id="label:74"><var>t</var>
</a></dt><!-- RDLabel: "t
" -->
<dd>
<p>argument class specifier, any object including Class.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<h3><a name="label:75" id="label:75">Instance methods</a></h3><!-- RDLabel: "Instance methods" -->
<dl>
<dt><a name="label:76" id="label:76"><code>OptionParser#banner</code></a><!-- RDLabel: "OptionParser#banner" -->
<dt><a name="label:77" id="label:77"><code>OptionParser#banner=(<var>heading</var>)</code></a></dt><!-- RDLabel: "OptionParser#banner=" -->
<dd>
<p>Heading banner preceding summary.</p></dd>
<dt><a name="label:78" id="label:78"><code>OptionParser#summary_width</code></a><!-- RDLabel: "OptionParser#summary_width" -->
<dt><a name="label:79" id="label:79"><code>OptionParser#summary_width=(<var>width</var>)</code></a></dt><!-- RDLabel: "OptionParser#summary_width=" -->
<dd>
<p>Width for option list portion of summary. Must be <code>Numeric</code>.</p></dd>
<dt><a name="label:80" id="label:80"><code>OptionParser#summary_indent</code></a><!-- RDLabel: "OptionParser#summary_indent" -->
<dt><a name="label:81" id="label:81"><code>OptionParser#summary_indent=(<var>indent</var>)</code></a></dt><!-- RDLabel: "OptionParser#summary_indent=" -->
<dd>
<p>Indentation for summary. Must be <code>String</code> (or have <code>+ String</code>).</p></dd>
<dt><a name="label:82" id="label:82"><code>OptionParser#program_name</code></a><!-- RDLabel: "OptionParser#program_name" -->
<dt><a name="label:83" id="label:83"><code>OptionParser#program_name=(<var>name</var>)</code></a></dt><!-- RDLabel: "OptionParser#program_name=" -->
<dd>
<p>Program name to be emitted in error message and default banner,
defaulted to <code>$0</code>.</p></dd>
</dl>
<dl>
<dt><a name="label:84" id="label:84"><code>OptionParser#version</code></a><!-- RDLabel: "OptionParser#version" -->
<dt><a name="label:85" id="label:85"><code>OptionParser#version=(<var>ver</var>)</code></a></dt><!-- RDLabel: "OptionParser#version=" -->
<dd>
<p>Version.</p></dd>
<dt><a name="label:86" id="label:86"><code>OptionParser#release</code></a><!-- RDLabel: "OptionParser#release" -->
<dt><a name="label:87" id="label:87"><code>OptionParser#release=(<var>rel</var>)</code></a></dt><!-- RDLabel: "OptionParser#release=" -->
<dd>
<p>Release code.</p></dd>
<dt><a name="label:88" id="label:88"><code>OptionParser#ver</code></a></dt><!-- RDLabel: "OptionParser#ver" -->
<dd>
<p>Returns version string from <!-- Reference, RDLabel "program_name" doesn't exist --><em class="label-not-found">program_name</em><!-- Reference end -->, <code>version</code> and
<code>release</code>.</p></dd>
</dl>
<dl>
<dt><a name="label:89" id="label:89"><code>OptionParser#top</code></a></dt><!-- RDLabel: "OptionParser#top" -->
<dd>
<p>Subject of <!-- Reference, RDLabel "on" doesn't exist --><em class="label-not-found">on</em><!-- Reference end -->/<!-- Reference, RDLabel "on_head" doesn't exist --><em class="label-not-found">on_head</em><!-- Reference end -->, <!-- Reference, RDLabel "accept" doesn't exist --><em class="label-not-found">accept</em><!-- Reference end -->/<!-- Reference, RDLabel "reject" doesn't exist --><em class="label-not-found">reject</em><!-- Reference end -->.</p></dd>
</dl>
<dl>
<dt><a name="label:90" id="label:90"><code>OptionParser#base</code></a></dt><!-- RDLabel: "OptionParser#base" -->
<dd>
<p>Subject of <!-- Reference, RDLabel "on_tail" doesn't exist --><em class="label-not-found">on_tail</em><!-- Reference end -->.</p></dd>
</dl>
<dl>
<dt><a name="label:91" id="label:91"><code>OptionParser#new</code></a></dt><!-- RDLabel: "OptionParser#new" -->
<dd>
<p>Pushes a new <code>List</code>.</p></dd>
</dl>
<dl>
<dt><a name="label:92" id="label:92"><code>OptionParser#remove</code></a></dt><!-- RDLabel: "OptionParser#remove" -->
<dd>
<p>Removes the last <code>List</code>.</p></dd>
</dl>
<dl>
<dt><a name="label:93" id="label:93"><code>OptionParser#summarize(<var>to</var> = [], <var>width</var> = @<var>summary_width</var>, <var>max</var> = <var>width</var> - <var>1</var>, <var>indent</var> = @<var>summary_indent</var>)</code></a></dt><!-- RDLabel: "OptionParser#summarize" -->
<dd>
<p>Puts option summary into <var>to</var>, and returns <var>to</var>.</p>
<dl>
<dt><a name="label:94" id="label:94">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:95" id="label:95"><var>to</var>
</a></dt><!-- RDLabel: "to
" -->
<dd>
<p>output destination, which must have method <var><<</var>. Defaulted to <code>[]</code>.</p>
</dd>
<dt><a name="label:96" id="label:96"><var>width</var>
</a></dt><!-- RDLabel: "width
" -->
<dd>
<p>width of left side. Defaulted to <var>@summary_width</var></p>
</dd>
<dt><a name="label:97" id="label:97"><var>max</var>
</a></dt><!-- RDLabel: "max
" -->
<dd>
<p>maximum length allowed for left side. Defaulted to <code><var>width</var> - 1</code></p>
</dd>
<dt><a name="label:98" id="label:98"><var>indent</var>
</a></dt><!-- RDLabel: "indent
" -->
<dd>
<p>indentation. Defaulted to <var>@summary_indent</var></p>
</dd>
<dt><a name="label:99" id="label:99"><code>Block</code>
</a></dt><!-- RDLabel: "Block
" -->
<dd>
<p>yields with each line if called as iterator.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:100" id="label:100"><code>OptionParser#to_str</code></a><!-- RDLabel: "OptionParser#to_str" -->
<dt><a name="label:101" id="label:101"><code>OptionParser#to_s</code></a></dt><!-- RDLabel: "OptionParser#to_s" -->
<dd>
<p>Returns option summary string.</p></dd>
</dl>
<dl>
<dt><a name="label:102" id="label:102"><code>OptionParser#to_a</code></a></dt><!-- RDLabel: "OptionParser#to_a" -->
<dd>
<p>Returns option summary list.</p></dd>
</dl>
<dl>
<dt><a name="label:103" id="label:103"><code>OptionParser#switch</code></a></dt><!-- RDLabel: "OptionParser#switch" -->
<dd>
<p>Creates <a href="#label:4">OptionParser::Switch</a>.</p>
<dl>
<dt><a name="label:104" id="label:104">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:105" id="label:105"><var>*opts</var>
</a></dt><!-- RDLabel: "*opts
" -->
<dd>
<p>option definition:</p>
<dl>
<dt><a name="label:106" id="label:106">argument style
</a></dt><!-- RDLabel: "argument style
" -->
<dd>
<p>see <a href="#label:43">OptionParser::ArgumentStyle</a></p>
</dd>
<dt><a name="label:107" id="label:107">argument pattern
</a></dt><!-- RDLabel: "argument pattern
" -->
<dd>
<p>acceptable option argument format, must pre-defined with
<a href="#label:65">OptionParser.accept</a> or <a href="#label:66">OptionParser#accept</a>, or
<code>Regexp</code>. This can appear once or assigned as <code>String</code>
if not present, otherwise causes exception <code>ArgumentError</code>.</p>
<p>cf. <a href="#label:137">Acceptable argument classes</a>.</p>
</dd>
<dt><a name="label:108" id="label:108">Hash
</a></dt><!-- RDLabel: "Hash
" -->
<dt><a name="label:109" id="label:109">Array
</a></dt><!-- RDLabel: "Array
" -->
<dd>
<p>possible argument values.</p>
</dd>
<dt><a name="label:110" id="label:110">Proc
</a></dt><!-- RDLabel: "Proc
" -->
<dt><a name="label:111" id="label:111">Method
</a></dt><!-- RDLabel: "Method
" -->
<dd>
<p>alternative way to give the <em>handler</em>.</p>
</dd>
<dt><a name="label:112" id="label:112">"--switch=MANDATORY", "--switch[=OPTIONAL]", "--switch"
</a></dt><!-- RDLabel: ""­­switch=MANDATORY", "­­switch[=OPTIONAL]", "­­switch"
" -->
<dd>
<p>specifies long style switch that takes <em>mandatory</em>,
<em>optional</em> and <em>no</em> argument, respectively.</p>
</dd>
<dt><a name="label:113" id="label:113">"-xMANDATORY", "-x[OPTIONAL]", "-x"
</a></dt><!-- RDLabel: ""-xMANDATORY", "-x[OPTIONAL]", "-x"
" -->
<dd>
<p>specifies short style switch that takes <em>mandatory</em>,
<em>optional</em> and <em>no</em> argument, respectively.</p>
</dd>
<dt><a name="label:114" id="label:114">"-[a-z]MANDATORY", "-[a-z][OPTIONAL]", "-[a-z]"
</a></dt><!-- RDLabel: ""-[a-z]MANDATORY", "-[a-z][OPTIONAL]", "-[a-z]"
" -->
<dd>
<p>special form short style switch that matches character
range(not fullset of regular expression).</p>
</dd>
<dt><a name="label:115" id="label:115">"=MANDATORY", "=[OPTIONAL]"
</a></dt><!-- RDLabel: ""=MANDATORY", "=[OPTIONAL]"
" -->
<dd>
<p>argument style and description.</p>
</dd>
<dt><a name="label:116" id="label:116">"description", ...
</a></dt><!-- RDLabel: ""description", ...
" -->
<dd>
<p><em>description</em> for this option.</p>
</dd>
</dl>
</dd>
<dt><a name="label:117" id="label:117"><code>Block</code>
</a></dt><!-- RDLabel: "Block
" -->
<dd>
<p><em>handler</em> to convert option argument to arbitrary <code>Class</code>.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:118" id="label:118"><code>OptionParser#on(*<var>opts</var>) [{...}]</code></a><!-- RDLabel: "OptionParser#on" -->
<dt><a name="label:119" id="label:119"><code>OptionParser#def_option(*<var>opts</var>) [{...}]</code></a><!-- RDLabel: "OptionParser#def_option" -->
<dt><a name="label:120" id="label:120"><code>OptionParser#on_head(*<var>opts</var>) [{...}]</code></a><!-- RDLabel: "OptionParser#on_head" -->
<dt><a name="label:121" id="label:121"><code>OptionParser#def_head_option(*<var>opts</var>) [{...}]</code></a><!-- RDLabel: "OptionParser#def_head_option" -->
<dt><a name="label:122" id="label:122"><code>OptionParser#on_tail(*<var>opts</var>) [{...}]</code></a><!-- RDLabel: "OptionParser#on_tail" -->
<dt><a name="label:123" id="label:123"><code>OptionParser#def_tail_option(*<var>opts</var>) [{...}]</code></a></dt><!-- RDLabel: "OptionParser#def_tail_option" -->
<dd>
<p>Defines option switch and handler. <code>on_head</code>, <code>def_head_option</code>
and <code>on_tail</code>, <code>def_tail_option</code> put the switch at head
and tail of summary, respectively.</p>
<p>cf. <a href="#label:103">OptionParser#switch</a>.</p></dd>
</dl>
<dl>
<dt><a name="label:124" id="label:124"><code>OptionParser#order(*<var>argv</var>) [{...}]</code></a><!-- RDLabel: "OptionParser#order" -->
<dt><a name="label:125" id="label:125"><code>OptionParser#order!([<var>argv</var> = <var>ARGV</var>]) [{...}]</code></a></dt><!-- RDLabel: "OptionParser#order!" -->
<dd>
<p>Parses <var>argv</var> in order. When non-option argument encountered,
yields it if called as iterator, otherwise terminates the parse
process.
Returns rest of <var>argv</var> left unparsed.</p>
<p><code>order!</code> takes argument array itself, and removes switches
destructively.
Defaults to parse <var>ARGV</var>.</p>
<dl>
<dt><a name="label:126" id="label:126">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:127" id="label:127"><var>argv</var>
</a></dt><!-- RDLabel: "argv
" -->
<dd>
<p>command line arguments to be parsed.</p>
</dd>
<dt><a name="label:128" id="label:128"><code>Block</code>
</a></dt><!-- RDLabel: "Block
" -->
<dd>
<p>called with each non-option argument.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:129" id="label:129"><code>OptionParser#permute(*<var>argv</var>)</code></a><!-- RDLabel: "OptionParser#permute" -->
<dt><a name="label:130" id="label:130"><code>OptionParser#permute!([<var>argv</var> = <var>ARGV</var>])</code></a></dt><!-- RDLabel: "OptionParser#permute!" -->
<dd>
<p>Parses <var>argv</var> in permutation mode, and returns list of
non-option arguments.</p>
<p><code>permute!</code> takes argument array itself, and removes switches
destructively.
Defaults to parse <var>ARGV</var>.</p>
<dl>
<dt><a name="label:131" id="label:131">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:132" id="label:132"><var>argv</var>
</a></dt><!-- RDLabel: "argv
" -->
<dd>
<p>command line arguments to be parsed.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:133" id="label:133"><code>OptionParser#parse(*<var>argv</var>)</code></a><!-- RDLabel: "OptionParser#parse" -->
<dt><a name="label:134" id="label:134"><code>OptionParser#parse!([<var>argv</var> = <var>ARGV</var>])</code></a></dt><!-- RDLabel: "OptionParser#parse!" -->
<dd>
<p>Parses <var>argv</var> in order when environment variable <code>POSIXLY_CORRECT</code>
is set, otherwise permutation mode</p>
<p><code>parse!</code> takes argument array itself, and removes switches
destructively.
Defaults to parse <var>ARGV</var>.</p>
<dl>
<dt><a name="label:135" id="label:135">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:136" id="label:136"><var>argv</var>
</a></dt><!-- RDLabel: "argv
" -->
<dd>
<p>command line arguments to be parsed.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<h1><a name="label:137" id="label:137">Acceptable argument classes</a></h1><!-- RDLabel: "Acceptable argument classes" -->
<dl>
<dt><a name="label:138" id="label:138">Object
</a></dt><!-- RDLabel: "Object
" -->
<dd>
<p>any string, and no conversion. this is fall-back.</p>
</dd>
</dl>
<dl>
<dt><a name="label:139" id="label:139">String
</a></dt><!-- RDLabel: "String
" -->
<dd>
<p>any none-empty string, and no conversion.</p>
</dd>
</dl>
<dl>
<dt><a name="label:140" id="label:140">Integer
</a></dt><!-- RDLabel: "Integer
" -->
<dd>
<p>Ruby/C-like integer, octal for <code>0-7</code> sequence, binary for
<code>0b</code>, hexadecimal for <code>0x</code>, and decimal for others; with
optional sign prefix. Converts to <code>Integer</code>.</p>
</dd>
</dl>
<dl>
<dt><a name="label:141" id="label:141">Float
</a></dt><!-- RDLabel: "Float
" -->
<dd>
<p>Float number format, and converts to <code>Float</code>.</p>
</dd>
</dl>
<dl>
<dt><a name="label:142" id="label:142">Numeric
</a></dt><!-- RDLabel: "Numeric
" -->
<dd>
<p>Generic numeric format, and converts to <code>Integer</code> for integer
format, <code>Float</code> for float format.</p>
</dd>
</dl>
<dl>
<dt><a name="label:143" id="label:143">OptionParser::DecimalInteger
</a></dt><!-- RDLabel: "OptionParser::DecimalInteger
" -->
<dd>
<p>Decimal integer format, to be converted to <code>Integer</code>.</p>
</dd>
</dl>
<dl>
<dt><a name="label:144" id="label:144">OptionParser::OctalInteger
</a></dt><!-- RDLabel: "OptionParser::OctalInteger
" -->
<dd>
<p>Ruby/C like octal/hexadecimal/binary integer format, to be converted
to <code>Integer</code>.</p>
</dd>
</dl>
<dl>
<dt><a name="label:145" id="label:145">OptionParser::DecimalNumeric
</a></dt><!-- RDLabel: "OptionParser::DecimalNumeric
" -->
<dd>
<p>Decimal integer/float number format, to be converted to
<code>Integer</code> for integer format, <code>Float</code> for float format.</p>
</dd>
</dl>
<dl>
<dt><a name="label:146" id="label:146">TrueClass
</a></dt><!-- RDLabel: "TrueClass
" -->
<dd>
<p>Boolean switch, which means whether it is present or not, whether it
is absent or not with prefix <code>no-</code>, or it takes an argument
<code>yes/no/true/false/+/-</code>.</p>
</dd>
<dt><a name="label:147" id="label:147">FalseClass
</a></dt><!-- RDLabel: "FalseClass
" -->
<dd>
<p>Similar to <!-- Reference, RDLabel "TrueClass" doesn't exist --><em class="label-not-found">TrueClass</em><!-- Reference end -->, but defaulted to <code>false</code>.</p>
</dd>
</dl>
<dl>
<dt><a name="label:148" id="label:148">Array
</a></dt><!-- RDLabel: "Array
" -->
<dd>
<p>List of strings separated by ","</p>
</dd>
</dl>
<h1><a name="label:149" id="label:149">Exceptions</a></h1><!-- RDLabel: "Exceptions" -->
<h2><a name="label:150" id="label:150"><!-- Index, but conflict -->OptionParser::ParseError<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::ParseError" -->
<p>Base class of exceptions from <a href="#label:41">OptionParser</a></p>
<h3><a name="label:151" id="label:151">Superclass</a></h3><!-- RDLabel: "Superclass" -->
<p><code>RuntimeError</code></p>
<h3><a name="label:152" id="label:152">Constants</a></h3><!-- RDLabel: "Constants" -->
<dl>
<dt><a name="label:153" id="label:153">OptionParser::ParseError::Reason
</a></dt><!-- RDLabel: "OptionParser::ParseError::Reason
" -->
<dd>
<p>Reason caused error.</p>
</dd>
</dl>
<h3><a name="label:154" id="label:154">Instance methods</a></h3><!-- RDLabel: "Instance methods" -->
<dl>
<dt><a name="label:155" id="label:155"><code>OptionParser::ParseError#recover(<var>argv</var>)</code></a></dt><!-- RDLabel: "OptionParser::ParseError#recover" -->
<dd>
<p>Push backs erred argument(s) to <var>argv</var>.</p></dd>
<dt><a name="label:156" id="label:156"><code>OptionParser::ParseError#reason</code></a></dt><!-- RDLabel: "OptionParser::ParseError#reason" -->
<dd>
<p>Returns error reason. Override this to I18N.</p></dd>
<dt><a name="label:157" id="label:157"><code>OptionParser::ParseError#inspect</code></a></dt><!-- RDLabel: "OptionParser::ParseError#inspect" -->
<dd>
<p>Returns inspection string.</p></dd>
<dt><a name="label:158" id="label:158"><code>OptionParser::ParseError#message</code></a><!-- RDLabel: "OptionParser::ParseError#message" -->
<dt><a name="label:159" id="label:159"><code>OptionParser::ParseError#to_s</code></a><!-- RDLabel: "OptionParser::ParseError#to_s" -->
<dt><a name="label:160" id="label:160"><code>OptionParser::ParseError#to_str</code></a></dt><!-- RDLabel: "OptionParser::ParseError#to_str" -->
<dd>
<p>Default stringizing method to emit standard error message.</p></dd>
</dl>
<h2><a name="label:161" id="label:161"><!-- Index, but conflict -->OptionParser::AmbiguousOption<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::AmbiguousOption" -->
<p>Raises when encountered ambiguously completable string.</p>
<h3><a name="label:162" id="label:162">Superclass</a></h3><!-- RDLabel: "Superclass" -->
<p><a href="#label:150">OptionParser::ParseError</a></p>
<h2><a name="label:163" id="label:163"><!-- Index, but conflict -->OptionParser::NeedlessArgument<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::NeedlessArgument" -->
<p>Raises when encountered argument for switch defined as which takes no
argument.</p>
<h3><a name="label:164" id="label:164">Superclass</a></h3><!-- RDLabel: "Superclass" -->
<p><a href="#label:150">OptionParser::ParseError</a></p>
<h2><a name="label:165" id="label:165"><!-- Index, but conflict -->OptionParser::MissingArgument<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::MissingArgument" -->
<p>Raises when no argument found for switch defined as which needs
argument.</p>
<h3><a name="label:166" id="label:166">Superclass</a></h3><!-- RDLabel: "Superclass" -->
<p><a href="#label:150">OptionParser::ParseError</a></p>
<h2><a name="label:167" id="label:167"><!-- Index, but conflict -->OptionParser::InvalidOption<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::InvalidOption" -->
<p>Raises when undefined switch.</p>
<h3><a name="label:168" id="label:168">Superclass</a></h3><!-- RDLabel: "Superclass" -->
<p><a href="#label:150">OptionParser::ParseError</a></p>
<h2><a name="label:169" id="label:169"><!-- Index, but conflict -->OptionParser::InvalidArgument<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::InvalidArgument" -->
<p>Raises when the given argument does not match required format.</p>
<h3><a name="label:170" id="label:170">Superclass</a></h3><!-- RDLabel: "Superclass" -->
<p><a href="#label:150">OptionParser::ParseError</a></p>
<h2><a name="label:171" id="label:171"><!-- Index, but conflict -->OptionParser::AmbiguousArgument<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::AmbiguousArgument" -->
<p>Raises when the given argument word can't completed uniquely.</p>
<h3><a name="label:172" id="label:172">Superclass</a></h3><!-- RDLabel: "Superclass" -->
<p><a href="#label:169">OptionParser::InvalidArgument</a></p>
<h1><a name="label:173" id="label:173">Miscellaneous</a></h1><!-- RDLabel: "Miscellaneous" -->
<h2><a name="label:174" id="label:174"><!-- Index, but conflict -->OptionParser::Arguable<!-- Index end --></a></h2><!-- RDLabel: "OptionParser::Arguable" -->
<p>Extends command line arguments array to parse itself.</p>
<dl>
<dt><a name="label:175" id="label:175"><code>OptionParser::Arguable#options=(<var>opt</var>)</code></a></dt><!-- RDLabel: "OptionParser::Arguable#options=" -->
<dd>
<p>Sets <a href="#label:41">OptionParser</a> object, when <var>opt</var> is <code>false</code> or
<code>nil</code>, methods <a href="#label:176">OptionParser::Arguable#options</a> and
<a href="#label:175">OptionParser::Arguable#options=</a> are undefined. Thus, there
is no ways to access the <a href="#label:41">OptionParser</a> object via the
receiver object.</p></dd>
</dl>
<dl>
<dt><a name="label:176" id="label:176"><code>OptionParser::Arguable#options</code></a></dt><!-- RDLabel: "OptionParser::Arguable#options" -->
<dd>
<p>Actual <a href="#label:41">OptionParser</a> object, automatically created if not
yet.</p>
<p>If called as iterator, yields with the <a href="#label:41">OptionParser</a> object
and returns the result of the block. In this case, rescues any
<a href="#label:150">OptionParser::ParseError</a> exceptions in the block, just emits
error message to <!-- Reference, RDLabel "STDERR" doesn't exist --><em class="label-not-found">STDERR</em><!-- Reference end --> and returns <code>nil</code>.</p>
<dl>
<dt><a name="label:177" id="label:177">Parameters:
</a></dt><!-- RDLabel: "Parameters:
" -->
<dd>
<dl>
<dt><a name="label:178" id="label:178"><code>block</code>
</a></dt><!-- RDLabel: "block
" -->
<dd>
<p>Yielded with the <a href="#label:41">OptionParser</a> instance.</p>
</dd>
</dl>
</dd>
</dl></dd>
</dl>
<dl>
<dt><a name="label:179" id="label:179"><code>OptionParser::Arguable#order!</code></a><!-- RDLabel: "OptionParser::Arguable#order!" -->
<dt><a name="label:180" id="label:180"><code>OptionParser::Arguable#permute!</code></a><!-- RDLabel: "OptionParser::Arguable#permute!" -->
<dt><a name="label:181" id="label:181"><code>OptionParser::Arguable#parse!</code></a></dt><!-- RDLabel: "OptionParser::Arguable#parse!" -->
<dd>
<p>Parses <var>self</var> destructively, and returns <var>self</var> just contains
rest arguments left without parsed.</p></dd>
</dl>
<h2><a name="label:182" id="label:182">OptionParser::Acceptables</a></h2><!-- RDLabel: "OptionParser::Acceptables" -->
<p>Acceptable argument classes. Now contains <code>DecimalInteger</code>,
<code>OctalInteger</code> and <code>DecimalNumeric</code>.
see <a href="#label:137">Acceptable argument classes</a>.</p>
<h1><a name="label:183" id="label:183">Example</a></h1><!-- RDLabel: "Example" -->
<pre>require 'optparse'
$0 = File.basename($0)
# keywords
CODES = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
CODE_ALIASES = {"jis" => "iso-2022-jp", "sjis" => "shift_jis"}
POSSIBLE_CODES = "(#{(CODES+CODE_ALIASES.keys).join(',')})"
vars = {}
ARGV.options do
|opts|
opts.banner = "Usage: #{$0} [options] argv...\n"
# separater
opts.on_tail
opts.on_tail("common options:")
# no argument, shows at tail
opts.on_tail("--help", "show this message") {puts opts; exit}
# mandatory argument
opts.on("-r", "--require=LIBRARY", String,
"require the LIBRARY, before",
"executing your script") {|vars[:library]|}
# optional argument
opts.on("-i", "--inplace=[EXTENSION]",
"edit ARGV files in place", # multiline description
"(make backup if EXTENSION supplied)") {|vars[:inplace]| vars[:inplace] ||= ''}
opts.on("-N=[NUM]", Integer) {|vars[:number]|}
# additional class
# opts.on("-t", "--time=TIME", Time, "it's the time") {|vars[:time]|}
# limit argument syntax
opts.on("-[0-7]", "-F", "--irs=[OCTAL]", OptionParser::OctalInteger,
"specify record separator", "(\\0, if no argument)") {|vars[:irs]|}
# boolean switch(default true)
vars[:exec] = true
opts.on("-n", "--no-exec", "not really execute") {|vars[:exec]|}
# array
opts.on("-a", "--list[=LIST,LIST]", Array, "list") {|vars[:list]|}
# fixed size array
opts.on("--pair[=car,cdr]", Array, "pair") {|vars[:x], vars[:y]|}
# keyword completion
opts.on("--code=CODE", CODES, CODE_ALIASES, "select coding system", POSSIBLE_CODES) {|vars[:code]|}
# optional argument with keyword completion
opts.on("--type[=TYPE]", [:text, :binary], "select type(text, binary)") {|vars[:type]|}
# boolean switch with optional argument(default false)
opts.on("-v", "--[no-]verbose=[FLAG]", "run verbosely") {|vars[:verbose]|}
# easy way, set local variable
opts.on("-q", "--quit", "quit when ARGV is empty") {|vars[:quit]|}
# adding on the fly
opts.on("--add=SWITCH=[ARG]", "add option on the fly", /\A(\w+)(?:=.+)?\Z/) do
|opt, var|
opts.on("--#{opt}", "added in runtime", &eval("proc {|vars[:#{var}]|}"))
end
opts.on_head("specific optins:")
# no argument
opts.on_tail("--version", "show version") do
puts OptionParser::Version.join('.')
exit
end
opts.parse!
end
if (Fixnum === :-)
class << vars
def inspect
"{" + collect {|k,v| ":#{k.id2name}=>#{v.inspect}"}.join(", ") + "}"
end
end
end
p vars
(puts ARGV.options; exit) if vars[:quit]
ARGV.options = nil # no more parse
puts "ARGV = #{ARGV.join(' ')}" if !ARGV.empty?
#opts.variable.each {|sym| puts "#{sym} = #{opts.send(sym).inspect}"}</pre>
</body>
</html>
|
