cmdr
Check-in [ca14a9b8c1]
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 tclconference@googlegroups.com
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:ca14a9b8c1f54e85cfa4ea23a18770e99674b0a5
User & Date: aku 2013-11-05 05:55:16
Context
2013-11-13
22:44
Filled the officer documentation, and tweaked privates a bit. check-in: 65c018615d user: andreask tags: trunk
2013-11-05
05:55
Updated embedded documentation check-in: ca14a9b8c1 user: aku tags: trunk
00:40
Another placeholder, for the DSL spec, and filled out actor reference check-in: 67f83ccddb user: andreask tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Added embedded/man/files/cmdr_actor.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
'\"
'\" Generated from file 'cmdr_actor\&.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_actor" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_actor \- Cmdr - Base class for officers and privates - Internal
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::actor\fR \fBnew\fR
.sp
\fB::cmdr::actor\fR \fBcreate\fR \fIobj\fR
.sp
\fB<actor>\fR \fBcompletions\fR \fIparse\fR \fIcmdlist\fR
.sp
\fB<actor>\fR \fBdescription\fR
.sp
\fB<actor>\fR \fBdescription:\fR \fItext\fR
.sp
\fB<actor>\fR \fBdname\fR
.sp
\fB<actor>\fR \fBdo\fR ?\fIword\&.\&.\&.\fR?
.sp
\fB<actor>\fR \fBdocumented\fR
.sp
\fB<actor>\fR \fBexists\fR \fIkey\fR
.sp
\fB<actor>\fR \fBfullname\fR
.sp
\fB<actor>\fR \fBget\fR \fIkey\fR
.sp
\fB<actor>\fR \fBhelp\fR
.sp
\fB<actor>\fR \fBkeys\fR
.sp
\fB<actor>\fR \fBlappend\fR \fIkey\fR \fIdata\fR
.sp
\fB<actor>\fR \fBmatch\fR \fIparse\fR \fIcmdlist\fR
.sp
\fB<actor>\fR \fBname\fR
.sp
\fB<actor>\fR \fBname:\fR \fIname\fR
.sp
\fB<actor>\fR \fBparse-line\fR \fIline\fR
.sp
\fB<actor>\fR \fBroot\fR
.sp
\fB<actor>\fR \fBset\fR \fIkey\fR \fIdata\fR
.sp
\fB<actor>\fR \fBsuper\fR
.sp
\fB<actor>\fR \fBsuper:\fR \fIobj\fR
.sp
\fB<actor>\fR \fBundocumented\fR
.sp
\fB<actor>\fR \fBunset\fR \fIkey\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 internal package implements the base class containing functionality
common to \fBcmdr::officer\fR and \fBcmdr::private\fR\&.
--TODO-- Describe the common parts (common blocks, super chain, completion support, DSL support)
.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
command 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::actor\fR \fBnew\fR
Create an auto-named instance of \fBcmdr::actor\fR\&.
.sp
\fINot used\fR\&.
.TP
\fB::cmdr::actor\fR \fBcreate\fR \fIobj\fR
Create a new instance of \fBcmdr::actor\fR, named \fIobj\fR\&.
.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\&.
.TP
\fB<actor>\fR \fBcompletions\fR \fIparse\fR \fIcmdlist\fR
This method is given the completion state \fIparse\fR of a partial
command line and a list of completions at the end of the line\&. It
returns a list of strings which are the valid completions of the whole
line, properly quoted\&.
.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\&.
.TP
list \fIcmdlist\fR
List of valid completions\&.
.RE
.TP
\fB<actor>\fR \fBdescription\fR
This accessor method returns the human-readable description of the
actor\&.
.TP
\fB<actor>\fR \fBdescription:\fR \fItext\fR
This method sets the description of the actor to the \fItext\fR\&.
.RS
.TP
string \fItext\fR
The description to remember\&.
.RE
.TP
\fB<actor>\fR \fBdname\fR
This accessor method returns the display name of the actor\&.  This is
the \fBname\fR of the actor prefixed with the contents of the
reserved common block \fB*prefix*\fR, set during command line
processing with the actual command path to reach the current actor\&.
.TP
\fB<actor>\fR \fBdo\fR ?\fIword\&.\&.\&.\fR?
This method processes the command-line given as a list of words\&.  Here
in the bse class it does nothing\&. It is a virtual method expecting to
be redefined by the derived classes\&.
.RS
.TP
list \fIword\fR
.RE
.TP
\fB<actor>\fR \fBdocumented\fR
This accessor method returns the "documented" flag of the actor\&.
.TP
\fB<actor>\fR \fBexists\fR \fIkey\fR
This method returns a boolean value indicating whether the common
block named by \fIkey\fR exists in the actor and its parents
(\fBtrue\fR), or not (\fBfalse\fR)\&.
.RS
.TP
string \fIkey\fR
The name of the common block to check for\&.
.RE
.TP
\fB<actor>\fR \fBfullname\fR
This method returns the full name of the actor\&.
This is the \fBname\fR of the actor prefixed with the path to it in
the specification, i\&.e\&. the names of all actors in the chain of
supers\&.
.TP
\fB<actor>\fR \fBget\fR \fIkey\fR
This method returns the content of the common block named by
\fIkey\fR\&. An error is thrown if the block is not known to the actor,
nor its parents\&.
.RS
.TP
string \fIkey\fR
The name of the common block to retrieve\&.
.RE
.TP
\fB<actor>\fR \fBhelp\fR
This accessor method returns the empty string\&. It is a virtual method
expecting to be redefined by the derived classes\&.
.TP
\fB<actor>\fR \fBkeys\fR
This accessor method returns a list of names for the set of common
blocks known to this actor, and all of its parents\&.
.TP
\fB<actor>\fR \fBlappend\fR \fIkey\fR \fIdata\fR
This method extends the contents of the common block named
by \fIkey\fR with \fIdata\fR\&.
Conceptually this is a get/lappend/set operation, i\&.e\&. while the
existing block content is taken from the actor or its parents, the new
content is always stored in the actor\&.
.RS
.TP
string \fIkey\fR
The name of the common block to extend\&.
.TP
any \fIdata\fR
The data to add to the block\&.
.RE
.TP
\fB<actor>\fR \fBmatch\fR \fIparse\fR \fIcmdlist\fR
This method is given the completion state \fIparse\fR of a partial
command line and a list of possible completions\&. The result is a list
of valid completions, filtered against the current word in the command
line\&.
.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\&.
.TP
list \fIcmdlist\fR
List of possible completions\&.
.RE
.TP
\fB<actor>\fR \fBname\fR
This accessor method returns the name of the actor\&.
.TP
\fB<actor>\fR \fBname:\fR \fIname\fR
This method sets the name of the actor\&.
.RS
.TP
string \fIname\fR
The name to remember\&.
.RE
.TP
\fB<actor>\fR \fBparse-line\fR \fIline\fR
This method is the main helper to begin command completion\&. Given the
entered command \fIline\fR it parses it into words and returns a parse
structure as is taken by all other methods taking part in command
completion\&.
.RS
.TP
string \fIline\fR
The command line\&.
.RE
.TP
\fB<actor>\fR \fBroot\fR
This accessor method returns the root actor instance the actor belongs
to\&.
.TP
\fB<actor>\fR \fBset\fR \fIkey\fR \fIdata\fR
This method sets the contents of the common block named by \fIkey\fR
to \fIdata\fR\&. If the block does not exist it is created\&. Otherwise
its existing content is written over\&.
.RS
.TP
string \fIkey\fR
The name of the common block to write\&.
.TP
any \fIdata\fR
The data to store in the block\&.
.RE
.TP
\fB<actor>\fR \fBsuper\fR
This accessor method returns the parent actor instance\&.  For the root
of the tree this is the empty string\&.
.TP
\fB<actor>\fR \fBsuper:\fR \fIobj\fR
This method links the actor to its parent actor\&.
.RS
.TP
cmdr::actor \fIobj\fR
The parent actor instance to remember\&.
.RE
.TP
\fB<actor>\fR \fBundocumented\fR
This method marks the actor as undocumented\&.
.TP
\fB<actor>\fR \fBunset\fR \fIkey\fR
This method removes the common block named by \fIkey\fR
from the actor\&. Note that definitions in parents are
not touched by this\&.
.RS
.TP
string \fIkey\fR
The name of the common block to remove\&.
.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
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

