cmdr
Check-in [b4bc5bcb6e]
Not logged in
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to [email protected]
or submit via the online form by Sep 9.

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Updated embedded documentation
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: b4bc5bcb6eb14f4089d500cf1875a4af301955e3
User & Date: aku 2013-11-03 07:18:20
Context
2013-11-04
17:38
Reworked the interaction for entry of scalar, and general calculation of the value - Show validation error message for proper feedback - Trap ^C properly, as done for the list-case already. Scalar was forgotten. - Report the ^C as 'undefined value' - Remember the undefined-ness and have additional attempts to retrieve the value abort early This prevents retries of computing the value where we cannot succeed. It also prevents additional attempts at interaction. Bumped version to 0.10. check-in: d2a2bc511f user: andreask tags: trunk
2013-11-03
07:18
Updated embedded documentation check-in: b4bc5bcb6e user: aku tags: trunk
2013-11-01
22:52
Near completed parameter documentation. check-in: c1ba65f517 user: andreask tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Added embedded/man/files/cmdr_parameter.n.






































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
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
'\"
'\" Generated from file 'cmdr_parameter\&.man' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2013 Andreas Kupries
'\" Copyright (c) 2013 Documentation, Andreas Kupries
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 4c 8c 12c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_private" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_private \- Cmdr - Single command handling, options, and arguments
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::parameter\fR \fBnew\fR \fIconfig\fR \fIorder\fR \fIcmdline\fR \fIrequired\fR \fIdefered\fR \fIname\fR \fIdescription\fR \fIspec\fR
.sp
\fB::cmdr::parameter\fR \fBcreate\fR \fIobj\fR \fIconfig\fR \fIorder\fR \fIcmdline\fR \fIrequired\fR \fIdefered\fR \fIname\fR \fIdescription\fR \fIspec\fR
.sp
\fB<parameter>\fR \fBaccept\fR \fIx\fR
.sp
\fB<parameter>\fR \fBcmdline\fR
.sp
\fB<parameter>\fR \fBcode\fR
.sp
\fB<parameter>\fR \fBcomplete-words\fR \fIparse\fR
.sp
\fB<parameter>\fR \fBconfig\fR \fIword\&.\&.\&.\fR
.sp
\fB<parameter>\fR \fBdefault\fR
.sp
\fB<parameter>\fR \fBdefered\fR
.sp
\fB<parameter>\fR \fBdescription\fR ?\fIdetail\fR?
.sp
\fB<parameter>\fR \fBdocumented\fR
.sp
\fB<parameter>\fR \fBdontinteract\fR
.sp
\fB<parameter>\fR \fBflag\fR
.sp
\fB<parameter>\fR \fBforget\fR
.sp
\fB<parameter>\fR \fBgenerator\fR
.sp
\fB<parameter>\fR \fBhasdefault\fR
.sp
\fB<parameter>\fR \fBhelp\fR
.sp
\fB<parameter>\fR \fBinteractive\fR
.sp
\fB<parameter>\fR \fBinteract\fR ?\fIprompt\fR?
.sp
\fB<parameter>\fR \fBisbool\fR
.sp
\fB<parameter>\fR \fBis\fR \fItype\fR
.sp
\fB<parameter>\fR \fBlabel\fR
.sp
\fB<parameter>\fR \fBlist\fR
.sp
\fB<parameter>\fR \fBlocker\fR
.sp
\fB<parameter>\fR \fBlock\fR \fIreason\fR
.sp
\fB<parameter>\fR \fBname\fR
.sp
\fB<parameter>\fR \fBoptions\fR
.sp
\fB<parameter>\fR \fBordered\fR
.sp
\fB<parameter>\fR \fBpresence\fR
.sp
\fB<parameter>\fR \fBprimary\fR \fIoption\fR
.sp
\fB<parameter>\fR \fBprocess\fR \fIdetail\fR \fIqueue\fR
.sp
\fB<parameter>\fR \fBprompt\fR
.sp
\fB<parameter>\fR \fBrequired\fR
.sp
\fB<parameter>\fR \fBreset\fR ?\fIcleanup\fR?
.sp
\fB<parameter>\fR \fBself\fR
.sp
\fB<parameter>\fR \fBset?\fR
.sp
\fB<parameter>\fR \fBsetq\fR \fIqueue\fR
.sp
\fB<parameter>\fR \fBset\fR \fIvalue\fR
.sp
\fB<parameter>\fR \fBstring\fR
.sp
\fB<parameter>\fR \fBthreshold:\fR \fIn\fR
.sp
\fB<parameter>\fR \fBthreshold\fR
.sp
\fB<parameter>\fR \fBtype\fR
.sp
\fB<parameter>\fR \fBundefined!\fR
.sp
\fB<parameter>\fR \fBvalidator\fR
.sp
\fB<parameter>\fR \fBvalue\fR
.sp
\fB<parameter>\fR \fBwhen-complete\fR
.sp
\fB<parameter>\fR \fBwhen-set\fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.
.PP
For availability please read \fICmdr - How To Get The Sources\fR\&.
.PP
This package implements \fIparameters\fR, collections of which (see
\fBcmdr::config\fR) serve as the configuration of privates (see
\fBcmdr::private\fR)\&.
.SH "CLASS API"
The class API is not public\&. It is used internally by the framework
when parsing a command hierarchy specification to create the necessary
parameter instances\&.
.PP
It is described here for use by developers maintaining,
modifying and extending the framework itself\&. A user of the framework
has no need for it\&.
.TP
\fB::cmdr::parameter\fR \fBnew\fR \fIconfig\fR \fIorder\fR \fIcmdline\fR \fIrequired\fR \fIdefered\fR \fIname\fR \fIdescription\fR \fIspec\fR
Create an auto-named instance of \fBcmdr::parameter\fR\&.
.sp
\fINot used\fR\&.
.TP
\fB::cmdr::parameter\fR \fBcreate\fR \fIobj\fR \fIconfig\fR \fIorder\fR \fIcmdline\fR \fIrequired\fR \fIdefered\fR \fIname\fR \fIdescription\fR \fIspec\fR
Create a new instance of \fBcmdr::parameter\fR, named \fIobj\fR\&.
Used by the DSL processing parts of the framework to instantiate parameters\&.
.RS
.TP
string \fIobj\fR
The (command) name of the new parameter instance\&.
.TP
cmdr::config \fIconfig\fR
The instance command of the \fBcmdr::config\fR instance
holding the parameter\&.
.TP
boolean \fIorder\fR
Flag\&. Parameter is specified by order (\fBtrue\fR: argument),
or name (\fBfalse\fR: option)\&.
.TP
boolean \fIcmdline\fR
Flag\&. Parameter is visible on the command line (\fBtrue\fR:
option, or argument), or not (\fBfalse\fR: state)\&.
.TP
boolean \fIrequired\fR
Flag\&. Parameter is must be specified by the user at runtime
(\fBtrue\fR), or not (\fBfalse\fR)\&.
.TP
boolean \fIdefered\fR
Flag\&. The internal representation is computed on-demand
(\fBtrue\fR), or in the completion phase (\fBfalse\fR)\&.
.TP
string \fIname\fR
Internal name of the parameter\&. Also the name used in the
help, if not overridden by a \fBlabel\fR declaration
(in \fIspec\fR)\&.
.TP
string \fIdescription\fR
Human-readable help text for the parameter\&.
.TP
script \fIspec\fR
Tcl-script specifying the parameter in detail\&. Please read
\fICmdr - Specification Language\fR, section --TODO-- for the details\&.
.RE
.PP
.SH "INSTANCE API"
Most of the instance API is not public\&.
.PP
It is described here for use by developers maintaining,
modifying and extending the framework itself\&. A user of the framework
has no need for it\&.
--TODO-- mark the methods which are public -- and/or write a separate document?
.TP
\fB<parameter>\fR \fBaccept\fR \fIx\fR
This method validates the string value \fIx\fR
against the validation type of the parameter and returns a
boolean value indicating success (\fBtrue\fR), or not
(\fBfalse\fR)\&.
The internal representation of \fIx\fR is not kept but
released immediately\&. The parameter itself is not changed
either\&.
This is used during runtime by the 'test'-based processing
of optional arguments\&.
.RS
.TP
string \fIx\fR
.RE
.TP
\fB<parameter>\fR \fBcmdline\fR
This accessor method returns the "cmdline" flag
set during parameter construction\&.
A result of \fBtrue\fR indicates that the parameter is
visible on the command line (option, or argument), and
otherwise (\fBfalse\fR) hidden (state)\&.
.TP
\fB<parameter>\fR \fBcode\fR
This method returns a string encoding the flags
"required" and "list"\&. The mapping is as follows:
.RS
.TP
\fB+\fR
required, scalar
.TP
\fB?\fR
optional, scalar
.TP
\fB+*\fR
required, list
.TP
\fB?*\fR
optional, list\&.
.RE
.TP
\fB<parameter>\fR \fBcomplete-words\fR \fIparse\fR
This method is given the completion state \fIparse\fR of a partial
command line and returns a list of strings which are the valid
completions at this point, for the parameter\&.
.RS
.TP
dict \fIparse\fR
A dictionary holding the current completion state of a partial command
line\&.
.sp
--TODO-- Describe the state fields and their meaning\&.
.RE
.TP
\fB<parameter>\fR \fBconfig\fR \fIword\&.\&.\&.\fR
This method either returns the \fBcmdr::config\fR instance
containing the parameter, or the result of applying the words to that config
instance\&. It is through this method that any script with access to a single
parameter instance of a private will have access to all its parameters\&.
.RS
.TP
string \fIword\&.\&.\&.\fR
The method and its arguments to apply to the config instance holding
the parameter\&. If none are specified the method \fBself\fR is
implied, causing the return of the config instance itself\&.
.RE
.TP
\fB<parameter>\fR \fBdefault\fR
This method returns the default value set by
the parameter's specification, or the empty string\&.
.TP
\fB<parameter>\fR \fBdefered\fR
This accessor method returns the "defered" flag
set during parameter construction\&.
A result of \fBtrue\fR indicates that the parameter's
internal representation is computed on-demand, and otherwise
(\fBfalse\fR) during the completion phase\&.
.TP
\fB<parameter>\fR \fBdescription\fR ?\fIdetail\fR?
This method returns the parameter's help text\&.
If the \fIdetail\fR is specified and the name of an automatic
option controlled by this parameter its implicit description
is returned instead of the description of its primary\&.
.RS
.TP
string \fIdetail\fR
Optional\&. The name of a automatic option controlled by the
parameter\&.
.RE
.TP
\fB<parameter>\fR \fBdocumented\fR
This accessor method returns the "documented"
flag of the parameter\&.
A value of \fBtrue\fR indicates that the parameter
should be included in generated help, otherwise not\&.
.TP
\fB<parameter>\fR \fBdontinteract\fR
This method disables interactive entry
of the parameter's value for one time\&. I\&.e\&. after
the information was used (see method \fBvalue\fR)
the flag automatically resets\&.
The result of the method is the empty string\&.
.TP
\fB<parameter>\fR \fBflag\fR
This method returns the text of the primary
flag of the parameter, including leading dashes\&.
.TP
\fB<parameter>\fR \fBforget\fR
This method releases the internal representation
of the parameter's value, if it has any\&.
See also method \fBreset\fR for a stronger form\&.
.TP
\fB<parameter>\fR \fBgenerator\fR
This method returns the "generate" command prefix callback,
if it was set, and an empty list otherwise\&.
.TP
\fB<parameter>\fR \fBhasdefault\fR
This method returns a boolean flag
indicating if the parameter's specification declared
a default value for it (\fBtrue\fR), or not (\fBfalse\fR)\&.
.TP
\fB<parameter>\fR \fBhelp\fR
This method returns the help information for the parameter\&.
Note that this method does \fInot\fR check the "documented"
flag of the parameter\&. That is the responsibility of the
caller\&.
The result of the command is a structure of the form
described in section \fBHelp Information\fR\&.
.TP
\fB<parameter>\fR \fBinteractive\fR
This method returns the "interactive" flag of the parameter\&.
A result of \fBtrue\fR indicates that the parameter's
string representation has to be queried interactively if no
value was specified at runtime\&.
.TP
\fB<parameter>\fR \fBinteract\fR ?\fIprompt\fR?
This method interactively queries the string representation of
the parameter from the user\&.
If no \fIprompt\fR is specified the parameter's prompt from the
specification is used\&. See also method \fBprompt\fR\&.
The interaction takes the "list"-ness of the parameter into account\&.
Note that the entered string(s) is/are validated and invalid
information is rejected\&.
.RS
.TP
string \fIprompt\fR
Optional\&. The prompt to use for the interaction\&.
.RE
.TP
\fB<parameter>\fR \fBisbool\fR
This method returns a boolean value indicating if the parameter
uses the standard validation type "boolean" (\fBtrue\fR) or
not (\fBfalse\fR)\&.
The parts of the parameter responsible for processing option
arguments use this information to invoke the hard-wired special
cases for this type, or not\&.
.TP
\fB<parameter>\fR \fBis\fR \fItype\fR
This method returns a boolean value indicating if the
parameter is of the specified \fItype\fR (\fBtrue\fR)
or not (\fBfalse\fR)\&.
.RS
.TP
string \fItype\fR
The type to check the parameter against\&.
Recognized values are
.RS
.TP
\fBargument\fR
.TP
\fBoption\fR
.TP
\fBstate\fR
.RE
.RE
.TP
\fB<parameter>\fR \fBlabel\fR
This method returns the human-readable name of the parameter,
for use in help\&. If not specifically overridden by the
parameter's specification this is the same as the internal
name (See method \fBname\fR)\&.
.TP
\fB<parameter>\fR \fBlist\fR
This accessor method returns the "list" flag of the parameter\&.
A value of \fBtrue\fR indicates that the parameter's value
is a list, otherwise a scalar\&.
.TP
\fB<parameter>\fR \fBlocker\fR
This accessor method returns the string set by method
\fBlock\fR below, or the empty string if
\fBlock\fR was not used\&.
\fINote\fR: This information is reset by method
\fBreset\fR, but not by \fBforget\fR\&.
.TP
\fB<parameter>\fR \fBlock\fR \fIreason\fR
This method locks the parameter against modification
by the methods \fBset\fR and \fBsetq\fR, and
remembers the \fIreason\fR for it\&. The reason is
expected to be the name of another parameter whose
use disallows the use of this one\&.
\fINote\fR: Such a lock is reset by method
\fBreset\fR, but not by \fBforget\fR\&.
.RS
.TP
string \fIreason\fR
The name of the parameter locking this one against further
modification\&.
.RE
.TP
\fB<parameter>\fR \fBname\fR
This method returns the internal name of the parameter\&.
.TP
\fB<parameter>\fR \fBoptions\fR
This method returns the list of option flags recognized
by the parameter\&.
.TP
\fB<parameter>\fR \fBordered\fR
This accessor method returns the "order" flag
set during parameter construction\&.
A result of \fBtrue\fR indicates that the parameter
is specified by order at runtime (argument), and otherwise
(\fBfalse\fR) by name (option)\&.
.TP
\fB<parameter>\fR \fBpresence\fR
This method returns a boolean value indicating if
the option parameter is set as presence-option
(\fBtrue\fR) or not (\fBfalse\fR)\&.
The parts of the parameter responsible for processing option
arguments use this information to invoke the hard-wired special
cases for presence, or not\&.
.TP
\fB<parameter>\fR \fBprimary\fR \fIoption\fR
This method returns a boolean value indicating if the named \fIoption\fR
is the primary option of this parameter (\fBtrue\fR), or not (\fBfalse\fR)\&.
An error will be thrown if the named option is not controlled by the parameter\&.
.RS
.TP
string \fIoption\fR
The name of the option to check\&.
.RE
.TP
\fB<parameter>\fR \fBprocess\fR \fIdetail\fR \fIqueue\fR
This method extracts the value of the parameter from the command line\&.
A \fBpresence\fR option takes nothing, whereas an \fBisbool\fR option
takes the first value in the \fIqueue\fR, if it is a proper boolean, and
defaults to \fBtrue\fR if not\&. Any other argument or option takes  the
first value in \fIqueue\fR\&.
.RS
.TP
string \fIdetail\fR
The name of the parameter, or the option flag referencing it\&.
.TP
struct::queue \fIqueue\fR
The queue instance holding the words of the command line not yet
processed by the system\&.
.RE
.TP
\fB<parameter>\fR \fBprompt\fR
This method returns the prompt string used by the parameter for
interactive entry\&. If not overridden by the parameter's specification
this defaults to a string derived from the internal name of the
parameter, i\&.e\&. "Enter \fBname\fR:"\&.
.TP
\fB<parameter>\fR \fBrequired\fR
This accessor method returns the "required" flag
set during parameter construction\&.
A result of \fBtrue\fR indicates that the parameter
must be specified by the user at runtime, and otherwise
may be left unspecified (\fBfalse\fR)\&.
.TP
\fB<parameter>\fR \fBreset\fR ?\fIcleanup\fR?
This method sets the parameter into the initial state where
it has neither string nor internal representation, nor is
it locked\&. This is a stronger form of \fBforget\fR\&.
.RS
.TP
boolean \fIcleanup\fR
.RE
.TP
\fB<parameter>\fR \fBself\fR
This method returns the parameter instance itself\&.
.TP
\fB<parameter>\fR \fBset?\fR
This accessor method returns a boolean value indicating
if the parameter was given a string representation at
runtime (\fBtrue\fR), or not (\fBfalse\fR)\&.
.TP
\fB<parameter>\fR \fBsetq\fR \fIqueue\fR
This method sets the first element of the \fIqueue\fR
as the value of the parameter\&.
For a "list" parameter all elements of the queue are
taken as the new value of the parameter\&.
This is not quite analogous to method \fBset\fR below\&.
They behave the same for scalar parameters, and differ
for "list" parameters\&.
.RS
.TP
stack::queue \fIqueue\fR
The queue instance holding the words of the command
line not yet processed\&.
.RE
.TP
\fB<parameter>\fR \fBset\fR \fIvalue\fR
This method sets the \fIvalue\fR as the new string
representation of the parameter\&.
For a "list" parameter the string representation is
\fIextended\fR with the \fIvalue\fR\&.
This action triggers the execution of the "when-set" callback\&.
A previously existing internal representation is
forgotten (See \fBforget\fR)\&.
.RS
.TP
string \fIvalue\fR
The new value of the parameter, or an extension of the
existing value\&.
.RE
.TP
\fB<parameter>\fR \fBstring\fR
This accessor method returns the string representation of
the parameter\&. If such was not set an error will be thrown
(See method \fBundefined!\fR)\&.
.TP
\fB<parameter>\fR \fBthreshold:\fR \fIn\fR
This method specifies the minimum number of words needed after
the optional argument parameter for it to accept the current
word for itself\&.
Parameters which are not optional arguments ignore this method\&.
The result of the method is the empty string\&.
.RS
.TP
integer \fIn\fR
The acceptance threshold for the parameter\&.
.RE
.TP
\fB<parameter>\fR \fBthreshold\fR
This method returns the threshold set on the parameter\&.
An empty string indicates a parameter without threshold\&.
A value of -1 indicates that the optional argument accepts
based on validation (See method \fBaccept\fR) instead
of using a threshold\&.
.TP
\fB<parameter>\fR \fBtype\fR
This accessor method returns the type of the parameter, one of
\fBargument\fR, \fBoption\fR, or \fBstate\fR\&. See also
method \fBis\fR for type-checking\&.
.TP
\fB<parameter>\fR \fBundefined!\fR
This method explicitly throws a "parameter undefined" error
for this parameter\&.
.TP
\fB<parameter>\fR \fBvalidator\fR
This method returns the "validate" command prefix callback
(i\&.e\&. the parameter's validation type)\&.
.TP
\fB<parameter>\fR \fBvalue\fR
This accessor method returns the internal representation of
the parameter\&. If necessary the data is computed from the
parameter's string representation, "default" value, or
"generate" callback\&.
An error is thrown if the value could not be determined\&.
(See method \fBundefined!\fR)\&.
If the value is newly computed the action triggers the
execution of the "when-complete" callback\&.
.sp
--TODO-- describe generation rules and order\&.
.TP
\fB<parameter>\fR \fBwhen-complete\fR
This method returns the "when-complete" command prefix callback,
if it was set, and an empty list otherwise\&.
.TP
\fB<parameter>\fR \fBwhen-set\fR
This method returns the "when-set" command prefix callback,
if it was set, and an empty list otherwise\&.
.PP
.SH "HELP INFORMATION"
The help information generated for parameters is a
dictionary containing the keys below:
.TP
cmdline
Output of method \fBcmdline\fR\&.
.TP
code
Output of method \fBcode\fR\&.
.TP
default
Output of method \fBdefault\fR\&.
.TP
defered
Output of method \fBdefered\fR\&.
.TP
description
Output of method \fBdescription\fR\&.
.TP
documented
Output of method \fBdocumented\fR\&.
.TP
flags
A dictionary mapping flag names to flag
types, i\&.e\&. \fBprimary\fR, \fBalias\fR,
or \fBinverted\fR\&.
.TP
generator
Output of method \fBgenerator\fR\&.
.TP
interactive
Output of method \fBinteractive\fR\&.
.TP
isbool
Output of method \fBisbool\fR\&.
.TP
label
Output of method \fBlabel\fR\&.
.TP
list
Output of method \fBlist\fR\&.
.TP
ordered
Output of method \fBordered\fR\&.
.TP
presence
Output of method \fBpresence\fR\&.
.TP
prompt
Output of method \fBprompt\fR\&.
.TP
required
Output of method \fBrequired\fR\&.
.TP
threshold
Output of method \fBthreshold\fR\&.
.TP
type
Output of method \fBtype\fR\&.
.TP
validator
Output of method \fBvalidator\fR\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at
\fICmdr Tickets\fR [https:/core\&.tcl\&.tk/akupries/cmdr]\&.
.PP
Please also report any ideas you may have for enhancements of
either package(s) and/or documentation\&.
.SH KEYWORDS
arguments, command hierarchy, command line completion, command line handling, command tree, editing command line, help for command line, hierarchy of commands, interactive command shell, optional arguments, options, parameters, processing command line, tree of commands
.SH COPYRIGHT
.nf
Copyright (c) 2013 Andreas Kupries
Copyright (c) 2013 Documentation, Andreas Kupries

.fi

Changes to embedded/man/files/cmdr_private.n.

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
...
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
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::private\fR \fBnew\fR \fIsuper\fR \fIname\fR \fIarguments\fR \fIaction\fR
.sp
\fB::cmdr::private\fR \fBcreate\fR \fIobj\fR \fIsuper\fR \fIname\fR \fIarguments\fR \fIaction\fR
.sp
\fBprivate\fR \fBcomplete-words\fR \fIparse\fR
.sp
\fBprivate\fR \fBdo\fR ?\fIword\fR\&.\&.\&.?
.sp
\fBprivate\fR \fBehandler\fR \fIcmd\fR
.sp
\fBprivate\fR \fBhelp\fR ?\fIprefix\fR?
.sp
\fBprivate\fR \fBunknown\fR \fIm\fR ?\fIword\fR\&.\&.\&.?
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.
.PP
For availability please read \fICmdr - How To Get The Sources\fR\&.
................................................................................
private instances\&.
.PP
It is described here for use by developers maintaining,
modifying and extending the framework itself\&. A user of the framework
has no need for it, although they have indirect access through
parameters and their container\&.
.TP
\fBprivate\fR \fBcomplete-words\fR \fIparse\fR
This command is given the completion state \fIparse\fR of a partial
command line and returns a list of strings which are the vaid
completions at this point\&.
.RS
.TP
dict \fIparse\fR
A dictionary holding the current completion state of a partial command
line\&.
.sp
-- TODO -- Describe the state fields and their meaning\&.
.RE
.TP
\fBprivate\fR \fBdo\fR ?\fIword\fR\&.\&.\&.?
This method parses the \fIword\fRs of the command line, matching them
to the parameters of the private, be they arguments, or options\&. When
done without error it invokes the action of the private with the
filled container of parameters\&.
.RS
.TP
string \fIword\fR
The words of the command line to parse and match to parameters\&.
.RE
.TP
\fBprivate\fR \fBehandler\fR \fIcmd\fR
This method specifies a command prefix to wrap around the parsing of
the command line for the private, and the execution of its action\&.
.RS
.TP
cmd-prefix \fIcmd\fR
A command prefix taking a single argument, a script\&. The command
prefix has to execute this script in its caller's context\&. The script
................................................................................
will parse words for the private,m and perform its action\&. The command
prefix then has the responsbility to perform any custom cleanup action
required by the application using the framework to prevent leakage of
data between multiple commands executed one after the other (i\&.e\&. in
an interactive shell run by the framework)\&.
.RE
.TP
\fBprivate\fR \fBhelp\fR ?\fIprefix\fR?
This method returns the help information for the private and its
parameters\&. The \fIprefix\fR, if specified provides the name of the
private within the help data\&. It defaults to the empty string\&.
.sp
-- TODO -- describe help structure --> custom help formats
.RS
.TP
string \fIprefix\fR
The name to use for the private within the generated help\&.
.RE
.TP
\fBprivate\fR \fBunknown\fR \fIm\fR ?\fIword\fR\&.\&.\&.?
This method overrides the standard behaviour for unknown methods\&.
Instead of throwing an error they are routed to the hidden container
of the private's parameters, of class \fBcmdr::config\fR\&.
.RS
.TP
string \fIm\fR
The name of the unknown method\&.
.TP
string \fIword\fR
The argument (one or more) of the unknown method\&.
.RE
.PP




























































































.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at
\fICmdr Tickets\fR [https:/core\&.tcl\&.tk/akupries/cmdr]\&.
.PP
Please also report any ideas you may have for enhancements of






|

|

|

|

|







 







|
|
|










|










|







 







|



|
|






|












>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>







246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
...
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
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::private\fR \fBnew\fR \fIsuper\fR \fIname\fR \fIarguments\fR \fIaction\fR
.sp
\fB::cmdr::private\fR \fBcreate\fR \fIobj\fR \fIsuper\fR \fIname\fR \fIarguments\fR \fIaction\fR
.sp
\fB<private>\fR \fBcomplete-words\fR \fIparse\fR
.sp
\fB<private>\fR \fBdo\fR ?\fIword\fR\&.\&.\&.?
.sp
\fB<private>\fR \fBehandler\fR \fIcmd\fR
.sp
\fB<private>\fR \fBhelp\fR ?\fIprefix\fR?
.sp
\fB<private>\fR \fBunknown\fR \fIm\fR ?\fIword\fR\&.\&.\&.?
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.
.PP
For availability please read \fICmdr - How To Get The Sources\fR\&.
................................................................................
private instances\&.
.PP
It is described here for use by developers maintaining,
modifying and extending the framework itself\&. A user of the framework
has no need for it, although they have indirect access through
parameters and their container\&.
.TP
\fB<private>\fR \fBcomplete-words\fR \fIparse\fR
This method is given the completion state \fIparse\fR of a partial
command line and returns a list of strings which are the valid
completions at this point\&.
.RS
.TP
dict \fIparse\fR
A dictionary holding the current completion state of a partial command
line\&.
.sp
-- TODO -- Describe the state fields and their meaning\&.
.RE
.TP
\fB<private>\fR \fBdo\fR ?\fIword\fR\&.\&.\&.?
This method parses the \fIword\fRs of the command line, matching them
to the parameters of the private, be they arguments, or options\&. When
done without error it invokes the action of the private with the
filled container of parameters\&.
.RS
.TP
string \fIword\fR
The words of the command line to parse and match to parameters\&.
.RE
.TP
\fB<private>\fR \fBehandler\fR \fIcmd\fR
This method specifies a command prefix to wrap around the parsing of
the command line for the private, and the execution of its action\&.
.RS
.TP
cmd-prefix \fIcmd\fR
A command prefix taking a single argument, a script\&. The command
prefix has to execute this script in its caller's context\&. The script
................................................................................
will parse words for the private,m and perform its action\&. The command
prefix then has the responsbility to perform any custom cleanup action
required by the application using the framework to prevent leakage of
data between multiple commands executed one after the other (i\&.e\&. in
an interactive shell run by the framework)\&.
.RE
.TP
\fB<private>\fR \fBhelp\fR ?\fIprefix\fR?
This method returns the help information for the private and its
parameters\&. The \fIprefix\fR, if specified provides the name of the
private within the help data\&. It defaults to the empty string\&.
The result of the command is a structure of the form
described in section \fBHelp Information\fR\&.
.RS
.TP
string \fIprefix\fR
The name to use for the private within the generated help\&.
.RE
.TP
\fB<private>\fR \fBunknown\fR \fIm\fR ?\fIword\fR\&.\&.\&.?
This method overrides the standard behaviour for unknown methods\&.
Instead of throwing an error they are routed to the hidden container
of the private's parameters, of class \fBcmdr::config\fR\&.
.RS
.TP
string \fIm\fR
The name of the unknown method\&.
.TP
string \fIword\fR
The argument (one or more) of the unknown method\&.
.RE
.PP
.SH "HELP INFORMATION"
The help information generated by various places of the framework
is a dictionary containing the following keys:
.TP
arguments
A list of strings, the names of the command arguments, in order\&.
These names are keys into the \fBparameters\fR sub-dictionary\&.
.TP
desc
The command's description, i\&.e\&. help text\&.
.TP
opt2para
A dictionary mapping option flags to option names\&.
These names are keys into the \fBparameters\fR sub-dictionary\&.
.TP
options
A dictionary mapping option names to their descriptions\&.
.TP
parameters
A dictionary mapping parameter names to their definition\&.
Each definition is a dictionary containing the keys below\&.
See also package \fBcmdr::parameter\fR\&.
.RS
.TP
cmdline
Output of method \fBcmdline\fR\&.
.TP
code
Output of method \fBcode\fR\&.
.TP
default
Output of method \fBdefault\fR\&.
.TP
defered
Output of method \fBdefered\fR\&.
.TP
description
Output of method \fBdescription\fR\&.
.TP
documented
Output of method \fBdocumented\fR\&.
.TP
flags
A dictionary mapping flag names to flag
types, i\&.e\&. \fBprimary\fR, \fBalias\fR,
or \fBinverted\fR\&.
.TP
generator
Output of method \fBgenerator\fR\&.
.TP
interactive
Output of method \fBinteractive\fR\&.
.TP
isbool
Output of method \fBisbool\fR\&.
.TP
label
Output of method \fBlabel\fR\&.
.TP
list
Output of method \fBlist\fR\&.
.TP
ordered
Output of method \fBordered\fR\&.
.TP
presence
Output of method \fBpresence\fR\&.
.TP
prompt
Output of method \fBprompt\fR\&.
.TP
required
Output of method \fBrequired\fR\&.
.TP
threshold
Output of method \fBthreshold\fR\&.
.TP
type
Output of method \fBtype\fR\&.
.TP
validator
Output of method \fBvalidator\fR\&.
.RE
.TP
sections
A list of sections the command belongs to\&.
Each section name is a list itself, the path of the section and sub-sections\&.
.TP
states
A list of strings, the names of the command's hidden state parameters\&.
These names are keys into the \fBparameters\fR sub-dictionary\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at
\fICmdr Tickets\fR [https:/core\&.tcl\&.tk/akupries/cmdr]\&.
.PP
Please also report any ideas you may have for enhancements of

Changes to embedded/man/index.n.

269
270
271
272
273
274
275



276
277
278
279
280
281
282
...
314
315
316
317
318
319
320



321
322
323
324
325
326
327
...
359
360
361
362
363
364
365



366
367
368
369
370
371
372
...
404
405
406
407
408
409
410



411
412
413
414
415
416
417
...
449
450
451
452
453
454
455



456
457
458
459
460
461
462
...
494
495
496
497
498
499
500



501
502
503
504
505
506
507
...
539
540
541
542
543
544
545



546
547
548
549
550
551
552
...
584
585
586
587
588
589
590



591
592
593
594
595
596
597
...
629
630
631
632
633
634
635



636
637
638
639
640
641
642
...
674
675
676
677
678
679
680



681
682
683
684
685
686
687
...
719
720
721
722
723
724
725



726
727
728
729
730
731
732
...
764
765
766
767
768
769
770



771
772
773
774
775
776
777
...
809
810
811
812
813
814
815



816
817
818
819
820
821
822
...
854
855
856
857
858
859
860



861
862
863
864
865
866
867
868
869
870
871
872
873
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private



.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
\fBfiles/cmdr_vcommon\&.n\fR
cmdr_validate_common
.TP
\fBfiles/cmdr_vtypes\&.n\fR
cmdr_vtypes
.RE






>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>







 







>
>
>













269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
...
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
...
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
...
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
...
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
...
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
...
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
...
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
...
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
...
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
...
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
...
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
...
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
...
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
................................................................................
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_private\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_private
.TP
\fBfiles/cmdr_util\&.n\fR
cmdr_util
.TP
\fBfiles/cmdr_validate\&.n\fR
cmdr_validate
.TP
\fBfiles/cmdr_vcommon\&.n\fR
cmdr_validate_common
.TP
\fBfiles/cmdr_vtypes\&.n\fR
cmdr_vtypes
.RE

Changes to embedded/man/toc.n.

268
269
270
271
272
273
274



275
276
277
278
279
280
281
282
283
284
285
.TP
\fBcmdr_license\fR
\fIfiles/cmdr_license\&.n\fR: Cmdr - License
.TP
\fBcmdr_private\fR
\fIfiles/cmdr_private\&.n\fR: Cmdr - Single command handling, options, and arguments
.TP



\fBcmdr_util\fR
\fIfiles/cmdr_util\&.n\fR: Cmdr - General Utilities - Internal
.TP
\fBcmdr_validate\fR
\fIfiles/cmdr_validate\&.n\fR: Cmdr - Standard validation types for parameters
.TP
\fBcmdr_validate_common\fR
\fIfiles/cmdr_vcommon\&.n\fR: Utilities for Validation Types
.TP
\fBcmdr_vtypes\fR
\fIfiles/cmdr_vtypes\&.n\fR: Cmdr - Writing custom validation types






>
>
>











268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
.TP
\fBcmdr_license\fR
\fIfiles/cmdr_license\&.n\fR: Cmdr - License
.TP
\fBcmdr_private\fR
\fIfiles/cmdr_private\&.n\fR: Cmdr - Single command handling, options, and arguments
.TP
\fBcmdr_private\fR
\fIfiles/cmdr_parameter\&.n\fR: Cmdr - Single command handling, options, and arguments
.TP
\fBcmdr_util\fR
\fIfiles/cmdr_util\&.n\fR: Cmdr - General Utilities - Internal
.TP
\fBcmdr_validate\fR
\fIfiles/cmdr_validate\&.n\fR: Cmdr - Standard validation types for parameters
.TP
\fBcmdr_validate_common\fR
\fIfiles/cmdr_vcommon\&.n\fR: Utilities for Validation Types
.TP
\fBcmdr_vtypes\fR
\fIfiles/cmdr_vtypes\&.n\fR: Cmdr - Writing custom validation types

Added embedded/www/doc/files/cmdr_parameter.html.








































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
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
<html><head>
<title>cmdr_private - &lt;&lt;unknown&gt;&gt;</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
	color:	 	black;
    }
    DIV.doctools {
	margin-left:	10%;
	margin-right:	10%;
    }
    DIV.doctools H1,DIV.doctools H2 {
	margin-left:	-5%;
    }
    H1, H2, H3, H4 {
	margin-top: 	1em;
	font-family:	sans-serif;
	font-size:	large;
	color:		#005A9C;
	background: 	transparent;
	text-align:		left;
    }
    H1.title {
	text-align: center;
    }
    UL,OL {
	margin-right: 0em;
	margin-top: 3pt;
	margin-bottom: 3pt;
    }
    UL LI {
	list-style: disc;
    }
    OL LI {
	list-style: decimal;
    }
    DT {
	padding-top: 	1ex;
    }
    UL.toc,UL.toc UL, UL.toc UL UL {
	font:		normal 12pt/14pt sans-serif;
	list-style:	none;
    }
    LI.section, LI.subsection {
	list-style: 	none;
	margin-left: 	0em;
	text-indent:	0em;
	padding: 	0em;
    }
    PRE {
	display: 	block;
	font-family:	monospace;
	white-space:	pre;
	margin:		0%;
	padding-top:	0.5ex;
	padding-bottom:	0.5ex;
	padding-left:	1ex;
	padding-right:	1ex;
	width:		100%;
    }
    PRE.example {
	color: 		black;
	background: 	#f5dcb3;
	border:		1px solid black;
    }
    UL.requirements LI, UL.syntax LI {
	list-style: 	none;
	margin-left: 	0em;
	text-indent:	0em;
	padding:	0em;
    }
    DIV.synopsis {
	color: 		black;
	background: 	#80ffff;
	border:		1px solid black;
	font-family:	serif;
	margin-top: 	1em;
	margin-bottom: 	1em;
    }
    UL.syntax {
	margin-top: 	1em;
	border-top:	1px solid black;
    }
    UL.requirements {
	margin-bottom: 	1em;
	border-bottom:	1px solid black;
    }
