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
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
|
<!-- Creator : groff version 1.18.1 -->
<!-- CreationDate: Fri Dec 23 00:39:57 2005 -->
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta name="Content-Style" content="text/css">
<title>ARGTABLE2</title>
</head>
<body>
<h1 align=center>ARGTABLE2</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#FUNCTION REFERENCE">FUNCTION REFERENCE</a><br>
<a href="#LITERAL OPTIONS (struct arg_lit)">LITERAL OPTIONS (struct arg_lit)</a><br>
<a href="#INTEGER OPTIONS (struct arg_int)">INTEGER OPTIONS (struct arg_int)</a><br>
<a href="#DOUBLE OPTIONS (struct arg_dbl)">DOUBLE OPTIONS (struct arg_dbl)</a><br>
<a href="#STRING OPTIONS (struct arg_str)">STRING OPTIONS (struct arg_str)</a><br>
<a href="#REGULAR EXPRESSION OPTIONS (struct arg_rex)">REGULAR EXPRESSION OPTIONS (struct arg_rex)</a><br>
<a href="#FILENAME OPTIONS (struct arg_file)">FILENAME OPTIONS (struct arg_file)</a><br>
<a href="#DATE/TIME OPTIONS (struct arg_date)">DATE/TIME OPTIONS (struct arg_date)</a><br>
<a href="#REMARK OPTIONS (struct arg_rem)">REMARK OPTIONS (struct arg_rem)</a><br>
<a href="#END-OF-TABLE OPTIONS (struct arg_end)">END-OF-TABLE OPTIONS (struct arg_end)</a><br>
<a href="#FILES">FILES</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<hr>
<a name="NAME"></a>
<h2>NAME</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>argtable2 − an ANSI C library for parsing GNU style
command line options</p>
</td>
</table>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>#include <argtable2.h>
struct <b>arg_lit
</b>struct <b>arg_int
</b>struct <b>arg_dbl
</b>struct <b>arg_str
</b>struct <b>arg_rex
</b>struct <b>arg_file
</b>struct <b>arg_date
</b>struct <b>arg_rem
</b>struct <b>arg_end
</b>struct <b>arg_xxx</b>* <b>arg_xxx0</b>(...)
struct <b>arg_xxx</b>* <b>arg_xxx1</b>(...)
struct <b>arg_xxx</b>* <b>arg_xxxn</b>(...)
int <b>arg_nullcheck</b>(void **argtable)
int <b>arg_parse</b>(int argc, char **argv, void **argtable)
void <b>arg_print_option</b>(FILE *fp, const char *shortopts, const char *longopts,
const char *datatype, const char *suffix)
void <b>arg_print_syntax</b>(FILE *fp, void **argtable, const char *suffix)
void <b>arg_print_syntaxv</b>(FILE *fp, void **argtable, const char *suffix)
void <b>arg_print_glossary</b>(FILE *fp, void **argtable, const char *format)
void <b>arg_print_glossary_gnu</b>(FILE *fp, void **argtable)
void <b>arg_print_errors</b>(FILE *fp, struct arg_end *end, const char *progname)
void <b>arg_freetable</b>(void **argtable, size_t n)
</pre>
</td>
</table>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Argtable is an ANSI C library for parsing GNU style
command line arguments with a minimum of fuss. It enables
the programmer to define their program’s argument
syntax directly in the source code as an array of structs.
The command line is then parsed according to that
specification and the resulting values stored directly into
user-defined program variables where they are accessible to
the main program.</p>
<!-- INDENTATION -->
<p>This man page is only for reference. Introductory and
advanced texts on argtable should be available on this
system in pdf, html, and postscript from under
<b>@prefix@/share/doc/argtable2/</b> along with example
source code. Alternatively refer to the argtable homepage at
http://argtable.sourceforge.net.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructing an arg_xxx data structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Each <b>arg_xxx</b> struct has it own unique set of
constructor functions and while these may differ slightly
between <b>arg_xxx</b> structs, they are generally of the
form:</p>
<!-- INDENTATION -->
<p>struct <b>arg_xxx* arg_xxx0</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
<!-- INDENTATION -->
<p>struct <b>arg_xxx* arg_xxx1</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
<!-- INDENTATION -->
<p>struct <b>arg_xxx* arg_xxxn</b> (const char *shortopts,
const char *longopts, const char *datatype, int mincount,
int maxcount, const char *glossary)</p>
<!-- INDENTATION -->
<p>The <b>arg_xxx0()</b> and <b>arg_xxx1()</b> forms are
merely abbreviated forms of <b>arg_xxxn()</b> and are
provided as a convenience for the most common arrangements
of command line options; namely those that have zero-or-one
occurrences (mincount=0,maxcount=1) and those that have one
exactly one occurrence (mincount=1,maxcount=1)
respectively.</p>
<!-- INDENTATION -->
<p>The <i>const char* shortopts</i> parameter defines the
option’s short form tag (eg: -x, -k3,
-D"macro"). It can be left as NULL if a short
option is not required, otherwise use it to specify the
desired short option character in the string (without the
leading "-" and without any whitespace). For
example, the short option -v is defined simply as
"v". In fact, a command line option may have
multiple alternate short form tags defined for it by
concatenating the desired characters into the shortopts
string. For instance "abc" defines an option which
will accept any of the three equivalent short forms -a, -b,
-c interchangeably.</p>
<!-- INDENTATION -->
<p>The <i>const char* longopts</i> parameter is similar to
<i>shortopts</i>, except it defines the option’s long
form tags (eg: --help, --depth=3, --name=myfile.txt). It too
can be left as NULL if not required, and it too can have
multiple equivalent tags defined but these must be separated
by commas. For example, if we wish to define two equivalent
long options --quiet and --silent then we would give
longopts as "quiet,silent". Remember not to
include any whitespace.</p>
<!-- INDENTATION -->
<p>If both <i>shortopts</i> and <i>longopts</i> are given as
NULL then the resulting option is an untagged argument.</p>
<!-- INDENTATION -->
<p>The <i>const char* datatype</i> parameter is a
descriptive string you can use to customize the appearance
of the argument data type in error messages and so forth. It
does not affect the actual data type definition as that is a
fixed property of the <b>arg_xxx</b> struct. So for example,
defining a <i>datatype</i> of "<bar>" will
result in the option being display something like "-x
<bar>" or "--foo=<bar>" depending
upon your option tags. If given as NULL, the <i>datatype</i>
string will revert to the default value for the particular
<b>arg_xxx</b> struct. You can effectively disable the
default by specifying <i>datatype</i> as an empty
string.</p>
<!-- INDENTATION -->
<p>The <i>int mincount</i> parameter specifies the minimum
number of occurrences that the option must appear on the
command line. If the option does not appear at least that
many times then the parser reports it as a syntax error. The
<i>mincount</i> defaults to 0 for the <b>arg_xxx0()</b>
functions and 1 for <b>arg_xxx1()</b> functions.</p>
<!-- INDENTATION -->
<p>The <i>int maxcount</i> parameter specifies the maximum
number of occurrences that the option may appear on the
command line. Any occurrences beyond the maximum are
discarded by the parser reported as syntax errors. The
<i>maxcount</i> defaults to 1 for both the <b>arg_xxx0()</b>
and <b>arg_xxx1()</b> functions.</p>
<!-- INDENTATION -->
<p>The <i>const char* glossary</i> parameter is another
descriptive string but this one appears in the glossary
table summarizing the program’s command line options.
The glossary table is generated automatically by the
<b>arg_print_glossary</b> function (see later). For example,
a glossary string of "the foobar factor" would
appear in the glossary table along side the option something
like:</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="20%"></td>
<td width="79%">
<p><tt>--foo=<bar> the foobar factor</tt></p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Specifying a NULL glossary string causes that option to
be omitted from the glossary table.</p>
<!-- INDENTATION -->
<p>See below for the exact definitions of the individual
<b>arg_xxx</b> structs and their constructor functions.</p>
</td>
</table>
<a name="FUNCTION REFERENCE"></a>
<h2>FUNCTION REFERENCE</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>int arg_nullcheck (void **argtable)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Returns non-zero if the <i>argtable[]</i> array contains
any NULL entries up until the terminating <b>arg_end*</b>
entry. Returns zero otherwise.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>int arg_parse (int argc, char **argv, void
**argtable)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Parse the command line arguments in <i>argv[]</i> using
the command line syntax specified in <i>argtable[]</i>,
returning the number of errors encountered. Error details
are recorded in the argument table’s <b>arg_end</b>
structure from where they can be displayed later with the
<b>arg_print_errors</b> function. Upon a successful parse,
the <b>arg_xxx</b> structures referenced in
<i>argtable[]</i> will contain the argument values extracted
from the command line.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>void arg_print_option (FILE *fp, const char
*shortopts, const char *longopts, const char *datatype,
const char *suffix)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>This function prints an option’s syntax, as in
<b>-K|--scalar=<int></b>, where the short options,
long options, and datatype are all given as parameters of
this function. It is primarily used within the
<b>arg_xxx</b> structures’ <i>errorfn</i> functions as
a way of displaying an option’s syntax inside of error
messages. However, it can also be used in user code if
desired. The <i>suffix</i> string is provided as a
convenience for appending newlines and so forth to the end
of the display and can be given as NULL if not required.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>void arg_print_syntax (FILE *fp, void **argtable,
const char *suffix)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Prints the GNU style command line syntax for the given
argument table, as in: [-abcv] [--scalar=<n>] [-o
myfile] <file> [<file>]<br>
The <i>suffix</i> string is provided as a convenience for
appending newlines and so forth to the end of the display
and can be given as NULL if not required.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>void arg_print_syntaxv (FILE *fp, void **argtable,
const char *suffix)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Prints the verbose form of the command line syntax for
the given argument table, as in: [-a] [-b] [-c]
[--scalar=<n>] [-o myfile] [-v|--verbose] <file>
[<file>]<br>
The <i>suffix</i> string is provided as a convenience for
appending newlines and so forth to the end of the display
and can be given as NULL if not required.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>void arg_print_glossary (FILE *fp, void **argtable,
const char *format)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Prints a glossary table describing each option in the
given argument table. The <i>format</i> string is passed to
printf to control the formatting of each entry in the the
glossary. It must have exactly two "%s" format
parameters as in "%-25s %s\n", the first is for
the option’s syntax and the second for its glossary
string. If an option’s glossary string is NULL then
that option in omitted from the glossary display.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>void arg_print_glossary_gnu (FILE *fp, void
**argtable)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>An alternate form of <b>arg_print_glossary()</b> that
prints the glossary using strict GNU formatting conventions
wherein long options are vertically aligned in a second
column, and lines are wrapped at 80 characters.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>void arg_print_errors (FILE *fp, struct arg_end *end,
const char *progname)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Prints the details of all errors stored in the <i>end</i>
data structure. The <i>progname</i> string is prepended to
each error message.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>void arg_freetable (void ** argtable, size_t
n)</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Deallocates the memory used by each <b>arg_xxx</b> struct
referenced by <i>argtable[]</i>. It does this by calling
<b>free</b> for each of the <i>n</i> pointers in the
argtable array and then nulling them for safety.</p>
</td>
</table>
<a name="LITERAL OPTIONS (struct arg_lit)"></a>
<h2>LITERAL OPTIONS (struct arg_lit)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Command line examples</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>-x, -y, -z, --help, --verbose</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_lit
</b> {
struct <b>arg_hdr</b> hdr;
int count;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Functions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_lit* arg_lit0</b> (const char *shortopts,
const char *longopts, const char *glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_lit* arg_lit1</b> (const char *shortopts,
const char *longopts, const char *glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_lit* arg_litn</b> (const char *shortopts,
const char *longopts, int mincount, int maxcount, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Literal options take no argument values so all that is to
be seen in the <b>arg_lit</b> struct is the <i>count</i> of
the number of times the option was present on the command
line. Upon a successful parse, <i>count</i> is guaranteed to
be within the <i>mincount</i> and <i>maxcount</i> limits set
for the option at construction.</p>
</td>
</table>
<a name="INTEGER OPTIONS (struct arg_int)"></a>
<h2>INTEGER OPTIONS (struct arg_int)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Command line examples</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>-x2, -y 7, -z-3, --size=734, --count 124</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_int
</b> {
struct <b>arg_hdr</b> hdr;
int count;
int *ival;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Functions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_int* arg_int0</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_int* arg_int1</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_int* arg_intn</b> (const char *shortopts,
const char *longopts, const char *datatype, int mincount,
int maxcount, const char *glossary</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>The <b>arg_int</b> struct contains the <i>count</i> of
the number of times the option was present on the command
line and a pointer (<i>ival</i>) to an array containing the
integer values given with those particular options. The
array is fixed at construction time to hold <i>maxcount</i>
integers at most.</p>
<!-- INDENTATION -->
<p>Upon a successful parse, <i>count</i> is guaranteed to be
within the <i>mincount</i> and <i>maxcount</i> limits set
for the option at construction with the appropriate values
store in the <i>ival</i> array. The parser will not accept
any values beyond that limit.</p>
<!-- INDENTATION -->
<p>It is quite acceptable to set default values in the
<i>ival</i> array prior to calling arg_parse if desired as
the parser does alter <i>ival</i> entries for which no
command line argument is received.</p>
</td>
</table>
<a name="DOUBLE OPTIONS (struct arg_dbl)"></a>
<h2>DOUBLE OPTIONS (struct arg_dbl)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Command line examples</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>-x2.234, -y 7e-03, -z-3.3E+6, --pi=3.1415, --tolerance
1.0E-6</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_dbl
</b> {
struct <b>arg_hdr</b> hdr;
int count;
double *dval;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Functions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_dbl* arg_dbl0</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_dbl* arg_dbl1</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_dbl* arg_dbln</b> (const char *shortopts,
const char *longopts, const char *datatype, int mincount,
int maxcount, const char *glossary</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Like <b>arg_int</b> but the arguments values are stored
as doubles in <i>dval</i>.</p>
</td>
</table>
<a name="STRING OPTIONS (struct arg_str)"></a>
<h2>STRING OPTIONS (struct arg_str)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Command line examples</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>-Dmacro, -t mytitle, -m "my message string",
--title="hello world"</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_str
</b> {
struct <b>arg_hdr</b> hdr;
int count;
const char **sval;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Functions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_str* arg_str0</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_str* arg_str1</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_str* arg_strn</b> (const char *shortopts,
const char *longopts, const char *datatype, int mincount,
int maxcount, const char *glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>The <b>arg_str</b> struct contains the <i>count</i> of
the number of times the option was present on the command
line and a pointer (<i>sval</i>) to an array containing
pointers to the parsed string values. The array is fixed at
construction time to hold <i>maxcount</i> string pointers at
most. These pointers in this array reference the actual
command line string buffers stored in argv[], so the string
contents should not be should not be altered. Although it is
quite acceptable to set default string pointers in the
<i>sval</i> array prior to calling arg_parse as the parser
does alter them if no matching command line argument is
received.</p>
</td>
</table>
<a name="REGULAR EXPRESSION OPTIONS (struct arg_rex)"></a>
<h2>REGULAR EXPRESSION OPTIONS (struct arg_rex)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Command line examples</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>"hello world", -t mytitle, -m "my message
string", --title="hello world"</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_rex
</b> {
struct <b>arg_hdr</b> hdr;
int count;
const char **sval;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Functions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_rex* arg_rex0</b> (const char *shortopts,
const char *longopts, const char *pattern, const char
*datatype, int flags, const char *glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_rex* arg_rex1</b> (const char *shortopts,
const char *longopts, const char *pattern, const char
*datatype, int flags, const char *glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_rex* arg_rexn</b> (const char *shortopts,
const char *longopts, const char *pattern, const char
*datatype, int mincount, int maxcount, int flags, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Like <b>arg_str</b> but but the string argument values
are only accepted if they match a predefined regular
expression. The regular expression is defined by the
<i>pattern</i> parameter passed to the <i>arg_rex</i>
constructor. The regular expression parsing is done using
regex, and its behaviour can be controlled via standard
regex bit flags which are passed to argtable via the
<i>flags</i> parameter in the <i>arg_rex</i> conbstructors.
However the only two regex flags that are relevant to
argtable are REG_EXTENDED (use extended regular expressions
rather than basic ones) and REG_ICASE (ignore case). These
may be logically ORed if desired. This argument type is
useful for matching command line keywords, particularly if
case insensitive strings or pattern matching is required.
See <b>regex(3)</b> for more details of regular expression
matching.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Restrictions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Argtable does not support <b>arg_date</b> functionality
under Microsoft Windows platforms as the Microsoft compilers
do include the necessary <b>regex</b> support as
standard.</p>
</td>
</table>
<a name="FILENAME OPTIONS (struct arg_file)"></a>
<h2>FILENAME OPTIONS (struct arg_file)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Command line xamples</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>-o myfile, -Ihome/foo/bar, --input=~/doc/letter.txt,
--name a.out</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_file
</b> {
struct <b>arg_hdr</b> hdr;
int count;
const char **filename;
const char **basename;
const char **extension;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Functions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_file* arg_file0</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_file* arg_file1</b> (const char *shortopts,
const char *longopts, const char *datatype, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_file* arg_filen</b> (const char *shortopts,
const char *longopts, const char *datatype, int mincount,
int maxcount, const char *glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Like <b>arg_str</b> but the argument strings are presumed
to have filename qualities so some additional pasring is
done to separate out the filename’s basename and
extension (if they exist). The three arrays filename[],
basename[], extension[] each store up to maxcount entries,
and the i’th entry of each of these arrays refer to
different components of the same string buffer.</p>
<!-- INDENTATION -->
<p>For instance, <b>-o /home/heitmann/mydir/foo.txt</b>
would be parsed as:</p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="16%"></td>
<td width="83%">
<pre>filename[i] = "/home/heitmann/mydir/foo.txt"
basename[i] = "foo.txt"
extension[i] = "txt"
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>If the filename has no leading path then the basename is
the same as the filename, and if no extension could be
identified then it is given as NULL. Note that filename
extensions are defined as all text following the last
"." in the filename. Thus <b>-o foo</b> would be
parsed as:</p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="16%"></td>
<td width="83%">
<pre>filename[i] = "foo"
basename[i] = "foo"
extension[i] = NULL
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>As with arg_str, the string pointers in
<i>filename[]</i>, <i>basename[]</i>, and <i>extension[]</i>
actually refer to the original <i>argv[]</i> command line
string buffers so you should not attempt to alter them.</p>
<!-- INDENTATION -->
<p>Note also that the parser only ever treats the filenames
as strings and never attempts to open them as files or
perform any directory lookups on them.</p>
</td>
</table>
<a name="DATE/TIME OPTIONS (struct arg_date)"></a>
<h2>DATE/TIME OPTIONS (struct arg_date)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Command line examples</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>12/31/04, -d 1982-11-28, --time 23:59</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_date
</b> {
struct <b>arg_hdr</b> hdr;
const char *format;
int count;
struct tm *tmval;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Functions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_date* arg_date0</b> (const char *shortopts,
const char *longopts, const char *format, const char
*datatype, const char *glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_date* arg_date1</b> (const char *shortopts,
const char *longopts, const char *format, const char
*datatype, const char *glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_date* arg_daten</b> (const char *shortopts,
const char *longopts, const char *format, const char
*datatype, int mincount, int maxcount, const char
*glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Accepts a timestamp string from the command line and
converts it to <i>struct tm</i> format using the system
<b>strptime</b> function. The time format is defined by the
<i>format</i> string passed to the <i>arg_date</i>
constructor, and is passed directly to <b>strptime</b>. See
<b>strptime(3)</b> for more details on the format
string.</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Restrictions</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Argtable does not support <b>arg_date</b> functionality
under Microsoft Windows as the Microsoft compilers do
include the necessary <b>strptime</b> support as
standard.</p>
</td>
</table>
<a name="REMARK OPTIONS (struct arg_rem)"></a>
<h2>REMARK OPTIONS (struct arg_rem)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_rem
</b> {
struct <b>arg_hdr</b> hdr;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Function</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_rem* arg_rem</b> (const char* datatype,
const char* glossary)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>The <b>arg_rem</b> struct is a dummy struct in the sense
it does not represent a command line option to be parsed.
Instead it provides a means to include additional
<i>datatype</i> and <i>glossary</i> strings in the output of
the <b>arg_print_syntax</b>, <b>arg_print_syntaxv</b>, and
<b>arg_print_glossary functions</b>. As such, <b>arg_rem</b>
structs may be used in the argument table to insert
additional lines of text into the glossary descriptions or
to insert additional text fields into the syntax
description. It has no data members apart from the mandatory
<i>arg_hdr</i> struct.</p>
</td>
</table>
<a name="END-OF-TABLE OPTIONS (struct arg_end)"></a>
<h2>END-OF-TABLE OPTIONS (struct arg_end)</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Data Structure</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<pre>struct <b>arg_end
</b> {
struct <b>arg_hdr</b> hdr;
int count;
int *error;
void **parent;
const char **argval;
};
</pre>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Constructor Function</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>struct <b>arg_end* arg_end</b> (int maxerrors)</p>
</td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="4%"></td>
<td width="95%">
<p><b>Description</b></p></td>
</table>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>The arg_end struct is primarily used to mark the end of
an argument table and doesn’t represent any command
line option. Every argument table must have an
<b>arg_end</b> structure as its last entry.</p>
<!-- INDENTATION -->
<p>Apart from terminating the argument table, the
<b>arg_end</b> structure also stores the error codes
generated by the <b>arg_parse</b> function as it attempts to
parse the command line with the given argument table. The
<i>maxerrors</i> parameter passed to the <b>arg_end</b>
constructor specifies the maximum number of errors that the
structure can store. Any further errors are discarded and
replaced with the single error code ARG_ELIMIT which is
later reported to the user by the message "too many
errors". A <i>maxerrors</i> limit of 20 is quite
reasonable.</p>
<!-- INDENTATION -->
<p>The <b>arg_print_errors</b> function will print the
errors stored in the <b>arg_end</b> struct in the same order
as they occurred, so there is no need to understand the
internals of the <b>arg_end</b> struct.</p>
<!-- INDENTATION -->
<p>For those that are curious, the three arrays
<i>error[]</i>, <i>parent[]</i>, and <i>argval[]</i> are
each allocated <i>maxerrors</i> entries at construction. As
usual, the <i>count</i> variable gives the number of entries
actually stored in these arrays. The same value applies to
all three arrays as the i’th entry of each all refer
to different aspects of the same error condition.</p>
<!-- INDENTATION -->
<p>The <i>error[i]</i> entry holds the error code returned
by the <i>hdr.scanfn</i> function of the particular
<b>arg_xxx</b> that is reporting the error. The meaning if
the code is usually known only to the issuing <b>arg_xxx</b>
struct. The predefined error codes that <b>arg_end</b>
handles from the parser itself are the exceptions.</p>
<!-- INDENTATION -->
<p>The <i>parent[i]</i> entry points to the parent
<b>arg_xxx</b> structure that reported the error. That same
<b>arg_xxx</b> structure is also responsible for displaying
a pertinent error message when called on to do so by the
<b>arg_print_errors</b> function. It calls the
<i>hdr.errorfn</i> function of each parent <b>arg_xxx</b>
struct listed in the <b>arg_end</b> structure.</p>
<!-- INDENTATION -->
<p>Lastly, the <i>argval[i]</i> entry points to the command
line argument at which the error occurred, although this may
be NULL when there is no relevant command line value. For
instance, if an error reports a missing option then there
will be no matching command line argument value.</p>
</td>
</table>
<a name="FILES"></a>
<h2>FILES</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>@prefix@/include/argtable2.h<br>
@prefix@/lib/libargtable2.a<br>
@prefix@/lib/libargtable2.so<br>
@prefix@/man3/argtable2.3<br>
@prefix@/share/doc/argtable2/<br>
@prefix@/share/doc/argtable2/example/</p>
</td>
</table>
<a name="AUTHOR"></a>
<h2>AUTHOR</h2>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>Stewart Heitmann
<sheitmann@users.sourceforge.net></p>
</td>
</table>
<hr>
</body>
</html>
|