Added embedded/man/files/cmdr_config.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
'\"
'\" Generated from file 'cmdr_config\&.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_config" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_config \- Cmdr - Collection of parameters for privates
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::config\fR \fBnew\fR \fIcontext\fR \fIspec\fR
.sp
\fB::cmdr::config\fR \fBcreate\fR \fIobj\fR \fIcontext\fR \fIspec\fR
.sp
\fB::cmdr::config\fR \fBinteractive\fR ?\fIenable\fR?
.sp
\fB::cmdr::config\fR \fBdisplay\fR \fIdisplaycmd\fR
.sp
\fB<config>\fR \fB@\&.\&.\&.\fR \fI\&.\&.\&.\fR
.sp
\fB<config>\fR \fBarguments\fR
.sp
\fB<config>\fR \fBcomplete\fR \fIline\fR
.sp
\fB<config>\fR \fBcomplete-repl\fR \fIparse\fR
.sp
\fB<config>\fR \fBcomplete-words\fR \fIparse\fR
.sp
\fB<config>\fR \fBcontinued\fR \fIline\fR
.sp
\fB<config>\fR \fBdispatch\fR \fIcmd\fR
.sp
\fB<config>\fR \fBdisplay\fR ?\fIplist\fR?
.sp
\fB<config>\fR \fBdump\fR
.sp
\fB<config>\fR \fBeoptions\fR
.sp
\fB<config>\fR \fBexit\fR
.sp
\fB<config>\fR \fBforce\fR ?\fIallowinteract\fR? ?\fIforcedefered\fR?
.sp
\fB<config>\fR \fBforget\fR
.sp
\fB<config>\fR \fBhas\fR \fIname\fR
.sp
\fB<config>\fR \fBhelp\fR ?\fImode\fR?
.sp
\fB<config>\fR \fBinteract\fR
.sp
\fB<config>\fR \fBinteractive\fR
.sp
\fB<config>\fR \fBlookup\fR \fIname\fR
.sp
\fB<config>\fR \fBlookup-option\fR \fIname\fR
.sp
\fB<config>\fR \fBmissingOptionValue\fR \fIname\fR
.sp
\fB<config>\fR \fBnames\fR
.sp
\fB<config>\fR \fBnotEnough\fR
.sp
\fB<config>\fR \fBoptions\fR
.sp
\fB<config>\fR \fBparse\fR ?\fIword\&.\&.\&.\fR?
.sp
\fB<config>\fR \fBparse-options\fR
.sp
\fB<config>\fR \fBprompt1\fR
.sp
\fB<config>\fR \fBprompt2\fR
.sp
\fB<config>\fR \fBpublic\fR
.sp
\fB<config>\fR \fBraise\fR \fImsg\fR ?\fIword\&.\&.\&.\fR?
.sp
\fB<config>\fR \fBreport\fR \fIwhat\fR \fIdata\fR
.sp
\fB<config>\fR \fBreset\fR
.sp
\fB<config>\fR \fBself\fR
.sp
\fB<config>\fR \fBtooMany\fR
.sp
\fB<config>\fR \fBunknown\fR \fImethod\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\&.
.PP
This package implements the collections of \fBcmdr::parameters\fR
serving 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
configuration 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::config\fR \fBnew\fR \fIcontext\fR \fIspec\fR
Create an auto-named instance of \fBcmdr::config\fR\&.
.sp
\fINot used\fR\&.
.TP
\fB::cmdr::config\fR \fBcreate\fR \fIobj\fR \fIcontext\fR \fIspec\fR
Create a new instance of \fBcmdr::config\fR, named \fIobj\fR\&.
.RS
.TP
string \fIobj\fR
The (command) name of the new config instance\&.
.TP
cmdr::config \fIcontext\fR
The instance command of the \fBcmdr::private\fR instance the configuration
will belong to\&.
.TP
script \fIspec\fR
Tcl-script specifying the parameters in detail\&. Please read
\fICmdr - Specification Language\fR, section --TODO-- for the details\&.
.RE
.TP
\fB::cmdr::config\fR \fBinteractive\fR ?\fIenable\fR?
Class method to change the global interaction default for the
mini-shell of privates\&. The default is to disable this mini-shell
for all privates, and enable it on a per-private basis, through
the specification\&.
.RS
.TP
boolean \fIenable\fR
Defaults to \fBtrue\fR, globally activating the mini-shell\&.
.RE
.TP
\fB::cmdr::config\fR \fBdisplay\fR \fIdisplaycmd\fR
Class method to override the standard display command used by
the mini-shell to show the current state of all parameters\&.
.RS
.TP
commandprefix \fIdisplaycmd\fR
The display command to use\&. The command will be called with a
single argument, a list containing the names of the parameters
to show\&. The command has to format the state of the requested
parameters as a string and return this string as its result\&.
.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\&.
.TP
\fB<config>\fR \fB@\&.\&.\&.\fR \fI\&.\&.\&.\fR
All parameters held by a configuration instance are accessible
through it\&. To this end each parameter named \fBfoo\fR has a
dynamically created accessor method \fB@foo\fR taking the
method and its arguments to apply to the parameter instance\&.
.sp
If no words are specified at all the system defaults to the
application of instance method \fBvalue\fR\&.
.sp
Together with a parameter's ability to access the
configuration holding it having access to a single parameter
instance (like in the various callbacks) provides access to all\&.
.RS
.TP
list \fIlist\fR
.RE
.TP
\fB<config>\fR \fBarguments\fR
This method returns a list of parameter names,
for the parameters which are arguments\&.
.TP
\fB<config>\fR \fBcomplete\fR \fIline\fR
This hook-method for the mini-shell is responsible
for computing the set of completions for the
entered \fIline\fR\&.
.RS
.TP
string \fIline\fR
The command line to complete\&.
.RE
.TP
\fB<config>\fR \fBcomplete-repl\fR \fIparse\fR
This internal method is used by the hook-method \fBcomplete\fR
for the mini-shell, see above\&. It 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<config>\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<config>\fR \fBcontinued\fR \fIline\fR
This hook-method for the mini-shell is responsible for the detection
of a continuation-line in the entered command \fIline\fR\&. It always
returns the boolean value \fBfalse\fR as the mini-shell does not
support continuation lines\&.
.RS
.TP
list \fIlist\fR
.RE
.TP
\fB<config>\fR \fBdispatch\fR \fIcmd\fR
This hook-method for the mini-shell is responsible for
the recognition and execution of the supported commands\&.
.RS
.TP
string \fIcmd\fR
The command line containing the command to run\&.
.RE
.TP
\fB<config>\fR \fBdisplay\fR ?\fIplist\fR?
This method formats the chosen parameters for display and returns
the result as a string\&. This invokes the chosen display callback,
if one was set\&. Without an internal formatter is used instead\&.
.RS
.TP
list \fIplist\fR
The list of parameters (by name) to format for display\&.
If not specified the list default to the set of
\fBpublic\fR parameters plus any undocumented parameters
already set by the user\&.
.RE
.TP
\fB<config>\fR \fBdump\fR
This method formats all parameters for display, using the
internal formatter, and returns the result as a string\&.
Useful for debugging\&.
.TP
\fB<config>\fR \fBeoptions\fR
This method returns a dictionary mapping all possible
option prefixes to a list of full option names with
that prefix\&.
.TP
\fB<config>\fR \fBexit\fR
This hook-method for the mini-shell returns a boolean
value indicating whether the mini-shell was stopped
and has to exit (\fBtrue\fR), or not (\fBfalse\fR)\&.
.TP
\fB<config>\fR \fBforce\fR ?\fIallowinteract\fR? ?\fIforcedefered\fR?
This method forces the calculation of the values for all parameters
in the configuration instance\&. This is the ''completion phase''\&.
.RS
.TP
boolean \fIallowinteract\fR
If specified as \fBfalse\fR parameters allowing the interactive
entry of their value have this feature disabled for the operation\&.
The default is \fBtrue\fR, allowing for the interaction\&.
.TP
boolean \fIforcedefered\fR
If specified as \fBtrue\fR even parameters marked as "defered"
are forced to generate their value\&. The default is \fBfalse\fR,
causing the method to ignore such parameters\&.
.RE
.TP
\fB<config>\fR \fBforget\fR
This method invokes the parameter method \fBforget\fR on all
parameters in the configuration\&.
.TP
\fB<config>\fR \fBhas\fR \fIname\fR
This method checks if the configuration instance contains
a parameter with the specified \fIname\fR and returns a
boolean value indicating whether the parameter exists
(\fBtrue\fR), or not (\fBfalse\fR)\&.
.RS
.TP
string \fIname\fR
The name of the parameter to check for existence
.RE
.TP
\fB<config>\fR \fBhelp\fR ?\fImode\fR?
This method returns the help information for the
parameters held in the configuration\&.
The result of the command is a structure of the form
described in section \fBHelp Information\fR\&.
.RS
.TP
enum \fImode\fR
The possible modes are \fBpublic\fR and \fBinteract\fR\&.
If not specified \fBpublic\fR is the default\&.
In this mode only "documented" parameters are included in the help\&.
In mode "interact", used by the mini-shell undocumented parameters
are included as well, if they are already set by the user\&.
.RE
.TP
\fB<config>\fR \fBinteract\fR
This method invokes the mini-shell for interactive parameter entry\&.
It returns on exit from the shell\&.
The result of the method is the empty string\&.
.TP
\fB<config>\fR \fBinteractive\fR
This accessor method returns a boolean value indicating whether use
of the mini-shell is allowed (\fBtrue\fR), or not (\fBfalse\fR)\&.
.TP
\fB<config>\fR \fBlookup\fR \fIname\fR
This method checks if the configuration instance contains
a parameter with the specified \fIname\fR and returns its
instance\&. An error is thrown if the parameter is not known\&.
.RS
.TP
string \fIname\fR
The name of the parameter to retrieve\&.
.RE
.TP
\fB<config>\fR \fBlookup-option\fR \fIname\fR
This method checks if the configuration instance contains
a parameter controlling the specified option \fIname\fR
and returns its instance\&. An error is thrown if the option
is not known\&.
.RS
.TP
string \fIname\fR
The option flag to find the controlling parameter for\&.
.RE
.TP
\fB<config>\fR \fBmissingOptionValue\fR \fIname\fR
This method throws the standard error for when the option \fIname\fR
requiring an argument value does not have one\&. See the
methods \fBnotEnough\fR and \fBtooMany\fR as well\&.
.RS
.TP
string \fIname\fR
The flag triggering the error\&.
.RE
.TP
\fB<config>\fR \fBnames\fR
This method returns a list of parameter names, for all parameters\&.
.TP
\fB<config>\fR \fBnotEnough\fR
This method throws the standard error for when a command is found
to be supplied with not enough arguments for its parameters\&. See
the methods \fBmissingOptionValue\fR and \fBtooMany\fR as well\&.
.TP
\fB<config>\fR \fBoptions\fR
This method returns a list of the option flags recognized
by the parameters in the configuration\&. This does not include
option prefixes\&.
.TP
\fB<config>\fR \fBparse\fR ?\fIword\&.\&.\&.\fR?
This method parses the words (from the command line) and
maps them to parameters, based on naming (options and flags),
or position (arguments)\&.
.RS
.TP
list \fIword\fR
The words of the command specifying the parameters of the private
holding the configuration instance\&.
.RE
.TP
\fB<config>\fR \fBparse-options\fR
This method is a helper for \fBparse\fR above\&.
Accessing the internal queue initialized by \fBparse\fR
it splits arguments and options, processing all the latter\&.
The arguments are put back into the queue, in the order
they were found in\&.
This is used by parameters (optional arguments) using the
regular threshold-regime to determine acceptance\&. All options
still in the command line must be removed (and processed) to
know the proper number of arguments words left\&.
.TP
\fB<config>\fR \fBprompt1\fR
This hook-method for the mini-shell returns the primary
prompt string to use\&.
.TP
\fB<config>\fR \fBprompt2\fR
This hook-method for the mini-shell returns the secondary
prompt string for use within a continuation\&. As the mini-shell
does not support continuation lines it should not be invoked
ever, and thus always throws an error should it be invoked\&.
.TP
\fB<config>\fR \fBpublic\fR
This method a list of parameter names, for all documented
option and argument parameters\&.
.TP
\fB<config>\fR \fBraise\fR \fImsg\fR ?\fIword\&.\&.\&.\fR?
This method is a helper for methods \fBtooMany\fR, \fBnotEnough\fR,
and \fBmissingOptionValue\fR, doing the bulk of the work\&.
.RS
.TP
string \fImsg\fR
The human-readable error message to use\&.
.TP
list \fIword\fR
The machine-readable (trap-able) error code to use\&.
.RE
.TP
\fB<config>\fR \fBreport\fR \fIwhat\fR \fIdata\fR
This hook-method for the mini-shell is responsible for the
reporting of the command results and handles the display of
the parameter state before a new prompt\&.
.sp
Its result is the empty string\&.
.RS
.TP
enum \fIwhat\fR
The result code of the command, one of \fBok\fR, or \fBfail\fR\&.
.TP
any \fIdata\fR
The result of the command, or an error message in case of failure\&.
.RE
.TP
\fB<config>\fR \fBreset\fR
This method invokes the parameter method \fBreset\fR on all
parameters in the configuration\&.
.TP
\fB<config>\fR \fBself\fR
This method returns the configuration instance itself\&.
.TP
\fB<config>\fR \fBtooMany\fR
This method throws the standard error for when a command is found
to be supplied with too many arguments for its parameters\&. See the
methods \fBmissingOptionValue\fR and \fBnotEnough\fR as well\&.
.TP
\fB<config>\fR \fBunknown\fR \fImethod\fR ?\fIword\&.\&.\&.\fR?
This method is the hook into the TclOO method resolution for the class\&.
It implements the dynamic accessor methods for the parameters held by
the configuration instance\&. See method \fB@\&.\&.\&.\fR at the top\&.
.RS
.TP
list \fIlist\fR
.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
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_help.n.

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_help \- Utilities for help text formatting and setup - Internal
.SH SYNOPSIS
package require \fBcmdr::help \fR
.sp
\fB::cmdr::help\fR \fBauto\fR \fIactor\fR
.sp
.BE
.SH DESCRIPTION