--></style>
</head>
<! -- Generated from file 'cmdr_parameter.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_private.n
   -->
<body><div class="doctools">
<hr> [
   <a href="../../../../../../home">Home</a>
| <a href="../../toc.html">Main Table Of Contents</a>
| <a href="../toc.html">Table Of Contents</a>
| <a href="../../index.html">Keyword Index</a>
 ] <hr>
<h1 class="title">cmdr_private(n) 0 doc &quot;&lt;&lt;unknown&gt;&gt;&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>cmdr_private - Cmdr - Single command handling, options, and arguments</p>
</div>
<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="toc">
<li class="section"><a href="#toc">Table Of Contents</a></li>
<li class="section"><a href="#synopsis">Synopsis</a></li>
<li class="section"><a href="#section1">Description</a></li>
<li class="section"><a href="#section2">Class API</a></li>
<li class="section"><a href="#section3">Instance API</a></li>
<li class="section"><a href="#section4">Help Information</a></li>
<li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li>
<li class="section"><a href="#keywords">Keywords</a></li>
<li class="section"><a href="#copyright">Copyright</a></li>
</ul>
</div>
<div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="synopsis">
<ul class="requirements">
<li>package require <b class="pkgname">cmdr::util</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::cmdr::parameter</b> <b class="method">new</b> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr::parameter</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></li>
<li><a href="#3"><b class="cmd">&lt;parameter&gt;</b> <b class="method">accept</b> <i class="arg">x</i></a></li>
<li><a href="#4"><b class="cmd">&lt;parameter&gt;</b> <b class="method">cmdline</b></a></li>
<li><a href="#5"><b class="cmd">&lt;parameter&gt;</b> <b class="method">code</b></a></li>
<li><a href="#6"><b class="cmd">&lt;parameter&gt;</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></li>
<li><a href="#7"><b class="cmd">&lt;parameter&gt;</b> <b class="method">config</b> <i class="arg">word...</i></a></li>
<li><a href="#8"><b class="cmd">&lt;parameter&gt;</b> <b class="method">default</b></a></li>
<li><a href="#9"><b class="cmd">&lt;parameter&gt;</b> <b class="method">defered</b></a></li>
<li><a href="#10"><b class="cmd">&lt;parameter&gt;</b> <b class="method">description</b> <span class="opt">?<i class="arg">detail</i>?</span></a></li>
<li><a href="#11"><b class="cmd">&lt;parameter&gt;</b> <b class="method">documented</b></a></li>
<li><a href="#12"><b class="cmd">&lt;parameter&gt;</b> <b class="method">dontinteract</b></a></li>
<li><a href="#13"><b class="cmd">&lt;parameter&gt;</b> <b class="method">flag</b></a></li>
<li><a href="#14"><b class="cmd">&lt;parameter&gt;</b> <b class="method">forget</b></a></li>
<li><a href="#15"><b class="cmd">&lt;parameter&gt;</b> <b class="method">generator</b></a></li>
<li><a href="#16"><b class="cmd">&lt;parameter&gt;</b> <b class="method">hasdefault</b></a></li>
<li><a href="#17"><b class="cmd">&lt;parameter&gt;</b> <b class="method">help</b></a></li>
<li><a href="#18"><b class="cmd">&lt;parameter&gt;</b> <b class="method">interactive</b></a></li>
<li><a href="#19"><b class="cmd">&lt;parameter&gt;</b> <b class="method">interact</b> <span class="opt">?<i class="arg">prompt</i>?</span></a></li>
<li><a href="#20"><b class="cmd">&lt;parameter&gt;</b> <b class="method">isbool</b></a></li>
<li><a href="#21"><b class="cmd">&lt;parameter&gt;</b> <b class="method">is</b> <i class="arg">type</i></a></li>
<li><a href="#22"><b class="cmd">&lt;parameter&gt;</b> <b class="method">label</b></a></li>
<li><a href="#23"><b class="cmd">&lt;parameter&gt;</b> <b class="method">list</b></a></li>
<li><a href="#24"><b class="cmd">&lt;parameter&gt;</b> <b class="method">locker</b></a></li>
<li><a href="#25"><b class="cmd">&lt;parameter&gt;</b> <b class="method">lock</b> <i class="arg">reason</i></a></li>
<li><a href="#26"><b class="cmd">&lt;parameter&gt;</b> <b class="method">name</b></a></li>
<li><a href="#27"><b class="cmd">&lt;parameter&gt;</b> <b class="method">options</b></a></li>
<li><a href="#28"><b class="cmd">&lt;parameter&gt;</b> <b class="method">ordered</b></a></li>
<li><a href="#29"><b class="cmd">&lt;parameter&gt;</b> <b class="method">presence</b></a></li>
<li><a href="#30"><b class="cmd">&lt;parameter&gt;</b> <b class="method">primary</b> <i class="arg">option</i></a></li>
<li><a href="#31"><b class="cmd">&lt;parameter&gt;</b> <b class="method">process</b> <i class="arg">detail</i> <i class="arg">queue</i></a></li>
<li><a href="#32"><b class="cmd">&lt;parameter&gt;</b> <b class="method">prompt</b></a></li>
<li><a href="#33"><b class="cmd">&lt;parameter&gt;</b> <b class="method">required</b></a></li>
<li><a href="#34"><b class="cmd">&lt;parameter&gt;</b> <b class="method">reset</b> <span class="opt">?<i class="arg">cleanup</i>?</span></a></li>
<li><a href="#35"><b class="cmd">&lt;parameter&gt;</b> <b class="method">self</b></a></li>
<li><a href="#36"><b class="cmd">&lt;parameter&gt;</b> <b class="method">set?</b></a></li>
<li><a href="#37"><b class="cmd">&lt;parameter&gt;</b> <b class="method">setq</b> <i class="arg">queue</i></a></li>
<li><a href="#38"><b class="cmd">&lt;parameter&gt;</b> <b class="method">set</b> <i class="arg">value</i></a></li>
<li><a href="#39"><b class="cmd">&lt;parameter&gt;</b> <b class="method">string</b></a></li>
<li><a href="#40"><b class="cmd">&lt;parameter&gt;</b> <b class="method">threshold:</b> <i class="arg">n</i></a></li>
<li><a href="#41"><b class="cmd">&lt;parameter&gt;</b> <b class="method">threshold</b></a></li>
<li><a href="#42"><b class="cmd">&lt;parameter&gt;</b> <b class="method">type</b></a></li>
<li><a href="#43"><b class="cmd">&lt;parameter&gt;</b> <b class="method">undefined!</b></a></li>
<li><a href="#44"><b class="cmd">&lt;parameter&gt;</b> <b class="method">validator</b></a></li>
<li><a href="#45"><b class="cmd">&lt;parameter&gt;</b> <b class="method">value</b></a></li>
<li><a href="#46"><b class="cmd">&lt;parameter&gt;</b> <b class="method">when-complete</b></a></li>
<li><a href="#47"><b class="cmd">&lt;parameter&gt;</b> <b class="method">when-set</b></a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This package implements <em>parameters</em>, collections of which (see
<b class="package">cmdr::config</b>) serve as the configuration of privates (see
<b class="package">cmdr::private</b>).</p>
</div>
<div id="section2" class="section"><h2><a name="section2">Class API</a></h2>
<p>The class API is not public. It is used internally by the framework
when parsing a command hierarchy specification to create the necessary
parameter instances.</p>
<p>It is described here for use by developers maintaining,
modifying and extending the framework itself. A user of the framework
has no need for it.</p>
<dl class="definitions">
<dt><a name="1"><b class="cmd">::cmdr::parameter</b> <b class="method">new</b> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></dt>
<dd><p>Create an auto-named instance of <b class="class">cmdr::parameter</b>.</p>
<p><em>Not used</em>.</p></dd>
<dt><a name="2"><b class="cmd">::cmdr::parameter</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></dt>
<dd><p>Create a new instance of <b class="class">cmdr::parameter</b>, named <i class="arg">obj</i>.
Used by the DSL processing parts of the framework to instantiate parameters.</p>
<dl class="arguments">
<dt>string <i class="arg">obj</i></dt>
<dd><p>The (command) name of the new parameter instance.</p></dd>
<dt>cmdr::config <i class="arg">config</i></dt>
<dd><p>The instance command of the <b class="package">cmdr::config</b> instance
holding the parameter.</p></dd>
<dt>boolean <i class="arg">order</i></dt>
<dd><p>Flag. Parameter is specified by order (<b class="const">true</b>: argument),
or name (<b class="const">false</b>: option).</p></dd>
<dt>boolean <i class="arg">cmdline</i></dt>
<dd><p>Flag. Parameter is visible on the command line (<b class="const">true</b>:
option, or argument), or not (<b class="const">false</b>: state).</p></dd>
<dt>boolean <i class="arg">required</i></dt>
<dd><p>Flag. Parameter is must be specified by the user at runtime
(<b class="const">true</b>), or not (<b class="const">false</b>).</p></dd>
<dt>boolean <i class="arg">defered</i></dt>
<dd><p>Flag. The internal representation is computed on-demand
(<b class="const">true</b>), or in the completion phase (<b class="const">false</b>).</p></dd>
<dt>string <i class="arg">name</i></dt>
<dd><p>Internal name of the parameter. Also the name used in the
help, if not overridden by a <b class="cmd">label</b> declaration
(in <i class="arg">spec</i>).</p></dd>
<dt>string <i class="arg">description</i></dt>
<dd><p>Human-readable help text for the parameter.</p></dd>
<dt>script <i class="arg">spec</i></dt>
<dd><p>Tcl-script specifying the parameter in detail. Please read
<i class="term">Cmdr - Specification Language</i>, section --TODO-- for the details.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section3" class="section"><h2><a name="section3">Instance API</a></h2>
<p>Most of the instance API is not public.</p>
<p>It is described here for use by developers maintaining,
modifying and extending the framework itself. A user of the framework
has no need for it.
--TODO-- mark the methods which are public -- and/or write a separate document?</p>
<dl class="definitions">
<dt><a name="3"><b class="cmd">&lt;parameter&gt;</b> <b class="method">accept</b> <i class="arg">x</i></a></dt>
<dd><p>This method validates the string value <i class="arg">x</i>
against the validation type of the parameter and returns a
boolean value indicating success (<b class="const">true</b>), or not
(<b class="const">false</b>).
The internal representation of <i class="arg">x</i> is not kept but
released immediately. The parameter itself is not changed
either.
This is used during runtime by the 'test'-based processing
of optional arguments.</p>
<dl class="arguments">
<dt>string <i class="arg">x</i></dt>
<dd></dd>
</dl></dd>
<dt><a name="4"><b class="cmd">&lt;parameter&gt;</b> <b class="method">cmdline</b></a></dt>
<dd><p>This accessor method returns the &quot;cmdline&quot; flag
set during parameter construction.
A result of <b class="const">true</b> indicates that the parameter is
visible on the command line (option, or argument), and
otherwise (<b class="const">false</b>) hidden (state).</p></dd>
<dt><a name="5"><b class="cmd">&lt;parameter&gt;</b> <b class="method">code</b></a></dt>
<dd><p>This method returns a string encoding the flags
&quot;required&quot; and &quot;list&quot;. The mapping is as follows:</p>
<dl class="definitions">
<dt><b class="const">+</b></dt>
<dd><p>required, scalar</p></dd>
<dt><b class="const">?</b></dt>
<dd><p>optional, scalar</p></dd>
<dt><b class="const">+*</b></dt>
<dd><p>required, list</p></dd>
<dt><b class="const">?*</b></dt>
<dd><p>optional, list.</p></dd>
</dl></dd>
<dt><a name="6"><b class="cmd">&lt;parameter&gt;</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></dt>
<dd><p>This method is given the completion state <i class="arg">parse</i> of a partial
command line and returns a list of strings which are the valid
completions at this point, for the parameter.</p>
<dl class="arguments">
<dt>dict <i class="arg">parse</i></dt>
<dd><p>A dictionary holding the current completion state of a partial command
line.</p>
<p>--TODO-- Describe the state fields and their meaning.</p></dd>
</dl></dd>
<dt><a name="7"><b class="cmd">&lt;parameter&gt;</b> <b class="method">config</b> <i class="arg">word...</i></a></dt>
<dd><p>This method either returns the <b class="package">cmdr::config</b> instance
containing the parameter, or the result of applying the words to that config
instance. It is through this method that any script with access to a single
parameter instance of a private will have access to all its parameters.</p>
<dl class="arguments">
<dt>string <i class="arg">word...</i></dt>
<dd><p>The method and its arguments to apply to the config instance holding
the parameter. If none are specified the method <b class="method">self</b> is
implied, causing the return of the config instance itself.</p></dd>
</dl></dd>
<dt><a name="8"><b class="cmd">&lt;parameter&gt;</b> <b class="method">default</b></a></dt>
<dd><p>This method returns the default value set by
the parameter's specification, or the empty string.</p></dd>
<dt><a name="9"><b class="cmd">&lt;parameter&gt;</b> <b class="method">defered</b></a></dt>
<dd><p>This accessor method returns the &quot;defered&quot; flag
set during parameter construction.
A result of <b class="const">true</b> indicates that the parameter's
internal representation is computed on-demand, and otherwise
(<b class="const">false</b>) during the completion phase.</p></dd>
<dt><a name="10"><b class="cmd">&lt;parameter&gt;</b> <b class="method">description</b> <span class="opt">?<i class="arg">detail</i>?</span></a></dt>
<dd><p>This method returns the parameter's help text.
If the <i class="arg">detail</i> is specified and the name of an automatic
option controlled by this parameter its implicit description
is returned instead of the description of its primary.</p>
<dl class="arguments">
<dt>string <i class="arg">detail</i></dt>
<dd><p>Optional. The name of a automatic option controlled by the
parameter.</p></dd>
</dl></dd>
<dt><a name="11"><b class="cmd">&lt;parameter&gt;</b> <b class="method">documented</b></a></dt>
<dd><p>This accessor method returns the &quot;documented&quot;
flag of the parameter.
A value of <b class="const">true</b> indicates that the parameter
should be included in generated help, otherwise not.</p></dd>
<dt><a name="12"><b class="cmd">&lt;parameter&gt;</b> <b class="method">dontinteract</b></a></dt>
<dd><p>This method disables interactive entry
of the parameter's value for one time. I.e. after
the information was used (see method <b class="method">value</b>)
the flag automatically resets.
The result of the method is the empty string.</p></dd>
<dt><a name="13"><b class="cmd">&lt;parameter&gt;</b> <b class="method">flag</b></a></dt>
<dd><p>This method returns the text of the primary
flag of the parameter, including leading dashes.</p></dd>
<dt><a name="14"><b class="cmd">&lt;parameter&gt;</b> <b class="method">forget</b></a></dt>
<dd><p>This method releases the internal representation
of the parameter's value, if it has any.
See also method <b class="method">reset</b> for a stronger form.</p></dd>
<dt><a name="15"><b class="cmd">&lt;parameter&gt;</b> <b class="method">generator</b></a></dt>
<dd><p>This method returns the &quot;generate&quot; command prefix callback,
if it was set, and an empty list otherwise.</p></dd>
<dt><a name="16"><b class="cmd">&lt;parameter&gt;</b> <b class="method">hasdefault</b></a></dt>
<dd><p>This method returns a boolean flag
indicating if the parameter's specification declared
a default value for it (<b class="const">true</b>), or not (<b class="const">false</b>).</p></dd>
<dt><a name="17"><b class="cmd">&lt;parameter&gt;</b> <b class="method">help</b></a></dt>
<dd><p>This method returns the help information for the parameter.
Note that this method does <em>not</em> check the &quot;documented&quot;
flag of the parameter. That is the responsibility of the
caller.
The result of the command is a structure of the form
described in section <span class="sectref"><a href="#section4">Help Information</a></span>.</p></dd>
<dt><a name="18"><b class="cmd">&lt;parameter&gt;</b> <b class="method">interactive</b></a></dt>
<dd><p>This method returns the &quot;interactive&quot; flag of the parameter.
A result of <b class="const">true</b> indicates that the parameter's
string representation has to be queried interactively if no
value was specified at runtime.</p></dd>
<dt><a name="19"><b class="cmd">&lt;parameter&gt;</b> <b class="method">interact</b> <span class="opt">?<i class="arg">prompt</i>?</span></a></dt>
<dd><p>This method interactively queries the string representation of
the parameter from the user.
If no <i class="arg">prompt</i> is specified the parameter's prompt from the
specification is used. See also method <b class="method">prompt</b>.
The interaction takes the &quot;list&quot;-ness of the parameter into account.
Note that the entered string(s) is/are validated and invalid
information is rejected.</p>
<dl class="arguments">
<dt>string <i class="arg">prompt</i></dt>
<dd><p>Optional. The prompt to use for the interaction.</p></dd>
</dl></dd>
<dt><a name="20"><b class="cmd">&lt;parameter&gt;</b> <b class="method">isbool</b></a></dt>
<dd><p>This method returns a boolean value indicating if the parameter
uses the standard validation type &quot;boolean&quot; (<b class="const">true</b>) or
not (<b class="const">false</b>).
The parts of the parameter responsible for processing option
arguments use this information to invoke the hard-wired special
cases for this type, or not.</p></dd>
<dt><a name="21"><b class="cmd">&lt;parameter&gt;</b> <b class="method">is</b> <i class="arg">type</i></a></dt>
<dd><p>This method returns a boolean value indicating if the
parameter is of the specified <i class="arg">type</i> (<b class="const">true</b>)
or not (<b class="const">false</b>).</p>
<dl class="arguments">
<dt>string <i class="arg">type</i></dt>
<dd><p>The type to check the parameter against.
Recognized values are</p>
<dl class="definitions">
<dt><b class="const">argument</b></dt>
<dd></dd>
<dt><b class="const">option</b></dt>
<dd></dd>
<dt><b class="const">state</b></dt>
<dd></dd>
</dl></dd>
</dl></dd>
<dt><a name="22"><b class="cmd">&lt;parameter&gt;</b> <b class="method">label</b></a></dt>
<dd><p>This method returns the human-readable name of the parameter,
for use in help. If not specifically overridden by the
parameter's specification this is the same as the internal
name (See method <b class="method">name</b>).</p></dd>
<dt><a name="23"><b class="cmd">&lt;parameter&gt;</b> <b class="method">list</b></a></dt>
<dd><p>This accessor method returns the &quot;list&quot; flag of the parameter.
A value of <b class="const">true</b> indicates that the parameter's value
is a list, otherwise a scalar.</p></dd>
<dt><a name="24"><b class="cmd">&lt;parameter&gt;</b> <b class="method">locker</b></a></dt>
<dd><p>This accessor method returns the string set by method
<b class="method">lock</b> below, or the empty string if
<b class="method">lock</b> was not used.
<em>Note</em>: This information is reset by method
<b class="method">reset</b>, but not by <b class="method">forget</b>.</p></dd>
<dt><a name="25"><b class="cmd">&lt;parameter&gt;</b> <b class="method">lock</b> <i class="arg">reason</i></a></dt>
<dd><p>This method locks the parameter against modification
by the methods <b class="method">set</b> and <b class="method">setq</b>, and
remembers the <i class="arg">reason</i> for it. The reason is
expected to be the name of another parameter whose
use disallows the use of this one.
<em>Note</em>: Such a lock is reset by method
<b class="method">reset</b>, but not by <b class="method">forget</b>.</p>
<dl class="arguments">
<dt>string <i class="arg">reason</i></dt>
<dd><p>The name of the parameter locking this one against further
modification.</p></dd>
</dl></dd>
<dt><a name="26"><b class="cmd">&lt;parameter&gt;</b> <b class="method">name</b></a></dt>
<dd><p>This method returns the internal name of the parameter.</p></dd>
<dt><a name="27"><b class="cmd">&lt;parameter&gt;</b> <b class="method">options</b></a></dt>
<dd><p>This method returns the list of option flags recognized
by the parameter.</p></dd>
<dt><a name="28"><b class="cmd">&lt;parameter&gt;</b> <b class="method">ordered</b></a></dt>
<dd><p>This accessor method returns the &quot;order&quot; flag
set during parameter construction.
A result of <b class="const">true</b> indicates that the parameter
is specified by order at runtime (argument), and otherwise
(<b class="const">false</b>) by name (option).</p></dd>
<dt><a name="29"><b class="cmd">&lt;parameter&gt;</b> <b class="method">presence</b></a></dt>
<dd><p>This method returns a boolean value indicating if
the option parameter is set as presence-option
(<b class="const">true</b>) or not (<b class="const">false</b>).
The parts of the parameter responsible for processing option
arguments use this information to invoke the hard-wired special
cases for presence, or not.</p></dd>
<dt><a name="30"><b class="cmd">&lt;parameter&gt;</b> <b class="method">primary</b> <i class="arg">option</i></a></dt>
<dd><p>This method returns a boolean value indicating if the named <i class="arg">option</i>
is the primary option of this parameter (<b class="const">true</b>), or not (<b class="const">false</b>).
An error will be thrown if the named option is not controlled by the parameter.</p>
<dl class="arguments">
<dt>string <i class="arg">option</i></dt>
<dd><p>The name of the option to check.</p></dd>
</dl></dd>
<dt><a name="31"><b class="cmd">&lt;parameter&gt;</b> <b class="method">process</b> <i class="arg">detail</i> <i class="arg">queue</i></a></dt>
<dd><p>This method extracts the value of the parameter from the command line.
A <b class="method">presence</b> option takes nothing, whereas an <b class="method">isbool</b> option
takes the first value in the <i class="arg">queue</i>, if it is a proper boolean, and
defaults to <b class="const">true</b> if not. Any other argument or option takes  the
first value in <i class="arg">queue</i>.</p>
<dl class="arguments">
<dt>string <i class="arg">detail</i></dt>
<dd><p>The name of the parameter, or the option flag referencing it.</p></dd>
<dt>struct::queue <i class="arg">queue</i></dt>
<dd><p>The queue instance holding the words of the command line not yet
processed by the system.</p></dd>
</dl></dd>
<dt><a name="32"><b class="cmd">&lt;parameter&gt;</b> <b class="method">prompt</b></a></dt>
<dd><p>This method returns the prompt string used by the parameter for
interactive entry. If not overridden by the parameter's specification
this defaults to a string derived from the internal name of the
parameter, i.e. &quot;Enter <b class="variable">name</b>:&quot;.</p></dd>
<dt><a name="33"><b class="cmd">&lt;parameter&gt;</b> <b class="method">required</b></a></dt>
<dd><p>This accessor method returns the &quot;required&quot; flag
set during parameter construction.
A result of <b class="const">true</b> indicates that the parameter
must be specified by the user at runtime, and otherwise
may be left unspecified (<b class="const">false</b>).</p></dd>
<dt><a name="34"><b class="cmd">&lt;parameter&gt;</b> <b class="method">reset</b> <span class="opt">?<i class="arg">cleanup</i>?</span></a></dt>
<dd><p>This method sets the parameter into the initial state where
it has neither string nor internal representation, nor is
it locked. This is a stronger form of <b class="method">forget</b>.</p>
<dl class="arguments">
<dt>boolean <i class="arg">cleanup</i></dt>
<dd></dd>
</dl></dd>
<dt><a name="35"><b class="cmd">&lt;parameter&gt;</b> <b class="method">self</b></a></dt>
<dd><p>This method returns the parameter instance itself.</p></dd>
<dt><a name="36"><b class="cmd">&lt;parameter&gt;</b> <b class="method">set?</b></a></dt>
<dd><p>This accessor method returns a boolean value indicating
if the parameter was given a string representation at
runtime (<b class="const">true</b>), or not (<b class="const">false</b>).</p></dd>
<dt><a name="37"><b class="cmd">&lt;parameter&gt;</b> <b class="method">setq</b> <i class="arg">queue</i></a></dt>
<dd><p>This method sets the first element of the <i class="arg">queue</i>
as the value of the parameter.
For a &quot;list&quot; parameter all elements of the queue are
taken as the new value of the parameter.
This is not quite analogous to method <b class="method">set</b> below.
They behave the same for scalar parameters, and differ
for &quot;list&quot; parameters.</p>
<dl class="arguments">
<dt>stack::queue <i class="arg">queue</i></dt>
<dd><p>The queue instance holding the words of the command
line not yet processed.</p></dd>
</dl></dd>
<dt><a name="38"><b class="cmd">&lt;parameter&gt;</b> <b class="method">set</b> <i class="arg">value</i></a></dt>
<dd><p>This method sets the <i class="arg">value</i> as the new string
representation of the parameter.
For a &quot;list&quot; parameter the string representation is
<em>extended</em> with the <i class="arg">value</i>.
This action triggers the execution of the &quot;when-set&quot; callback.
A previously existing internal representation is
forgotten (See <b class="method">forget</b>).</p>
<dl class="arguments">
<dt>string <i class="arg">value</i></dt>
<dd><p>The new value of the parameter, or an extension of the
existing value.</p></dd>
</dl></dd>
<dt><a name="39"><b class="cmd">&lt;parameter&gt;</b> <b class="method">string</b></a></dt>
<dd><p>This accessor method returns the string representation of
the parameter. If such was not set an error will be thrown
(See method <b class="method">undefined!</b>).</p></dd>
<dt><a name="40"><b class="cmd">&lt;parameter&gt;</b> <b class="method">threshold:</b> <i class="arg">n</i></a></dt>
<dd><p>This method specifies the minimum number of words needed after
the optional argument parameter for it to accept the current
word for itself.
Parameters which are not optional arguments ignore this method.
The result of the method is the empty string.</p>
<dl class="arguments">
<dt>integer <i class="arg">n</i></dt>
<dd><p>The acceptance threshold for the parameter.</p></dd>
</dl></dd>
<dt><a name="41"><b class="cmd">&lt;parameter&gt;</b> <b class="method">threshold</b></a></dt>
<dd><p>This method returns the threshold set on the parameter.
An empty string indicates a parameter without threshold.
A value of -1 indicates that the optional argument accepts
based on validation (See method <b class="method">accept</b>) instead
of using a threshold.</p></dd>
<dt><a name="42"><b class="cmd">&lt;parameter&gt;</b> <b class="method">type</b></a></dt>
<dd><p>This accessor method returns the type of the parameter, one of
<b class="const">argument</b>, <b class="const">option</b>, or <b class="const">state</b>. See also
method <b class="method">is</b> for type-checking.</p></dd>
<dt><a name="43"><b class="cmd">&lt;parameter&gt;</b> <b class="method">undefined!</b></a></dt>
<dd><p>This method explicitly throws a &quot;parameter undefined&quot; error
for this parameter.</p></dd>
<dt><a name="44"><b class="cmd">&lt;parameter&gt;</b> <b class="method">validator</b></a></dt>
<dd><p>This method returns the &quot;validate&quot; command prefix callback
(i.e. the parameter's validation type).</p></dd>
<dt><a name="45"><b class="cmd">&lt;parameter&gt;</b> <b class="method">value</b></a></dt>
<dd><p>This accessor method returns the internal representation of
the parameter. If necessary the data is computed from the
parameter's string representation, &quot;default&quot; value, or
&quot;generate&quot; callback.
An error is thrown if the value could not be determined.
(See method <b class="method">undefined!</b>).
If the value is newly computed the action triggers the
execution of the &quot;when-complete&quot; callback.</p>
<p>--TODO-- describe generation rules and order.</p></dd>
<dt><a name="46"><b class="cmd">&lt;parameter&gt;</b> <b class="method">when-complete</b></a></dt>
<dd><p>This method returns the &quot;when-complete&quot; command prefix callback,
if it was set, and an empty list otherwise.</p></dd>
<dt><a name="47"><b class="cmd">&lt;parameter&gt;</b> <b class="method">when-set</b></a></dt>
<dd><p>This method returns the &quot;when-set&quot; command prefix callback,
if it was set, and an empty list otherwise.</p></dd>
</dl>
</div>
<div id="section4" class="section"><h2><a name="section4">Help Information</a></h2>
<p>The help information generated for parameters is a
dictionary containing the keys below:</p>
<dl class="definitions">
<dt>cmdline</dt>
<dd><p>Output of method <b class="method">cmdline</b>.</p></dd>
<dt>code</dt>
<dd><p>Output of method <b class="method">code</b>.</p></dd>
<dt>default</dt>
<dd><p>Output of method <b class="method">default</b>.</p></dd>
<dt>defered</dt>
<dd><p>Output of method <b class="method">defered</b>.</p></dd>
<dt>description</dt>
<dd><p>Output of method <b class="method">description</b>.</p></dd>
<dt>documented</dt>
<dd><p>Output of method <b class="method">documented</b>.</p></dd>
<dt>flags</dt>
<dd><p>A dictionary mapping flag names to flag
                   types, i.e. <b class="const">primary</b>, <b class="const">alias</b>,
                   or <b class="const">inverted</b>.</p></dd>
<dt>generator</dt>
<dd><p>Output of method <b class="method">generator</b>.</p></dd>
<dt>interactive</dt>
<dd><p>Output of method <b class="method">interactive</b>.</p></dd>
<dt>isbool</dt>
<dd><p>Output of method <b class="method">isbool</b>.</p></dd>
<dt>label</dt>
<dd><p>Output of method <b class="method">label</b>.</p></dd>
<dt>list</dt>
<dd><p>Output of method <b class="method">list</b>.</p></dd>
<dt>ordered</dt>
<dd><p>Output of method <b class="method">ordered</b>.</p></dd>
<dt>presence</dt>
<dd><p>Output of method <b class="method">presence</b>.</p></dd>
<dt>prompt</dt>
<dd><p>Output of method <b class="method">prompt</b>.</p></dd>
<dt>required</dt>
<dd><p>Output of method <b class="method">required</b>.</p></dd>
<dt>threshold</dt>
<dd><p>Output of method <b class="method">threshold</b>.</p></dd>
<dt>type</dt>
<dd><p>Output of method <b class="method">type</b>.</p></dd>
<dt>validator</dt>
<dd><p>Output of method <b class="method">validator</b>.</p></dd>
</dl>
</div>
<div id="section5" class="section"><h2><a name="section5">Bugs, Ideas, Feedback</a></h2>
<p>Both the package(s) and this documentation will undoubtedly contain
bugs and other problems.
Please report such at
<a href="https:/core.tcl.tk/akupries/cmdr">Cmdr Tickets</a>.</p>
<p>Please also report any ideas you may have for enhancements of
either package(s) and/or documentation.</p>
</div>
<div id="keywords" class="section"><h2><a name="keywords">Keywords</a></h2>
<p><a href="../../index.html#key4">arguments</a>, <a href="../../index.html#key5">command hierarchy</a>, <a href="../../index.html#key9">command line completion</a>, <a href="../../index.html#key11">command line handling</a>, <a href="../../index.html#key13">command tree</a>, <a href="../../index.html#key0">editing command line</a>, <a href="../../index.html#key8">help for command line</a>, <a href="../../index.html#key6">hierarchy of commands</a>, <a href="../../index.html#key3">interactive command shell</a>, <a href="../../index.html#key1">optional arguments</a>, <a href="../../index.html#key2">options</a>, <a href="../../index.html#key12">parameters</a>, <a href="../../index.html#key10">processing command line</a>, <a href="../../index.html#key7">tree of commands</a></p>
</div>
<div id="copyright" class="section"><h2><a name="copyright">Copyright</a></h2>
<p>Copyright &copy; 2013 Andreas Kupries<br>
Copyright &copy; 2013 Documentation, Andreas Kupries</p>
</div>
</div></body></html>

Changes to embedded/www/doc/files/cmdr_private.html.

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
...
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
<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="toc">
<li class="section"><a href="#toc">Table Of Contents</a></li>
<li class="section"><a href="#synopsis">Synopsis</a></li>
<li class="section"><a href="#section1">Description</a></li>
<li class="section"><a href="#section2">Class API</a></li>
<li class="section"><a href="#section3">Instance API</a></li>
<li class="section"><a href="#section4">Bugs, Ideas, Feedback</a></li>

<li class="section"><a href="#keywords">Keywords</a></li>
<li class="section"><a href="#copyright">Copyright</a></li>
</ul>
</div>
<div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="synopsis">
<ul class="requirements">
<li>package require <b class="pkgname">cmdr::util</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::cmdr::private</b> <b class="method">new</b> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">arguments</i> <i class="arg">action</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr::private</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">arguments</i> <i class="arg">action</i></a></li>
<li><a href="#3"><b class="cmd">private</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></li>
<li><a href="#4"><b class="cmd">private</b> <b class="method">do</b> <span class="opt">?<i class="arg">word</i>...?</span></a></li>
<li><a href="#5"><b class="cmd">private</b> <b class="method">ehandler</b> <i class="arg">cmd</i></a></li>
<li><a href="#6"><b class="cmd">private</b> <b class="method">help</b> <span class="opt">?<i class="arg">prefix</i>?</span></a></li>
<li><a href="#7"><b class="cmd">private</b> <b class="method">unknown</b> <i class="arg">m</i> <span class="opt">?<i class="arg">word</i>...?</span></a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This package implements <em>privates</em>, the leaves of command
................................................................................
parsing a command hierarchy specification to create the necessary
private instances.</p>
<p>It is described here for use by developers maintaining,
modifying and extending the framework itself. A user of the framework
has no need for it, although they have indirect access through
parameters and their container.</p>
<dl class="definitions">
<dt><a name="3"><b class="cmd">private</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></dt>
<dd><p>This command is given the completion state <i class="arg">parse</i> of a partial
command line and returns a list of strings which are the vaid
completions at this point.</p>
<dl class="arguments">
<dt>dict <i class="arg">parse</i></dt>
<dd><p>A dictionary holding the current completion state of a partial command
line.</p>
<p>-- TODO -- Describe the state fields and their meaning.</p></dd>
</dl></dd>
<dt><a name="4"><b class="cmd">private</b> <b class="method">do</b> <span class="opt">?<i class="arg">word</i>...?</span></a></dt>
<dd><p>This method parses the <i class="arg">word</i>s of the command line, matching them
to the parameters of the private, be they arguments, or options. When
done without error it invokes the action of the private with the
filled container of parameters.</p>
<dl class="arguments">
<dt>string <i class="arg">word</i></dt>
<dd><p>The words of the command line to parse and match to parameters.</p></dd>
</dl></dd>
<dt><a name="5"><b class="cmd">private</b> <b class="method">ehandler</b> <i class="arg">cmd</i></a></dt>
<dd><p>This method specifies a command prefix to wrap around the parsing of
the command line for the private, and the execution of its action.</p>
<dl class="arguments">
<dt>cmd-prefix <i class="arg">cmd</i></dt>
<dd><p>A command prefix taking a single argument, a script. The command
prefix has to execute this script in its caller's context. The script
will parse words for the private,m and perform its action. The command
prefix then has the responsbility to perform any custom cleanup action
required by the application using the framework to prevent leakage of
data between multiple commands executed one after the other (i.e. in
an interactive shell run by the framework).</p></dd>
</dl></dd>
<dt><a name="6"><b class="cmd">private</b> <b class="method">help</b> <span class="opt">?<i class="arg">prefix</i>?</span></a></dt>
<dd><p>This method returns the help information for the private and its
parameters. The <i class="arg">prefix</i>, if specified provides the name of the
private within the help data. It defaults to the empty string.</p>
<p>-- TODO -- describe help structure --&gt; custom help formats</p>

<dl class="arguments">
<dt>string <i class="arg">prefix</i></dt>
<dd><p>The name to use for the private within the generated help.</p></dd>
</dl></dd>
<dt><a name="7"><b class="cmd">private</b> <b class="method">unknown</b> <i class="arg">m</i> <span class="opt">?<i class="arg">word</i>...?</span></a></dt>
<dd><p>This method overrides the standard behaviour for unknown methods.
Instead of throwing an error they are routed to the hidden container
of the private's parameters, of class <b class="package">cmdr::config</b>.</p>
<dl class="arguments">
<dt>string <i class="arg">m</i></dt>
<dd><p>The name of the unknown method.</p></dd>
<dt>string <i class="arg">word</i></dt>
<dd><p>The argument (one or more) of the unknown method.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section4" class="section"><h2><a name="section4">Bugs, Ideas, Feedback</a></h2>




































































<p>Both the package(s) and this documentation will undoubtedly contain
bugs and other problems.
Please report such at
<a href="https:/core.tcl.tk/akupries/cmdr">Cmdr Tickets</a>.</p>
<p>Please also report any ideas you may have for enhancements of
either package(s) and/or documentation.</p>
</div>






|
>












|
|
|
|
|







 







|
|
|







|








|












|


|
|
>




|











|
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>







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
...
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
<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="toc">
<li class="section"><a href="#toc">Table Of Contents</a></li>
<li class="section"><a href="#synopsis">Synopsis</a></li>
<li class="section"><a href="#section1">Description</a></li>
<li class="section"><a href="#section2">Class API</a></li>
<li class="section"><a href="#section3">Instance API</a></li>
<li class="section"><a href="#section4">Help Information</a></li>
<li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li>
<li class="section"><a href="#keywords">Keywords</a></li>
<li class="section"><a href="#copyright">Copyright</a></li>
</ul>
</div>
<div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="synopsis">
<ul class="requirements">
<li>package require <b class="pkgname">cmdr::util</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::cmdr::private</b> <b class="method">new</b> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">arguments</i> <i class="arg">action</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr::private</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">arguments</i> <i class="arg">action</i></a></li>
<li><a href="#3"><b class="cmd">&lt;private&gt;</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></li>
<li><a href="#4"><b class="cmd">&lt;private&gt;</b> <b class="method">do</b> <span class="opt">?<i class="arg">word</i>...?</span></a></li>
<li><a href="#5"><b class="cmd">&lt;private&gt;</b> <b class="method">ehandler</b> <i class="arg">cmd</i></a></li>
<li><a href="#6"><b class="cmd">&lt;private&gt;</b> <b class="method">help</b> <span class="opt">?<i class="arg">prefix</i>?</span></a></li>
<li><a href="#7"><b class="cmd">&lt;private&gt;</b> <b class="method">unknown</b> <i class="arg">m</i> <span class="opt">?<i class="arg">word</i>...?</span></a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This package implements <em>privates</em>, the leaves of command
................................................................................
parsing a command hierarchy specification to create the necessary
private instances.</p>
<p>It is described here for use by developers maintaining,
modifying and extending the framework itself. A user of the framework
has no need for it, although they have indirect access through
parameters and their container.</p>
<dl class="definitions">
<dt><a name="3"><b class="cmd">&lt;private&gt;</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></dt>
<dd><p>This method is given the completion state <i class="arg">parse</i> of a partial
command line and returns a list of strings which are the valid
completions at this point.</p>
<dl class="arguments">
<dt>dict <i class="arg">parse</i></dt>
<dd><p>A dictionary holding the current completion state of a partial command
line.</p>
<p>-- TODO -- Describe the state fields and their meaning.</p></dd>
</dl></dd>
<dt><a name="4"><b class="cmd">&lt;private&gt;</b> <b class="method">do</b> <span class="opt">?<i class="arg">word</i>...?</span></a></dt>
<dd><p>This method parses the <i class="arg">word</i>s of the command line, matching them
to the parameters of the private, be they arguments, or options. When
done without error it invokes the action of the private with the
filled container of parameters.</p>
<dl class="arguments">
<dt>string <i class="arg">word</i></dt>
<dd><p>The words of the command line to parse and match to parameters.</p></dd>
</dl></dd>
<dt><a name="5"><b class="cmd">&lt;private&gt;</b> <b class="method">ehandler</b> <i class="arg">cmd</i></a></dt>
<dd><p>This method specifies a command prefix to wrap around the parsing of
the command line for the private, and the execution of its action.</p>
<dl class="arguments">
<dt>cmd-prefix <i class="arg">cmd</i></dt>
<dd><p>A command prefix taking a single argument, a script. The command
prefix has to execute this script in its caller's context. The script
will parse words for the private,m and perform its action. The command
prefix then has the responsbility to perform any custom cleanup action
required by the application using the framework to prevent leakage of
data between multiple commands executed one after the other (i.e. in
an interactive shell run by the framework).</p></dd>
</dl></dd>
<dt><a name="6"><b class="cmd">&lt;private&gt;</b> <b class="method">help</b> <span class="opt">?<i class="arg">prefix</i>?</span></a></dt>
<dd><p>This method returns the help information for the private and its
parameters. The <i class="arg">prefix</i>, if specified provides the name of the
private within the help data. It defaults to the empty string.
The result of the command is a structure of the form
described in section <span class="sectref"><a href="#section4">Help Information</a></span>.</p>
<dl class="arguments">
<dt>string <i class="arg">prefix</i></dt>
<dd><p>The name to use for the private within the generated help.</p></dd>
</dl></dd>
<dt><a name="7"><b class="cmd">&lt;private&gt;</b> <b class="method">unknown</b> <i class="arg">m</i> <span class="opt">?<i class="arg">word</i>...?</span></a></dt>
<dd><p>This method overrides the standard behaviour for unknown methods.
Instead of throwing an error they are routed to the hidden container
of the private's parameters, of class <b class="package">cmdr::config</b>.</p>
<dl class="arguments">
<dt>string <i class="arg">m</i></dt>
<dd><p>The name of the unknown method.</p></dd>
<dt>string <i class="arg">word</i></dt>
<dd><p>The argument (one or more) of the unknown method.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section4" class="section"><h2><a name="section4">Help Information</a></h2>
<p>The help information generated by various places of the framework
is a dictionary containing the following keys:</p>
<dl class="definitions">
<dt>arguments</dt>
<dd><p>A list of strings, the names of the command arguments, in order.
These names are keys into the <b class="variable">parameters</b> sub-dictionary.</p></dd>
<dt>desc</dt>
<dd><p>The command's description, i.e. help text.</p></dd>
<dt>opt2para</dt>
<dd><p>A dictionary mapping option flags to option names.
These names are keys into the <b class="variable">parameters</b> sub-dictionary.</p></dd>
<dt>options</dt>
<dd><p>A dictionary mapping option names to their descriptions.</p></dd>
<dt>parameters</dt>
<dd><p>A dictionary mapping parameter names to their definition.
Each definition is a dictionary containing the keys below.
See also package <b class="package">cmdr::parameter</b>.</p>
<dl class="definitions">
<dt>cmdline</dt>
<dd><p>Output of method <b class="method">cmdline</b>.</p></dd>
<dt>code</dt>
<dd><p>Output of method <b class="method">code</b>.</p></dd>
<dt>default</dt>
<dd><p>Output of method <b class="method">default</b>.</p></dd>
<dt>defered</dt>
<dd><p>Output of method <b class="method">defered</b>.</p></dd>
<dt>description</dt>
<dd><p>Output of method <b class="method">description</b>.</p></dd>
<dt>documented</dt>
<dd><p>Output of method <b class="method">documented</b>.</p></dd>
<dt>flags</dt>
<dd><p>A dictionary mapping flag names to flag
                   types, i.e. <b class="const">primary</b>, <b class="const">alias</b>,
                   or <b class="const">inverted</b>.</p></dd>
<dt>generator</dt>
<dd><p>Output of method <b class="method">generator</b>.</p></dd>
<dt>interactive</dt>
<dd><p>Output of method <b class="method">interactive</b>.</p></dd>
<dt>isbool</dt>
<dd><p>Output of method <b class="method">isbool</b>.</p></dd>
<dt>label</dt>
<dd><p>Output of method <b class="method">label</b>.</p></dd>
<dt>list</dt>
<dd><p>Output of method <b class="method">list</b>.</p></dd>
<dt>ordered</dt>
<dd><p>Output of method <b class="method">ordered</b>.</p></dd>
<dt>presence</dt>
<dd><p>Output of method <b class="method">presence</b>.</p></dd>
<dt>prompt</dt>
<dd><p>Output of method <b class="method">prompt</b>.</p></dd>
<dt>required</dt>
<dd><p>Output of method <b class="method">required</b>.</p></dd>
<dt>threshold</dt>
<dd><p>Output of method <b class="method">threshold</b>.</p></dd>
<dt>type</dt>
<dd><p>Output of method <b class="method">type</b>.</p></dd>
<dt>validator</dt>
<dd><p>Output of method <b class="method">validator</b>.</p></dd>
</dl></dd>
<dt>sections</dt>
<dd><p>A list of sections the command belongs to.
Each section name is a list itself, the path of the section and sub-sections.</p></dd>
<dt>states</dt>
<dd><p>A list of strings, the names of the command's hidden state parameters.
These names are keys into the <b class="variable">parameters</b> sub-dictionary.</p></dd>
</dl>
</div>
<div id="section5" class="section"><h2><a name="section5">Bugs, Ideas, Feedback</a></h2>
<p>Both the package(s) and this documentation will undoubtedly contain
bugs and other problems.
Please report such at
<a href="https:/core.tcl.tk/akupries/cmdr">Cmdr Tickets</a>.</p>
<p>Please also report any ideas you may have for enhancements of
either package(s) and/or documentation.</p>
</div>

Changes to embedded/www/doc/toc.html.

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
<td class="#tocright">Cmdr - Introduction to the project</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_license.html">cmdr_license</a></td>
<td class="#tocright">Cmdr - License</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_private.html">cmdr_private</a></td>
<td class="#tocright">Cmdr - Single command handling, options, and arguments</td>
</tr>
<tr class="#toceven" >




<td class="#tocleft" ><a href="files/cmdr_util.html">cmdr_util</a></td>
<td class="#tocright">Cmdr - General Utilities - Internal</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_validate.html">cmdr_validate</a></td>
<td class="#tocright">Cmdr - Standard validation types for parameters</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_vcommon.html">cmdr_validate_common</a></td>
<td class="#tocright">Utilities for Validation Types</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_vtypes.html">cmdr_vtypes</a></td>
<td class="#tocright">Cmdr - Writing custom validation types</td>
</tr>
</table>
</dl><hr></body></html>






|



>
>
>
>



|



|



|





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
<td class="#tocright">Cmdr - Introduction to the project</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_license.html">cmdr_license</a></td>
<td class="#tocright">Cmdr - License</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_parameter.html">cmdr_private</a></td>
<td class="#tocright">Cmdr - Single command handling, options, and arguments</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_private.html">cmdr_private</a></td>
<td class="#tocright">Cmdr - Single command handling, options, and arguments</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_util.html">cmdr_util</a></td>
<td class="#tocright">Cmdr - General Utilities - Internal</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_validate.html">cmdr_validate</a></td>
<td class="#tocright">Cmdr - Standard validation types for parameters</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_vcommon.html">cmdr_validate_common</a></td>
<td class="#tocright">Utilities for Validation Types</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_vtypes.html">cmdr_vtypes</a></td>
<td class="#tocright">Cmdr - Writing custom validation types</td>
</tr>
</table>
</dl><hr></body></html>

Changes to embedded/www/index.html.

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
<hr><table class="#idx" width="100%">
<tr class="#idxheader"><th colspan="2">
<a name="c1">Keywords: A</a>
</th></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key4"> arguments </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c2">Keywords: C</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key5"> command hierarchy </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key9"> command line completion </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key11"> command line handling </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key13"> command tree </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c3">Keywords: E</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key0"> editing command line </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c4">Keywords: H</a>
</th></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key8"> help for command line </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key6"> hierarchy of commands </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c5">Keywords: I</a>
</th></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key3"> interactive command shell </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c6">Keywords: O</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key1"> optional arguments </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key2"> options </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c7">Keywords: P</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key12"> parameters </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key10"> processing command line </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c8">Keywords: T</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key7"> tree of commands </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
</table>
</body></html>






|







|




|




|




|







|







|




|







|







|




|







|




|







|



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
<hr><table class="#idx" width="100%">
<tr class="#idxheader"><th colspan="2">
<a name="c1">Keywords: A</a>
</th></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key4"> arguments </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c2">Keywords: C</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key5"> command hierarchy </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key9"> command line completion </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key11"> command line handling </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key13"> command tree </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c3">Keywords: E</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key0"> editing command line </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c4">Keywords: H</a>
</th></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key8"> help for command line </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key6"> hierarchy of commands </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c5">Keywords: I</a>
</th></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key3"> interactive command shell </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c6">Keywords: O</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key1"> optional arguments </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key2"> options </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c7">Keywords: P</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key12"> parameters </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxeven" valign=top>
<td class="#idxleft" width="35%"><a name="key10"> processing command line </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
<tr class="#idxheader"><th colspan="2">
<a name="c8">Keywords: T</a>
</th></tr>
<tr class="#idxodd" valign=top>
<td class="#idxleft" width="35%"><a name="key7"> tree of commands </a></td>
<td class="#idxright" width="65%">
<a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> &#183; <a href="doc/files/cmdr_help.html"> cmdr_help </a> &#183; <a href="doc/files/cmdr_help_json.html"> cmdr_help_json </a> &#183; <a href="doc/files/cmdr_help_sql.html"> cmdr_help_sql </a> &#183; <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> &#183; <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> &#183; <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> &#183; <a href="doc/files/cmdr_license.html"> cmdr_license </a> &#183; <a href="doc/files/cmdr_parameter.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_private.html"> cmdr_private </a> &#183; <a href="doc/files/cmdr_util.html"> cmdr_util </a> &#183; <a href="doc/files/cmdr_validate.html"> cmdr_validate </a> &#183; <a href="doc/files/cmdr_vcommon.html"> cmdr_validate_common </a> &#183; <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a>
</td></tr>
</table>
</body></html>

Changes to embedded/www/toc.html.

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
<td class="#tocright">Cmdr - Introduction to the project</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_license.html">cmdr_license</a></td>
<td class="#tocright">Cmdr - License</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_private.html">cmdr_private</a></td>
<td class="#tocright">Cmdr - Single command handling, options, and arguments</td>
</tr>
<tr class="#toceven" >




<td class="#tocleft" ><a href="doc/files/cmdr_util.html">cmdr_util</a></td>
<td class="#tocright">Cmdr - General Utilities - Internal</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_validate.html">cmdr_validate</a></td>
<td class="#tocright">Cmdr - Standard validation types for parameters</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_vcommon.html">cmdr_validate_common</a></td>
<td class="#tocright">Utilities for Validation Types</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_vtypes.html">cmdr_vtypes</a></td>
<td class="#tocright">Cmdr - Writing custom validation types</td>
</tr>
</table>
</dl><hr></body></html>






|



>
>
>
>



|



|



|





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
<td class="#tocright">Cmdr - Introduction to the project</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_license.html">cmdr_license</a></td>
<td class="#tocright">Cmdr - License</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_parameter.html">cmdr_private</a></td>
<td class="#tocright">Cmdr - Single command handling, options, and arguments</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_private.html">cmdr_private</a></td>
<td class="#tocright">Cmdr - Single command handling, options, and arguments</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_util.html">cmdr_util</a></td>
<td class="#tocright">Cmdr - General Utilities - Internal</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_validate.html">cmdr_validate</a></td>
<td class="#tocright">Cmdr - Standard validation types for parameters</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_vcommon.html">cmdr_validate_common</a></td>
<td class="#tocright">Utilities for Validation Types</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_vtypes.html">cmdr_vtypes</a></td>
<td class="#tocright">Cmdr - Writing custom validation types</td>
</tr>
</table>
</dl><hr></body></html>