|







238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_help \- Cmdr - Utilities for help text formatting and setup - Internal
.SH SYNOPSIS
package require \fBcmdr::help \fR
.sp
\fB::cmdr::help\fR \fBauto\fR \fIactor\fR
.sp
.BE
.SH DESCRIPTION

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

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help_json" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_help_json \- Formatting help as JSON object
.SH SYNOPSIS
package require \fBcmdr::help::json \fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.







|







238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help_json" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_help_json \- Cmdr - Formatting help as JSON object
.SH SYNOPSIS
package require \fBcmdr::help::json \fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.

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

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help_sql" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_help_sql \- Formatting help as series of SQL commands
.SH SYNOPSIS
package require \fBcmdr::help::sql \fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.







|







238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help_sql" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_help_sql \- Cmdr - Formatting help as series of SQL commands
.SH SYNOPSIS
package require \fBcmdr::help::sql \fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.

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

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
.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







|


|







235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_parameter" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_parameter \- Cmdr - Command parameters
.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

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

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_validate_common" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_validate_common \- Utilities for Validation Types
.SH SYNOPSIS
package require \fBcmdr::validate::common \fR
.sp
\fB::cmdr::validate::common\fR \fBfail\fR \fIp\fR \fIcode\fR \fItype\fR \fIx\fR
.sp
\fB::cmdr::validate::common\fR \fBcomplete-enum\fR \fIchoices\fR \fInocase\fR \fIbuffer\fR
.sp







|







238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_validate_common" n 0 doc "<<unknown>>"
.BS
.SH NAME
cmdr_validate_common \- Cmdr - Utilities for Validation Types
.SH SYNOPSIS
package require \fBcmdr::validate::common \fR
.sp
\fB::cmdr::validate::common\fR \fBfail\fR \fIp\fR \fIcode\fR \fItype\fR \fIx\fR
.sp
\fB::cmdr::validate::common\fR \fBcomplete-enum\fR \fIchoices\fR \fInocase\fR \fIbuffer\fR
.sp

Changes to embedded/man/index.n.

239
240
241
242
243
244
245
246



247
248









































































































































































































































































































































































































































































































249
250
251
252
253
254
255
...
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
...
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
...
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
...
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
...
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
.TH "Keyword Index" n
.BS
.SH INDEX
doc
.RS
arguments
.RS
.TP



\fBfiles/cmdr_changes\&.n\fR
cmdr_changes









































































































































































































































































































































































































































































































.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
command hierarchy
.RS



.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes



.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
command line completion
.RS



.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes



.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
command line handling
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
command tree
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
editing command line
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
help for command line
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
hierarchy of commands
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
interactive command shell
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
optional arguments
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
options
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
parameters
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
processing command line
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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
tree of commands
.RS
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
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








>
>
>


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







 







|
|

|







 







|

>
>
>



>
>
>







 







|
|

|







 







|

>
>
>



>
>
>







 







|
|

|







 







|


<
<
<
<
<
<
|
|

<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
|
|

<
<
<
<
<
<
<
<
<
<
<
<
|
|







 







|
|

|







 







|


<
<
<
<
<
<
|
|

<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<



<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
|
|







 







<
<
<

<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
|
<

<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<



<
<
<











|
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
<
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
...
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
...
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
...
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
...
885
886
887
888
889
890
891
892
893
894






895
896
897
























898
899
900












901
902
903
904
905
906
907
908
909
...
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
...
939
940
941
942
943
944
945
946
947
948






949
950
951







































952
953
954













































955
956
957
958
959
960
961
962
963
...
975
976
977
978
979
980
981



982






























































































































































983

984



























985
986
987



988
989
990
991
992
993
994
995
996
997
998
999
































































































.TH "Keyword Index" n
.BS
.SH INDEX
doc
.RS
arguments
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
command hierarchy
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
command line completion
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
command line handling
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
command tree
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
editing command line
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
help for command line
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
hierarchy of commands
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
interactive command shell
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
\fBfiles/cmdr_help_json\&.n\fR
cmdr_help_json
.TP
\fBfiles/cmdr_help_sql\&.n\fR
cmdr_help_sql
.TP
\fBfiles/cmdr_howto_get_sources\&.n\fR
cmdr_howto_get_sources
.TP
\fBfiles/cmdr_howto_installation\&.n\fR
cmdr_installation
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
optional arguments
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
options
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
parameters
.RS
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
processing command line
.RS
.TP






\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP
























\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP












\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP
\fBfiles/cmdr_parameter\&.n\fR
cmdr_parameter
.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
tree of commands
.RS
.TP






\fBfiles/cmdr_actor\&.n\fR
cmdr_actor
.TP







































\fBfiles/cmdr_changes\&.n\fR
cmdr_changes
.TP













































\fBfiles/cmdr_config\&.n\fR
cmdr_config
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_help\&.n\fR
cmdr_help
.TP
................................................................................
.TP
\fBfiles/cmdr_introduction\&.n\fR
cmdr_introduction
.TP
\fBfiles/cmdr_license\&.n\fR
cmdr_license
.TP



\fBfiles/cmdr_parameter\&.n\fR






























































































































































cmdr_parameter

.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
































































































Changes to embedded/man/toc.n.

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
..
.TH "Table Of Contents" n
.BS
.SH CONTENTS
doc
.RS
.TP



\fBcmdr_changes\fR
\fIfiles/cmdr_changes\&.n\fR: Cmdr - Log of Changes
.TP



\fBcmdr_development\fR
\fIfiles/cmdr_howto_development\&.n\fR: Cmdr - The Developer's Guide
.TP
\fBcmdr_help\fR
\fIfiles/cmdr_help\&.n\fR: Utilities for help text formatting and setup - Internal
.TP
\fBcmdr_help_json\fR
\fIfiles/cmdr_help_json\&.n\fR: Formatting help as JSON object
.TP
\fBcmdr_help_sql\fR
\fIfiles/cmdr_help_sql\&.n\fR: Formatting help as series of SQL commands
.TP
\fBcmdr_howto_get_sources\fR
\fIfiles/cmdr_howto_get_sources\&.n\fR: Cmdr - How To Get The Sources
.TP
\fBcmdr_installation\fR
\fIfiles/cmdr_howto_installation\&.n\fR: Cmdr - The Installer's Guide
.TP
\fBcmdr_introduction\fR
\fIfiles/cmdr_introduction\&.n\fR: Cmdr - Introduction to the project
.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







>
>
>



>
>
>




|


|


|













|
|


|








|



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
..
.TH "Table Of Contents" n
.BS
.SH CONTENTS
doc
.RS
.TP
\fBcmdr_actor\fR
\fIfiles/cmdr_actor\&.n\fR: Cmdr - Base class for officers and privates - Internal
.TP
\fBcmdr_changes\fR
\fIfiles/cmdr_changes\&.n\fR: Cmdr - Log of Changes
.TP
\fBcmdr_config\fR
\fIfiles/cmdr_config\&.n\fR: Cmdr - Collection of parameters for privates
.TP
\fBcmdr_development\fR
\fIfiles/cmdr_howto_development\&.n\fR: Cmdr - The Developer's Guide
.TP
\fBcmdr_help\fR
\fIfiles/cmdr_help\&.n\fR: Cmdr - Utilities for help text formatting and setup - Internal
.TP
\fBcmdr_help_json\fR
\fIfiles/cmdr_help_json\&.n\fR: Cmdr - Formatting help as JSON object
.TP
\fBcmdr_help_sql\fR
\fIfiles/cmdr_help_sql\&.n\fR: Cmdr - Formatting help as series of SQL commands
.TP
\fBcmdr_howto_get_sources\fR
\fIfiles/cmdr_howto_get_sources\&.n\fR: Cmdr - How To Get The Sources
.TP
\fBcmdr_installation\fR
\fIfiles/cmdr_howto_installation\&.n\fR: Cmdr - The Installer's Guide
.TP
\fBcmdr_introduction\fR
\fIfiles/cmdr_introduction\&.n\fR: Cmdr - Introduction to the project
.TP
\fBcmdr_license\fR
\fIfiles/cmdr_license\&.n\fR: Cmdr - License
.TP
\fBcmdr_parameter\fR
\fIfiles/cmdr_parameter\&.n\fR: Cmdr - Command parameters
.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: Cmdr - Utilities for Validation Types
.TP
\fBcmdr_vtypes\fR
\fIfiles/cmdr_vtypes\&.n\fR: Cmdr - Writing custom validation types

Added embedded/www/doc/files/cmdr_actor.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

<html><head>
<title>cmdr_actor - &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_actor.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_actor.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_actor(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_actor - Cmdr - Base class for officers and privates - Internal</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::actor</b> <b class="method">new</b></a></li>
<li><a href="#2"><b class="cmd">::cmdr::actor</b> <b class="method">create</b> <i class="arg">obj</i></a></li>
<li><a href="#3"><b class="cmd">&lt;actor&gt;</b> <b class="method">completions</b> <i class="arg">parse</i> <i class="arg">cmdlist</i></a></li>
<li><a href="#4"><b class="cmd">&lt;actor&gt;</b> <b class="method">description</b></a></li>
<li><a href="#5"><b class="cmd">&lt;actor&gt;</b> <b class="method">description:</b> <i class="arg">text</i></a></li>
<li><a href="#6"><b class="cmd">&lt;actor&gt;</b> <b class="method">dname</b></a></li>
<li><a href="#7"><b class="cmd">&lt;actor&gt;</b> <b class="method">do</b> <span class="opt">?<i class="arg">word...</i>?</span></a></li>
<li><a href="#8"><b class="cmd">&lt;actor&gt;</b> <b class="method">documented</b></a></li>
<li><a href="#9"><b class="cmd">&lt;actor&gt;</b> <b class="method">exists</b> <i class="arg">key</i></a></li>
<li><a href="#10"><b class="cmd">&lt;actor&gt;</b> <b class="method">fullname</b></a></li>
<li><a href="#11"><b class="cmd">&lt;actor&gt;</b> <b class="method">get</b> <i class="arg">key</i></a></li>
<li><a href="#12"><b class="cmd">&lt;actor&gt;</b> <b class="method">help</b></a></li>
<li><a href="#13"><b class="cmd">&lt;actor&gt;</b> <b class="method">keys</b></a></li>
<li><a href="#14"><b class="cmd">&lt;actor&gt;</b> <b class="method">lappend</b> <i class="arg">key</i> <i class="arg">data</i></a></li>
<li><a href="#15"><b class="cmd">&lt;actor&gt;</b> <b class="method">match</b> <i class="arg">parse</i> <i class="arg">cmdlist</i></a></li>
<li><a href="#16"><b class="cmd">&lt;actor&gt;</b> <b class="method">name</b></a></li>
<li><a href="#17"><b class="cmd">&lt;actor&gt;</b> <b class="method">name:</b> <i class="arg">name</i></a></li>
<li><a href="#18"><b class="cmd">&lt;actor&gt;</b> <b class="method">parse-line</b> <i class="arg">line</i></a></li>
<li><a href="#19"><b class="cmd">&lt;actor&gt;</b> <b class="method">root</b></a></li>
<li><a href="#20"><b class="cmd">&lt;actor&gt;</b> <b class="method">set</b> <i class="arg">key</i> <i class="arg">data</i></a></li>
<li><a href="#21"><b class="cmd">&lt;actor&gt;</b> <b class="method">super</b></a></li>
<li><a href="#22"><b class="cmd">&lt;actor&gt;</b> <b class="method">super:</b> <i class="arg">obj</i></a></li>
<li><a href="#23"><b class="cmd">&lt;actor&gt;</b> <b class="method">undocumented</b></a></li>
<li><a href="#24"><b class="cmd">&lt;actor&gt;</b> <b class="method">unset</b> <i class="arg">key</i></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 internal package implements the base class containing functionality
common to <b class="package">cmdr::officer</b> and <b class="package">cmdr::private</b>.
--TODO-- Describe the common parts (common blocks, super chain, completion support, DSL support)</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
command 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::actor</b> <b class="method">new</b></a></dt>
<dd><p>Create an auto-named instance of <b class="class">cmdr::actor</b>.</p>
<p><em>Not used</em>.</p></dd>
<dt><a name="2"><b class="cmd">::cmdr::actor</b> <b class="method">create</b> <i class="arg">obj</i></a></dt>
<dd><p>Create a new instance of <b class="class">cmdr::actor</b>, named <i class="arg">obj</i>.</p></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.</p>
<dl class="definitions">
<dt><a name="3"><b class="cmd">&lt;actor&gt;</b> <b class="method">completions</b> <i class="arg">parse</i> <i class="arg">cmdlist</i></a></dt>
<dd><p>This method is given the completion state <i class="arg">parse</i> of a partial
command line and a list of completions at the end of the line. It
returns a list of strings which are the valid completions of the whole
line, properly quoted.</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>
<dt>list <i class="arg">cmdlist</i></dt>
<dd><p>List of valid completions.</p></dd>
</dl></dd>
<dt><a name="4"><b class="cmd">&lt;actor&gt;</b> <b class="method">description</b></a></dt>
<dd><p>This accessor method returns the human-readable description of the
actor.</p></dd>
<dt><a name="5"><b class="cmd">&lt;actor&gt;</b> <b class="method">description:</b> <i class="arg">text</i></a></dt>
<dd><p>This method sets the description of the actor to the <i class="arg">text</i>.</p>
<dl class="arguments">
<dt>string <i class="arg">text</i></dt>
<dd><p>The description to remember.</p></dd>
</dl></dd>
<dt><a name="6"><b class="cmd">&lt;actor&gt;</b> <b class="method">dname</b></a></dt>
<dd><p>This accessor method returns the display name of the actor.  This is
the <b class="method">name</b> of the actor prefixed with the contents of the
reserved common block <b class="const">*prefix*</b>, set during command line
processing with the actual command path to reach the current actor.</p></dd>
<dt><a name="7"><b class="cmd">&lt;actor&gt;</b> <b class="method">do</b> <span class="opt">?<i class="arg">word...</i>?</span></a></dt>
<dd><p>This method processes the command-line given as a list of words.  Here
in the bse class it does nothing. It is a virtual method expecting to
be redefined by the derived classes.</p>
<dl class="arguments">
<dt>list <i class="arg">word</i></dt>
<dd></dd>
</dl></dd>
<dt><a name="8"><b class="cmd">&lt;actor&gt;</b> <b class="method">documented</b></a></dt>
<dd><p>This accessor method returns the &quot;documented&quot; flag of the actor.</p></dd>
<dt><a name="9"><b class="cmd">&lt;actor&gt;</b> <b class="method">exists</b> <i class="arg">key</i></a></dt>
<dd><p>This method returns a boolean value indicating whether the common
block named by <i class="arg">key</i> exists in the actor and its parents
(<b class="const">true</b>), or not (<b class="const">false</b>).</p>
<dl class="arguments">
<dt>string <i class="arg">key</i></dt>
<dd><p>The name of the common block to check for.</p></dd>
</dl></dd>
<dt><a name="10"><b class="cmd">&lt;actor&gt;</b> <b class="method">fullname</b></a></dt>
<dd><p>This method returns the full name of the actor.
This is the <b class="method">name</b> of the actor prefixed with the path to it in
the specification, i.e. the names of all actors in the chain of
supers.</p></dd>
<dt><a name="11"><b class="cmd">&lt;actor&gt;</b> <b class="method">get</b> <i class="arg">key</i></a></dt>
<dd><p>This method returns the content of the common block named by
<i class="arg">key</i>. An error is thrown if the block is not known to the actor,
nor its parents.</p>
<dl class="arguments">
<dt>string <i class="arg">key</i></dt>
<dd><p>The name of the common block to retrieve.</p></dd>
</dl></dd>
<dt><a name="12"><b class="cmd">&lt;actor&gt;</b> <b class="method">help</b></a></dt>
<dd><p>This accessor method returns the empty string. It is a virtual method
expecting to be redefined by the derived classes.</p></dd>
<dt><a name="13"><b class="cmd">&lt;actor&gt;</b> <b class="method">keys</b></a></dt>
<dd><p>This accessor method returns a list of names for the set of common
blocks known to this actor, and all of its parents.</p></dd>
<dt><a name="14"><b class="cmd">&lt;actor&gt;</b> <b class="method">lappend</b> <i class="arg">key</i> <i class="arg">data</i></a></dt>
<dd><p>This method extends the contents of the common block named
by <i class="arg">key</i> with <i class="arg">data</i>.
Conceptually this is a get/lappend/set operation, i.e. while the
existing block content is taken from the actor or its parents, the new
content is always stored in the actor.</p>
<dl class="arguments">
<dt>string <i class="arg">key</i></dt>
<dd><p>The name of the common block to extend.</p></dd>
<dt>any <i class="arg">data</i></dt>
<dd><p>The data to add to the block.</p></dd>
</dl></dd>
<dt><a name="15"><b class="cmd">&lt;actor&gt;</b> <b class="method">match</b> <i class="arg">parse</i> <i class="arg">cmdlist</i></a></dt>
<dd><p>This method is given the completion state <i class="arg">parse</i> of a partial
command line and a list of possible completions. The result is a list
of valid completions, filtered against the current word in the command
line.</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>
<dt>list <i class="arg">cmdlist</i></dt>
<dd><p>List of possible completions.</p></dd>
</dl></dd>
<dt><a name="16"><b class="cmd">&lt;actor&gt;</b> <b class="method">name</b></a></dt>
<dd><p>This accessor method returns the name of the actor.</p></dd>
<dt><a name="17"><b class="cmd">&lt;actor&gt;</b> <b class="method">name:</b> <i class="arg">name</i></a></dt>
<dd><p>This method sets the name of the actor.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The name to remember.</p></dd>
</dl></dd>
<dt><a name="18"><b class="cmd">&lt;actor&gt;</b> <b class="method">parse-line</b> <i class="arg">line</i></a></dt>
<dd><p>This method is the main helper to begin command completion. Given the
entered command <i class="arg">line</i> it parses it into words and returns a parse
structure as is taken by all other methods taking part in command
completion.</p>
<dl class="arguments">
<dt>string <i class="arg">line</i></dt>
<dd><p>The command line.</p></dd>
</dl></dd>
<dt><a name="19"><b class="cmd">&lt;actor&gt;</b> <b class="method">root</b></a></dt>
<dd><p>This accessor method returns the root actor instance the actor belongs
to.</p></dd>
<dt><a name="20"><b class="cmd">&lt;actor&gt;</b> <b class="method">set</b> <i class="arg">key</i> <i class="arg">data</i></a></dt>
<dd><p>This method sets the contents of the common block named by <i class="arg">key</i>
to <i class="arg">data</i>. If the block does not exist it is created. Otherwise
its existing content is written over.</p>
<dl class="arguments">
<dt>string <i class="arg">key</i></dt>
<dd><p>The name of the common block to write.</p></dd>
<dt>any <i class="arg">data</i></dt>
<dd><p>The data to store in the block.</p></dd>
</dl></dd>
<dt><a name="21"><b class="cmd">&lt;actor&gt;</b> <b class="method">super</b></a></dt>
<dd><p>This accessor method returns the parent actor instance.  For the root
of the tree this is the empty string.</p></dd>
<dt><a name="22"><b class="cmd">&lt;actor&gt;</b> <b class="method">super:</b> <i class="arg">obj</i></a></dt>
<dd><p>This method links the actor to its parent actor.</p>
<dl class="arguments">
<dt>cmdr::actor <i class="arg">obj</i></dt>
<dd><p>The parent actor instance to remember.</p></dd>
</dl></dd>
<dt><a name="23"><b class="cmd">&lt;actor&gt;</b> <b class="method">undocumented</b></a></dt>
<dd><p>This method marks the actor as undocumented.</p></dd>
<dt><a name="24"><b class="cmd">&lt;actor&gt;</b> <b class="method">unset</b> <i class="arg">key</i></a></dt>
<dd><p>This method removes the common block named by <i class="arg">key</i>
from the actor. Note that definitions in parents are
not touched by this.</p>
<dl class="arguments">
<dt>string <i class="arg">key</i></dt>
<dd><p>The name of the common block to remove.</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>
<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>

Added embedded/www/doc/files/cmdr_config.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

<html><head>
<title>cmdr_config - &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_config.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_config.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_config(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_config - Cmdr - Collection of parameters for privates</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::config</b> <b class="method">new</b> <i class="arg">context</i> <i class="arg">spec</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr::config</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">context</i> <i class="arg">spec</i></a></li>
<li><a href="#3"><b class="cmd">::cmdr::config</b> <b class="method">interactive</b> <span class="opt">?<i class="arg">enable</i>?</span></a></li>
<li><a href="#4"><b class="cmd">::cmdr::config</b> <b class="method">display</b> <i class="arg">displaycmd</i></a></li>
<li><a href="#5"><b class="cmd">&lt;config&gt;</b> <b class="method">@...</b> <i class="arg">...</i></a></li>
<li><a href="#6"><b class="cmd">&lt;config&gt;</b> <b class="method">arguments</b></a></li>
<li><a href="#7"><b class="cmd">&lt;config&gt;</b> <b class="method">complete</b> <i class="arg">line</i></a></li>
<li><a href="#8"><b class="cmd">&lt;config&gt;</b> <b class="method">complete-repl</b> <i class="arg">parse</i></a></li>
<li><a href="#9"><b class="cmd">&lt;config&gt;</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></li>
<li><a href="#10"><b class="cmd">&lt;config&gt;</b> <b class="method">continued</b> <i class="arg">line</i></a></li>
<li><a href="#11"><b class="cmd">&lt;config&gt;</b> <b class="method">dispatch</b> <i class="arg">cmd</i></a></li>
<li><a href="#12"><b class="cmd">&lt;config&gt;</b> <b class="method">display</b> <span class="opt">?<i class="arg">plist</i>?</span></a></li>
<li><a href="#13"><b class="cmd">&lt;config&gt;</b> <b class="method">dump</b></a></li>
<li><a href="#14"><b class="cmd">&lt;config&gt;</b> <b class="method">eoptions</b></a></li>
<li><a href="#15"><b class="cmd">&lt;config&gt;</b> <b class="method">exit</b></a></li>
<li><a href="#16"><b class="cmd">&lt;config&gt;</b> <b class="method">force</b> <span class="opt">?<i class="arg">allowinteract</i>?</span> <span class="opt">?<i class="arg">forcedefered</i>?</span></a></li>
<li><a href="#17"><b class="cmd">&lt;config&gt;</b> <b class="method">forget</b></a></li>
<li><a href="#18"><b class="cmd">&lt;config&gt;</b> <b class="method">has</b> <i class="arg">name</i></a></li>
<li><a href="#19"><b class="cmd">&lt;config&gt;</b> <b class="method">help</b> <span class="opt">?<i class="arg">mode</i>?</span></a></li>
<li><a href="#20"><b class="cmd">&lt;config&gt;</b> <b class="method">interact</b></a></li>
<li><a href="#21"><b class="cmd">&lt;config&gt;</b> <b class="method">interactive</b></a></li>
<li><a href="#22"><b class="cmd">&lt;config&gt;</b> <b class="method">lookup</b> <i class="arg">name</i></a></li>
<li><a href="#23"><b class="cmd">&lt;config&gt;</b> <b class="method">lookup-option</b> <i class="arg">name</i></a></li>
<li><a href="#24"><b class="cmd">&lt;config&gt;</b> <b class="method">missingOptionValue</b> <i class="arg">name</i></a></li>
<li><a href="#25"><b class="cmd">&lt;config&gt;</b> <b class="method">names</b></a></li>
<li><a href="#26"><b class="cmd">&lt;config&gt;</b> <b class="method">notEnough</b></a></li>
<li><a href="#27"><b class="cmd">&lt;config&gt;</b> <b class="method">options</b></a></li>
<li><a href="#28"><b class="cmd">&lt;config&gt;</b> <b class="method">parse</b> <span class="opt">?<i class="arg">word...</i>?</span></a></li>
<li><a href="#29"><b class="cmd">&lt;config&gt;</b> <b class="method">parse-options</b></a></li>
<li><a href="#30"><b class="cmd">&lt;config&gt;</b> <b class="method">prompt1</b></a></li>
<li><a href="#31"><b class="cmd">&lt;config&gt;</b> <b class="method">prompt2</b></a></li>
<li><a href="#32"><b class="cmd">&lt;config&gt;</b> <b class="method">public</b></a></li>
<li><a href="#33"><b class="cmd">&lt;config&gt;</b> <b class="method">raise</b> <i class="arg">msg</i> <span class="opt">?<i class="arg">word...</i>?</span></a></li>
<li><a href="#34"><b class="cmd">&lt;config&gt;</b> <b class="method">report</b> <i class="arg">what</i> <i class="arg">data</i></a></li>
<li><a href="#35"><b class="cmd">&lt;config&gt;</b> <b class="method">reset</b></a></li>
<li><a href="#36"><b class="cmd">&lt;config&gt;</b> <b class="method">self</b></a></li>
<li><a href="#37"><b class="cmd">&lt;config&gt;</b> <b class="method">tooMany</b></a></li>
<li><a href="#38"><b class="cmd">&lt;config&gt;</b> <b class="method">unknown</b> <i class="arg">method</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 the collections of <b class="package">cmdr::parameters</b>
serving 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
configuration 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::config</b> <b class="method">new</b> <i class="arg">context</i> <i class="arg">spec</i></a></dt>
<dd><p>Create an auto-named instance of <b class="class">cmdr::config</b>.</p>
<p><em>Not used</em>.</p></dd>
<dt><a name="2"><b class="cmd">::cmdr::config</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">context</i> <i class="arg">spec</i></a></dt>
<dd><p>Create a new instance of <b class="class">cmdr::config</b>, named <i class="arg">obj</i>.</p>
<dl class="arguments">
<dt>string <i class="arg">obj</i></dt>
<dd><p>The (command) name of the new config instance.</p></dd>
<dt>cmdr::config <i class="arg">context</i></dt>
<dd><p>The instance command of the <b class="package">cmdr::private</b> instance the configuration
will belong to.</p></dd>
<dt>script <i class="arg">spec</i></dt>
<dd><p>Tcl-script specifying the parameters in detail. Please read
<i class="term">Cmdr - Specification Language</i>, section --TODO-- for the details.</p></dd>
</dl></dd>
<dt><a name="3"><b class="cmd">::cmdr::config</b> <b class="method">interactive</b> <span class="opt">?<i class="arg">enable</i>?</span></a></dt>
<dd><p>Class method to change the global interaction default for the
mini-shell of privates. The default is to disable this mini-shell
for all privates, and enable it on a per-private basis, through
the specification.</p>
<dl class="arguments">
<dt>boolean <i class="arg">enable</i></dt>
<dd><p>Defaults to <b class="const">true</b>, globally activating the mini-shell.</p></dd>
</dl></dd>
<dt><a name="4"><b class="cmd">::cmdr::config</b> <b class="method">display</b> <i class="arg">displaycmd</i></a></dt>
<dd><p>Class method to override the standard display command used by
the mini-shell to show the current state of all parameters.</p>
<dl class="arguments">
<dt>commandprefix <i class="arg">displaycmd</i></dt>
<dd><p>The display command to use. The command will be called with a
single argument, a list containing the names of the parameters
to show. The command has to format the state of the requested
parameters as a string and return this string as its result.</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.</p>
<dl class="definitions">
<dt><a name="5"><b class="cmd">&lt;config&gt;</b> <b class="method">@...</b> <i class="arg">...</i></a></dt>
<dd><p>All parameters held by a configuration instance are accessible
through it. To this end each parameter named <b class="variable">foo</b> has a
dynamically created accessor method <b class="method">@foo</b> taking the
method and its arguments to apply to the parameter instance.</p>
<p>If no words are specified at all the system defaults to the
application of instance method <b class="method">value</b>.</p>
<p>Together with a parameter's ability to access the
configuration holding it having access to a single parameter
instance (like in the various callbacks) provides access to all.</p>
<dl class="arguments">
<dt>list <i class="arg">list</i></dt>
<dd></dd>
</dl></dd>
<dt><a name="6"><b class="cmd">&lt;config&gt;</b> <b class="method">arguments</b></a></dt>
<dd><p>This method returns a list of parameter names,
for the parameters which are arguments.</p></dd>
<dt><a name="7"><b class="cmd">&lt;config&gt;</b> <b class="method">complete</b> <i class="arg">line</i></a></dt>
<dd><p>This hook-method for the mini-shell is responsible
for computing the set of completions for the
entered <i class="arg">line</i>.</p>
<dl class="arguments">
<dt>string <i class="arg">line</i></dt>
<dd><p>The command line to complete.</p></dd>
</dl></dd>
<dt><a name="8"><b class="cmd">&lt;config&gt;</b> <b class="method">complete-repl</b> <i class="arg">parse</i></a></dt>
<dd><p>This internal method is used by the hook-method <b class="method">complete</b>
for the mini-shell, see above. It 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="9"><b class="cmd">&lt;config&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="10"><b class="cmd">&lt;config&gt;</b> <b class="method">continued</b> <i class="arg">line</i></a></dt>
<dd><p>This hook-method for the mini-shell is responsible for the detection
of a continuation-line in the entered command <i class="arg">line</i>. It always
returns the boolean value <b class="const">false</b> as the mini-shell does not
support continuation lines.</p>
<dl class="arguments">
<dt>list <i class="arg">list</i></dt>
<dd></dd>
</dl></dd>
<dt><a name="11"><b class="cmd">&lt;config&gt;</b> <b class="method">dispatch</b> <i class="arg">cmd</i></a></dt>
<dd><p>This hook-method for the mini-shell is responsible for
the recognition and execution of the supported commands.</p>
<dl class="arguments">
<dt>string <i class="arg">cmd</i></dt>
<dd><p>The command line containing the command to run.</p></dd>
</dl></dd>
<dt><a name="12"><b class="cmd">&lt;config&gt;</b> <b class="method">display</b> <span class="opt">?<i class="arg">plist</i>?</span></a></dt>
<dd><p>This method formats the chosen parameters for display and returns
the result as a string. This invokes the chosen display callback,
if one was set. Without an internal formatter is used instead.</p>
<dl class="arguments">
<dt>list <i class="arg">plist</i></dt>
<dd><p>The list of parameters (by name) to format for display.
If not specified the list default to the set of
<b class="method">public</b> parameters plus any undocumented parameters
already set by the user.</p></dd>
</dl></dd>
<dt><a name="13"><b class="cmd">&lt;config&gt;</b> <b class="method">dump</b></a></dt>
<dd><p>This method formats all parameters for display, using the
internal formatter, and returns the result as a string.
Useful for debugging.</p></dd>
<dt><a name="14"><b class="cmd">&lt;config&gt;</b> <b class="method">eoptions</b></a></dt>
<dd><p>This method returns a dictionary mapping all possible
option prefixes to a list of full option names with
that prefix.</p></dd>
<dt><a name="15"><b class="cmd">&lt;config&gt;</b> <b class="method">exit</b></a></dt>
<dd><p>This hook-method for the mini-shell returns a boolean
value indicating whether the mini-shell was stopped
and has to exit (<b class="const">true</b>), or not (<b class="const">false</b>).</p></dd>
<dt><a name="16"><b class="cmd">&lt;config&gt;</b> <b class="method">force</b> <span class="opt">?<i class="arg">allowinteract</i>?</span> <span class="opt">?<i class="arg">forcedefered</i>?</span></a></dt>
<dd><p>This method forces the calculation of the values for all parameters
in the configuration instance. This is the ''completion phase''.</p>
<dl class="arguments">
<dt>boolean <i class="arg">allowinteract</i></dt>
<dd><p>If specified as <b class="const">false</b> parameters allowing the interactive
entry of their value have this feature disabled for the operation.
The default is <b class="const">true</b>, allowing for the interaction.</p></dd>
<dt>boolean <i class="arg">forcedefered</i></dt>
<dd><p>If specified as <b class="const">true</b> even parameters marked as &quot;defered&quot;
are forced to generate their value. The default is <b class="const">false</b>,
causing the method to ignore such parameters.</p></dd>
</dl></dd>
<dt><a name="17"><b class="cmd">&lt;config&gt;</b> <b class="method">forget</b></a></dt>
<dd><p>This method invokes the parameter method <b class="method">forget</b> on all
parameters in the configuration.</p></dd>
<dt><a name="18"><b class="cmd">&lt;config&gt;</b> <b class="method">has</b> <i class="arg">name</i></a></dt>
<dd><p>This method checks if the configuration instance contains
a parameter with the specified <i class="arg">name</i> and returns a
boolean value indicating whether the parameter exists
(<b class="const">true</b>), or not (<b class="const">false</b>).</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The name of the parameter to check for existence</p></dd>
</dl></dd>
<dt><a name="19"><b class="cmd">&lt;config&gt;</b> <b class="method">help</b> <span class="opt">?<i class="arg">mode</i>?</span></a></dt>
<dd><p>This method returns the help information for the
parameters held in the configuration. 
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>enum <i class="arg">mode</i></dt>
<dd><p>The possible modes are <b class="const">public</b> and <b class="const">interact</b>.
If not specified <b class="const">public</b> is the default.
In this mode only &quot;documented&quot; parameters are included in the help.
In mode &quot;interact&quot;, used by the mini-shell undocumented parameters
are included as well, if they are already set by the user.</p></dd>
</dl></dd>
<dt><a name="20"><b class="cmd">&lt;config&gt;</b> <b class="method">interact</b></a></dt>
<dd><p>This method invokes the mini-shell for interactive parameter entry.
It returns on exit from the shell.
The result of the method is the empty string.</p></dd>
<dt><a name="21"><b class="cmd">&lt;config&gt;</b> <b class="method">interactive</b></a></dt>
<dd><p>This accessor method returns a boolean value indicating whether use
of the mini-shell is allowed (<b class="const">true</b>), or not (<b class="const">false</b>).</p></dd>
<dt><a name="22"><b class="cmd">&lt;config&gt;</b> <b class="method">lookup</b> <i class="arg">name</i></a></dt>
<dd><p>This method checks if the configuration instance contains
a parameter with the specified <i class="arg">name</i> and returns its
instance. An error is thrown if the parameter is not known.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The name of the parameter to retrieve.</p></dd>
</dl></dd>
<dt><a name="23"><b class="cmd">&lt;config&gt;</b> <b class="method">lookup-option</b> <i class="arg">name</i></a></dt>
<dd><p>This method checks if the configuration instance contains
a parameter controlling the specified option <i class="arg">name</i>
and returns its instance. An error is thrown if the option
is not known.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The option flag to find the controlling parameter for.</p></dd>
</dl></dd>
<dt><a name="24"><b class="cmd">&lt;config&gt;</b> <b class="method">missingOptionValue</b> <i class="arg">name</i></a></dt>
<dd><p>This method throws the standard error for when the option <i class="arg">name</i>
requiring an argument value does not have one. See the
methods <b class="method">notEnough</b> and <b class="method">tooMany</b> as well.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The flag triggering the error.</p></dd>
</dl></dd>
<dt><a name="25"><b class="cmd">&lt;config&gt;</b> <b class="method">names</b></a></dt>
<dd><p>This method returns a list of parameter names, for all parameters.</p></dd>
<dt><a name="26"><b class="cmd">&lt;config&gt;</b> <b class="method">notEnough</b></a></dt>
<dd><p>This method throws the standard error for when a command is found
to be supplied with not enough arguments for its parameters. See
the methods <b class="method">missingOptionValue</b> and <b class="method">tooMany</b> as well.</p></dd>
<dt><a name="27"><b class="cmd">&lt;config&gt;</b> <b class="method">options</b></a></dt>
<dd><p>This method returns a list of the option flags recognized
by the parameters in the configuration. This does not include
option prefixes.</p></dd>
<dt><a name="28"><b class="cmd">&lt;config&gt;</b> <b class="method">parse</b> <span class="opt">?<i class="arg">word...</i>?</span></a></dt>
<dd><p>This method parses the words (from the command line) and
maps them to parameters, based on naming (options and flags),
or position (arguments).</p>
<dl class="arguments">
<dt>list <i class="arg">word</i></dt>
<dd><p>The words of the command specifying the parameters of the private
holding the configuration instance.</p></dd>
</dl></dd>
<dt><a name="29"><b class="cmd">&lt;config&gt;</b> <b class="method">parse-options</b></a></dt>
<dd><p>This method is a helper for <b class="method">parse</b> above.
Accessing the internal queue initialized by <b class="method">parse</b>
it splits arguments and options, processing all the latter.
The arguments are put back into the queue, in the order
they were found in.
This is used by parameters (optional arguments) using the
regular threshold-regime to determine acceptance. All options
still in the command line must be removed (and processed) to
know the proper number of arguments words left.</p></dd>
<dt><a name="30"><b class="cmd">&lt;config&gt;</b> <b class="method">prompt1</b></a></dt>
<dd><p>This hook-method for the mini-shell returns the primary
prompt string to use.</p></dd>
<dt><a name="31"><b class="cmd">&lt;config&gt;</b> <b class="method">prompt2</b></a></dt>
<dd><p>This hook-method for the mini-shell returns the secondary
prompt string for use within a continuation. As the mini-shell
does not support continuation lines it should not be invoked
ever, and thus always throws an error should it be invoked.</p></dd>
<dt><a name="32"><b class="cmd">&lt;config&gt;</b> <b class="method">public</b></a></dt>
<dd><p>This method a list of parameter names, for all documented
option and argument parameters.</p></dd>
<dt><a name="33"><b class="cmd">&lt;config&gt;</b> <b class="method">raise</b> <i class="arg">msg</i> <span class="opt">?<i class="arg">word...</i>?</span></a></dt>
<dd><p>This method is a helper for methods <b class="method">tooMany</b>, <b class="method">notEnough</b>,
and <b class="method">missingOptionValue</b>, doing the bulk of the work.</p>
<dl class="arguments">
<dt>string <i class="arg">msg</i></dt>
<dd><p>The human-readable error message to use.</p></dd>
<dt>list <i class="arg">word</i></dt>
<dd><p>The machine-readable (trap-able) error code to use.</p></dd>
</dl></dd>
<dt><a name="34"><b class="cmd">&lt;config&gt;</b> <b class="method">report</b> <i class="arg">what</i> <i class="arg">data</i></a></dt>
<dd><p>This hook-method for the mini-shell is responsible for the
reporting of the command results and handles the display of
the parameter state before a new prompt.</p>
<p>Its result is the empty string.</p>
<dl class="arguments">
<dt>enum <i class="arg">what</i></dt>
<dd><p>The result code of the command, one of <b class="const">ok</b>, or <b class="const">fail</b>.</p></dd>
<dt>any <i class="arg">data</i></dt>
<dd><p>The result of the command, or an error message in case of failure.</p></dd>
</dl></dd>
<dt><a name="35"><b class="cmd">&lt;config&gt;</b> <b class="method">reset</b></a></dt>
<dd><p>This method invokes the parameter method <b class="method">reset</b> on all
parameters in the configuration.</p></dd>
<dt><a name="36"><b class="cmd">&lt;config&gt;</b> <b class="method">self</b></a></dt>
<dd><p>This method returns the configuration instance itself.</p></dd>
<dt><a name="37"><b class="cmd">&lt;config&gt;</b> <b class="method">tooMany</b></a></dt>
<dd><p>This method throws the standard error for when a command is found
to be supplied with too many arguments for its parameters. See the
methods <b class="method">missingOptionValue</b> and <b class="method">notEnough</b> as well.</p></dd>
<dt><a name="38"><b class="cmd">&lt;config&gt;</b> <b class="method">unknown</b> <i class="arg">method</i> <span class="opt">?<i class="arg">word...</i>?</span></a></dt>
<dd><p>This method is the hook into the TclOO method resolution for the class.
It implements the dynamic accessor methods for the parameters held by
the configuration instance. See method <b class="method">@...</b> at the top.</p>
<dl class="arguments">
<dt>list <i class="arg">list</i></dt>
<dd></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>
<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_help.html.

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
   <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_help(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_help - Utilities for help text formatting and setup - Internal</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">API</a></li>







|







103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
   <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_help(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_help - Cmdr - Utilities for help text formatting and setup - Internal</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">API</a></li>

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

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
   <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_help_json(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_help_json - Formatting help as JSON object</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">Bugs, Ideas, Feedback</a></li>







|







103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
   <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_help_json(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_help_json - Cmdr - Formatting help as JSON object</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">Bugs, Ideas, Feedback</a></li>

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

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
   <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_help_sql(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_help_sql - Formatting help as series of SQL commands</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">Bugs, Ideas, Feedback</a></li>







|







103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
   <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_help_sql(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_help_sql - Cmdr - Formatting help as series of SQL commands</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">Bugs, Ideas, Feedback</a></li>

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

1
2
3
4
5
6
7
8
9
10
..
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

<html><head>
<title>cmdr_private - &lt;&lt;unknown&gt;&gt;</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></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>


|







 







|








|

|







1
2
3
4
5
6
7
8
9
10
..
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

<html><head>
<title>cmdr_parameter - &lt;&lt;unknown&gt;&gt;</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></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_parameter.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_parameter(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_parameter - Cmdr - Command parameters</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>

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

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
   <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_validate_common(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_validate_common - Utilities for Validation Types</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">API</a></li>







|







103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
   <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_validate_common(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_validate_common - Cmdr - Utilities for Validation Types</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">API</a></li>

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

255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
for the parameter instance <i class="arg">p</i>, and return the associated internal
representation.</p>
<dl class="arguments">
<dt><b class="package">cmdr::parameter</b> <i class="arg">p</i></dt>
<dd><p>The <b class="package">cmdr::parameter</b> instance governing the validation
process. The standard validation types make use of it in case of a
validation failure to generate a proper error message.
See also <i class="term"><a href="cmdr_vcommon.html">Utilities for Validation Types</a></i> for commands helping
with keeping validation error messages uniform.</p></dd>
<dt>string <i class="arg">x</i></dt>
<dd><p>The string value to validate cand convert.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section4" class="section"><h2><a name="section4">Example</a></h2>







|







255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
for the parameter instance <i class="arg">p</i>, and return the associated internal
representation.</p>
<dl class="arguments">
<dt><b class="package">cmdr::parameter</b> <i class="arg">p</i></dt>
<dd><p>The <b class="package">cmdr::parameter</b> instance governing the validation
process. The standard validation types make use of it in case of a
validation failure to generate a proper error message.
See also <i class="term">Utilities for Validation Types</i> for commands helping
with keeping validation error messages uniform.</p></dd>
<dt>string <i class="arg">x</i></dt>
<dd><p>The string value to validate cand convert.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section4" class="section"><h2><a name="section4">Example</a></h2>

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

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
..
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
..
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
   <a href="../../../../../home">Home</a>
| <a href="../index.html">Keyword Index</a>
 ] <hr>
<h3> Table Of Contents </h3>
<hr><dl><dt><h2> doc </h2><dd>
<table class="#toc">
<tr class="#toceven" >




<td class="#tocleft" ><a href="files/cmdr_changes.html">cmdr_changes</a></td>
<td class="#tocright">Cmdr - Log of Changes</td>
</tr>




<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_howto_development.html">cmdr_development</a></td>
<td class="#tocright">Cmdr - The Developer's Guide</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_help.html">cmdr_help</a></td>
<td class="#tocright">Utilities for help text formatting and setup - Internal</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_help_json.html">cmdr_help_json</a></td>
<td class="#tocright">Formatting help as JSON object</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_help_sql.html">cmdr_help_sql</a></td>
<td class="#tocright">Formatting help as series of SQL commands</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_howto_get_sources.html">cmdr_howto_get_sources</a></td>
<td class="#tocright">Cmdr - How To Get The Sources</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_howto_installation.html">cmdr_installation</a></td>
................................................................................
<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>
................................................................................
</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>







>
>
>
>



>
>
>
>






|



|



|







 







|
|







 







|







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
..
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
..
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
   <a href="../../../../../home">Home</a>
| <a href="../index.html">Keyword Index</a>
 ] <hr>
<h3> Table Of Contents </h3>
<hr><dl><dt><h2> doc </h2><dd>
<table class="#toc">
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_actor.html">cmdr_actor</a></td>
<td class="#tocright">Cmdr - Base class for officers and privates - Internal</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_changes.html">cmdr_changes</a></td>
<td class="#tocright">Cmdr - Log of Changes</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_config.html">cmdr_config</a></td>
<td class="#tocright">Cmdr - Collection of parameters for privates</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_howto_development.html">cmdr_development</a></td>
<td class="#tocright">Cmdr - The Developer's Guide</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_help.html">cmdr_help</a></td>
<td class="#tocright">Cmdr - Utilities for help text formatting and setup - Internal</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_help_json.html">cmdr_help_json</a></td>
<td class="#tocright">Cmdr - Formatting help as JSON object</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_help_sql.html">cmdr_help_sql</a></td>
<td class="#tocright">Cmdr - Formatting help as series of SQL commands</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="files/cmdr_howto_get_sources.html">cmdr_howto_get_sources</a></td>
<td class="#tocright">Cmdr - How To Get The Sources</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="files/cmdr_howto_installation.html">cmdr_installation</a></td>
................................................................................
<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_parameter</a></td>
<td class="#tocright">Cmdr - Command parameters</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>
................................................................................
</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">Cmdr - 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_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>







|







|




|




|




|







|







|




|







|







|




|







|




|







|



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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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_actor.html"> cmdr_actor </a> &#183; <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> &#183; <a href="doc/files/cmdr_config.html"> cmdr_config </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_parameter </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.

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
..
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
..
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
   <a href="../../../../home">Home</a>
| <a href="index.html">Keyword Index</a>
 ] <hr>
<h3> Table Of Contents </h3>
<hr><dl><dt><h2> doc </h2><dd>
<table class="#toc">
<tr class="#toceven" >




<td class="#tocleft" ><a href="doc/files/cmdr_changes.html">cmdr_changes</a></td>
<td class="#tocright">Cmdr - Log of Changes</td>
</tr>




<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_howto_development.html">cmdr_development</a></td>
<td class="#tocright">Cmdr - The Developer's Guide</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_help.html">cmdr_help</a></td>
<td class="#tocright">Utilities for help text formatting and setup - Internal</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_help_json.html">cmdr_help_json</a></td>
<td class="#tocright">Formatting help as JSON object</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_help_sql.html">cmdr_help_sql</a></td>
<td class="#tocright">Formatting help as series of SQL commands</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_howto_get_sources.html">cmdr_howto_get_sources</a></td>
<td class="#tocright">Cmdr - How To Get The Sources</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_howto_installation.html">cmdr_installation</a></td>
................................................................................
<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>
................................................................................
</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>







>
>
>
>



>
>
>
>






|



|



|







 







|
|







 







|







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
..
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
..
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
   <a href="../../../../home">Home</a>
| <a href="index.html">Keyword Index</a>
 ] <hr>
<h3> Table Of Contents </h3>
<hr><dl><dt><h2> doc </h2><dd>
<table class="#toc">
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_actor.html">cmdr_actor</a></td>
<td class="#tocright">Cmdr - Base class for officers and privates - Internal</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_changes.html">cmdr_changes</a></td>
<td class="#tocright">Cmdr - Log of Changes</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_config.html">cmdr_config</a></td>
<td class="#tocright">Cmdr - Collection of parameters for privates</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_howto_development.html">cmdr_development</a></td>
<td class="#tocright">Cmdr - The Developer's Guide</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_help.html">cmdr_help</a></td>
<td class="#tocright">Cmdr - Utilities for help text formatting and setup - Internal</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_help_json.html">cmdr_help_json</a></td>
<td class="#tocright">Cmdr - Formatting help as JSON object</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_help_sql.html">cmdr_help_sql</a></td>
<td class="#tocright">Cmdr - Formatting help as series of SQL commands</td>
</tr>
<tr class="#tocodd"  >
<td class="#tocleft" ><a href="doc/files/cmdr_howto_get_sources.html">cmdr_howto_get_sources</a></td>
<td class="#tocright">Cmdr - How To Get The Sources</td>
</tr>
<tr class="#toceven" >
<td class="#tocleft" ><a href="doc/files/cmdr_howto_installation.html">cmdr_installation</a></td>
................................................................................
<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_parameter</a></td>
<td class="#tocright">Cmdr - Command parameters</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>
................................................................................
</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">Cmdr - 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>