[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT] [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_MAIN]]
[description]
[include parts/welcome.inc]

This is the main package of the framework, its public entry point.

It provides four commands for setup and configuration of command
................................................................................
[para] The result of the command is the new instance command.

[list_begin arguments]
[arg_def string name]
The user-visible name of the command (hierarchy).

[arg_def script actions]

The specification of the subordinate commands. On the command line
these are the toplevel commands of the application using the
hierarchy. Please read [term [vset TITLE_DSL]], (section "Officers")
for the details.

[list_end][comment arguments]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr] [method interactive] [opt [arg enable]]]

This command globally (de)activates the interactive parts of the

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT] [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr]
[titledesc [vset TITLE_MAIN]]
[description]
[include parts/welcome.inc]

This is the main package of the framework, its public entry point.

It provides four commands for setup and configuration of command
................................................................................
[para] The result of the command is the new instance command.

[list_begin arguments]
[arg_def string name]
The user-visible name of the command (hierarchy).

[arg_def script actions]

The specification of the subordinate commands. On the command line
these are the toplevel commands of the application using the
hierarchy. Please read [term [vset TITLE_DSL_OFFICER]] for the
details.

[list_end][comment arguments]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr] [method interactive] [opt [arg enable]]]

This command globally (de)activates the interactive parts of the

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_actor [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_ACTOR]]
[description]
[include parts/welcome.inc]

This internal package implements the base class containing functionality
common to [package cmdr::officer] and [package cmdr::private].

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::actor [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::actor]
[titledesc [vset TITLE_ACTOR]]
[description]
[include parts/welcome.inc]

This internal package implements the base class containing functionality
common to [package cmdr::officer] and [package cmdr::private].

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_config [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_CONFIG]]
[description]
[include parts/welcome.inc]

This package implements the collections of [package cmdr::parameters]
serving as the configuration of privates (see [package cmdr::private]).

................................................................................

[arg_def cmdr::config context]
The instance command of the [package cmdr::private] instance the configuration
will belong to.

[arg_def script spec]

Tcl-script specifying the parameters in detail. Please read
[term [vset TITLE_DSL]] (section "Parameters") for the details.

[list_end][comment arguments]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr::config] [method interactive] [opt [arg enable]]]

Class method to change the global interaction default for the

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::config [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::config]
[titledesc [vset TITLE_CONFIG]]
[description]
[include parts/welcome.inc]

This package implements the collections of [package cmdr::parameters]
serving as the configuration of privates (see [package cmdr::private]).

................................................................................

[arg_def cmdr::config context]
The instance command of the [package cmdr::private] instance the configuration
will belong to.

[arg_def script spec]

Tcl-script specifying the parameters in detail.
Please read [term [vset TITLE_DSL_PARAMETER]] for the details.

[list_end][comment arguments]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr::config] [method interactive] [opt [arg enable]]]

Class method to change the global interaction default for the

[include parts/welcome.inc]

This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of command hierarchies
with commands and their parameters by way of examples and then
provides links to the detailed reference documents.

[para] These related documents are:

[include parts/related_dsl.inc]

[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Introductory examples}]

Instead of immediately diving into the full syntax of the
specification language first a few examples to demonstrate the general
look and feel, plus basic features.

[comment ================================================]
[subsection {Basic setup, private with inputs}]
[include parts/ex_alias0.inc]

[comment ================================================]
[subsection {Basic setup, command nesting}]
[include parts/ex_alias1.inc]

[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Language Reference}]

With the examples behind us we can now go and specify the entire
specification language. If you have skipped here on first reading,
ignoring the examples, please go back and read them first.

[include parts/dsl_general.inc]

[para] For the details please continue reading at

[include parts/related_dsl.inc]

[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]

[include parts/welcome.inc]

This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of command hierarchies
with commands and their parameters by way of examples and then
provides links to the detailed reference documents.



[include parts/related_dsl.inc]

[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Introductory examples}]

Instead of immediately diving into the full syntax of the
specification language first a few examples to demonstrate the general
look and feel, plus basic features.

[comment ================================================]
[subsection {Basic private commands with inputs}]
[include parts/ex_alias0.inc]

[comment ================================================]
[subsection {Simple command nesting}]
[include parts/ex_alias1.inc]

[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Language Reference}]

With the examples behind us we can now go and specify the entire
specification language. If you have skipped here on first reading,
ignoring the examples, please go back and read them first.

[include parts/dsl_general.inc]

[para] Please continue reading with [term [vset TITLE_DSL_OFFICER]].



[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]

[manpage_begin [vset PROJECT]_dsl_officer [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[titledesc [vset TITLE_DSL_OFFICER]]
[description]
[include parts/welcome.inc]

This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of officers in detail.

[para] Related documents are:

[include parts/related_dsl.inc]


[include parts/dsl_officer.inc]

[include parts/related_dsl.inc]


[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]

[manpage_begin [vset PROJECT]_dsl_officer [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[titledesc [vset TITLE_DSL_OFFICER]]
[description]
[include parts/welcome.inc]

This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of [term officer]s in
detail.


[include parts/related_dsl.inc]

[section {Language Reference}]
[include parts/dsl_officer.inc]


[para] Please continue reading with [term [vset TITLE_DSL_PRIVATE]].

[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]

[description]
[include parts/welcome.inc]

This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of parameters in
detail.

[para] Related documents are:

[include parts/related_dsl.inc]


[include parts/dsl_parameter.inc]

[include parts/related_dsl.inc]
[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]

[description]
[include parts/welcome.inc]

This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of parameters in
detail.



[include parts/related_dsl.inc]

[section {Language Reference}]
[include parts/dsl_parameter.inc]


[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]

[titledesc [vset TITLE_DSL_PRIVATE]]
[description]
[include parts/welcome.inc]

This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of privates in detail.

[para] Related documents are:

[include parts/related_dsl.inc]


[include parts/dsl_private.inc]

[include parts/related_dsl.inc]


[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]

[titledesc [vset TITLE_DSL_PRIVATE]]
[description]
[include parts/welcome.inc]

This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of privates in detail.



[include parts/related_dsl.inc]

[section {Language Reference}]
[include parts/dsl_private.inc]


[para] Please continue reading with [term [vset TITLE_DSL_PARAMETER]].

[include parts/related.inc]
[include parts/feedback.inc]
[manpage_end]

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help]
[titledesc [vset TITLE_HELP]]
[description]
[include parts/welcome.inc]

This internal package implements the four standard help formats

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::help [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help]
[titledesc [vset TITLE_HELP]]
[description]
[include parts/welcome.inc]

This internal package implements the four standard help formats

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help_json [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help::json]
[titledesc [vset TITLE_HELP_JSON]]
[description]
[include parts/welcome.inc]

This package provides a single command implementing the help format

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::help::json [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help::json]
[titledesc [vset TITLE_HELP_JSON]]
[description]
[include parts/welcome.inc]

This package provides a single command implementing the help format

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_help_sql [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help::sql]
[titledesc [vset TITLE_HELP_SQL]]
[description]
[include parts/welcome.inc]

This package provides a single command implementing the help format

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::help::sql [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::help::sql]
[titledesc [vset TITLE_HELP_SQL]]
[description]
[include parts/welcome.inc]

This package provides a single command implementing the help format

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_officer [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_OFFICER]]
[description]
[include parts/welcome.inc]

This package implements [emph officers], the inner nodes of command
hierarchies.  Each officer can execute many actions, by delegating
them to their sub-ordinate actors, officers and privates.
................................................................................
The instance command of the actor (officer actually) which contains the new officer.

[arg_def string name]
The user-visible name of the command.

[arg_def script actions]
The specification of the officer's subordinates.
Please read [term [vset TITLE_DSL]] (section "Officers") for the details.

[list_end][comment arguments]
[list_end][comment definitions]

[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Instance API}]

................................................................................
The list of names specifying the route from this officer to the new
private. The last element is the name of the private command, while
the preceding names specify the intermediate officers.

[comment {--- TODO place into text block for inclusion --- see private - constructor}]
[arg_def script arguments]
The specification of the private's parameters.
Please read [term [vset TITLE_DSL]] (section "Parameters") for the details.

[arg_def cmd-prefix action]
The command prefix to invoke when this private is selected for
execution.  It takes a single argument, the instance command of the
hidden [package cmdr::config] container holding the private's
parameters. The result of the action, if there is any, is ignored by
the framework.
................................................................................
the set of subordinates known to this officer. This is the same type
of script as used during construction, except here we dynamically
extend the officer.

[list_begin arguments]
[arg_def script actions]
The specification of the officer's additional subordinates.
Please read [term [vset TITLE_DSL]] (section "Officers") for the details.

[list_end][comment arguments]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd <officer>] [method lookup] [arg name]]

This method returns the instance command of the sub-ordinate with the

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::officer [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::officer]
[titledesc [vset TITLE_OFFICER]]
[description]
[include parts/welcome.inc]

This package implements [emph officers], the inner nodes of command
hierarchies.  Each officer can execute many actions, by delegating
them to their sub-ordinate actors, officers and privates.
................................................................................
The instance command of the actor (officer actually) which contains the new officer.

[arg_def string name]
The user-visible name of the command.

[arg_def script actions]
The specification of the officer's subordinates.
Please read [term [vset TITLE_DSL_OFFICER]] for the details.

[list_end][comment arguments]
[list_end][comment definitions]

[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Instance API}]

................................................................................
The list of names specifying the route from this officer to the new
private. The last element is the name of the private command, while
the preceding names specify the intermediate officers.

[comment {--- TODO place into text block for inclusion --- see private - constructor}]
[arg_def script arguments]
The specification of the private's parameters.
Please read [term [vset TITLE_DSL_PARAMETER]] for the details.

[arg_def cmd-prefix action]
The command prefix to invoke when this private is selected for
execution.  It takes a single argument, the instance command of the
hidden [package cmdr::config] container holding the private's
parameters. The result of the action, if there is any, is ignored by
the framework.
................................................................................
the set of subordinates known to this officer. This is the same type
of script as used during construction, except here we dynamically
extend the officer.

[list_begin arguments]
[arg_def script actions]
The specification of the officer's additional subordinates.
Please read [term [vset TITLE_DSL_OFFICER]] for the details.

[list_end][comment arguments]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd <officer>] [method lookup] [arg name]]

This method returns the instance command of the sub-ordinate with the

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_parameter [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_PARAMETER]]
[description]
[include parts/welcome.inc]

This package implements [emph parameters], collections of which (see
[package cmdr::config]) serve as the configuration of privates (see
[package cmdr::private]).
................................................................................
help, if not overridden by a [cmd label] declaration
(in [arg spec]).

[arg_def string description]
Human-readable help text for the parameter.

[arg_def script spec]
Tcl-script specifying the parameter in detail. Please read
[term [vset TITLE_DSL]] (section "Parameters") for the details.

[list_end][comment arguments]
[list_end][comment definitions]

[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Instance API}]

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::parameter [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::parameter]
[titledesc [vset TITLE_PARAMETER]]
[description]
[include parts/welcome.inc]

This package implements [emph parameters], collections of which (see
[package cmdr::config]) serve as the configuration of privates (see
[package cmdr::private]).
................................................................................
help, if not overridden by a [cmd label] declaration
(in [arg spec]).

[arg_def string description]
Human-readable help text for the parameter.

[arg_def script spec]
Tcl-script specifying the parameter in detail.
Please read [term [vset TITLE_DSL_PARAMETER]] for the details.

[list_end][comment arguments]
[list_end][comment definitions]

[comment @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@]
[section {Instance API}]

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_private [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_PRIVATE]]
[description]
[include parts/welcome.inc]

This package implements [emph privates], the leaves of command
hierarchies.  While each private can execute only a single action they
have parameters, i.e. arguments and options with which to configure
................................................................................

[arg_def string name]
The user-visible name of the command.

[comment {--- TODO place into text block for inclusion --- see officer - extend}]
[arg_def script arguments]
The specification of the private's parameters.
Please read [term [vset TITLE_DSL]] (section "Privates") for the details.

[arg_def cmd-prefix action]
The command prefix to invoke when this private is selected for
execution.  It takes a single argument, the instance command of the
hidden [package cmdr::config] container holding the private's
parameters. The result of the action, if there is any, is ignored by
the framework.

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::private [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::private]
[titledesc [vset TITLE_PRIVATE]]
[description]
[include parts/welcome.inc]

This package implements [emph privates], the leaves of command
hierarchies.  While each private can execute only a single action they
have parameters, i.e. arguments and options with which to configure
................................................................................

[arg_def string name]
The user-visible name of the command.

[comment {--- TODO place into text block for inclusion --- see officer - extend}]
[arg_def script arguments]
The specification of the private's parameters.
Please read [term [vset TITLE_DSL_PRIVATE]] for the details.

[arg_def cmd-prefix action]
The command prefix to invoke when this private is selected for
execution.  It takes a single argument, the instance command of the
hidden [package cmdr::config] container holding the private's
parameters. The result of the action, if there is any, is ignored by
the framework.

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_util [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_UTIL]]
[description]
[include parts/welcome.inc]

This internal package provides a single utility command.

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::util [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_UTIL]]
[description]
[include parts/welcome.inc]

This internal package provides a single utility command.

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_validate [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::validate]
[titledesc [vset TITLE_VALIDATE]]
[description]
[include parts/welcome.inc]

This internal package implements the twelve standard validation types

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::validate [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::validate]
[titledesc [vset TITLE_VALIDATE]]
[description]
[include parts/welcome.inc]

This internal package implements the twelve standard validation types

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]_validate_common [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::validate::common]
[titledesc [vset TITLE_VCOMMON]]
[description]
[include parts/welcome.inc]

This package publicly exports three commands for use in the

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[manpage_begin [vset PROJECT]::validate::common [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::validate::common]
[titledesc [vset TITLE_VCOMMON]]
[description]
[include parts/welcome.inc]

This package publicly exports three commands for use in the

[manpage_begin [vset PROJECT]_vtypes [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::validate]
[titledesc [vset TITLE_DEV_VT]]
[description]
[include parts/welcome.inc]

This document describes the API expected of validation types to make
them usable within the [vset PTITLE] framework, and how to write a
custom validation type.

[para] Readers interested in the standard validation types of the
framework should read [term [vset TITLE_VALIDATE]].

[section Background]

Validation types are [vset PTITLE]'s answer to the necessity of moving
................................................................................
[para] Because of the same necessity all parameters must have a
validation type assigned to them, and the framework will choose which,
if the user did not. This choice is made per the six rules below and
always returns one of the builtins described in [term [vset TITLE_VALIDATE]].

[list_begin enumerated]
[enum] Use [const identity] if a  [cmd generate] callback is specified.
[enum] Use [const boolean]  if no [cmd default] is specified and the parameter is an option.
[enum] Use [const identity] if no [cmd default] is specified and the parameter is an input.
[enum] Use [const boolean]  if the specified [cmd default] value is a Tcl boolean.
[enum] Use [const integer]  if the specified [cmd default] value is a Tcl integer.
[enum] Use [const identity] as fallback of last resort.
[list_end]

[para] The general concept of validation types was taken from package
[package snit], and modified to suit [vset PTITLE]. Where snit's types

expect only a single method to validate the input we expect all types
to support an ensemble of [emph four] methods. One for the basic


validation and transformation of the input, another for the release of
any internal representation so generated, plus two more for delivery
of a default representation and support for command line completion.


The details (method names, signatures, etc.) can be found in section
[sectref API] below.

[para] As an example the implementation of the standard boolean
validation type is shown in section [sectref Example].

[para] It should be noted that while snit's validation types in
principle allow for the transformation of input into a disparate
internal representation, they never went so far as to allow complex
representations which might require the release of resources after
use.

[para] The [cmd validate] and [cmd release] methods are primarily used
during either completion or execution phases, depending on the chosen


deferal state. They may also be used during parsing, for optional
inputs under the [cmd test]-regime].

[para] The [cmd complete] method will be used whereever the system
activates an interactive command line shell where arguments may be
assigned to parameters.

[para] The [cmd default] method on the other hand can expect to be
invoked during dispatch, as part of the system's declaration
processing, if not preempted by [cmd default] and [cmd generate]
declarations for the parameter. Note here that the [cmd default]


method has the same signature as a [cmd generate] callback and can be

used as such. This is actually needed and useful when the default
internal representation for a validation type cannot be expressed as a
fixed value and its creation while parsing the specification itself is


too early. We can still use the validation type for its generation, by
hooking it explicitly into [cmd generate] to change the timing of its
invokation.

[section API]

In the descriptions below the [cmd cmd] is a placeholder for the
actual command prefix, most often a main command, of the validation
type.

[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd cmd] [method complete] [arg p] [arg x]]

This method is invoked during command completion done by the framework.

[para] It has to return the list of legal string representations for
the type and parameter instance [arg p] which have the incomplete word
[arg x] as their prefix.

................................................................................
custom type may have need for access to the context of the completion.

[arg_def string x]
The string value to complete.
[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd cmd] [method default] [arg p]]

This method is invoked when the framework has to determine the
internal representation of a parameter which has no user-specified
string representation.

[para] It has to return the default internal representation for
the type and parameter instance [arg p].
................................................................................
do not make use of it a custom type may have need for access to the
context.

[arg_def string x]
The string value to complete.
[list_end]


[comment {- - -- --- ----- -------- -------------}]
[call [cmd cmd] [method release] [arg p] [arg x]]

This method is invoked when the framework has to get rid of an
internal representation for a parameter.

[para] It has to release any resources associated with the internal
representation [arg x] of parameter instance [arg p].

................................................................................
of the completion.

[arg_def string x]
The internal representation to release.
[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd cmd] [method validate] [arg p] [arg x]]

This method is invoked during to validate and convert a string
representation.

[para] It has to verify that [arg x] is a legal string representation
for the parameter instance [arg p], and return the associated internal
representation.

[manpage_begin [vset PROJECT]_vtypes [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::validate]
[titledesc [vset TITLE_DEV_VT]]
[description]
[include parts/welcome.inc]

This document describes the API expected of [term {validation types}]
to make them usable within the [vset PTITLE] framework, and how to
write a custom validation type.

[para] Readers interested in the standard validation types of the
framework should read [term [vset TITLE_VALIDATE]].

[section Background]

Validation types are [vset PTITLE]'s answer to the necessity of moving
................................................................................
[para] Because of the same necessity all parameters must have a
validation type assigned to them, and the framework will choose which,
if the user did not. This choice is made per the six rules below and
always returns one of the builtins described in [term [vset TITLE_VALIDATE]].

[list_begin enumerated]
[enum] Use [const identity] if a  [cmd generate] callback is specified.
[enum] Use [const boolean]  if no [cmd default] is specified and the parameter is an [term option].
[enum] Use [const identity] if no [cmd default] is specified and the parameter is an [term input].
[enum] Use [const boolean]  if the specified [cmd default] value is a Tcl boolean.
[enum] Use [const integer]  if the specified [cmd default] value is a Tcl integer.
[enum] Use [const identity] as fallback of last resort.
[list_end]

[para] The general concept of [term {validation types}] was taken from
package [package snit], and modified to suit [vset PTITLE].

Where [package snit]'s types expect only a single method to validate
the input we expect all types to support an ensemble of [emph four]
methods.

One for the basic validation and transformation of the string, another
for the release of any internal representation so generated, plus two
more for delivery of a default representation and support for command
line completion.

The details (method names, signatures, etc.) can be found in section
[sectref API] below.

[para] As an example the implementation of the standard boolean
validation type is shown in section [sectref Example].

[para] It should be noted that while [package snit]'s validation types
in principle allow for the transformation of input into a disparate
internal representation, they never went so far as to allow complex
representations which might require the release of resources after
use.

[para] The [cmd validate] and [cmd release] methods are primarily used
during either [term Completion] or [term Execution] phases, depending
on the chosen deferal state.

They may also be used during the [term Parsing] phase, for optional
[term inputs] under the [cmd test]-regime].

[para] The [cmd complete] method will be used whereever the system
activates an interactive command line shell where arguments may be
assigned to parameters.

[para] The [cmd default] method on the other hand can expect to be
invoked during the [term Dispatch] phase, as part of the system's
declaration processing, if not preempted by [cmd default] and
[cmd generate] declarations for the parameter.

Note here that the [cmd default] method has the same signature as a
paramete's [cmd generate] callback and can be used as such.

This is actually needed and useful when the default internal
representation for a validation type cannot be expressed as a fixed
value and its creation while parsing the specification itself is too
early.

We can still use the validation type for its generation, by hooking it
explicitly into [cmd generate] to change the timing of its invokation.


[section API]

In the descriptions below the [cmd <v-type>] is a placeholder for the
actual command prefix, most often a main command, of the validation
type.

[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd <v-type>] [method complete] [arg p] [arg x]]

This method is invoked during command completion done by the framework.

[para] It has to return the list of legal string representations for
the type and parameter instance [arg p] which have the incomplete word
[arg x] as their prefix.

................................................................................
custom type may have need for access to the context of the completion.

[arg_def string x]
The string value to complete.
[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd <v-type>] [method default] [arg p]]

This method is invoked when the framework has to determine the
internal representation of a parameter which has no user-specified
string representation.

[para] It has to return the default internal representation for
the type and parameter instance [arg p].
................................................................................
do not make use of it a custom type may have need for access to the
context.

[arg_def string x]
The string value to complete.
[list_end]


[comment {- - -- --- ----- -------- -------------}]
[call [cmd <v-type>] [method release] [arg p] [arg x]]

This method is invoked when the framework has to get rid of an
internal representation for a parameter.

[para] It has to release any resources associated with the internal
representation [arg x] of parameter instance [arg p].

................................................................................
of the completion.

[arg_def string x]
The internal representation to release.
[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd <v-type>] [method validate] [arg p] [arg x]]

This method is invoked during to validate and convert a string
representation.

[para] It has to verify that [arg x] is a legal string representation
for the parameter instance [arg p], and return the associated internal
representation.

[include configuration.inc]
[vset TITLE_INTRO    "[vset PTITLE] - Introduction to the project"]
[vset TITLE_LICENSE  "[vset PTITLE] - License"			 ]
[vset TITLE_CHANGES  "[vset PTITLE] - Log of Changes"    	 ]
[vset TITLE_SOURCES  "[vset PTITLE] - How To Get The Sources"	 ]
[vset TITLE_INSTALL  "[vset PTITLE] - The Installer's Guide"	 ]
[vset TITLE_DEV      "[vset PTITLE] - The Developer's Guide"	 ]

[comment {- Custom documents & titles - - -- --- ----- --------}]
[vset TITLE_MAIN      "[vset PTITLE] - Main package and API"]
[vset TITLE_ACTOR     "[vset PTITLE] - Base class for officers and privates - Internal"]
[vset TITLE_CONFIG    "[vset PTITLE] - Collection of parameters for privates"]
[vset TITLE_DEV_HF    "[vset PTITLE] - Writing custom help formats"]
[vset TITLE_DEV_VT    "[vset PTITLE] - Writing custom validation types"]
[vset TITLE_DSL           "[vset PTITLE] - Introduction to the Specification Language"]

[include configuration.inc]
[vset TITLE_INTRO    "[vset PTITLE] - Introduction to the project"]
[vset TITLE_LICENSE  "[vset PTITLE] - License"			 ]
[vset TITLE_CHANGES  "[vset PTITLE] - Log of Changes"    	 ]
[vset TITLE_SOURCES  "[vset PTITLE] - How To Get The Sources"	 ]
[vset TITLE_INSTALL  "[vset PTITLE] - The Installer's Guide"	 ]
[vset TITLE_DEV      "[vset PTITLE] - The Developer's Guide"	 ]

[comment {- Custom documents & titles - - -- --- ----- --------}]
[vset TITLE_MAIN      "[vset PTITLE] - Main package and API"]
[vset TITLE_ACTOR     "[vset PTITLE] - Base class for officers and privates - Internal"]
[vset TITLE_CONFIG    "[vset PTITLE] - Collection of parameters for privates"]
[vset TITLE_DEV_HF    "[vset PTITLE] - Writing custom help formats"]
[vset TITLE_DEV_VT    "[vset PTITLE] - Writing custom validation types"]
[vset TITLE_DSL           "[vset PTITLE] - Introduction to the Specification Language"]

[para] The conceptual model underneath the command hierarchy is that
of a tree.

[para] The inner nodes of the tree represent command ensembles, here
called "officer"s. Each officer knows one or more commands, and
delegates actual execution to their respective specification, which
may be another officer, or a private.

[para] The leaf nodes of the tree represent the individual commands,


here called "private"s. Each private is responsible for a single
action, and knows how to perform it and the parameters used to

configure that action at runtime.

[para] The same model is graphically presented in the
Entity-Relationship-Diagram below.

[image erd]

[para] The "Actor" in that diagram is the common base class for the
ensembles and commands and not directly relevant to users.

[para] The "Config" on the other hand is the second interface seen by
the user, as the sole argument to the action command prefix of
[cmd private] (See section [sectref Officer]).


This container holds all the declared parameters of the command the
action is invoked for, and provides easy access to them through its
methods (see package [package cmdr::config]) at the time of execution.

[para] The conceptual model underneath the command hierarchy is that
of a tree.

[para] The inner nodes of the tree represent command ensembles, here
called [term officer]s. Each officer knows one or more commands to
perform, and delegates actual execution to their respective
specification, which may be another [term officer], or a [term private].

[para] The leaf nodes of the tree represent the individual commands,
here called [term private]s.

Each [term private] is responsible for a single action and knows how

to perform it, and the set of [term parameter]s used to configure that
action at runtime.

[para] The same model is graphically presented in the
Entity-Relationship-Diagram below.

[image erd]

[para] The [term actor] in that diagram is the common base class for the
ensembles and commands and not directly relevant to users.

[para] The [term config] on the other hand is the second interface
seen by the user, as the sole argument to the action command prefix of
[cmd private]. See [term [vset TITLE_DSL_OFFICER]] for the details.

This container, an instance of [package cmdr::config], holds all the
declared parameters of the command the action is invoked for, and
provides easy access to them through its methods at the time of

execution.

[comment { No tables in doctools, using an example to get a tabular formatting. }]
[comment { TODO doctools: table markup }]
[comment { TODO doctools: named TOCs for commands - embedded small TOCs}]

[example {
alias <name> = <name'>...            Declare an alternate name for a command path.
alias <name>                         Declare an alternate name for the previous command.
common <name> <script>               Declare a named shared code block.
default                              Set last command as default.
description <text>                   Set help text for the current ensemble.
ehandler <cmdprefix>                 Execution Interposition.
officer <name> <script>              Declare a nested ensemble = sub-officer
private <name> <script> <cmdprefix>  Declare a simple command  = private
undocumented                         Hide ensemble from help.
}]

[list_begin definitions]

[def "[cmd alias] [arg name] [const =] [arg name']..."]
[def "[cmd alias] [arg name]"]

This is a structuring command, for the command hierarchy. Its main
uses are the creation of alternate command names, and of shortcuts
through the command hierarchy. 

[para] For example, stackato's command specification for alias management is
more like [sectref {Basic setup, command nesting}] and uses shortcuts
similar to what is shown in
--TODO--(example ls-alias2)-- to provide the look of a flat namespace.

[para] In the first form the [arg name] is given the explicit path to
the command it is an alias for. In the second form it implicitly


refers to the immediately preceding officer or private.


Note that "immediately" is interpreted at the current level. The
system is [emph not] looking into a nested specification for its last
command.










[def "[cmd common] [arg name] [arg text]"]

This is another structuring command, for structuring the specification
itself instead of the command tree it declares.

[para] It creates named values, usually code blocks, which can be
shared between specifications. Note that while each block is visible
in the current officer and its subordinates, parents and siblings have
no access.

[para] An example of such a block would be

[example {
common *all* {
    option debug {
	Activate client internal tracing.
................................................................................
	    foreach t $tags { debug on $t }
	}]
    }
}
}]

This example defines an option to access the subsystem for debug
narative (See package [package Tcllib]). 

The example is actually special, as the block named [const *all*] is


reserved by the framework. This block, if defined, is automatically
included at the front of all "private" specifications, i.e. shared
across all the specified commands underneath this officer. A very

important trait for the option in the example, as it makes the debug
setup available to all commands without having to explicitly include
the block, and possibly forgetting such.

[para] Generally speaking, the framework reserves all blocks whose
name begins with a star, i.e [const *], for its own use.










[def "[cmd default]"]

This command sets up a special kind of alias. The last "private" or


"officer" is set as the default command to use at runtime.

This means that if during "Dispatch" the currently processed word does
not match any of the commands known to this officer this default is
used. If no default is specified an error will be thrown instead.



[def "[cmd description] [arg text]"]

This command declares the help text of the officer.


[def "[cmd ehandler] [arg cmdprefix]"]

This is an advanced command which should normally only be specified at
the top of the whole hierarchy (from which its value will
automatically propagate to all subordinates).

[para] At runtime the framework will call the specified command prefix
with a single argument, a script whose execution is equivalent to the
phases "Parsing", "Completion", and "Execution" of the framework, as
described in section --TODO--(sectref:flow/phases)--. The handler [emph must]
call this script, and can perform any application-specific actions
before and after.

[para] This handler's main uses are two-fold:

[list_begin enumerated]

[enum] Capture and hande application-specific errors which should not
abort the application, or shown as Tcl stacktrace.

[enum] Cleanup of application-specific transient settings the

parameter callbacks and/or command implementations may have set during

their execution. This is especially important if the interactive
command line shells of the framework are active. Without such a

handler and its bespoke cleanup code transient settings will leak
between multiple commands run from such a shell, something which is
definitely not wanted.

[list_end]


[def "[cmd officer] [arg name] [arg script]"]

This command creates a named subordinate officer with its
specification [arg script] of officer commands as described here.


[def "[cmd private] [arg name] [arg script] [arg cmdprefix]"]

This command creates a named subordinate private with its
specification [arg script] of private commands as described in the
following section, and a command prefix to invoke when it is chosen.


[para] This command prefix is called with a single argument, the
[package cmdr::config] instance holding the parameters of the private.


--TODO--(ref:backend-example-code)--


[def "[cmd undocumented]"]
Use of this command influences the generation of help, excluding all
officers having this marker (and their subordinates) from the




help. Note that subordinates reachable through aliases may be
included, under the alias name, if not explicitly excluded themselves.

[list_end]

[list_begin definitions]
[comment {- - -- --- ----- -------- -------------}]
[call [cmd alias] [arg name] [const =] [arg name']...]
[call [cmd alias] [arg name]]

This is a structuring command, for the command hierarchy. Its main
uses are the creation of alternate command names, and of shortcuts
through the command hierarchy.

[para] For example, [syscmd stackato]'s command specification for
alias management is written using deep nesting and uses aliases to

provide the look of a flat namespace to application users.

[para] In the first form the [arg name] is given the explicit path to

the actor the name is an alias for.

In the second form the alias implicitly refers to the immediately
preceding [term officer] or [term private].

Note that "immediately" is interpreted at the current level. The
system is [emph not] looking into a nested specification for its last
command.

[list_begin arguments]
[arg_def string name]
The name of the alias.

[arg_def string name'...]
The path to the actor, as list of names.
[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd common] [arg name] [arg text]]

This is another structuring command, for structuring the specification
itself instead of the command tree it declares.

[para] It creates named values, usually code blocks, which can be
shared between specifications. Note that while each block is visible
in the current [term officer] and its subordinates, parents and
siblings have no access.

[para] An example of such a block would be

[example {
common *all* {
    option debug {
	Activate client internal tracing.
................................................................................
	    foreach t $tags { debug on $t }
	}]
    }
}
}]

This example defines an option to access the subsystem for debug
narative (See package [package Tcllib]).

The example is actually special, as the block named [const *all*] is
reserved by the framework.

This block, if defined, is automatically included at the front of all
[term private] specifications, i.e. shared across all the privates

specified underneath this [term officer]. A very important trait for
the [term option] in the example, as it makes the debug setup
available to all privates without having to explicitly include the
block, and possibly forgetting such.

[para] Generally speaking, the framework reserves all blocks whose
name begins with a star, i.e [const *], for its own use.

[list_begin arguments]
[arg_def string name]
The name of the common block.

[arg_def string text]
The text of the block.
[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd default]]

This command sets up a special kind of alias.

The last [term private] or [term officer] is set as the default
command to use at runtime.

This means that if during "Dispatch" phase the currently processed
word does not match any of the commands known to this [term officer]
this default is used. If no default is specified an error will be
thrown instead.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd description] [arg text]]

This command declares the help text of the [term officer].

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ehandler] [arg cmdprefix]]

This is an advanced command which should normally only be specified at
the top of the whole hierarchy (from which its value will
automatically propagate to all subordinates).

[para] At runtime the framework will call the specified command prefix
with a single argument, a script whose execution is equivalent to the
phases "Parsing", "Completion", and "Execution" of the framework, as
described in --TODO--(sectref:flow/phases)--. The handler [emph must]
call this script, and can perform any application-specific actions
before and after.

[para] This handler's main uses are two-fold:

[list_begin enumerated]

[enum] Capture and hande application-specific errors which should not
abort the application, nor shown as Tcl stacktrace.

[enum] Cleanup of application-specific transient state the
[term parameter] callbacks (See [term [vset TITLE_DSL_PARAMETER]])
and/or actions may have set during their execution.

This is especially important if the interactive command line shells of

the framework are enabled. Without such a handler and its bespoke
cleanup code transient state [emph will] leak between multiple
commands run from such a shell, something which is definitely not
wanted.

[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd officer] [arg name] [arg script]]

This command creates a named subordinate [term officer] with its
specification [arg script] of officer commands as described here.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd private] [arg name] [arg script] [arg cmdprefix]]

This command creates a named subordinate [term private] with its
specification [arg script] of private commands
(See [term [vset TITLE_DSL_PRIVATE]]), and a command prefix to invoke
when it is chosen.

[para] This command prefix is called with a single argument, the
[package cmdr::config] instance holding the [term parameter]s of the
private.

--TODO--(ref:backend-example-code)--

[comment {- - -- --- ----- -------- -------------}]
[call [cmd undocumented]]



This command excludes the [term officer] (and its subordinates) from
the generated help.

Note that subordinates reachable through aliases may be included,
under the alias name, if they are not explicitly excluded themselves.

[list_end]

Of the four callbacks supported by parameters the first two,
"generate" and "validate" have been described already, in the sections
--TODO--\ref{para/reps} about representations and
--TODO--\ref{para/vtype} about validation types, respectively.

[para] This section explains the commonalities between the callbacks
in general, and the last two, for notifications about state changes in
detail.

[para] All callbacks are treated as command prefixes, not
scripts.

There are no placeholder substitutions, only arguments added to each
command prefix on invokation. This does not harm the generality of the
system, as complex scripts can be used via procedures or equivalents
(i.e. [cmd apply]).

[para] The two callbacks not yet described are the state-change
callbacks through which the framework can actively drive parts of the
application while processing the command line, whereas normally the
application drives access to parameters through their methods.

[list_begin definitions]


[def "[cmd when-complete] [arg cmdprefix]"]

This command declares the state-change callback to invoke when the
internal representation of the parameter is generated from the string


representation, or the various ways of getting a default.

[para] The callback is invoked with two arguments, the
[package cmdr::parameter] instance of the parameter which changed, and
its internal representation, in this order.



[def "[cmd when-set] [arg cmdprefix]"]

This command declares the state-change callback to invoke when the
string representation of the parameter is set during command line

parsing.

[para] The callback is invoked with two arguments, the
[package cmdr::parameter] instance of the parameter which changed, and
its string representation, in this order.



[list_end]

Due to their nature these callbacks are invoked at runtime during
either parsing, completion," or execution. The details are shown in


the table below. The specification commands influencing the timing,
i.e. forcing the use in a specific phase are shown in the intersection
of callback and phase.

[example {
                    | Dispatch | Parsing | Completion  | Execution
--------------------+----------+---------+-------------+-----------
validate (default)  | *        |         |             |          
--------------------+----------+---------+-------------+-----------
validate (complete) |          | *       | immediate   | defered

Of the four callbacks supported by parameters the first two,
[cmd generate] and [cmd validate] have been described already, in the
sections [sectref Representations] and [sectref Validation],
respectively.

[para] This section explains the commonalities between the callbacks
in general, and the last two, for notifications about state changes in
detail.

[para] All callbacks are treated as command prefixes, not scripts.


There are no placeholder substitutions, only arguments added to each
command prefix on invokation. This does not harm the generality of the
system, as complex scripts can be used via procedures or equivalents
(i.e. [cmd apply]).

[para] The two callbacks not yet described are the state-change
callbacks through which the framework can actively drive parts of the
application while processing the command line, whereas normally the
application drives access to parameters through their methods.

[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd when-complete] [arg cmdprefix]]

This command declares the state-change callback to invoke when the

[term {internal representation}] of the [term parameter] is generated
from the [term {string representation}], or the various ways of
getting a default.

[para] The callback is invoked with two arguments, the
[package cmdr::parameter] instance of the changed [term parameter],

and its [term {internal representation}], in this order.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd when-set] [arg cmdprefix]]

This command declares the state-change callback to invoke when the

[term {string representation}] of the [term parameter] is set during
command line parsing.

[para] The callback is invoked with two arguments, the
[package cmdr::parameter] instance of the changed [term parameter],


and its [term {string representation}], in this order.

[list_end]

Due to their nature these callbacks are invoked at runtime during
either the [term Parsing], [term Completion], or [term Execution]
phases.

The details are shown in the table below. The specification commands
influencing the timing, i.e. forcing the use in a specific phase are
shown in the intersection of callback and phase.

[example {
                    | Dispatch | Parsing | Completion  | Execution
--------------------+----------+---------+-------------+-----------
validate (default)  | *        |         |             |          
--------------------+----------+---------+-------------+-----------
validate (complete) |          | *       | immediate   | defered

[para] The general handling of a parameter is influenced by three
commands.

[list_begin definitions]


[def "[cmd optional]"]

This command marks the parameter as optional, i.e. as something the
user may skip on the command line, and the application supplying
sensible defaults. --TODO--(sectref:para/vtype)--


During parsing the framework will then expend some effort to determine

whether an argument word should be assigned to the parameter, or not.


[para] This setting is only applicable to "inputs", as "options" are
optional by definition, and "state" is hidden.


[def "[cmd test]"]

This command is related to the above, switching from the standard
regime for acceptance based on counting and thresholds to a different
one based on validation. The details are explained in section

--TODO--(sectref:flow/parsing, flow/optional)--.


[def "[cmd undocumented]"]

Like "officers" and "privates" parameters can be hidden from the
generated help. This is the command for doing so, the same as for the
first two.


[para] The main use case is the hiding of options giving an
application developer access to the internals of their application,
something a regular user has no need of, and doesn't have to know
about.

[list_end]

[para] The general handling of a [term parameter] is influenced by
three commands:

[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd optional]]

This command marks the parameter as [term optional], i.e. as something
the user may skip on the command line, with the application supplying

sensible defaults (See section [sectref Representations]).


This causes the framework to expend some effort in the [term Parsing]
phase to determine whether an argument word should be assigned to the
parameter, or not.

[para] This setting is only applicable to [term input]s, as
[term option]s are optional by definition, and [term state] is hidden.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd test]]

This command is related to the above, switching the runtime from the
standard regime for acceptance (based on counting and thresholds) to a
different regime based on validation.

The details are explained in --TODO--(sectref:flow/parsing,flow/optional)--.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd undocumented]]




This command excludes the [term parameter] from the generated help.

[para] Its main use case is the hiding of [term option]s giving an
application developer access to the internals of their application,
something a regular user has no need of, and doesn't have to know
about.

[list_end]

[para] We have two commands to influence the visible naming of all
parameters.

[para] As background, all parameters are named for proper
identification within the framework and other Tcl code, i.e. the
various callbacks, including a "private"s action. This "system name"

has to be unique within the "private" a parameter belongs to. Beyond


that however the visible parameters have to be identified within help
texts, and, in case of "options", for detection during "Parsing". That





is the visible naming, seen by a user of any application whose command
line processing is based on the [vset PTITLE] framework.

[list_begin definitions]


[def "[cmd label] [arg text]"]

This command declares the visible name, if different from the system
name used as the default. Note that in most cases this default is good
enough, obviating the need for this command.


[para] The only use case seen so far is when two semantically
equivalent input and option parameters clash, requiring different

internal names due to the requirement for uniqueness, yet also the
same visible name and flag within the help to highlight their
connection and equivalence.


[def "[cmd alias] [arg name]"]
For option parameters the "label" command and its default specifies
the name of the primary flag recognized during parsing. If that is not
enough for a specific option this command allows the specification of






any number additional flags to be recognized.

[para] Note however that the framework automatically recognizes not
only the specified flags, but also all unique prefixes, obviating the

need for this command in many cases.

[list_end]

[para] We have two commands to influence the visible naming of all
[term parameter]s.

[para] As background, all [term parameter]s are named, to properly
identify them within the framework and other Tcl code, i.e. in the
various callbacks and the [term private]'s action.

This [term {system name}] has to be unique within the [term private] a
[term parameter] belongs to.

Beyond that however the visible (i.e. non-term state])


[term parameter]s have to be identified by users within help texts,
and, in the case of [term option]s, for detection during the
[term Parsing] phase.

That is the visible naming, seen by a user of any application whose
command line processing is based on the [vset PTITLE] framework.

[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd label] [arg text]]

This command declares the [term parameter]'s visible name, if
different from the [term {system name}] used as the default. Note that
in most cases this default is good enough, obviating the need for this
command.

[para] The only use case seen so far is when two semantically

equivalent [term input] and [term option] [term parameter]s clash,
forcing the use of different system names due to the requirement for
their uniqueness, yet also use the same visible name and flag within
the help to highlight their connection and equivalence.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd alias] [arg name]]




For [term option]s the [cmd label] command and its default specifies
the name of the [term {primary flag}] recognized during the
[term Parsing] phase.

If that is not enough for a specific [term option] this command allows
the specification of any number additional flags to be recognized.

[para] Note however that the framework automatically recognizes not

only the specified flag(s), but also all their unique prefixes,
obviating the need for this command in many cases.

[list_end]

[para] An important concept of parameters is something taken up from
Tcl itself.

The differentation between string and internal representations.

Where Tcl uses internal representations to speed up its execution here
this separation is that of between the information delivered to the
application by a user, and the application-specific data structures
behind them.

[para] All parameters will have an internal representation.

This is usually derived from the string representation provided by the
user.

The details of that process are explained in section
--TODO--(sectref:para/vtype)--
about validation types.

However we have cases where the user cannot specify a string
representation ("states"), or is allowed to choose not to (optional
"inputs", "options").


For these cases three specification commands are made available
enabling us to programmatically choose the internal representation.

[list_begin definitions]


[def "[cmd default] [arg value]"]

This command provides a constant value for the internal
representation.


[def "[cmd generate] [arg cmdprefix]"]

This command provides a callback to compute the internal
representation at runtime. This is useful if the default is something
which cannot be captured as a fixed value, for example a handle to
some resource, or a dynamically created object.

[para] The command prefix is invoked with a single argument, the
[package cmdr::parameter] instance for which to generate the internal
representation. 

[list_end]

[para] The commands "default" and "generate" exclude each other,
i.e. only of them can be specified.

If neither are specified, and we need a default (see the cases
above) a default is chosen per the two rules below:


[list_begin enumerated]
[enum] Use the empty string for a "list" parameter.

[enum] Use the default value supplied by the chosen validation type
       (See section --TODO--(sectref:para/vtype)--).

[list_end]

[list_begin definitions]

[def "[cmd interact] [opt [arg prompt]]"]

This command actually does not specify an internal representation, but
activates another method for the user to specify a string value for

the parameter, outside of the command line. 

As such it has priority over either "default" and "generate," and can
be specified with either. A parameter marked with it will
interactively ask the user for a value if none was specified on the
command line.

[para] The default [arg prompt] is derived from the system name.


[list_end]

[para] To recapitulate:

[list_begin enumerated]

[enum] A string representation specified on the command line has the
       highest priority and goes through the chosen validation type to

       get the associated internal representation.

[enum] If activated via "interact" a small shell is run asking the
       user for a value (or more, as per "list", see below). The
       result goes through the chosen validation type to get the
       associated internal representation.

[enum] After that the internal representation is either the declared

       "default," or the result of invoking the "generate"


       callback. As internal representations they are [emph not] run
       through the chosen validation type.

[list_end]

[list_begin definitions]

[def "[cmd list]"]
This command is used to mark parameters whose string and thus internal





value should be treated as a list. By default all parameters are scalar.

[para] This affects the handling of the parameter during parsing, by
"interact" above, and the use of the validation type. The last two ask



for multiple values, and feed the elements of the string value

separately through validation instead of just the string value in one.
During parsing treatment of "options" changes from keeping only the


last assigned value to accumulation of all values. Similarly a
list-"input" takes all remaining words on the command line for itself



instead of just the current word. Because of this list-"inputs" are
only allowed as the last parameter of a "private."


[list_end]

[para] The last two specification commands dealing with the
representations control when the internal representation is created.


[list_begin definitions]


[def "[cmd defered]"]
This command marks a parameter as defered, with the internal


representation computed on first access to its value. This is the
default for "state" parameters.



[def "[cmd immediate]"]
This command marks a parameter as immediate, with the internal
representation computed in the "Completion" phase. This is the default
for "input" and "option" parameters.







[list_end]

[para] An important concept of [term parameter]s is something taken up
from Tcl itself.

The differentation between [term string] and [term {internal representations}].

Where Tcl uses [term {internal representations}] to speed up its
execution here this separation is that of between the information
delivered to the application by a user, and the application-specific
data structures behind them.

[para] All [term parameter]s will have an [term {internal representation}].

This is usually derived from the [term {string representation}]
provided by the user.

The details of that process are explained in section [sectref Validation].



However we have cases where the user cannot specify a string
representation ([term state]s), or is allowed to choose not to

(optional [term input]s, [term option]s).

For these cases three specification commands are made available
enabling us to programmatically choose the internal representation.

[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd default] [arg value]]

This command specifies a constant default value for the internal
representation.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd generate] [arg cmdprefix]]

This command specifies a callback to compute the default internal
representation at runtime. This is useful if the default is something
which cannot be captured as a fixed value. An example would be a
handle to some resource, or a dynamically created object.

[para] The command prefix is invoked with a single argument, the
[package cmdr::parameter] instance for which to generate the internal
representation.

[list_end]

[para] The commands [cmd default] and [cmd generate] exclude each
other, i.e. only of them can be specified, but not both.

If neither are specified, and we need a default (see the cases above)
then a default is chosen by the framework itself, as per the two rules
below:

[list_begin enumerated]
[enum] Use the empty string for a [cmd list] parameter.

[enum] Use the default value supplied by the chosen

[term {validation type}] (See section [sectref Validation]).
[list_end]

[list_begin definitions]
[comment {- - -- --- ----- -------- -------------}]
[call [cmd interact] [opt [arg prompt]]]

This command actually does not specify an
[term {internal representation}], but activates another method for the
user to specify the [term {string representation}] of the
[term parameter], outside of the command line.

As such it has priority over either [cmd default] and [cmd generate],
and can be specified with either. A [term parameter] marked with it
will interactively ask the user for a value if none was specified on
the command line.

[para] The default for the [arg prompt] is derived from the
[term parameter]'s [term {system name}].

[list_end]

[para] To recapitulate:

[list_begin enumerated]

[enum] A [term {string representation}] specified on the command line
has the highest priority and goes through the chosen
[term {validation type}] to get the associated
[term {internal representation}].

[enum] If activated via [cmd interact] a small shell is run asking the
user for a value (or more, as per [cmd list], see below). The result
goes through the chosen [term {validation type}] to get the associated
[term {internal representation}].


[enum] After that the [term {internal representation}] is either the
declared [cmd default] value, or the result of invoking the
[cmd generate] callback.

As [term {internal representation}]s the resulting values are
[emph not] run through the chosen [term {validation type}].

[list_end]

[list_begin definitions]
[comment {- - -- --- ----- -------- -------------}]
[call [cmd list]]


This command marks the [term parameter] as a list. In other words, its
[term string] and [term {internal representation}] is actually a list
of such, instead of a single value.

By default all parameters are scalar.

[para] This affects the handling of the parameter by the

[term Parsing] phase, by [cmd interact] above, and the use of the
[term {validation type}].

The last two ask for multiple values, and feed the elements of the
[term {string representation}] separately through validation instead
of just the string value in one. 


In the [term Parsing] phase treatment of [term option]s changes from
keeping only the last assigned value to the accumulation of all

values.

Similarly a list-[term input] takes all the remaining words on the
command line for itself instead of just the current word. Because of
this list-[term inputs] are only allowed as the last [term parameter]
of a [term private].

[list_end]

[para] The last two specification commands dealing with the
representations control [emph when] the
[term {internal representation}] is created.

[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd defered]]


This command marks a [term parameter] as [term defered], causing its
[term {internal representation}] to be computed on first access to its

value. This is the default for [term state] parameters.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd immediate]]




This command marks a [term parameter] as [term immediate], causing its
[term {internal representation}] to be computed in the
[term Completion] phase.

This is the default for [term input] and [term option] parameters.

[list_end]

[para] The answer to the necessity of moving between the string and
internal representations described in the previous section are the
validation types. Given a string representation they either return the
associated internal representation or raise an error, signaling that



the input was illegal. This part of their work, the verification of
the legality of the input string gave them their name.


[comment {--TODO--(textblock shared with cmdr-vtypes.man)}]
[para] The general concept of validation types was taken from
[package snit], and modified to suit [vset PTITLE]. Where snit's types

expect only a single method to validate the input [vset PTITLE]
expects all types to support an ensemble of [emph four] methods, one
for the basic validation and transformation of the input, another for
the release of any internal representation so generated, plus delivery
of a default representation and support for command line completion.



[list_begin definitions]


[def "[cmd validate] [arg cmdprefix]"]

This command specifies a validation type for the parameter, in the

form of a command prefix.


The set of methods this callback has to support, their signatures,
etc. are all explained in [term [vset TITLE_DEV_VT]]. This document
contains the implementation of the standard boolean validation type as
an example as well.

[para] Because of the same necessity all parameters must have a
validation type assigned to them, and the system will choose which, if
the user did not. This choice is made per the six rules below and
always returns one of the standard types implemented in package
[package cmdr::validate].

[list_begin enumerated]
[enum] Use "identity" if a "generate" callback is specified.
[enum] Use "boolean"  if no "default" is specified and the parameter is an option.
[enum] Use "identity" if no "default" is specified and the parameter is an input.
[enum] Use "boolean"  if the specified "default" value is a Tcl boolean.
[enum] Use "integer"  if the specified "default" value is a Tcl integer.
[enum] Use "identity" as fallback of last resort.
[list_end]


[def "[cmd presence]"]

This command is best discussed as part of the wider area of "boolean"
options, i.e. options with validation type "boolean" assigned to



them. These have associated special behaviours, both in the handling
of the specification, and during parsing.

[para] First, normal boolean options. They have automatic aliases

declared for them, derived from their primary flag. An option named


"foo" will have an alias of "no-foo", and the reverse. During parsing


the "foo" and "no-foo" flags have inverse semantics, and both are
allowed to occur without option argument following the flag. This is


in contrast to all other options which must have such an argument. The
parser essentially uses the validation type to decide if the word
after the flag is a proper boolean value, or not, i.e. an argument to
assign to the parameter, or not.


[para] Now "presence" declares a variant of the above, a boolean
option without the automatic aliases, and [emph never] taking an


argument during parsing. Its mere [emph presence] on the command line


will set its parameter. Their default value is consequently fixed to
[const false] as well.

[list_end]

[para] The answer to the necessity of moving between the [term string]
and [term {internal representations}] described in the previous
section are the [term {validation types}].


Given a [term {string representation}] they either return the
associated [term {internal representation}] or raise an error,
signaling that the string was illegal. This part of their work, the
verification of the legality of the input string gave them their name.


[comment {--TODO--(textblock shared with cmdr-vtypes.man)}]
[para] The general concept of [term {validation types}] was taken from
[package snit], and modified to suit [vset PTITLE].

Where snit's types expect only a single method to validate the input
[vset PTITLE] expects all types to support an ensemble of [emph four]
methods, one for the basic validation and transformation of the input,
another for the release of any internal representation so generated,
plus delivery of a default representation and support for command line
completion.


[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd validate] [arg cmdprefix]]

This command specifies a [term {validation type}] for the

[term parameter], in the form of a command prefix (or the name of one
of the builtin types, see package [package cmdr::validate]).

The set of methods this callback has to support, their signatures,
etc. are all explained in [term [vset TITLE_DEV_VT]]. This document
contains the implementation of the standard boolean validation type as
an example as well.

[para] Because of the same necessity all [term parameter]s must have a
[term {validation type}] assigned to them, and the system will choose
which, if the user did not. This choice is made as per the six rules
below and always returns one of the standard types implemented by
package [package cmdr::validate].

[list_begin enumerated]
[enum] Use [const identity] if a [cmd generate] callback is specified.
[enum] Use [const boolean]  if no [cmd default] is specified and the parameter is an [term option].
[enum] Use [const identity] if no [cmd default] is specified and the parameter is an [term input].
[enum] Use [const boolean]  if the specified [cmd default] value is a Tcl boolean.
[enum] Use [const integer]  if the specified [cmd default] value is a Tcl integer.
[enum] Use [const identity] as fallback of last resort.
[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd presence]]

This command is best discussed as part of the wider area of


[term boolean] [term option]s, i.e. [term option]s with the standard
[term {validation type}] [const boolean] assigned to them. These have
associated special behaviours, both in the handling of the
specification, and in the [term Parsing] phase.

[para] First, normal boolean options.

They have automatic aliases declared for them, derived from their
primary flag.

An option named "foo" will have an alias of "no-foo", and the
reverse.

In the [term Parsing] phase the "foo" and "no-foo" flags have inverse
semantics, and both are allowed to occur without option argument
following the flag.

This is in contrast to all other [term option]s which must have such
an argument. The parser essentially uses the [term {validation type}]
to decide if the word after the flag is a proper boolean value, or

not, i.e. an argument to assign to the [term parameter], or not.

[para] Now [cmd presence] declares a variant of the above, a boolean
option [emph without] the automatic aliases, and [emph never] taking
an argument during parsing.

Its mere [emph presence] on the command line will set its
[term parameter].

Their [cmd default] value is consequently fixed to [const false] as
well.

[list_end]

[para] The parameters of private commands are the heart of the system,
providing the space needed to transfer the command arguments to the
implementations, and having the most attributes controlling their
behaviour.

[para] This complexity is mitigated strongly by the use of sensible
defaults for each of the three possible kinds of parameter, i.e.
positional "inputs", named "options", and "state" hidden from the
command line.

[para] Each kind has its own construction command in the DSL for
[sectref Privates] which specifies the common information which cannot
have defaults, i.e.

[list_begin enumerated]
[enum] the name identifying it to the system,
[enum] the help text describing it in informal speech, and, of course,
[enum] the parameter specification itself, using the commands of this section.
[list_end]

[comment { No tables in doctools, using an example to get a tabular formatting. }]
[comment { TODO doctools: table markup }]
[comment { TODO doctools: named TOCs for commands - embedded small TOCs}]


[example {
alias <name>              N  Declare alternate flag for an option.
default <value>            R Set constant default value.
defered                    R  Defer calculation of the internal representation until demanded.
generate <cmdprefix>       R  Set callback returning the default value.
immediate                  R  Complement of defered.
interact ?<prompt>?        R  Enable the interactive entry of the string value.
label <text>              N  Name to use in the help, and as primary flag (for an option).
list                       R Declare as list-valued.
optional                  G  Declare input as optional.
presence                   V Declare as boolean option without argument.
test                      G  Control the matching of words to optional inputs.
undocumented              G  Declare as hidden from help.
validate <cmdprefix>       V Declare validation type.
when-complete <cmdprefix> C  Set callback executed when the value becomes known.
when-set <cmdprefix>      C  Set callback executed when the string value becomes known.
}]

[para][emph Naming]            [include dsl_para_naming.inc]
[para][emph {General control}] [include dsl_para_general.inc]
[para][emph Representations]   [include dsl_para_reps.inc]
[para][emph Validation]        [include dsl_para_validation.inc]
[para][emph Signaling]         [include dsl_para_callbacks.inc]




[comment {


Command & Attribute & Input & Option & State & Notes





presence & presence &
no & no & n/a &
Declare as boolean \coption without argument.
Implies \cdefault and \cvalidate settings.

validate <cmdprefix> & validate &
$*$ & $*$ & $*$ &
Declare validation type.
Details in section \ref{para/vtype}.



when-complete <cmdprefix> & when-complete &
none & none & none &
Set callback executed when the value becomes known.

when-set <cmdprefix> & when-set &
none & none & none &
Set callback executed when the string value becomes known.

}]

[para] The [term parameter]s of [term private]s are the heart of the
system, providing the space needed to transfer command arguments to
their implementations, and having the most attributes controlling
their behaviour.

[para] This complexity is strongly mitigated by the use of sensible
defaults for each of the three possible kinds of parameter, i.e.
positional [term input]s, named [term option]s", and [term state]
hidden from the command line.

[para] Each kind has its own construction command in the language for
[term private]s (See [term [vset TITLE_DSL_PRIVATE]]) which specifies
the common information which cannot have defaults, i.e.

[list_begin enumerated]
[enum] the name identifying it to the system,
[enum] the help text describing it in informal speech, and, of course,
[enum] the parameter specification itself, using the commands of this section.
[list_end]

[para][subsection Naming]
[include dsl_para_naming.inc]


[para][subsection {General control}]
[include dsl_para_general.inc]



















[para][subsection Representations]
[include dsl_para_reps.inc]


[para][subsection Validation]
[include dsl_para_validation.inc]































[para][subsection Signaling]
[include dsl_para_callbacks.inc]

[para] The specification of simple commands, i.e. "privates" is quite
easy, with only seven commands (see the table below). The important
parts are found in the parameter specifications, explained in the next
section.

[comment { No tables in doctools, using an example to get a tabular formatting. }]
[comment { TODO doctools: table markup }]
[comment { TODO doctools: named TOCs for commands - embedded small TOCs}]

[example {
description <text>             Set help text for command.
input <name> <help> <script>   Declare a positional parameter.
interactive                    Allow interactive shell.
option <name> <help> <script>  Declare a named parameter.
state <name> <help> <script>   Declare a hidden parameter.
undocumented                   Hide command from help.
use <name>                     Execute the named "common" block here.
}]

[list_begin definitions]
[def "[cmd description] [arg text]"]
Like the equivalent command for [sectref Officers] this command
declares the help text for the private.

[def "[cmd input] [arg name] [arg help] [arg script]"]
This command adds an "input" (positional) parameter to the "private",
with description [arg help] and its specification [arg script] of
parameter commands as described in the following section.

[def "[cmd interactive]"]
This command influences the runtime. By default the only interactive
command line shells are associated with the officers. Setting this
marker activates such a shell for the private, to be invoked when
required parameters do not have a value.

[para] The global command [cmd {cmdr::config interactive}] in package
[package cmdr::config] can be used to globally activate this type of
shell for all "privates".

[def "[cmd option] [arg name] [arg help] [arg script]"]
This command adds an "option" (named) parameter to the "private", with
description [arg help] and its specification [arg script] of parameter
commands as described in the following section.

[def "[cmd state] [arg name] [arg help] [arg script]"]
This command adds a "state" (hidden) parameter to the "private", with
description [arg help] and its specification [arg script] of parameter
commands as described in the following section.

[def "[cmd undocumented]"]
Like the equivalent command for [sectref Officers] use of this command
influences the generation of help, excluding all privates having this
marker from it.

[def "[cmd use] [arg name]"]
This command is the counterpart to [cmd common] of [sectref Officers].
It inserts the named block into the specification, executing it. As
such it expects the contents to be a script of private commands as
described in this section.

[list_end]

[para] The specification of [term private]s is quite easy, with only
seven commands. The important parts are found in the [term parameter]
specifications, explained in [term [vset TITLE_DSL_PARAMETER]].

[list_begin definitions]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd description] [arg text]]

This command declares the help text for the [term private].

[comment {- - -- --- ----- -------- -------------}]
[call [cmd input] [arg name] [arg help] [arg script]]

This command adds an [term input] (i.e. positional) [term parameter]
to the [term private], with description [arg help] and its
specification [arg script] of parameter commands as described in
[term [vset TITLE_DSL_PARAMETER]].

[comment {- - -- --- ----- -------- -------------}]
[call [cmd interactive]]

This command activates a mini-shell for this [term private] which will
be invoked when required [term parameter]s do not have a value after
argument extraction and matching.

[para] By default the only interactive command line shells are
associated with the [term officer]s.

[para] The command [cmd {cmdr::config interactive}] provided by the
package [package cmdr::config] can be used to globally activate this
type of shell for all [term private]s.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd option] [arg name] [arg help] [arg script]]

This command adds an [term option] (i.e. named) [term parameter] to
the [term private], with description [arg help] and its specification
[arg script] of parameter commands as described in
[term [vset TITLE_DSL_PARAMETER]].

[comment {- - -- --- ----- -------- -------------}]
[call [cmd state] [arg name] [arg help] [arg script]]

This command adds a [term state] (i.e. hidden) [term parameter] to the
[term private], with description [arg help] and its specification
[arg script] of parameter commands as described in
[term [vset TITLE_DSL_PARAMETER]].

[comment {- - -- --- ----- -------- -------------}]
[call [cmd undocumented]]

This command excludes the [term private] from the generated help.

[comment {- - -- --- ----- -------- -------------}]
[call [cmd use] [arg name]]

This command is the counterpart to [cmd common] of [term officer]s
(See [term [vset TITLE_DSL_OFFICER]]).

It inserts the named block into the specification, executing it in
place. As such it expects the contents to be a script of private
commands as described in this section.

[list_end]

\\$1\l'|0\(ul'\\$2
..
.TH "cmdr" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr \- Cmdr - Main package and API
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr\fR \fBnew\fR \fIname\fR \fIspecification\fR
.sp
\fB::cmdr\fR \fBcreate\fR \fIobj\fR \fIname\fR \fIspecification\fR
.sp
\fB::cmdr\fR \fBinteractive\fR ?\fIenable\fR?
.sp
................................................................................
.TP
string \fIname\fR
The user-visible name of the command (hierarchy)\&.
.TP
script \fIactions\fR
The specification of the subordinate commands\&. On the command line
these are the toplevel commands of the application using the
hierarchy\&. Please read \fICmdr - Specification Language\fR, (section "Officers")
for the details\&.
.RE
.TP
\fB::cmdr\fR \fBinteractive\fR ?\fIenable\fR?
This command globally (de)activates the interactive parts of the
framework, as per the value of \fIenable\fR\&.
.sp
By default (initial state) the framework allows interaction\&.

\\$1\l'|0\(ul'\\$2
..
.TH "cmdr" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr \- Cmdr - Main package and API
.SH SYNOPSIS
package require \fBcmdr \fR
.sp
\fB::cmdr\fR \fBnew\fR \fIname\fR \fIspecification\fR
.sp
\fB::cmdr\fR \fBcreate\fR \fIobj\fR \fIname\fR \fIspecification\fR
.sp
\fB::cmdr\fR \fBinteractive\fR ?\fIenable\fR?
.sp
................................................................................
.TP
string \fIname\fR
The user-visible name of the command (hierarchy)\&.
.TP
script \fIactions\fR
The specification of the subordinate commands\&. On the command line
these are the toplevel commands of the application using the
hierarchy\&. Please read \fICmdr - Officer Specification Language\fR for the
details\&.
.RE
.TP
\fB::cmdr\fR \fBinteractive\fR ?\fIenable\fR?
This command globally (de)activates the interactive parts of the
framework, as per the value of \fIenable\fR\&.
.sp
By default (initial state) the framework allows interaction\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_actor" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::actor" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr::actor \- Cmdr - Base class for officers and privates - Internal
.SH SYNOPSIS
package require \fBcmdr::actor \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

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_config" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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
................................................................................
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 "Parameters") 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\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::config" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr::config \- Cmdr - Collection of parameters for privates
.SH SYNOPSIS
package require \fBcmdr::config \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
................................................................................
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 - Parameter Specification Language\fR 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\&.

..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_dsl" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_dsl \- Cmdr - Specification Language
.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 document is for users of the cmdr framework\&. It describes the
domain-specific language for the specification of command hierarchies
with commands and their parameters (options, and inputs)\&.











.SH "INTRODUCTORY EXAMPLES"
Instead of immediately diving into the full syntax of the
specification language first a few examples to demonstrate the general
look and feel, plus basic features\&.
.SS "BASIC SETUP, PRIVATE WITH INPUTS"
.PP
This example specifies a command line providing 3 commands for
the management of command aliases\&.
This is actually a slice of \fBstackato\fR's interface, reduced and
modified to fit here\&.
While it does not have the necessary backend procedures required to
actually run the commands, it is enough to demonstrate basic features,
................................................................................

.CE
.PP
At the bottom of the example, just above we can also see the
very simple Tcl command which invokes the command line processing for
a list of words, here coming from \fB$argv\fR, i\&.e\&. the application's
command line\&.
.SS "BASIC SETUP, COMMAND NESTING"
.PP
The decoupling of command names from their implementations seen
in the previous example makes it easy to re-arrange and re-label the
user visible commands without having to touch any other part of the
code\&.
.PP
This is demonstrated in the example below, moving the 3
................................................................................
\&.\&.\&.

.CE
.SH "LANGUAGE REFERENCE"
With the examples behind us we can now go and specify the entire
specification language\&. If you have skipped here on first reading,
ignoring the examples, please go back and read them first\&.
.SS GENERAL
.PP
The conceptual model underneath the command hierarchy is that
of a tree\&.
.PP
The inner nodes of the tree represent command ensembles, here
called "officer"s\&. Each officer knows one or more commands, and
delegates actual execution to their respective specification, which
may be another officer, or a private\&.
.PP
The leaf nodes of the tree represent the individual commands,
here called "private"s\&. Each private is responsible for a single
action, and knows how to perform it and the parameters used to

configure that action at runtime\&.
.PP
The same model is graphically presented in the
Entity-Relationship-Diagram below\&.
.PS
.nf
      is-a         is-a
    /-1:1-> actor <-1:1-\\
................................................................................
 \\--/
 1:(0-n)
 has

.fi
.PE
.PP
The "Actor" in that diagram is the common base class for the
ensembles and commands and not directly relevant to users\&.
.PP
The "Config" on the other hand is the second interface seen by
the user, as the sole argument to the action command prefix of
\fBprivate\fR (See section \fBOfficer\fR)\&.

This container holds all the declared parameters of the command the
action is invoked for, and provides easy access to them through its
methods (see package \fBcmdr::config\fR) at the time of execution\&.
.SS OFFICERS
.CS


alias <name> = <name'>\&.\&.\&.            Declare an alternate name for a command path\&.
alias <name>                         Declare an alternate name for the previous command\&.
common <name> <script>               Declare a named shared code block\&.
default                              Set last command as default\&.
description <text>                   Set help text for the current ensemble\&.
ehandler <cmdprefix>                 Execution Interposition\&.
officer <name> <script>              Declare a nested ensemble = sub-officer
private <name> <script> <cmdprefix>  Declare a simple command  = private
undocumented                         Hide ensemble from help\&.

.CE
.TP
\fBalias\fR \fIname\fR \fB=\fR \fIname'\fR\&.\&.\&.
.TP
\fBalias\fR \fIname\fR
This is a structuring command, for the command hierarchy\&. Its main
uses are the creation of alternate command names, and of shortcuts
through the command hierarchy\&.
.sp
For example, stackato's command specification for alias management is
more like \fBBasic setup, command nesting\fR and uses shortcuts
similar to what is shown in
--TODO--(example ls-alias2)-- to provide the look of a flat namespace\&.
.sp
In the first form the \fIname\fR is given the explicit path to
the command it is an alias for\&. In the second form it implicitly
refers to the immediately preceding officer or private\&.
Note that "immediately" is interpreted at the current level\&. The
system is \fInot\fR looking into a nested specification for its last
command\&.
.TP
\fBcommon\fR \fIname\fR \fItext\fR
This is another structuring command, for structuring the specification
itself instead of the command tree it declares\&.
.sp
It creates named values, usually code blocks, which can be
shared between specifications\&. Note that while each block is visible
in the current officer and its subordinates, parents and siblings have
no access\&.
.sp
An example of such a block would be
.CS


common *all* {
    option debug {
	Activate client internal tracing\&.
    } {
	undocumented
	list
	when-complete [lambda {p tags} {
	    foreach t $tags { debug on $t }
	}]
    }
}

.CE
.IP
This example defines an option to access the subsystem for debug
narative (See package \fBTcllib\fR)\&.
The example is actually special, as the block named \fB*all*\fR is
reserved by the framework\&. This block, if defined, is automatically
included at the front of all "private" specifications, i\&.e\&. shared
across all the specified commands underneath this officer\&. A very
important trait for the option in the example, as it makes the debug
setup available to all commands without having to explicitly include
the block, and possibly forgetting such\&.
.sp
Generally speaking, the framework reserves all blocks whose
name begins with a star, i\&.e \fB*\fR, for its own use\&.
.TP
\fBdefault\fR
This command sets up a special kind of alias\&. The last "private" or
"officer" is set as the default command to use at runtime\&.
This means that if during "Dispatch" the currently processed word does
not match any of the commands known to this officer this default is
used\&. If no default is specified an error will be thrown instead\&.
.TP
\fBdescription\fR \fItext\fR
This command declares the help text of the officer\&.
.TP
\fBehandler\fR \fIcmdprefix\fR
This is an advanced command which should normally only be specified at
the top of the whole hierarchy (from which its value will
automatically propagate to all subordinates)\&.
.sp
At runtime the framework will call the specified command prefix
with a single argument, a script whose execution is equivalent to the
phases "Parsing", "Completion", and "Execution" of the framework, as
described in section --TODO--(sectref:flow/phases)--\&. The handler \fImust\fR
call this script, and can perform any application-specific actions
before and after\&.
.sp
This handler's main uses are two-fold:
.RS
.IP [1]
Capture and hande application-specific errors which should not
abort the application, or shown as Tcl stacktrace\&.
.IP [2]
Cleanup of application-specific transient settings the
parameter callbacks and/or command implementations may have set during
their execution\&. This is especially important if the interactive
command line shells of the framework are active\&. Without such a
handler and its bespoke cleanup code transient settings will leak
between multiple commands run from such a shell, something which is
definitely not wanted\&.
.RE
.TP
\fBofficer\fR \fIname\fR \fIscript\fR
This command creates a named subordinate officer with its
specification \fIscript\fR of officer commands as described here\&.
.TP
\fBprivate\fR \fIname\fR \fIscript\fR \fIcmdprefix\fR
This command creates a named subordinate private with its
specification \fIscript\fR of private commands as described in the
following section, and a command prefix to invoke when it is chosen\&.
.sp
This command prefix is called with a single argument, the
\fBcmdr::config\fR instance holding the parameters of the private\&.
--TODO--(ref:backend-example-code)--
.TP
\fBundocumented\fR
Use of this command influences the generation of help, excluding all
officers having this marker (and their subordinates) from the
help\&. Note that subordinates reachable through aliases may be
included, under the alias name, if not explicitly excluded themselves\&.
.PP
.SS PRIVATES
.PP
The specification of simple commands, i\&.e\&. "privates" is quite
easy, with only seven commands (see the table below)\&. The important
parts are found in the parameter specifications, explained in the next
section\&.
.CS


description <text>             Set help text for command\&.
input <name> <help> <script>   Declare a positional parameter\&.
interactive                    Allow interactive shell\&.
option <name> <help> <script>  Declare a named parameter\&.
state <name> <help> <script>   Declare a hidden parameter\&.
undocumented                   Hide command from help\&.
use <name>                     Execute the named "common" block here\&.

.CE
.TP
\fBdescription\fR \fItext\fR
Like the equivalent command for \fBOfficers\fR this command
declares the help text for the private\&.
.TP
\fBinput\fR \fIname\fR \fIhelp\fR \fIscript\fR
This command adds an "input" (positional) parameter to the "private",
with description \fIhelp\fR and its specification \fIscript\fR of
parameter commands as described in the following section\&.
.TP
\fBinteractive\fR
This command influences the runtime\&. By default the only interactive
command line shells are associated with the officers\&. Setting this
marker activates such a shell for the private, to be invoked when
required parameters do not have a value\&.
.sp
The global command \fBcmdr::config interactive\fR in package
\fBcmdr::config\fR can be used to globally activate this type of
shell for all "privates"\&.
.TP
\fBoption\fR \fIname\fR \fIhelp\fR \fIscript\fR
This command adds an "option" (named) parameter to the "private", with
description \fIhelp\fR and its specification \fIscript\fR of parameter
commands as described in the following section\&.
.TP
\fBstate\fR \fIname\fR \fIhelp\fR \fIscript\fR
This command adds a "state" (hidden) parameter to the "private", with
description \fIhelp\fR and its specification \fIscript\fR of parameter
commands as described in the following section\&.
.TP
\fBundocumented\fR
Like the equivalent command for \fBOfficers\fR use of this command
influences the generation of help, excluding all privates having this
marker from it\&.
.TP
\fBuse\fR \fIname\fR
This command is the counterpart to \fBcommon\fR of \fBOfficers\fR\&.
It inserts the named block into the specification, executing it\&. As
such it expects the contents to be a script of private commands as
described in this section\&.
.PP
.SS PARAMETERS
.PP
The parameters of private commands are the heart of the system,
providing the space needed to transfer the command arguments to the
implementations, and having the most attributes controlling their
behaviour\&.
.PP
This complexity is mitigated strongly by the use of sensible
defaults for each of the three possible kinds of parameter, i\&.e\&.
positional "inputs", named "options", and "state" hidden from the
command line\&.
.PP
Each kind has its own construction command in the DSL for
\fBPrivates\fR which specifies the common information which cannot
have defaults, i\&.e\&.
.IP [1]
the name identifying it to the system,
.IP [2]
the help text describing it in informal speech, and, of course,
.IP [3]
the parameter specification itself, using the commands of this section\&.
.PP
.CS


alias <name>              N  Declare alternate flag for an option\&.
default <value>            R Set constant default value\&.
defered                    R  Defer calculation of the internal representation until demanded\&.
generate <cmdprefix>       R  Set callback returning the default value\&.
immediate                  R  Complement of defered\&.
interact ?<prompt>?        R  Enable the interactive entry of the string value\&.
label <text>              N  Name to use in the help, and as primary flag (for an option)\&.
list                       R Declare as list-valued\&.
optional                  G  Declare input as optional\&.
presence                   V Declare as boolean option without argument\&.
test                      G  Control the matching of words to optional inputs\&.
undocumented              G  Declare as hidden from help\&.
validate <cmdprefix>       V Declare validation type\&.
when-complete <cmdprefix> C  Set callback executed when the value becomes known\&.
when-set <cmdprefix>      C  Set callback executed when the string value becomes known\&.

.CE
.PP
\fINaming\fR
.PP
We have two commands to influence the visible naming of all
parameters\&.
.PP
As background, all parameters are named for proper
identification within the framework and other Tcl code, i\&.e\&. the
various callbacks, including a "private"s action\&. This "system name"
has to be unique within the "private" a parameter belongs to\&. Beyond
that however the visible parameters have to be identified within help
texts, and, in case of "options", for detection during "Parsing"\&. That
is the visible naming, seen by a user of any application whose command
line processing is based on the Cmdr framework\&.
.TP
\fBlabel\fR \fItext\fR
This command declares the visible name, if different from the system
name used as the default\&. Note that in most cases this default is good
enough, obviating the need for this command\&.
.sp
The only use case seen so far is when two semantically
equivalent input and option parameters clash, requiring different
internal names due to the requirement for uniqueness, yet also the
same visible name and flag within the help to highlight their
connection and equivalence\&.
.TP
\fBalias\fR \fIname\fR
For option parameters the "label" command and its default specifies
the name of the primary flag recognized during parsing\&. If that is not
enough for a specific option this command allows the specification of
any number additional flags to be recognized\&.
.sp
Note however that the framework automatically recognizes not
only the specified flags, but also all unique prefixes, obviating the
need for this command in many cases\&.
.PP
.PP
\fIGeneral control\fR
.PP
The general handling of a parameter is influenced by three
commands\&.
.TP
\fBoptional\fR
This command marks the parameter as optional, i\&.e\&. as something the
user may skip on the command line, and the application supplying
sensible defaults\&. --TODO--(sectref:para/vtype)--
During parsing the framework will then expend some effort to determine
whether an argument word should be assigned to the parameter, or not\&.
.sp
This setting is only applicable to "inputs", as "options" are
optional by definition, and "state" is hidden\&.
.TP
\fBtest\fR
This command is related to the above, switching from the standard
regime for acceptance based on counting and thresholds to a different
one based on validation\&. The details are explained in section
--TODO--(sectref:flow/parsing, flow/optional)--\&.
.TP
\fBundocumented\fR
Like "officers" and "privates" parameters can be hidden from the
generated help\&. This is the command for doing so, the same as for the
first two\&.
.sp
The main use case is the hiding of options giving an
application developer access to the internals of their application,
something a regular user has no need of, and doesn't have to know
about\&.
.PP
.PP
\fIRepresentations\fR
.PP
An important concept of parameters is something taken up from
Tcl itself\&.
The differentation between string and internal representations\&.
Where Tcl uses internal representations to speed up its execution here
this separation is that of between the information delivered to the
application by a user, and the application-specific data structures
behind them\&.
.PP
All parameters will have an internal representation\&.
This is usually derived from the string representation provided by the
user\&.
The details of that process are explained in section
--TODO--(sectref:para/vtype)--
about validation types\&.
However we have cases where the user cannot specify a string
representation ("states"), or is allowed to choose not to (optional
"inputs", "options")\&.
For these cases three specification commands are made available
enabling us to programmatically choose the internal representation\&.
.TP
\fBdefault\fR \fIvalue\fR
This command provides a constant value for the internal
representation\&.
.TP
\fBgenerate\fR \fIcmdprefix\fR
This command provides a callback to compute the internal
representation at runtime\&. This is useful if the default is something
which cannot be captured as a fixed value, for example a handle to
some resource, or a dynamically created object\&.
.sp
The command prefix is invoked with a single argument, the
\fBcmdr::parameter\fR instance for which to generate the internal
representation\&.
.PP
.PP
The commands "default" and "generate" exclude each other,
i\&.e\&. only of them can be specified\&.
If neither are specified, and we need a default (see the cases
above) a default is chosen per the two rules below:
.IP [1]
Use the empty string for a "list" parameter\&.
.IP [2]
Use the default value supplied by the chosen validation type
(See section --TODO--(sectref:para/vtype)--)\&.
.PP
.TP
\fBinteract\fR ?\fIprompt\fR?
This command actually does not specify an internal representation, but
activates another method for the user to specify a string value for
the parameter, outside of the command line\&.
As such it has priority over either "default" and "generate," and can
be specified with either\&. A parameter marked with it will
interactively ask the user for a value if none was specified on the
command line\&.
.sp
The default \fIprompt\fR is derived from the system name\&.
.PP
.PP
To recapitulate:
.IP [1]
A string representation specified on the command line has the
highest priority and goes through the chosen validation type to
get the associated internal representation\&.
.IP [2]
If activated via "interact" a small shell is run asking the
user for a value (or more, as per "list", see below)\&. The
result goes through the chosen validation type to get the
associated internal representation\&.
.IP [3]
After that the internal representation is either the declared
"default," or the result of invoking the "generate"
callback\&. As internal representations they are \fInot\fR run
through the chosen validation type\&.
.PP
.TP
\fBlist\fR
This command is used to mark parameters whose string and thus internal
value should be treated as a list\&. By default all parameters are scalar\&.
.sp
This affects the handling of the parameter during parsing, by
"interact" above, and the use of the validation type\&. The last two ask
for multiple values, and feed the elements of the string value
separately through validation instead of just the string value in one\&.
During parsing treatment of "options" changes from keeping only the
last assigned value to accumulation of all values\&. Similarly a
list-"input" takes all remaining words on the command line for itself
instead of just the current word\&. Because of this list-"inputs" are
only allowed as the last parameter of a "private\&."
.PP
.PP
The last two specification commands dealing with the
representations control when the internal representation is created\&.
.TP
\fBdefered\fR
This command marks a parameter as defered, with the internal
representation computed on first access to its value\&. This is the
default for "state" parameters\&.
.TP
\fBimmediate\fR
This command marks a parameter as immediate, with the internal
representation computed in the "Completion" phase\&. This is the default
for "input" and "option" parameters\&.
.PP
.PP
\fIValidation\fR
.PP
The answer to the necessity of moving between the string and
internal representations described in the previous section are the
validation types\&. Given a string representation they either return the
associated internal representation or raise an error, signaling that
the input was illegal\&. This part of their work, the verification of
the legality of the input string gave them their name\&.
.PP
The general concept of validation types was taken from
\fBsnit\fR, and modified to suit Cmdr\&. Where snit's types
expect only a single method to validate the input Cmdr
expects all types to support an ensemble of \fIfour\fR methods, one
for the basic validation and transformation of the input, another for
the release of any internal representation so generated, plus delivery
of a default representation and support for command line completion\&.
.TP
\fBvalidate\fR \fIcmdprefix\fR
This command specifies a validation type for the parameter, in the
form of a command prefix\&.
The set of methods this callback has to support, their signatures,
etc\&. are all explained in \fICmdr - Writing custom validation types\fR\&. This document
contains the implementation of the standard boolean validation type as
an example as well\&.
.sp
Because of the same necessity all parameters must have a
validation type assigned to them, and the system will choose which, if
the user did not\&. This choice is made per the six rules below and
always returns one of the standard types implemented in package
\fBcmdr::validate\fR\&.
.RS
.IP [1]
Use "identity" if a "generate" callback is specified\&.
.IP [2]
Use "boolean"  if no "default" is specified and the parameter is an option\&.
.IP [3]
Use "identity" if no "default" is specified and the parameter is an input\&.
.IP [4]
Use "boolean"  if the specified "default" value is a Tcl boolean\&.
.IP [5]
Use "integer"  if the specified "default" value is a Tcl integer\&.
.IP [6]
Use "identity" as fallback of last resort\&.
.RE
.TP
\fBpresence\fR
This command is best discussed as part of the wider area of "boolean"
options, i\&.e\&. options with validation type "boolean" assigned to
them\&. These have associated special behaviours, both in the handling
of the specification, and during parsing\&.
.sp
First, normal boolean options\&. They have automatic aliases
declared for them, derived from their primary flag\&. An option named
"foo" will have an alias of "no-foo", and the reverse\&. During parsing
the "foo" and "no-foo" flags have inverse semantics, and both are
allowed to occur without option argument following the flag\&. This is
in contrast to all other options which must have such an argument\&. The
parser essentially uses the validation type to decide if the word
after the flag is a proper boolean value, or not, i\&.e\&. an argument to
assign to the parameter, or not\&.
.sp
Now "presence" declares a variant of the above, a boolean
option without the automatic aliases, and \fInever\fR taking an
argument during parsing\&. Its mere \fIpresence\fR on the command line
will set its parameter\&. Their default value is consequently fixed to
\fBfalse\fR as well\&.
.PP
.PP
\fISignaling\fR
Of the four callbacks supported by parameters the first two,
"generate" and "validate" have been described already, in the sections
--TODO--\\ref{para/reps} about representations and
--TODO--\\ref{para/vtype} about validation types, respectively\&.
.PP
This section explains the commonalities between the callbacks
in general, and the last two, for notifications about state changes in
detail\&.
.PP
All callbacks are treated as command prefixes, not
scripts\&.
There are no placeholder substitutions, only arguments added to each
command prefix on invokation\&. This does not harm the generality of the
system, as complex scripts can be used via procedures or equivalents
(i\&.e\&. \fBapply\fR)\&.
.PP
The two callbacks not yet described are the state-change
callbacks through which the framework can actively drive parts of the
application while processing the command line, whereas normally the
application drives access to parameters through their methods\&.
.TP
\fBwhen-complete\fR \fIcmdprefix\fR
This command declares the state-change callback to invoke when the
internal representation of the parameter is generated from the string
representation, or the various ways of getting a default\&.
.sp
The callback is invoked with two arguments, the
\fBcmdr::parameter\fR instance of the parameter which changed, and
its internal representation, in this order\&.
.TP
\fBwhen-set\fR \fIcmdprefix\fR
This command declares the state-change callback to invoke when the
string representation of the parameter is set during command line
parsing\&.
.sp
The callback is invoked with two arguments, the
\fBcmdr::parameter\fR instance of the parameter which changed, and
its string representation, in this order\&.
.PP
Due to their nature these callbacks are invoked at runtime during
either parsing, completion," or execution\&. The details are shown in
the table below\&. The specification commands influencing the timing,
i\&.e\&. forcing the use in a specific phase are shown in the intersection
of callback and phase\&.
.CS


                    | Dispatch | Parsing | Completion  | Execution
--------------------+----------+---------+-------------+-----------
validate (default)  | *        |         |             |
--------------------+----------+---------+-------------+-----------
validate (complete) |          | *       | immediate   | defered
when-set            |          | *       |             |
--------------------+----------+---------+-------------+-----------
generate            |          |         | immediate   | defered
validate (validate) |          | test    | immediate   | defered
validate (release)  |          | test    | immediate   | defered
--------------------+----------+---------+-------------+-----------
when-complete       |          |         | immediate   | defered
--------------------+----------+---------+-------------+-----------

.CE

.SH "RELATED DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the project\fR
.IP [2]
\fICmdr - License\fR
.IP [3]
\fICmdr - Log of Changes\fR

..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_dsl" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_dsl \- Cmdr - Introduction to the Specification Language
.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 document is for users of the cmdr framework\&. It introduces the
domain-specific language for the specification of command hierarchies
with commands and their parameters by way of examples and then
provides links to the detailed reference documents\&.
.SH "RELATED SPECIFICATION DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the Specification Language\fR
.IP [2]
\fICmdr - Officer Specification Language\fR
.IP [3]
\fICmdr - Private Specification Language\fR
.IP [4]
\fICmdr - Parameter Specification Language\fR
.PP
.SH "INTRODUCTORY EXAMPLES"
Instead of immediately diving into the full syntax of the
specification language first a few examples to demonstrate the general
look and feel, plus basic features\&.
.SS "BASIC PRIVATE COMMANDS WITH INPUTS"
.PP
This example specifies a command line providing 3 commands for
the management of command aliases\&.
This is actually a slice of \fBstackato\fR's interface, reduced and
modified to fit here\&.
While it does not have the necessary backend procedures required to
actually run the commands, it is enough to demonstrate basic features,
................................................................................

.CE
.PP
At the bottom of the example, just above we can also see the
very simple Tcl command which invokes the command line processing for
a list of words, here coming from \fB$argv\fR, i\&.e\&. the application's
command line\&.
.SS "SIMPLE COMMAND NESTING"
.PP
The decoupling of command names from their implementations seen
in the previous example makes it easy to re-arrange and re-label the
user visible commands without having to touch any other part of the
code\&.
.PP
This is demonstrated in the example below, moving the 3
................................................................................
\&.\&.\&.

.CE
.SH "LANGUAGE REFERENCE"
With the examples behind us we can now go and specify the entire
specification language\&. If you have skipped here on first reading,
ignoring the examples, please go back and read them first\&.

.PP
The conceptual model underneath the command hierarchy is that
of a tree\&.
.PP
The inner nodes of the tree represent command ensembles, here
called \fIofficer\fRs\&. Each officer knows one or more commands to
perform, and delegates actual execution to their respective
specification, which may be another \fIofficer\fR, or a \fIprivate\fR\&.
.PP
The leaf nodes of the tree represent the individual commands,
here called \fIprivate\fRs\&.
Each \fIprivate\fR is responsible for a single action and knows how
to perform it, and the set of \fIparameter\fRs used to configure that
action at runtime\&.
.PP
The same model is graphically presented in the
Entity-Relationship-Diagram below\&.
.PS
.nf
      is-a         is-a
    /-1:1-> actor <-1:1-\\
................................................................................
 \\--/
 1:(0-n)
 has

.fi
.PE
.PP
The \fIactor\fR in that diagram is the common base class for the
ensembles and commands and not directly relevant to users\&.
.PP
The \fIconfig\fR on the other hand is the second interface
seen by the user, as the sole argument to the action command prefix of
\fBprivate\fR\&. See \fICmdr - Officer Specification Language\fR for the details\&.
This container, an instance of \fBcmdr::config\fR, holds all the
declared parameters of the command the action is invoked for, and
provides easy access to them through its methods at the time of









































































































































execution\&.




















































.PP




























































































































































































































































































































































Please continue reading with \fICmdr - Officer Specification Language\fR\&.
.SH "RELATED DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the project\fR
.IP [2]
\fICmdr - License\fR
.IP [3]
\fICmdr - Log of Changes\fR

'\"
'\" Generated from file 'cmdr_dsl_officer\&.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_dsl_officer" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_dsl_officer \- Cmdr - Officer Specification Language
.SH SYNOPSIS
\fBalias\fR \fIname\fR \fB=\fR \fIname'\fR\&.\&.\&.
.sp
\fBalias\fR \fIname\fR
.sp
\fBcommon\fR \fIname\fR \fItext\fR
.sp
\fBdefault\fR
.sp
\fBdescription\fR \fItext\fR
.sp
\fBehandler\fR \fIcmdprefix\fR
.sp
\fBofficer\fR \fIname\fR \fIscript\fR
.sp
\fBprivate\fR \fIname\fR \fIscript\fR \fIcmdprefix\fR
.sp
\fBundocumented\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 document is for users of the cmdr framework\&. It introduces the
domain-specific language for the specification of \fIofficer\fRs in
detail\&.
.SH "RELATED SPECIFICATION DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the Specification Language\fR
.IP [2]
\fICmdr - Officer Specification Language\fR
.IP [3]
\fICmdr - Private Specification Language\fR
.IP [4]
\fICmdr - Parameter Specification Language\fR
.PP
.SH "LANGUAGE REFERENCE"
.TP
\fBalias\fR \fIname\fR \fB=\fR \fIname'\fR\&.\&.\&.
.TP
\fBalias\fR \fIname\fR
This is a structuring command, for the command hierarchy\&. Its main
uses are the creation of alternate command names, and of shortcuts
through the command hierarchy\&.
.sp
For example, \fBstackato\fR's command specification for
alias management is written using deep nesting and uses aliases to
provide the look of a flat namespace to application users\&.
.sp
In the first form the \fIname\fR is given the explicit path to
the actor the name is an alias for\&.
In the second form the alias implicitly refers to the immediately
preceding \fIofficer\fR or \fIprivate\fR\&.
Note that "immediately" is interpreted at the current level\&. The
system is \fInot\fR looking into a nested specification for its last
command\&.
.RS
.TP
string \fIname\fR
The name of the alias\&.
.TP
string \fIname'\&.\&.\&.\fR
The path to the actor, as list of names\&.
.RE
.TP
\fBcommon\fR \fIname\fR \fItext\fR
This is another structuring command, for structuring the specification
itself instead of the command tree it declares\&.
.sp
It creates named values, usually code blocks, which can be
shared between specifications\&. Note that while each block is visible
in the current \fIofficer\fR and its subordinates, parents and
siblings have no access\&.
.sp
An example of such a block would be
.CS


common *all* {
    option debug {
	Activate client internal tracing\&.
    } {
	undocumented
	list
	when-complete [lambda {p tags} {
	    foreach t $tags { debug on $t }
	}]
    }
}

.CE
.IP
This example defines an option to access the subsystem for debug
narative (See package \fBTcllib\fR)\&.
The example is actually special, as the block named \fB*all*\fR is
reserved by the framework\&.
This block, if defined, is automatically included at the front of all
\fIprivate\fR specifications, i\&.e\&. shared across all the privates
specified underneath this \fIofficer\fR\&. A very important trait for
the \fIoption\fR in the example, as it makes the debug setup
available to all privates without having to explicitly include the
block, and possibly forgetting such\&.
.sp
Generally speaking, the framework reserves all blocks whose
name begins with a star, i\&.e \fB*\fR, for its own use\&.
.RS
.TP
string \fIname\fR
The name of the common block\&.
.TP
string \fItext\fR
The text of the block\&.
.RE
.TP
\fBdefault\fR
This command sets up a special kind of alias\&.
The last \fIprivate\fR or \fIofficer\fR is set as the default
command to use at runtime\&.
This means that if during "Dispatch" phase the currently processed
word does not match any of the commands known to this \fIofficer\fR
this default is used\&. If no default is specified an error will be
thrown instead\&.
.TP
\fBdescription\fR \fItext\fR
This command declares the help text of the \fIofficer\fR\&.
.TP
\fBehandler\fR \fIcmdprefix\fR
This is an advanced command which should normally only be specified at
the top of the whole hierarchy (from which its value will
automatically propagate to all subordinates)\&.
.sp
At runtime the framework will call the specified command prefix
with a single argument, a script whose execution is equivalent to the
phases "Parsing", "Completion", and "Execution" of the framework, as
described in --TODO--(sectref:flow/phases)--\&. The handler \fImust\fR
call this script, and can perform any application-specific actions
before and after\&.
.sp
This handler's main uses are two-fold:
.RS
.IP [1]
Capture and hande application-specific errors which should not
abort the application, nor shown as Tcl stacktrace\&.
.IP [2]
Cleanup of application-specific transient state the
\fIparameter\fR callbacks (See \fICmdr - Parameter Specification Language\fR)
and/or actions may have set during their execution\&.
This is especially important if the interactive command line shells of
the framework are enabled\&. Without such a handler and its bespoke
cleanup code transient state \fIwill\fR leak between multiple
commands run from such a shell, something which is definitely not
wanted\&.
.RE
.TP
\fBofficer\fR \fIname\fR \fIscript\fR
This command creates a named subordinate \fIofficer\fR with its
specification \fIscript\fR of officer commands as described here\&.
.TP
\fBprivate\fR \fIname\fR \fIscript\fR \fIcmdprefix\fR
This command creates a named subordinate \fIprivate\fR with its
specification \fIscript\fR of private commands
(See \fICmdr - Private Specification Language\fR), and a command prefix to invoke
when it is chosen\&.
.sp
This command prefix is called with a single argument, the
\fBcmdr::config\fR instance holding the \fIparameter\fRs of the
private\&.
--TODO--(ref:backend-example-code)--
.TP
\fBundocumented\fR
This command excludes the \fIofficer\fR (and its subordinates) from
the generated help\&.
Note that subordinates reachable through aliases may be included,
under the alias name, if they are not explicitly excluded themselves\&.
.PP
.PP
Please continue reading with \fICmdr - Private Specification Language\fR\&.
.SH "RELATED DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the project\fR
.IP [2]
\fICmdr - License\fR
.IP [3]
\fICmdr - Log of Changes\fR
.IP [4]
\fICmdr - How To Get The Sources\fR
.IP [5]
\fICmdr - The Installer's Guide\fR
.IP [6]
\fICmdr - The Developer's Guide\fR
.PP
.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at
\fICmdr Tickets\fR [https:/core\&.tcl\&.tk/akupries/cmdr]\&.
.PP
Please also report any ideas you may have for enhancements of
either package(s) and/or documentation\&.
.SH KEYWORDS
arguments, command hierarchy, command line completion, command line handling, command tree, editing command line, help for command line, hierarchy of commands, interactive command shell, optional arguments, options, parameters, processing command line, tree of commands
.SH COPYRIGHT
.nf
Copyright (c) 2013 Andreas Kupries
Copyright (c) 2013 Documentation, Andreas Kupries

.fi

'\"
'\" Generated from file 'cmdr_dsl_parameter\&.man' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2013 Andreas Kupries
'\" Copyright (c) 2013 Documentation, Andreas Kupries
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 4c 8c 12c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_dsl_parameter" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_dsl_parameter \- Cmdr - Parameter Specification Language
.SH SYNOPSIS
\fBlabel\fR \fItext\fR
.sp
\fBalias\fR \fIname\fR
.sp
\fBoptional\fR
.sp
\fBtest\fR
.sp
\fBundocumented\fR
.sp
\fBdefault\fR \fIvalue\fR
.sp
\fBgenerate\fR \fIcmdprefix\fR
.sp
\fBinteract\fR ?\fIprompt\fR?
.sp
\fBlist\fR
.sp
\fBdefered\fR
.sp
\fBimmediate\fR
.sp
\fBvalidate\fR \fIcmdprefix\fR
.sp
\fBpresence\fR
.sp
\fBwhen-complete\fR \fIcmdprefix\fR
.sp
\fBwhen-set\fR \fIcmdprefix\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 document is for users of the cmdr framework\&. It introduces the
domain-specific language for the specification of parameters in
detail\&.
.SH "RELATED SPECIFICATION DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the Specification Language\fR
.IP [2]
\fICmdr - Officer Specification Language\fR
.IP [3]
\fICmdr - Private Specification Language\fR
.IP [4]
\fICmdr - Parameter Specification Language\fR
.PP
.SH "LANGUAGE REFERENCE"
.PP
The \fIparameter\fRs of \fIprivate\fRs are the heart of the
system, providing the space needed to transfer command arguments to
their implementations, and having the most attributes controlling
their behaviour\&.
.PP
This complexity is strongly mitigated by the use of sensible
defaults for each of the three possible kinds of parameter, i\&.e\&.
positional \fIinput\fRs, named \fIoption\fRs", and \fIstate\fR
hidden from the command line\&.
.PP
Each kind has its own construction command in the language for
\fIprivate\fRs (See \fICmdr - Private Specification Language\fR) which specifies
the common information which cannot have defaults, i\&.e\&.
.IP [1]
the name identifying it to the system,
.IP [2]
the help text describing it in informal speech, and, of course,
.IP [3]
the parameter specification itself, using the commands of this section\&.
.PP
.PP
.SS NAMING
.PP
We have two commands to influence the visible naming of all
\fIparameter\fRs\&.
.PP
As background, all \fIparameter\fRs are named, to properly
identify them within the framework and other Tcl code, i\&.e\&. in the
various callbacks and the \fIprivate\fR's action\&.
This \fIsystem name\fR has to be unique within the \fIprivate\fR a
\fIparameter\fR belongs to\&.
Beyond that however the visible (i\&.e\&. non-term state])
\fIparameter\fRs have to be identified by users within help texts,
and, in the case of \fIoption\fRs, for detection during the
\fIParsing\fR phase\&.
That is the visible naming, seen by a user of any application whose
command line processing is based on the Cmdr framework\&.
.TP
\fBlabel\fR \fItext\fR
This command declares the \fIparameter\fR's visible name, if
different from the \fIsystem name\fR used as the default\&. Note that
in most cases this default is good enough, obviating the need for this
command\&.
.sp
The only use case seen so far is when two semantically
equivalent \fIinput\fR and \fIoption\fR \fIparameter\fRs clash,
forcing the use of different system names due to the requirement for
their uniqueness, yet also use the same visible name and flag within
the help to highlight their connection and equivalence\&.
.TP
\fBalias\fR \fIname\fR
For \fIoption\fRs the \fBlabel\fR command and its default specifies
the name of the \fIprimary flag\fR recognized during the
\fIParsing\fR phase\&.
If that is not enough for a specific \fIoption\fR this command allows
the specification of any number additional flags to be recognized\&.
.sp
Note however that the framework automatically recognizes not
only the specified flag(s), but also all their unique prefixes,
obviating the need for this command in many cases\&.
.PP
.PP
.SS "GENERAL CONTROL"
.PP
The general handling of a \fIparameter\fR is influenced by
three commands:
.TP
\fBoptional\fR
This command marks the parameter as \fIoptional\fR, i\&.e\&. as something
the user may skip on the command line, with the application supplying
sensible defaults (See section \fBRepresentations\fR)\&.
This causes the framework to expend some effort in the \fIParsing\fR
phase to determine whether an argument word should be assigned to the
parameter, or not\&.
.sp
This setting is only applicable to \fIinput\fRs, as
\fIoption\fRs are optional by definition, and \fIstate\fR is hidden\&.
.TP
\fBtest\fR
This command is related to the above, switching the runtime from the
standard regime for acceptance (based on counting and thresholds) to a
different regime based on validation\&.
The details are explained in --TODO--(sectref:flow/parsing,flow/optional)--\&.
.TP
\fBundocumented\fR
This command excludes the \fIparameter\fR from the generated help\&.
.sp
Its main use case is the hiding of \fIoption\fRs giving an
application developer access to the internals of their application,
something a regular user has no need of, and doesn't have to know
about\&.
.PP
.PP
.SS REPRESENTATIONS
.PP
An important concept of \fIparameter\fRs is something taken up
from Tcl itself\&.
The differentation between \fIstring\fR and \fIinternal representations\fR\&.
Where Tcl uses \fIinternal representations\fR to speed up its
execution here this separation is that of between the information
delivered to the application by a user, and the application-specific
data structures behind them\&.
.PP
All \fIparameter\fRs will have an \fIinternal representation\fR\&.
This is usually derived from the \fIstring representation\fR
provided by the user\&.
The details of that process are explained in section \fBValidation\fR\&.
However we have cases where the user cannot specify a string
representation (\fIstate\fRs), or is allowed to choose not to
(optional \fIinput\fRs, \fIoption\fRs)\&.
For these cases three specification commands are made available
enabling us to programmatically choose the internal representation\&.
.TP
\fBdefault\fR \fIvalue\fR
This command specifies a constant default value for the internal
representation\&.
.TP
\fBgenerate\fR \fIcmdprefix\fR
This command specifies a callback to compute the default internal
representation at runtime\&. This is useful if the default is something
which cannot be captured as a fixed value\&. An example would be a
handle to some resource, or a dynamically created object\&.
.sp
The command prefix is invoked with a single argument, the
\fBcmdr::parameter\fR instance for which to generate the internal
representation\&.
.PP
.PP
The commands \fBdefault\fR and \fBgenerate\fR exclude each
other, i\&.e\&. only of them can be specified, but not both\&.
If neither are specified, and we need a default (see the cases above)
then a default is chosen by the framework itself, as per the two rules
below:
.IP [1]
Use the empty string for a \fBlist\fR parameter\&.
.IP [2]
Use the default value supplied by the chosen
\fIvalidation type\fR (See section \fBValidation\fR)\&.
.PP
.TP
\fBinteract\fR ?\fIprompt\fR?
This command actually does not specify an
\fIinternal representation\fR, but activates another method for the
user to specify the \fIstring representation\fR of the
\fIparameter\fR, outside of the command line\&.
As such it has priority over either \fBdefault\fR and \fBgenerate\fR,
and can be specified with either\&. A \fIparameter\fR marked with it
will interactively ask the user for a value if none was specified on
the command line\&.
.sp
The default for the \fIprompt\fR is derived from the
\fIparameter\fR's \fIsystem name\fR\&.
.PP
.PP
To recapitulate:
.IP [1]
A \fIstring representation\fR specified on the command line
has the highest priority and goes through the chosen
\fIvalidation type\fR to get the associated
\fIinternal representation\fR\&.
.IP [2]
If activated via \fBinteract\fR a small shell is run asking the
user for a value (or more, as per \fBlist\fR, see below)\&. The result
goes through the chosen \fIvalidation type\fR to get the associated
\fIinternal representation\fR\&.
.IP [3]
After that the \fIinternal representation\fR is either the
declared \fBdefault\fR value, or the result of invoking the
\fBgenerate\fR callback\&.
As \fIinternal representation\fRs the resulting values are
\fInot\fR run through the chosen \fIvalidation type\fR\&.
.PP
.TP
\fBlist\fR
This command marks the \fIparameter\fR as a list\&. In other words, its
\fIstring\fR and \fIinternal representation\fR is actually a list
of such, instead of a single value\&.
By default all parameters are scalar\&.
.sp
This affects the handling of the parameter by the
\fIParsing\fR phase, by \fBinteract\fR above, and the use of the
\fIvalidation type\fR\&.
The last two ask for multiple values, and feed the elements of the
\fIstring representation\fR separately through validation instead
of just the string value in one\&.
In the \fIParsing\fR phase treatment of \fIoption\fRs changes from
keeping only the last assigned value to the accumulation of all
values\&.
Similarly a list-\fIinput\fR takes all the remaining words on the
command line for itself instead of just the current word\&. Because of
this list-\fIinputs\fR are only allowed as the last \fIparameter\fR
of a \fIprivate\fR\&.
.PP
.PP
The last two specification commands dealing with the
representations control \fIwhen\fR the
\fIinternal representation\fR is created\&.
.TP
\fBdefered\fR
This command marks a \fIparameter\fR as \fIdefered\fR, causing its
\fIinternal representation\fR to be computed on first access to its
value\&. This is the default for \fIstate\fR parameters\&.
.TP
\fBimmediate\fR
This command marks a \fIparameter\fR as \fIimmediate\fR, causing its
\fIinternal representation\fR to be computed in the
\fICompletion\fR phase\&.
This is the default for \fIinput\fR and \fIoption\fR parameters\&.
.PP
.PP
.SS VALIDATION
.PP
The answer to the necessity of moving between the \fIstring\fR
and \fIinternal representations\fR described in the previous
section are the \fIvalidation types\fR\&.
Given a \fIstring representation\fR they either return the
associated \fIinternal representation\fR or raise an error,
signaling that the string was illegal\&. This part of their work, the
verification of the legality of the input string gave them their name\&.
.PP
The general concept of \fIvalidation types\fR was taken from
\fBsnit\fR, and modified to suit Cmdr\&.
Where snit's types expect only a single method to validate the input
Cmdr expects all types to support an ensemble of \fIfour\fR
methods, one for the basic validation and transformation of the input,
another for the release of any internal representation so generated,
plus delivery of a default representation and support for command line
completion\&.
.TP
\fBvalidate\fR \fIcmdprefix\fR
This command specifies a \fIvalidation type\fR for the
\fIparameter\fR, in the form of a command prefix (or the name of one
of the builtin types, see package \fBcmdr::validate\fR)\&.
The set of methods this callback has to support, their signatures,
etc\&. are all explained in \fICmdr - Writing custom validation types\fR\&. This document
contains the implementation of the standard boolean validation type as
an example as well\&.
.sp
Because of the same necessity all \fIparameter\fRs must have a
\fIvalidation type\fR assigned to them, and the system will choose
which, if the user did not\&. This choice is made as per the six rules
below and always returns one of the standard types implemented by
package \fBcmdr::validate\fR\&.
.RS
.IP [1]
Use \fBidentity\fR if a \fBgenerate\fR callback is specified\&.
.IP [2]
Use \fBboolean\fR  if no \fBdefault\fR is specified and the parameter is an \fIoption\fR\&.
.IP [3]
Use \fBidentity\fR if no \fBdefault\fR is specified and the parameter is an \fIinput\fR\&.
.IP [4]
Use \fBboolean\fR  if the specified \fBdefault\fR value is a Tcl boolean\&.
.IP [5]
Use \fBinteger\fR  if the specified \fBdefault\fR value is a Tcl integer\&.
.IP [6]
Use \fBidentity\fR as fallback of last resort\&.
.RE
.TP
\fBpresence\fR
This command is best discussed as part of the wider area of
\fIboolean\fR \fIoption\fRs, i\&.e\&. \fIoption\fRs with the standard
\fIvalidation type\fR \fBboolean\fR assigned to them\&. These have
associated special behaviours, both in the handling of the
specification, and in the \fIParsing\fR phase\&.
.sp
First, normal boolean options\&.
They have automatic aliases declared for them, derived from their
primary flag\&.
An option named "foo" will have an alias of "no-foo", and the
reverse\&.
In the \fIParsing\fR phase the "foo" and "no-foo" flags have inverse
semantics, and both are allowed to occur without option argument
following the flag\&.
This is in contrast to all other \fIoption\fRs which must have such
an argument\&. The parser essentially uses the \fIvalidation type\fR
to decide if the word after the flag is a proper boolean value, or
not, i\&.e\&. an argument to assign to the \fIparameter\fR, or not\&.
.sp
Now \fBpresence\fR declares a variant of the above, a boolean
option \fIwithout\fR the automatic aliases, and \fInever\fR taking
an argument during parsing\&.
Its mere \fIpresence\fR on the command line will set its
\fIparameter\fR\&.
Their \fBdefault\fR value is consequently fixed to \fBfalse\fR as
well\&.
.PP
.PP
.SS SIGNALING
Of the four callbacks supported by parameters the first two,
\fBgenerate\fR and \fBvalidate\fR have been described already, in the
sections \fBRepresentations\fR and \fBValidation\fR,
respectively\&.
.PP
This section explains the commonalities between the callbacks
in general, and the last two, for notifications about state changes in
detail\&.
.PP
All callbacks are treated as command prefixes, not scripts\&.
There are no placeholder substitutions, only arguments added to each
command prefix on invokation\&. This does not harm the generality of the
system, as complex scripts can be used via procedures or equivalents
(i\&.e\&. \fBapply\fR)\&.
.PP
The two callbacks not yet described are the state-change
callbacks through which the framework can actively drive parts of the
application while processing the command line, whereas normally the
application drives access to parameters through their methods\&.
.TP
\fBwhen-complete\fR \fIcmdprefix\fR
This command declares the state-change callback to invoke when the
\fIinternal representation\fR of the \fIparameter\fR is generated
from the \fIstring representation\fR, or the various ways of
getting a default\&.
.sp
The callback is invoked with two arguments, the
\fBcmdr::parameter\fR instance of the changed \fIparameter\fR,
and its \fIinternal representation\fR, in this order\&.
.TP
\fBwhen-set\fR \fIcmdprefix\fR
This command declares the state-change callback to invoke when the
\fIstring representation\fR of the \fIparameter\fR is set during
command line parsing\&.
.sp
The callback is invoked with two arguments, the
\fBcmdr::parameter\fR instance of the changed \fIparameter\fR,
and its \fIstring representation\fR, in this order\&.
.PP
Due to their nature these callbacks are invoked at runtime during
either the \fIParsing\fR, \fICompletion\fR, or \fIExecution\fR
phases\&.
The details are shown in the table below\&. The specification commands
influencing the timing, i\&.e\&. forcing the use in a specific phase are
shown in the intersection of callback and phase\&.
.CS


                    | Dispatch | Parsing | Completion  | Execution
--------------------+----------+---------+-------------+-----------
validate (default)  | *        |         |             |
--------------------+----------+---------+-------------+-----------
validate (complete) |          | *       | immediate   | defered
when-set            |          | *       |             |
--------------------+----------+---------+-------------+-----------
generate            |          |         | immediate   | defered
validate (validate) |          | test    | immediate   | defered
validate (release)  |          | test    | immediate   | defered
--------------------+----------+---------+-------------+-----------
when-complete       |          |         | immediate   | defered
--------------------+----------+---------+-------------+-----------

.CE
.SH "RELATED DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the project\fR
.IP [2]
\fICmdr - License\fR
.IP [3]
\fICmdr - Log of Changes\fR
.IP [4]
\fICmdr - How To Get The Sources\fR
.IP [5]
\fICmdr - The Installer's Guide\fR
.IP [6]
\fICmdr - The Developer's Guide\fR
.PP
.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at
\fICmdr Tickets\fR [https:/core\&.tcl\&.tk/akupries/cmdr]\&.
.PP
Please also report any ideas you may have for enhancements of
either package(s) and/or documentation\&.
.SH KEYWORDS
arguments, command hierarchy, command line completion, command line handling, command tree, editing command line, help for command line, hierarchy of commands, interactive command shell, optional arguments, options, parameters, processing command line, tree of commands
.SH COPYRIGHT
.nf
Copyright (c) 2013 Andreas Kupries
Copyright (c) 2013 Documentation, Andreas Kupries

.fi

'\"
'\" Generated from file 'cmdr_dsl_private\&.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_dsl_private" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_dsl_private \- Cmdr - Private Specification Language
.SH SYNOPSIS
\fBdescription\fR \fItext\fR
.sp
\fBinput\fR \fIname\fR \fIhelp\fR \fIscript\fR
.sp
\fBinteractive\fR
.sp
\fBoption\fR \fIname\fR \fIhelp\fR \fIscript\fR
.sp
\fBstate\fR \fIname\fR \fIhelp\fR \fIscript\fR
.sp
\fBundocumented\fR
.sp
\fBuse\fR \fIname\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 document is for users of the cmdr framework\&. It introduces the
domain-specific language for the specification of privates in detail\&.
.SH "RELATED SPECIFICATION DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the Specification Language\fR
.IP [2]
\fICmdr - Officer Specification Language\fR
.IP [3]
\fICmdr - Private Specification Language\fR
.IP [4]
\fICmdr - Parameter Specification Language\fR
.PP
.SH "LANGUAGE REFERENCE"
.PP
The specification of \fIprivate\fRs is quite easy, with only
seven commands\&. The important parts are found in the \fIparameter\fR
specifications, explained in \fICmdr - Parameter Specification Language\fR\&.
.TP
\fBdescription\fR \fItext\fR
This command declares the help text for the \fIprivate\fR\&.
.TP
\fBinput\fR \fIname\fR \fIhelp\fR \fIscript\fR
This command adds an \fIinput\fR (i\&.e\&. positional) \fIparameter\fR
to the \fIprivate\fR, with description \fIhelp\fR and its
specification \fIscript\fR of parameter commands as described in
\fICmdr - Parameter Specification Language\fR\&.
.TP
\fBinteractive\fR
This command activates a mini-shell for this \fIprivate\fR which will
be invoked when required \fIparameter\fRs do not have a value after
argument extraction and matching\&.
.sp
By default the only interactive command line shells are
associated with the \fIofficer\fRs\&.
.sp
The command \fBcmdr::config interactive\fR provided by the
package \fBcmdr::config\fR can be used to globally activate this
type of shell for all \fIprivate\fRs\&.
.TP
\fBoption\fR \fIname\fR \fIhelp\fR \fIscript\fR
This command adds an \fIoption\fR (i\&.e\&. named) \fIparameter\fR to
the \fIprivate\fR, with description \fIhelp\fR and its specification
\fIscript\fR of parameter commands as described in
\fICmdr - Parameter Specification Language\fR\&.
.TP
\fBstate\fR \fIname\fR \fIhelp\fR \fIscript\fR
This command adds a \fIstate\fR (i\&.e\&. hidden) \fIparameter\fR to the
\fIprivate\fR, with description \fIhelp\fR and its specification
\fIscript\fR of parameter commands as described in
\fICmdr - Parameter Specification Language\fR\&.
.TP
\fBundocumented\fR
This command excludes the \fIprivate\fR from the generated help\&.
.TP
\fBuse\fR \fIname\fR
This command is the counterpart to \fBcommon\fR of \fIofficer\fRs
(See \fICmdr - Officer Specification Language\fR)\&.
It inserts the named block into the specification, executing it in
place\&. As such it expects the contents to be a script of private
commands as described in this section\&.
.PP
.PP
Please continue reading with \fICmdr - Parameter Specification Language\fR\&.
.SH "RELATED DOCUMENTS"
.IP [1]
\fICmdr - Introduction to the project\fR
.IP [2]
\fICmdr - License\fR
.IP [3]
\fICmdr - Log of Changes\fR
.IP [4]
\fICmdr - How To Get The Sources\fR
.IP [5]
\fICmdr - The Installer's Guide\fR
.IP [6]
\fICmdr - The Developer's Guide\fR
.PP
.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at
\fICmdr Tickets\fR [https:/core\&.tcl\&.tk/akupries/cmdr]\&.
.PP
Please also report any ideas you may have for enhancements of
either package(s) and/or documentation\&.
.SH KEYWORDS
arguments, command hierarchy, command line completion, command line handling, command tree, editing command line, help for command line, hierarchy of commands, interactive command shell, optional arguments, options, parameters, processing command line, tree of commands
.SH COPYRIGHT
.nf
Copyright (c) 2013 Andreas Kupries
Copyright (c) 2013 Documentation, Andreas Kupries

.fi

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::help" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help_json" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::help::json" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_help_sql" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::help::sql" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_officer" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_officer \- Cmdr - Aggregation of multiple commands for dispatch\&.
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::officer\fR \fBnew\fR \fIsuper\fR \fIname\fR \fIactions\fR
.sp
\fB::cmdr::officer\fR \fBcreate\fR \fIobj\fR \fIsuper\fR \fIname\fR \fIactions\fR
.sp
\fB<officer>\fR \fBchildren\fR
.sp
................................................................................
The instance command of the actor (officer actually) which contains the new officer\&.
.TP
string \fIname\fR
The user-visible name of the command\&.
.TP
script \fIactions\fR
The specification of the officer's subordinates\&.
Please read \fICmdr - Specification Language\fR (section "Officers") for the details\&.
.RE
.PP
.SH "INSTANCE API"
The instance API is not public\&. It is used internally by the framework
during the parsing of a command hierarchy specification to configure
the officer instances, and when processing a command line at runtime
to manage navigation of the hierarchy, word-completion, etc\&.
................................................................................
script \fIpath\fR
The list of names specifying the route from this officer to the new
private\&. The last element is the name of the private command, while
the preceding names specify the intermediate officers\&.
.TP
script \fIarguments\fR
The specification of the private's parameters\&.
Please read \fICmdr - Specification Language\fR (section "Parameters") for the details\&.
.TP
cmd-prefix \fIaction\fR
The command prefix to invoke when this private is selected for
execution\&.  It takes a single argument, the instance command of the
hidden \fBcmdr::config\fR container holding the private's
parameters\&. The result of the action, if there is any, is ignored by
the framework\&.
................................................................................
the set of subordinates known to this officer\&. This is the same type
of script as used during construction, except here we dynamically
extend the officer\&.
.RS
.TP
script \fIactions\fR
The specification of the officer's additional subordinates\&.
Please read \fICmdr - Specification Language\fR (section "Officers") for the details\&.
.RE
.TP
\fB<officer>\fR \fBlookup\fR \fIname\fR
This method returns the instance command of the sub-ordinate with the
given \fIname\fR\&. An error is thrown if such a sub-ordinate does not
exist\&. See also method \fBhas\fR\&.
.RS

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::officer" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr::officer \- Cmdr - Aggregation of multiple commands for dispatch\&.
.SH SYNOPSIS
package require \fBcmdr::officer \fR
.sp
\fB::cmdr::officer\fR \fBnew\fR \fIsuper\fR \fIname\fR \fIactions\fR
.sp
\fB::cmdr::officer\fR \fBcreate\fR \fIobj\fR \fIsuper\fR \fIname\fR \fIactions\fR
.sp
\fB<officer>\fR \fBchildren\fR
.sp
................................................................................
The instance command of the actor (officer actually) which contains the new officer\&.
.TP
string \fIname\fR
The user-visible name of the command\&.
.TP
script \fIactions\fR
The specification of the officer's subordinates\&.
Please read \fICmdr - Officer Specification Language\fR for the details\&.
.RE
.PP
.SH "INSTANCE API"
The instance API is not public\&. It is used internally by the framework
during the parsing of a command hierarchy specification to configure
the officer instances, and when processing a command line at runtime
to manage navigation of the hierarchy, word-completion, etc\&.
................................................................................
script \fIpath\fR
The list of names specifying the route from this officer to the new
private\&. The last element is the name of the private command, while
the preceding names specify the intermediate officers\&.
.TP
script \fIarguments\fR
The specification of the private's parameters\&.
Please read \fICmdr - Parameter Specification Language\fR for the details\&.
.TP
cmd-prefix \fIaction\fR
The command prefix to invoke when this private is selected for
execution\&.  It takes a single argument, the instance command of the
hidden \fBcmdr::config\fR container holding the private's
parameters\&. The result of the action, if there is any, is ignored by
the framework\&.
................................................................................
the set of subordinates known to this officer\&. This is the same type
of script as used during construction, except here we dynamically
extend the officer\&.
.RS
.TP
script \fIactions\fR
The specification of the officer's additional subordinates\&.
Please read \fICmdr - Officer Specification Language\fR for the details\&.
.RE
.TP
\fB<officer>\fR \fBlookup\fR \fIname\fR
This method returns the instance command of the sub-ordinate with the
given \fIname\fR\&. An error is thrown if such a sub-ordinate does not
exist\&. See also method \fBhas\fR\&.
.RS

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_parameter" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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
\fB<parameter>\fR \fBaccept\fR \fIx\fR
.sp
................................................................................
help, if not overridden by a \fBlabel\fR declaration
(in \fIspec\fR)\&.
.TP
string \fIdescription\fR
Human-readable help text for the parameter\&.
.TP
script \fIspec\fR
Tcl-script specifying the parameter in detail\&. Please read
\fICmdr - Specification Language\fR (section "Parameters") for the details\&.
.RE
.PP
.SH "INSTANCE API"
Most of the instance API is not public\&.
.PP
It is described here for use by developers maintaining,
modifying and extending the framework itself\&. A user of the framework

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::parameter" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr::parameter \- Cmdr - Command parameters
.SH SYNOPSIS
package require \fBcmdr::parameter \fR
.sp
\fB::cmdr::parameter\fR \fBnew\fR \fIconfig\fR \fIorder\fR \fIcmdline\fR \fIrequired\fR \fIdefered\fR \fIname\fR \fIdescription\fR \fIspec\fR
.sp
\fB::cmdr::parameter\fR \fBcreate\fR \fIobj\fR \fIconfig\fR \fIorder\fR \fIcmdline\fR \fIrequired\fR \fIdefered\fR \fIname\fR \fIdescription\fR \fIspec\fR
.sp
\fB<parameter>\fR \fBaccept\fR \fIx\fR
.sp
................................................................................
help, if not overridden by a \fBlabel\fR declaration
(in \fIspec\fR)\&.
.TP
string \fIdescription\fR
Human-readable help text for the parameter\&.
.TP
script \fIspec\fR
Tcl-script specifying the parameter in detail\&.
Please read \fICmdr - Parameter Specification Language\fR for the details\&.
.RE
.PP
.SH "INSTANCE API"
Most of the instance API is not public\&.
.PP
It is described here for use by developers maintaining,
modifying and extending the framework itself\&. A user of the framework

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_private" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_private \- Cmdr - Single command handling, options, and arguments
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::private\fR \fBnew\fR \fIsuper\fR \fIname\fR \fIarguments\fR \fIaction\fR
.sp
\fB::cmdr::private\fR \fBcreate\fR \fIobj\fR \fIsuper\fR \fIname\fR \fIarguments\fR \fIaction\fR
.sp
\fB<private>\fR \fBcomplete-words\fR \fIparse\fR
.sp
................................................................................
The instance command of the actor (officer actually) which contains the new private\&.
.TP
string \fIname\fR
The user-visible name of the command\&.
.TP
script \fIarguments\fR
The specification of the private's parameters\&.
Please read \fICmdr - Specification Language\fR (section "Privates") for the details\&.
.TP
cmd-prefix \fIaction\fR
The command prefix to invoke when this private is selected for
execution\&.  It takes a single argument, the instance command of the
hidden \fBcmdr::config\fR container holding the private's
parameters\&. The result of the action, if there is any, is ignored by
the framework\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::private" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr::private \- Cmdr - Single command handling, options, and arguments
.SH SYNOPSIS
package require \fBcmdr::private \fR
.sp
\fB::cmdr::private\fR \fBnew\fR \fIsuper\fR \fIname\fR \fIarguments\fR \fIaction\fR
.sp
\fB::cmdr::private\fR \fBcreate\fR \fIobj\fR \fIsuper\fR \fIname\fR \fIarguments\fR \fIaction\fR
.sp
\fB<private>\fR \fBcomplete-words\fR \fIparse\fR
.sp
................................................................................
The instance command of the actor (officer actually) which contains the new private\&.
.TP
string \fIname\fR
The user-visible name of the command\&.
.TP
script \fIarguments\fR
The specification of the private's parameters\&.
Please read \fICmdr - Private Specification Language\fR for the details\&.
.TP
cmd-prefix \fIaction\fR
The command prefix to invoke when this private is selected for
execution\&.  It takes a single argument, the instance command of the
hidden \fBcmdr::config\fR container holding the private's
parameters\&. The result of the action, if there is any, is ignored by
the framework\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_util" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_util \- Cmdr - General Utilities - Internal
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::util\fR \fBpadr\fR \fIlist\fR
.sp
.BE
.SH DESCRIPTION

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::util" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr::util \- Cmdr - General Utilities - Internal
.SH SYNOPSIS
package require \fBcmdr::util \fR
.sp
\fB::cmdr::util\fR \fBpadr\fR \fIlist\fR
.sp
.BE
.SH DESCRIPTION

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_validate" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_validate \- Cmdr - Standard validation types for parameters
.SH SYNOPSIS
package require \fBcmdr::validate \fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::validate" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr::validate \- Cmdr - Standard validation types for parameters
.SH SYNOPSIS
package require \fBcmdr::validate \fR
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr_validate_common" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cmdr::validate::common" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.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

.TH "cmdr_vtypes" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_vtypes \- Cmdr - Writing custom validation types
.SH SYNOPSIS
package require \fBcmdr::validate \fR
.sp
\fBcmd\fR \fBcomplete\fR \fIp\fR \fIx\fR
.sp
\fBcmd\fR \fBdefault\fR \fIp\fR
.sp
\fBcmd\fR \fBrelease\fR \fIp\fR \fIx\fR
.sp
\fBcmd\fR \fBvalidate\fR \fIp\fR \fIx\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 document describes the API expected of validation types to make
them usable within the Cmdr framework, and how to write a
custom validation type\&.
.PP
Readers interested in the standard validation types of the
framework should read \fICmdr - Standard validation types for parameters\fR\&.
.SH BACKGROUND
Validation types are Cmdr's answer to the necessity of moving
between the string and internal representations of
\fBcmdr::parameter\fR instances\&.
................................................................................
Because of the same necessity all parameters must have a
validation type assigned to them, and the framework will choose which,
if the user did not\&. This choice is made per the six rules below and
always returns one of the builtins described in \fICmdr - Standard validation types for parameters\fR\&.
.IP [1]
Use \fBidentity\fR if a  \fBgenerate\fR callback is specified\&.
.IP [2]
Use \fBboolean\fR  if no \fBdefault\fR is specified and the parameter is an option\&.
.IP [3]
Use \fBidentity\fR if no \fBdefault\fR is specified and the parameter is an input\&.
.IP [4]
Use \fBboolean\fR  if the specified \fBdefault\fR value is a Tcl boolean\&.
.IP [5]
Use \fBinteger\fR  if the specified \fBdefault\fR value is a Tcl integer\&.
.IP [6]
Use \fBidentity\fR as fallback of last resort\&.
.PP
.PP
The general concept of validation types was taken from package
\fBsnit\fR, and modified to suit Cmdr\&. Where snit's types
expect only a single method to validate the input we expect all types
to support an ensemble of \fIfour\fR methods\&. One for the basic

validation and transformation of the input, another for the release of
any internal representation so generated, plus two more for delivery
of a default representation and support for command line completion\&.

The details (method names, signatures, etc\&.) can be found in section
\fBAPI\fR below\&.
.PP
As an example the implementation of the standard boolean
validation type is shown in section \fBExample\fR\&.
.PP
It should be noted that while snit's validation types in
principle allow for the transformation of input into a disparate
internal representation, they never went so far as to allow complex
representations which might require the release of resources after
use\&.
.PP
The \fBvalidate\fR and \fBrelease\fR methods are primarily used
during either completion or execution phases, depending on the chosen

deferal state\&. They may also be used during parsing, for optional
inputs under the \fBtest\fR-regime]\&.
.PP
The \fBcomplete\fR method will be used whereever the system
activates an interactive command line shell where arguments may be
assigned to parameters\&.
.PP
The \fBdefault\fR method on the other hand can expect to be
invoked during dispatch, as part of the system's declaration
processing, if not preempted by \fBdefault\fR and \fBgenerate\fR
declarations for the parameter\&. Note here that the \fBdefault\fR

method has the same signature as a \fBgenerate\fR callback and can be
used as such\&. This is actually needed and useful when the default
internal representation for a validation type cannot be expressed as a
fixed value and its creation while parsing the specification itself is

too early\&. We can still use the validation type for its generation, by
hooking it explicitly into \fBgenerate\fR to change the timing of its
invokation\&.
.SH API
In the descriptions below the \fBcmd\fR is a placeholder for the
actual command prefix, most often a main command, of the validation
type\&.
.TP
\fBcmd\fR \fBcomplete\fR \fIp\fR \fIx\fR
This method is invoked during command completion done by the framework\&.
.sp
It has to return the list of legal string representations for
the type and parameter instance \fIp\fR which have the incomplete word
\fIx\fR as their prefix\&.
.RS
.TP
................................................................................
process\&.  While the standard validation types do not make use of it a
custom type may have need for access to the context of the completion\&.
.TP
string \fIx\fR
The string value to complete\&.
.RE
.TP
\fBcmd\fR \fBdefault\fR \fIp\fR
This method is invoked when the framework has to determine the
internal representation of a parameter which has no user-specified
string representation\&.
.sp
It has to return the default internal representation for
the type and parameter instance \fIp\fR\&.
.RS
................................................................................
do not make use of it a custom type may have need for access to the
context\&.
.TP
string \fIx\fR
The string value to complete\&.
.RE
.TP
\fBcmd\fR \fBrelease\fR \fIp\fR \fIx\fR
This method is invoked when the framework has to get rid of an
internal representation for a parameter\&.
.sp
It has to release any resources associated with the internal
representation \fIx\fR of parameter instance \fIp\fR\&.
.sp
Note that the result of this method, if there is any, is
................................................................................
make use of it a custom type may have need for access to the context
of the completion\&.
.TP
string \fIx\fR
The internal representation to release\&.
.RE
.TP
\fBcmd\fR \fBvalidate\fR \fIp\fR \fIx\fR
This method is invoked during to validate and convert a string
representation\&.
.sp
It has to verify that \fIx\fR is a legal string representation
for the parameter instance \fIp\fR, and return the associated internal
representation\&.
.RS

.TH "cmdr_vtypes" n 0 doc "Cmdr, a framework for command line parsing and dispatch"
.BS
.SH NAME
cmdr_vtypes \- Cmdr - Writing custom validation types
.SH SYNOPSIS
package require \fBcmdr::validate \fR
.sp
\fB<v-type>\fR \fBcomplete\fR \fIp\fR \fIx\fR
.sp
\fB<v-type>\fR \fBdefault\fR \fIp\fR
.sp
\fB<v-type>\fR \fBrelease\fR \fIp\fR \fIx\fR
.sp
\fB<v-type>\fR \fBvalidate\fR \fIp\fR \fIx\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 document describes the API expected of \fIvalidation types\fR
to make them usable within the Cmdr framework, and how to
write a custom validation type\&.
.PP
Readers interested in the standard validation types of the
framework should read \fICmdr - Standard validation types for parameters\fR\&.
.SH BACKGROUND
Validation types are Cmdr's answer to the necessity of moving
between the string and internal representations of
\fBcmdr::parameter\fR instances\&.
................................................................................
Because of the same necessity all parameters must have a
validation type assigned to them, and the framework will choose which,
if the user did not\&. This choice is made per the six rules below and
always returns one of the builtins described in \fICmdr - Standard validation types for parameters\fR\&.
.IP [1]
Use \fBidentity\fR if a  \fBgenerate\fR callback is specified\&.
.IP [2]
Use \fBboolean\fR  if no \fBdefault\fR is specified and the parameter is an \fIoption\fR\&.
.IP [3]
Use \fBidentity\fR if no \fBdefault\fR is specified and the parameter is an \fIinput\fR\&.
.IP [4]
Use \fBboolean\fR  if the specified \fBdefault\fR value is a Tcl boolean\&.
.IP [5]
Use \fBinteger\fR  if the specified \fBdefault\fR value is a Tcl integer\&.
.IP [6]
Use \fBidentity\fR as fallback of last resort\&.
.PP
.PP
The general concept of \fIvalidation types\fR was taken from
package \fBsnit\fR, and modified to suit Cmdr\&.
Where \fBsnit\fR's types expect only a single method to validate
the input we expect all types to support an ensemble of \fIfour\fR
methods\&.
One for the basic validation and transformation of the string, another
for the release of any internal representation so generated, plus two
more for delivery of a default representation and support for command
line completion\&.
The details (method names, signatures, etc\&.) can be found in section
\fBAPI\fR below\&.
.PP
As an example the implementation of the standard boolean
validation type is shown in section \fBExample\fR\&.
.PP
It should be noted that while \fBsnit\fR's validation types
in principle allow for the transformation of input into a disparate
internal representation, they never went so far as to allow complex
representations which might require the release of resources after
use\&.
.PP
The \fBvalidate\fR and \fBrelease\fR methods are primarily used
during either \fICompletion\fR or \fIExecution\fR phases, depending
on the chosen deferal state\&.
They may also be used during the \fIParsing\fR phase, for optional
\fIinputs\fR under the \fBtest\fR-regime]\&.
.PP
The \fBcomplete\fR method will be used whereever the system
activates an interactive command line shell where arguments may be
assigned to parameters\&.
.PP
The \fBdefault\fR method on the other hand can expect to be
invoked during the \fIDispatch\fR phase, as part of the system's
declaration processing, if not preempted by \fBdefault\fR and
\fBgenerate\fR declarations for the parameter\&.
Note here that the \fBdefault\fR method has the same signature as a
paramete's \fBgenerate\fR callback and can be used as such\&.
This is actually needed and useful when the default internal
representation for a validation type cannot be expressed as a fixed
value and its creation while parsing the specification itself is too
early\&.
We can still use the validation type for its generation, by hooking it
explicitly into \fBgenerate\fR to change the timing of its invokation\&.

.SH API
In the descriptions below the \fB<v-type>\fR is a placeholder for the
actual command prefix, most often a main command, of the validation
type\&.
.TP
\fB<v-type>\fR \fBcomplete\fR \fIp\fR \fIx\fR
This method is invoked during command completion done by the framework\&.
.sp
It has to return the list of legal string representations for
the type and parameter instance \fIp\fR which have the incomplete word
\fIx\fR as their prefix\&.
.RS
.TP
................................................................................
process\&.  While the standard validation types do not make use of it a
custom type may have need for access to the context of the completion\&.
.TP
string \fIx\fR
The string value to complete\&.
.RE
.TP
\fB<v-type>\fR \fBdefault\fR \fIp\fR
This method is invoked when the framework has to determine the
internal representation of a parameter which has no user-specified
string representation\&.
.sp
It has to return the default internal representation for
the type and parameter instance \fIp\fR\&.
.RS
................................................................................
do not make use of it a custom type may have need for access to the
context\&.
.TP
string \fIx\fR
The string value to complete\&.
.RE
.TP
\fB<v-type>\fR \fBrelease\fR \fIp\fR \fIx\fR
This method is invoked when the framework has to get rid of an
internal representation for a parameter\&.
.sp
It has to release any resources associated with the internal
representation \fIx\fR of parameter instance \fIp\fR\&.
.sp
Note that the result of this method, if there is any, is
................................................................................
make use of it a custom type may have need for access to the context
of the completion\&.
.TP
string \fIx\fR
The internal representation to release\&.
.RE
.TP
\fB<v-type>\fR \fBvalidate\fR \fIp\fR \fIx\fR
This method is invoked during to validate and convert a string
representation\&.
.sp
It has to verify that \fIx\fR is a legal string representation
for the parameter instance \fIp\fR, and return the associated internal
representation\&.
.RS

arguments
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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\&.n\fR
cmdr
.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_dsl\&.n\fR
cmdr_dsl
.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_officer\&.n\fR
cmdr_officer
.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

arguments
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
command hierarchy
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
command line completion
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
command line handling
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
command tree
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
editing command line
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
help for command line
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
hierarchy of commands
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
interactive command shell
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
optional arguments
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
options
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
parameters
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP



\fBfiles/cmdr_config\&.n\fR






cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP



\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR
cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR

cmdr_dsl_parameter
.TP
\fBfiles/cmdr_dsl_private\&.n\fR

cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
processing command line
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP



\fBfiles/cmdr_config\&.n\fR






cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP



\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP
\fBfiles/cmdr_dsl_officer\&.n\fR





















cmdr_dsl_officer
.TP
\fBfiles/cmdr_dsl_parameter\&.n\fR
cmdr_dsl_parameter
.TP

































\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE
tree of commands
.RS
.TP
\fBfiles/cmdr\&.n\fR
cmdr
.TP
\fBfiles/cmdr_actor\&.n\fR
cmdr::actor
.TP
\fBfiles/cmdr_config\&.n\fR
cmdr::config
.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_officer\&.n\fR
cmdr::officer
.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_changes\&.n\fR
cmdr_changes
.TP
\fBfiles/cmdr_howto_development\&.n\fR
cmdr_development
.TP
\fBfiles/cmdr_dsl\&.n\fR
cmdr_dsl
.TP




























































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




























































\fBfiles/cmdr_dsl_parameter\&.n\fR












































cmdr_dsl_parameter

.TP















\fBfiles/cmdr_dsl_private\&.n\fR
cmdr_dsl_private
.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_vtypes\&.n\fR
cmdr_vtypes
.RE

.SH CONTENTS
doc
.RS
.TP
\fBcmdr\fR
\fIfiles/cmdr\&.n\fR: Cmdr - Main package and API
.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_dsl\fR
\fIfiles/cmdr_dsl\&.n\fR: Cmdr - Specification Language
.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_officer\fR
\fIfiles/cmdr_officer\&.n\fR: Cmdr - Aggregation of multiple commands for dispatch\&.
.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

.SH CONTENTS
doc
.RS
.TP
\fBcmdr\fR
\fIfiles/cmdr\&.n\fR: Cmdr - Main package and API
.TP
\fBcmdr::actor\fR
\fIfiles/cmdr_actor\&.n\fR: Cmdr - Base class for officers and privates - Internal
.TP
\fBcmdr::config\fR
\fIfiles/cmdr_config\&.n\fR: Cmdr - Collection of parameters for privates
.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::officer\fR
\fIfiles/cmdr_officer\&.n\fR: Cmdr - Aggregation of multiple commands for dispatch\&.
.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_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_dsl\fR
\fIfiles/cmdr_dsl\&.n\fR: Cmdr - Introduction to the Specification Language
.TP
\fBcmdr_dsl_officer\fR
\fIfiles/cmdr_dsl_officer\&.n\fR: Cmdr - Officer Specification Language
.TP
\fBcmdr_dsl_parameter\fR
\fIfiles/cmdr_dsl_parameter\&.n\fR: Cmdr - Parameter Specification Language
.TP
\fBcmdr_dsl_private\fR
\fIfiles/cmdr_dsl_private\&.n\fR: Cmdr - Private Specification Language
.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_vtypes\fR
\fIfiles/cmdr_vtypes\&.n\fR: Cmdr - Writing custom validation types

<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</b> <b class="method">new</b> <i class="arg">name</i> <i class="arg">specification</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">name</i> <i class="arg">specification</i></a></li>
<li><a href="#3"><b class="cmd">::cmdr</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</b> <b class="method">interactive?</b></a></li>
</ul>
................................................................................
<p>The result of the command is the new instance command.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The user-visible name of the command (hierarchy).</p></dd>
<dt>script <i class="arg">actions</i></dt>
<dd><p>The specification of the subordinate commands. On the command line
these are the toplevel commands of the application using the
hierarchy. Please read <i class="term"><a href="cmdr_dsl.html">Cmdr - Specification Language</a></i>, (section &quot;Officers&quot;)
for the details.</p></dd>
</dl></dd>
<dt><a name="3"><b class="cmd">::cmdr</b> <b class="method">interactive</b> <span class="opt">?<i class="arg">enable</i>?</span></a></dt>
<dd><p>This command globally (de)activates the interactive parts of the
framework, as per the value of <i class="arg">enable</i>.</p>
<p>By default (initial state) the framework allows interaction.</p>
<dl class="arguments">
<dt>boolean <i class="arg">enable</i></dt>

<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</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::cmdr</b> <b class="method">new</b> <i class="arg">name</i> <i class="arg">specification</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">name</i> <i class="arg">specification</i></a></li>
<li><a href="#3"><b class="cmd">::cmdr</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</b> <b class="method">interactive?</b></a></li>
</ul>
................................................................................
<p>The result of the command is the new instance command.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The user-visible name of the command (hierarchy).</p></dd>
<dt>script <i class="arg">actions</i></dt>
<dd><p>The specification of the subordinate commands. On the command line
these are the toplevel commands of the application using the
hierarchy. Please read <i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i> for the
details.</p></dd>
</dl></dd>
<dt><a name="3"><b class="cmd">::cmdr</b> <b class="method">interactive</b> <span class="opt">?<i class="arg">enable</i>?</span></a></dt>
<dd><p>This command globally (de)activates the interactive parts of the
framework, as per the value of <i class="arg">enable</i>.</p>
<p>By default (initial state) the framework allows interaction.</p>
<dl class="arguments">
<dt>boolean <i class="arg">enable</i></dt>

<html><head>
<title>cmdr_actor - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></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;Cmdr, a framework for command line parsing and dispatch&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="#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>
................................................................................
</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,
................................................................................
<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>

<html><head>
<title>cmdr::actor - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></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;Cmdr, a framework for command line parsing and dispatch&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="#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::actor</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>
................................................................................
</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"><a href="cmdr_officer.html">cmdr::officer</a></b> and <b class="package"><a href="cmdr_private.html">cmdr::private</a></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,
................................................................................
<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"><a href="cmdr_parameter.html">cmdr::parameter</a></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>

<html><head>
<title>cmdr_config - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></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;Cmdr, a framework for command line parsing and dispatch&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="#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>
................................................................................
</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
................................................................................
<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"><a href="cmdr_dsl.html">Cmdr - Specification Language</a></i> (section &quot;Parameters&quot;) 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">
................................................................................
<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>

<html><head>
<title>cmdr::config - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></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;Cmdr, a framework for command line parsing and dispatch&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="#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::config</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>
................................................................................
</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"><a href="cmdr_private.html">cmdr::private</a></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
................................................................................
<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"><a href="cmdr_private.html">cmdr::private</a></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"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i> 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">
................................................................................
<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"><a href="cmdr_parameter.html">cmdr::parameter</a></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>

   <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_dsl(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>cmdr_dsl - Cmdr - Specification Language</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="#section1">Description</a></li>
<li class="section"><a href="#section2">Introductory examples</a>
<ul>
<li class="subsection"><a href="#subsection1">Basic setup, private with inputs</a></li>
<li class="subsection"><a href="#subsection2">Basic setup, command nesting</a></li>
</ul>
</li>
<li class="section"><a href="#section3">Language Reference</a>
<ul>
<li class="subsection"><a href="#subsection3">General</a></li>
<li class="subsection"><a href="#subsection4">Officers</a></li>
<li class="subsection"><a href="#subsection5">Privates</a></li>
<li class="subsection"><a href="#subsection6">Parameters</a></li>
</ul>
</li>
<li class="section"><a href="#section4">Related Documents</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="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 document is for users of the cmdr framework. It describes the
domain-specific language for the specification of command hierarchies
with commands and their parameters (options, and inputs).</p>

</div>
<div id="section2" class="section"><h2><a name="section2">Introductory examples</a></h2>








<p>Instead of immediately diving into the full syntax of the
specification language first a few examples to demonstrate the general
look and feel, plus basic features.</p>
<div id="subsection1" class="subsection"><h3><a name="subsection1">Basic setup, private with inputs</a></h3>
<p>This example specifies a command line providing 3 commands for
the management of command aliases.
This is actually a slice of <b class="syscmd">stackato</b>'s interface, reduced and
modified to fit here.
While it does not have the necessary backend procedures required to
actually run the commands, it is enough to demonstrate basic features,
namely the declaration of &quot;privates&quot; with &quot;input&quot; parameters.</p>
................................................................................
exit
</pre>
<p>At the bottom of the example, just above we can also see the
very simple Tcl command which invokes the command line processing for
a list of words, here coming from <b class="variable">$argv</b>, i.e. the application's
command line.</p>
</div>
<div id="subsection2" class="subsection"><h3><a name="subsection2">Basic setup, command nesting</a></h3>
<p>The decoupling of command names from their implementations seen
in the previous example makes it easy to re-arrange and re-label the
user visible commands without having to touch any other part of the
code.</p>
<p>This is demonstrated in the example below, moving the 3
&quot;privates&quot; into an &quot;officer&quot; and renaming them, without changing the
actions. Note that the parameter specifications were removed for
................................................................................
	} ::foo::backend::alias::list
    }
}
...
</pre>
</div>
</div>
<div id="section3" class="section"><h2><a name="section3">Language Reference</a></h2>
<p>With the examples behind us we can now go and specify the entire
specification language. If you have skipped here on first reading,
ignoring the examples, please go back and read them first.</p>
<div id="subsection3" class="subsection"><h3><a name="subsection3">General</a></h3>
<p>The conceptual model underneath the command hierarchy is that
of a tree.</p>
<p>The inner nodes of the tree represent command ensembles, here
called &quot;officer&quot;s. Each officer knows one or more commands, and
delegates actual execution to their respective specification, which
may be another officer, or a private.</p>
<p>The leaf nodes of the tree represent the individual commands,
here called &quot;private&quot;s. Each private is responsible for a single
action, and knows how to perform it and the parameters used to

configure that action at runtime.</p>
<p>The same model is graphically presented in the
Entity-Relationship-Diagram below.
<img alt="erd" src="../../image/erd.png"></p>
<p>The &quot;Actor&quot; in that diagram is the common base class for the
ensembles and commands and not directly relevant to users.</p>
<p>The &quot;Config&quot; on the other hand is the second interface seen by
the user, as the sole argument to the action command prefix of
<b class="cmd">private</b> (See section <b class="sectref">Officer</b>).

This container holds all the declared parameters of the command the
action is invoked for, and provides easy access to them through its
methods (see package <b class="package">cmdr::config</b>) at the time of execution.</p>
</div>
<div id="subsection4" class="subsection"><h3><a name="subsection4">Officers</a></h3>
<pre class="example">
alias &lt;name&gt; = &lt;name'&gt;...            Declare an alternate name for a command path.
alias &lt;name&gt;                         Declare an alternate name for the previous command.
common &lt;name&gt; &lt;script&gt;               Declare a named shared code block.
default                              Set last command as default.
description &lt;text&gt;                   Set help text for the current ensemble.
ehandler &lt;cmdprefix&gt;                 Execution Interposition.
officer &lt;name&gt; &lt;script&gt;              Declare a nested ensemble = sub-officer
private &lt;name&gt; &lt;script&gt; &lt;cmdprefix&gt;  Declare a simple command  = private
undocumented                         Hide ensemble from help.
</pre>
<dl class="definitions">
<dt><b class="cmd">alias</b> <i class="arg">name</i> <b class="const">=</b> <i class="arg">name'</i>...</dt>
<dd></dd>
<dt><b class="cmd">alias</b> <i class="arg">name</i></dt>
<dd><p>This is a structuring command, for the command hierarchy. Its main
uses are the creation of alternate command names, and of shortcuts
through the command hierarchy.</p>
<p>For example, stackato's command specification for alias management is
more like <span class="sectref"><a href="#subsection2">Basic setup, command nesting</a></span> and uses shortcuts
similar to what is shown in
--TODO--(example ls-alias2)-- to provide the look of a flat namespace.</p>
<p>In the first form the <i class="arg">name</i> is given the explicit path to
the command it is an alias for. In the second form it implicitly
refers to the immediately preceding officer or private.
Note that &quot;immediately&quot; is interpreted at the current level. The
system is <em>not</em> looking into a nested specification for its last
command.</p></dd>
<dt><b class="cmd">common</b> <i class="arg">name</i> <i class="arg">text</i></dt>
<dd><p>This is another structuring command, for structuring the specification
itself instead of the command tree it declares.</p>
<p>It creates named values, usually code blocks, which can be
shared between specifications. Note that while each block is visible
in the current officer and its subordinates, parents and siblings have
no access.</p>
<p>An example of such a block would be</p>
<pre class="example">
common *all* {
    option debug {
	Activate client internal tracing.
    } {
	undocumented
	list
	when-complete [lambda {p tags} {
	    foreach t $tags { debug on $t }
	}]
    }
}
</pre>
<p>This example defines an option to access the subsystem for debug
narative (See package <b class="package">Tcllib</b>). 
The example is actually special, as the block named <b class="const">*all*</b> is
reserved by the framework. This block, if defined, is automatically
included at the front of all &quot;private&quot; specifications, i.e. shared
across all the specified commands underneath this officer. A very
important trait for the option in the example, as it makes the debug
setup available to all commands without having to explicitly include
the block, and possibly forgetting such.</p>
<p>Generally speaking, the framework reserves all blocks whose
name begins with a star, i.e <b class="const">*</b>, for its own use.</p></dd>
<dt><b class="cmd">default</b></dt>
<dd><p>This command sets up a special kind of alias. The last &quot;private&quot; or
&quot;officer&quot; is set as the default command to use at runtime.
This means that if during &quot;Dispatch&quot; the currently processed word does
not match any of the commands known to this officer this default is
used. If no default is specified an error will be thrown instead.</p></dd>
<dt><b class="cmd">description</b> <i class="arg">text</i></dt>
<dd><p>This command declares the help text of the officer.</p></dd>
<dt><b class="cmd">ehandler</b> <i class="arg">cmdprefix</i></dt>
<dd><p>This is an advanced command which should normally only be specified at
the top of the whole hierarchy (from which its value will
automatically propagate to all subordinates).</p>
<p>At runtime the framework will call the specified command prefix
with a single argument, a script whose execution is equivalent to the
phases &quot;Parsing&quot;, &quot;Completion&quot;, and &quot;Execution&quot; of the framework, as
described in section --TODO--(sectref:flow/phases)--. The handler <em>must</em>
call this script, and can perform any application-specific actions
before and after.</p>
<p>This handler's main uses are two-fold:</p>
<ol class="enumerated">
<li><p>Capture and hande application-specific errors which should not
abort the application, or shown as Tcl stacktrace.</p></li>
<li><p>Cleanup of application-specific transient settings the
parameter callbacks and/or command implementations may have set during
their execution. This is especially important if the interactive
command line shells of the framework are active. Without such a
handler and its bespoke cleanup code transient settings will leak
between multiple commands run from such a shell, something which is
definitely not wanted.</p></li>
</ol></dd>
<dt><b class="cmd">officer</b> <i class="arg">name</i> <i class="arg">script</i></dt>
<dd><p>This command creates a named subordinate officer with its
specification <i class="arg">script</i> of officer commands as described here.</p></dd>
<dt><b class="cmd">private</b> <i class="arg">name</i> <i class="arg">script</i> <i class="arg">cmdprefix</i></dt>
<dd><p>This command creates a named subordinate private with its
specification <i class="arg">script</i> of private commands as described in the
following section, and a command prefix to invoke when it is chosen.</p>
<p>This command prefix is called with a single argument, the
<b class="package">cmdr::config</b> instance holding the parameters of the private.
--TODO--(ref:backend-example-code)--</p></dd>
<dt><b class="cmd">undocumented</b></dt>
<dd><p>Use of this command influences the generation of help, excluding all
officers having this marker (and their subordinates) from the
help. Note that subordinates reachable through aliases may be
included, under the alias name, if not explicitly excluded themselves.</p></dd>
</dl>
</div>
<div id="subsection5" class="subsection"><h3><a name="subsection5">Privates</a></h3>
<p>The specification of simple commands, i.e. &quot;privates&quot; is quite
easy, with only seven commands (see the table below). The important
parts are found in the parameter specifications, explained in the next
section.</p>
<pre class="example">
description &lt;text&gt;             Set help text for command.
input &lt;name&gt; &lt;help&gt; &lt;script&gt;   Declare a positional parameter.
interactive                    Allow interactive shell.
option &lt;name&gt; &lt;help&gt; &lt;script&gt;  Declare a named parameter.
state &lt;name&gt; &lt;help&gt; &lt;script&gt;   Declare a hidden parameter.
undocumented                   Hide command from help.
use &lt;name&gt;                     Execute the named &quot;common&quot; block here.
</pre>
<dl class="definitions">
<dt><b class="cmd">description</b> <i class="arg">text</i></dt>
<dd><p>Like the equivalent command for <span class="sectref"><a href="#subsection4">Officers</a></span> this command
declares the help text for the private.</p></dd>
<dt><b class="cmd">input</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></dt>
<dd><p>This command adds an &quot;input&quot; (positional) parameter to the &quot;private&quot;,
with description <i class="arg">help</i> and its specification <i class="arg">script</i> of
parameter commands as described in the following section.</p></dd>
<dt><b class="cmd">interactive</b></dt>
<dd><p>This command influences the runtime. By default the only interactive
command line shells are associated with the officers. Setting this
marker activates such a shell for the private, to be invoked when
required parameters do not have a value.</p>
<p>The global command <b class="cmd">cmdr::config interactive</b> in package
<b class="package">cmdr::config</b> can be used to globally activate this type of
shell for all &quot;privates&quot;.</p></dd>
<dt><b class="cmd">option</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></dt>
<dd><p>This command adds an &quot;option&quot; (named) parameter to the &quot;private&quot;, with
description <i class="arg">help</i> and its specification <i class="arg">script</i> of parameter
commands as described in the following section.</p></dd>
<dt><b class="cmd">state</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></dt>
<dd><p>This command adds a &quot;state&quot; (hidden) parameter to the &quot;private&quot;, with
description <i class="arg">help</i> and its specification <i class="arg">script</i> of parameter
commands as described in the following section.</p></dd>
<dt><b class="cmd">undocumented</b></dt>
<dd><p>Like the equivalent command for <span class="sectref"><a href="#subsection4">Officers</a></span> use of this command
influences the generation of help, excluding all privates having this
marker from it.</p></dd>
<dt><b class="cmd">use</b> <i class="arg">name</i></dt>
<dd><p>This command is the counterpart to <b class="cmd">common</b> of <span class="sectref"><a href="#subsection4">Officers</a></span>.
It inserts the named block into the specification, executing it. As
such it expects the contents to be a script of private commands as
described in this section.</p></dd>
</dl>

</div>
<div id="subsection6" class="subsection"><h3><a name="subsection6">Parameters</a></h3>
<p>The parameters of private commands are the heart of the system,
providing the space needed to transfer the command arguments to the
implementations, and having the most attributes controlling their
behaviour.</p>
<p>This complexity is mitigated strongly by the use of sensible
defaults for each of the three possible kinds of parameter, i.e.
positional &quot;inputs&quot;, named &quot;options&quot;, and &quot;state&quot; hidden from the
command line.</p>
<p>Each kind has its own construction command in the DSL for
<span class="sectref"><a href="#subsection5">Privates</a></span> which specifies the common information which cannot
have defaults, i.e.</p>
<ol class="enumerated">
<li><p>the name identifying it to the system,</p></li>
<li><p>the help text describing it in informal speech, and, of course,</p></li>
<li><p>the parameter specification itself, using the commands of this section.</p></li>
</ol>
<pre class="example">
alias &lt;name&gt;              N  Declare alternate flag for an option.
default &lt;value&gt;            R Set constant default value.
defered                    R  Defer calculation of the internal representation until demanded.
generate &lt;cmdprefix&gt;       R  Set callback returning the default value.
immediate                  R  Complement of defered.
interact ?&lt;prompt&gt;?        R  Enable the interactive entry of the string value.
label &lt;text&gt;              N  Name to use in the help, and as primary flag (for an option).
list                       R Declare as list-valued.
optional                  G  Declare input as optional.
presence                   V Declare as boolean option without argument.
test                      G  Control the matching of words to optional inputs.
undocumented              G  Declare as hidden from help.
validate &lt;cmdprefix&gt;       V Declare validation type.
when-complete &lt;cmdprefix&gt; C  Set callback executed when the value becomes known.
when-set &lt;cmdprefix&gt;      C  Set callback executed when the string value becomes known.
</pre>
<p><em>Naming</em></p>
<p>We have two commands to influence the visible naming of all
parameters.</p>
<p>As background, all parameters are named for proper
identification within the framework and other Tcl code, i.e. the
various callbacks, including a &quot;private&quot;s action. This &quot;system name&quot;
has to be unique within the &quot;private&quot; a parameter belongs to. Beyond
that however the visible parameters have to be identified within help
texts, and, in case of &quot;options&quot;, for detection during &quot;Parsing&quot;. That
is the visible naming, seen by a user of any application whose command
line processing is based on the Cmdr framework.</p>
<dl class="definitions">
<dt><b class="cmd">label</b> <i class="arg">text</i></dt>
<dd><p>This command declares the visible name, if different from the system
name used as the default. Note that in most cases this default is good
enough, obviating the need for this command.</p>
<p>The only use case seen so far is when two semantically
equivalent input and option parameters clash, requiring different
internal names due to the requirement for uniqueness, yet also the
same visible name and flag within the help to highlight their
connection and equivalence.</p></dd>
<dt><b class="cmd">alias</b> <i class="arg">name</i></dt>
<dd><p>For option parameters the &quot;label&quot; command and its default specifies
the name of the primary flag recognized during parsing. If that is not
enough for a specific option this command allows the specification of
any number additional flags to be recognized.</p>
<p>Note however that the framework automatically recognizes not
only the specified flags, but also all unique prefixes, obviating the
need for this command in many cases.</p></dd>
</dl>
<p><em>General control</em></p>
<p>The general handling of a parameter is influenced by three
commands.</p>
<dl class="definitions">
<dt><b class="cmd">optional</b></dt>
<dd><p>This command marks the parameter as optional, i.e. as something the
user may skip on the command line, and the application supplying
sensible defaults. --TODO--(sectref:para/vtype)--
During parsing the framework will then expend some effort to determine
whether an argument word should be assigned to the parameter, or not.</p>
<p>This setting is only applicable to &quot;inputs&quot;, as &quot;options&quot; are
optional by definition, and &quot;state&quot; is hidden.</p></dd>
<dt><b class="cmd">test</b></dt>
<dd><p>This command is related to the above, switching from the standard
regime for acceptance based on counting and thresholds to a different
one based on validation. The details are explained in section
--TODO--(sectref:flow/parsing, flow/optional)--.</p></dd>
<dt><b class="cmd">undocumented</b></dt>
<dd><p>Like &quot;officers&quot; and &quot;privates&quot; parameters can be hidden from the
generated help. This is the command for doing so, the same as for the
first two.</p>
<p>The main use case is the hiding of options giving an
application developer access to the internals of their application,
something a regular user has no need of, and doesn't have to know
about.</p></dd>
</dl>
<p><em>Representations</em></p>
<p>An important concept of parameters is something taken up from
Tcl itself.
The differentation between string and internal representations.
Where Tcl uses internal representations to speed up its execution here
this separation is that of between the information delivered to the
application by a user, and the application-specific data structures
behind them.</p>
<p>All parameters will have an internal representation.
This is usually derived from the string representation provided by the
user.
The details of that process are explained in section
--TODO--(sectref:para/vtype)--
about validation types.
However we have cases where the user cannot specify a string
representation (&quot;states&quot;), or is allowed to choose not to (optional
&quot;inputs&quot;, &quot;options&quot;).
For these cases three specification commands are made available
enabling us to programmatically choose the internal representation.</p>
<dl class="definitions">
<dt><b class="cmd">default</b> <i class="arg">value</i></dt>
<dd><p>This command provides a constant value for the internal
representation.</p></dd>
<dt><b class="cmd">generate</b> <i class="arg">cmdprefix</i></dt>
<dd><p>This command provides a callback to compute the internal
representation at runtime. This is useful if the default is something
which cannot be captured as a fixed value, for example a handle to
some resource, or a dynamically created object.</p>
<p>The command prefix is invoked with a single argument, the
<b class="package">cmdr::parameter</b> instance for which to generate the internal
representation.</p></dd>
</dl>
<p>The commands &quot;default&quot; and &quot;generate&quot; exclude each other,
i.e. only of them can be specified.
If neither are specified, and we need a default (see the cases
above) a default is chosen per the two rules below:</p>
<ol class="enumerated">
<li><p>Use the empty string for a &quot;list&quot; parameter.</p></li>
<li><p>Use the default value supplied by the chosen validation type
       (See section --TODO--(sectref:para/vtype)--).</p></li>
</ol>
<dl class="definitions">
<dt><b class="cmd">interact</b> <span class="opt">?<i class="arg">prompt</i>?</span></dt>
<dd><p>This command actually does not specify an internal representation, but
activates another method for the user to specify a string value for
the parameter, outside of the command line. 
As such it has priority over either &quot;default&quot; and &quot;generate,&quot; and can
be specified with either. A parameter marked with it will
interactively ask the user for a value if none was specified on the
command line.</p>
<p>The default <i class="arg">prompt</i> is derived from the system name.</p></dd>
</dl>
<p>To recapitulate:</p>
<ol class="enumerated">
<li><p>A string representation specified on the command line has the
       highest priority and goes through the chosen validation type to
       get the associated internal representation.</p></li>
<li><p>If activated via &quot;interact&quot; a small shell is run asking the
       user for a value (or more, as per &quot;list&quot;, see below). The
       result goes through the chosen validation type to get the
       associated internal representation.</p></li>
<li><p>After that the internal representation is either the declared
       &quot;default,&quot; or the result of invoking the &quot;generate&quot;
       callback. As internal representations they are <em>not</em> run
       through the chosen validation type.</p></li>
</ol>
<dl class="definitions">
<dt><b class="cmd">list</b></dt>
<dd><p>This command is used to mark parameters whose string and thus internal
value should be treated as a list. By default all parameters are scalar.</p>
<p>This affects the handling of the parameter during parsing, by
&quot;interact&quot; above, and the use of the validation type. The last two ask
for multiple values, and feed the elements of the string value
separately through validation instead of just the string value in one.
During parsing treatment of &quot;options&quot; changes from keeping only the
last assigned value to accumulation of all values. Similarly a
list-&quot;input&quot; takes all remaining words on the command line for itself
instead of just the current word. Because of this list-&quot;inputs&quot; are
only allowed as the last parameter of a &quot;private.&quot;</p></dd>
</dl>
<p>The last two specification commands dealing with the
representations control when the internal representation is created.</p>
<dl class="definitions">
<dt><b class="cmd">defered</b></dt>
<dd><p>This command marks a parameter as defered, with the internal
representation computed on first access to its value. This is the
default for &quot;state&quot; parameters.</p></dd>
<dt><b class="cmd">immediate</b></dt>
<dd><p>This command marks a parameter as immediate, with the internal
representation computed in the &quot;Completion&quot; phase. This is the default
for &quot;input&quot; and &quot;option&quot; parameters.</p></dd>
</dl>
<p><em>Validation</em></p>
<p>The answer to the necessity of moving between the string and
internal representations described in the previous section are the
validation types. Given a string representation they either return the
associated internal representation or raise an error, signaling that
the input was illegal. This part of their work, the verification of
the legality of the input string gave them their name.</p>
<p>The general concept of validation types was taken from
<b class="package">snit</b>, and modified to suit Cmdr. Where snit's types
expect only a single method to validate the input Cmdr
expects all types to support an ensemble of <em>four</em> methods, one
for the basic validation and transformation of the input, another for
the release of any internal representation so generated, plus delivery
of a default representation and support for command line completion.</p>
<dl class="definitions">
<dt><b class="cmd">validate</b> <i class="arg">cmdprefix</i></dt>
<dd><p>This command specifies a validation type for the parameter, in the
form of a command prefix.
The set of methods this callback has to support, their signatures,
etc. are all explained in <i class="term"><a href="cmdr_vtypes.html">Cmdr - Writing custom validation types</a></i>. This document
contains the implementation of the standard boolean validation type as
an example as well.</p>
<p>Because of the same necessity all parameters must have a
validation type assigned to them, and the system will choose which, if
the user did not. This choice is made per the six rules below and
always returns one of the standard types implemented in package
<b class="package">cmdr::validate</b>.</p>
<ol class="enumerated">
<li><p>Use &quot;identity&quot; if a &quot;generate&quot; callback is specified.</p></li>
<li><p>Use &quot;boolean&quot;  if no &quot;default&quot; is specified and the parameter is an option.</p></li>
<li><p>Use &quot;identity&quot; if no &quot;default&quot; is specified and the parameter is an input.</p></li>
<li><p>Use &quot;boolean&quot;  if the specified &quot;default&quot; value is a Tcl boolean.</p></li>
<li><p>Use &quot;integer&quot;  if the specified &quot;default&quot; value is a Tcl integer.</p></li>
<li><p>Use &quot;identity&quot; as fallback of last resort.</p></li>
</ol></dd>
<dt><b class="cmd">presence</b></dt>
<dd><p>This command is best discussed as part of the wider area of &quot;boolean&quot;
options, i.e. options with validation type &quot;boolean&quot; assigned to
them. These have associated special behaviours, both in the handling
of the specification, and during parsing.</p>
<p>First, normal boolean options. They have automatic aliases
declared for them, derived from their primary flag. An option named
&quot;foo&quot; will have an alias of &quot;no-foo&quot;, and the reverse. During parsing
the &quot;foo&quot; and &quot;no-foo&quot; flags have inverse semantics, and both are
allowed to occur without option argument following the flag. This is
in contrast to all other options which must have such an argument. The
parser essentially uses the validation type to decide if the word
after the flag is a proper boolean value, or not, i.e. an argument to
assign to the parameter, or not.</p>
<p>Now &quot;presence&quot; declares a variant of the above, a boolean
option without the automatic aliases, and <em>never</em> taking an
argument during parsing. Its mere <em>presence</em> on the command line
will set its parameter. Their default value is consequently fixed to
<b class="const">false</b> as well.</p></dd>
</dl>
<p><em>Signaling</em>         
Of the four callbacks supported by parameters the first two,
&quot;generate&quot; and &quot;validate&quot; have been described already, in the sections
--TODO--\ref{para/reps} about representations and
--TODO--\ref{para/vtype} about validation types, respectively.</p>
<p>This section explains the commonalities between the callbacks
in general, and the last two, for notifications about state changes in
detail.</p>
<p>All callbacks are treated as command prefixes, not
scripts.
There are no placeholder substitutions, only arguments added to each
command prefix on invokation. This does not harm the generality of the
system, as complex scripts can be used via procedures or equivalents
(i.e. <b class="cmd">apply</b>).</p>
<p>The two callbacks not yet described are the state-change
callbacks through which the framework can actively drive parts of the
application while processing the command line, whereas normally the
application drives access to parameters through their methods.</p>
<dl class="definitions">
<dt><b class="cmd">when-complete</b> <i class="arg">cmdprefix</i></dt>
<dd><p>This command declares the state-change callback to invoke when the
internal representation of the parameter is generated from the string
representation, or the various ways of getting a default.</p>
<p>The callback is invoked with two arguments, the
<b class="package">cmdr::parameter</b> instance of the parameter which changed, and
its internal representation, in this order.</p></dd>
<dt><b class="cmd">when-set</b> <i class="arg">cmdprefix</i></dt>
<dd><p>This command declares the state-change callback to invoke when the
string representation of the parameter is set during command line
parsing.</p>
<p>The callback is invoked with two arguments, the
<b class="package">cmdr::parameter</b> instance of the parameter which changed, and
its string representation, in this order.</p></dd>
</dl>
<p>Due to their nature these callbacks are invoked at runtime during
either parsing, completion,&quot; or execution. The details are shown in
the table below. The specification commands influencing the timing,
i.e. forcing the use in a specific phase are shown in the intersection
of callback and phase.</p>
<pre class="example">
                    | Dispatch | Parsing | Completion  | Execution
--------------------+----------+---------+-------------+-----------
validate (default)  | *        |         |             |          
--------------------+----------+---------+-------------+-----------
validate (complete) |          | *       | immediate   | defered
when-set            |          | *       |             |          
--------------------+----------+---------+-------------+-----------
generate            |          |         | immediate   | defered
validate (validate) |          | test    | immediate   | defered
validate (release)  |          | test    | immediate   | defered
--------------------+----------+---------+-------------+-----------
when-complete       |          |         | immediate   | defered
--------------------+----------+---------+-------------+-----------
</pre>
</div>
</div>
<div id="section4" class="section"><h2><a name="section4">Related Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term"><a href="cmdr_introduction.html">Cmdr - Introduction to the project</a></i></p></li>
<li><p><i class="term"><a href="cmdr_license.html">Cmdr - License</a></i></p></li>
<li><p><i class="term"><a href="cmdr_changes.html">Cmdr - Log of Changes</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_installation.html">Cmdr - The Installer's Guide</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_development.html">Cmdr - The Developer's Guide</a></i></p></li>
</ol>
</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>

   <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_dsl(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>cmdr_dsl - Cmdr - Introduction to the Specification Language</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="#section1">Description</a></li>
<li class="section"><a href="#section2">Related Specification Documents</a></li>





<li class="section"><a href="#section3">Introductory examples</a>
<ul>
<li class="subsection"><a href="#subsection1">Basic private commands with inputs</a></li>
<li class="subsection"><a href="#subsection2">Simple command nesting</a></li>


</ul>
</li>
<li class="section"><a href="#section4">Language Reference</a></li>
<li class="section"><a href="#section5">Related Documents</a></li>
<li class="section"><a href="#section6">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="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 document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of command hierarchies
with commands and their parameters by way of examples and then
provides links to the detailed reference documents.</p>
</div>
<div id="section2" class="section"><h2><a name="section2">Related Specification Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term">Cmdr - Introduction to the Specification Language</i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_private.html">Cmdr - Private Specification Language</a></i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i></p></li>
</ol>
</div>
<div id="section3" class="section"><h2><a name="section3">Introductory examples</a></h2>
<p>Instead of immediately diving into the full syntax of the
specification language first a few examples to demonstrate the general
look and feel, plus basic features.</p>
<div id="subsection1" class="subsection"><h3><a name="subsection1">Basic private commands with inputs</a></h3>
<p>This example specifies a command line providing 3 commands for
the management of command aliases.
This is actually a slice of <b class="syscmd">stackato</b>'s interface, reduced and
modified to fit here.
While it does not have the necessary backend procedures required to
actually run the commands, it is enough to demonstrate basic features,
namely the declaration of &quot;privates&quot; with &quot;input&quot; parameters.</p>
................................................................................
exit
</pre>
<p>At the bottom of the example, just above we can also see the
very simple Tcl command which invokes the command line processing for
a list of words, here coming from <b class="variable">$argv</b>, i.e. the application's
command line.</p>
</div>
<div id="subsection2" class="subsection"><h3><a name="subsection2">Simple command nesting</a></h3>
<p>The decoupling of command names from their implementations seen
in the previous example makes it easy to re-arrange and re-label the
user visible commands without having to touch any other part of the
code.</p>
<p>This is demonstrated in the example below, moving the 3
&quot;privates&quot; into an &quot;officer&quot; and renaming them, without changing the
actions. Note that the parameter specifications were removed for
................................................................................
	} ::foo::backend::alias::list
    }
}
...
</pre>
</div>
</div>
<div id="section4" class="section"><h2><a name="section4">Language Reference</a></h2>
<p>With the examples behind us we can now go and specify the entire
specification language. If you have skipped here on first reading,
ignoring the examples, please go back and read them first.</p>

<p>The conceptual model underneath the command hierarchy is that
of a tree.</p>
<p>The inner nodes of the tree represent command ensembles, here
called <i class="term">officer</i>s. Each officer knows one or more commands to
perform, and delegates actual execution to their respective
specification, which may be another <i class="term">officer</i>, or a <i class="term">private</i>.</p>
<p>The leaf nodes of the tree represent the individual commands,
here called <i class="term">private</i>s.
Each <i class="term">private</i> is responsible for a single action and knows how
to perform it, and the set of <i class="term">parameter</i>s used to configure that
action at runtime.</p>
<p>The same model is graphically presented in the
Entity-Relationship-Diagram below.
<img alt="erd" src="../../image/erd.png"></p>
<p>The <i class="term">actor</i> in that diagram is the common base class for the
ensembles and commands and not directly relevant to users.</p>
<p>The <i class="term">config</i> on the other hand is the second interface
seen by the user, as the sole argument to the action command prefix of
<b class="cmd">private</b>. See <i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i> for the details.
This container, an instance of <b class="package"><a href="cmdr_config.html">cmdr::config</a></b>, holds all the
declared parameters of the command the action is invoked for, and
provides easy access to them through its methods at the time of


















































































































execution.</p>











































<p>Please continue reading with <i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i>.</p>
</div>





































































































































































































































































































<div id="section5" class="section"><h2><a name="section5">Related Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term"><a href="cmdr_introduction.html">Cmdr - Introduction to the project</a></i></p></li>
<li><p><i class="term"><a href="cmdr_license.html">Cmdr - License</a></i></p></li>
<li><p><i class="term"><a href="cmdr_changes.html">Cmdr - Log of Changes</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_installation.html">Cmdr - The Installer's Guide</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_development.html">Cmdr - The Developer's Guide</a></i></p></li>
</ol>
</div>
<div id="section6" class="section"><h2><a name="section6">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>

<html><head>
<title>cmdr_dsl_officer - Cmdr, a framework for command line parsing and dispatch</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_dsl_officer.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_dsl_officer.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_dsl_officer(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>cmdr_dsl_officer - Cmdr - Officer Specification Language</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">Related Specification Documents</a></li>
<li class="section"><a href="#section3">Language Reference</a></li>
<li class="section"><a href="#section4">Related Documents</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="syntax">
<li><a href="#1"><b class="cmd">alias</b> <i class="arg">name</i> <b class="const">=</b> <i class="arg">name'</i>...</a></li>
<li><a href="#2"><b class="cmd">alias</b> <i class="arg">name</i></a></li>
<li><a href="#3"><b class="cmd">common</b> <i class="arg">name</i> <i class="arg">text</i></a></li>
<li><a href="#4"><b class="cmd">default</b></a></li>
<li><a href="#5"><b class="cmd">description</b> <i class="arg">text</i></a></li>
<li><a href="#6"><b class="cmd">ehandler</b> <i class="arg">cmdprefix</i></a></li>
<li><a href="#7"><b class="cmd">officer</b> <i class="arg">name</i> <i class="arg">script</i></a></li>
<li><a href="#8"><b class="cmd">private</b> <i class="arg">name</i> <i class="arg">script</i> <i class="arg">cmdprefix</i></a></li>
<li><a href="#9"><b class="cmd">undocumented</b></a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of <i class="term">officer</i>s in
detail.</p>
</div>
<div id="section2" class="section"><h2><a name="section2">Related Specification Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term"><a href="cmdr_dsl.html">Cmdr - Introduction to the Specification Language</a></i></p></li>
<li><p><i class="term">Cmdr - Officer Specification Language</i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_private.html">Cmdr - Private Specification Language</a></i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i></p></li>
</ol>
</div>
<div id="section3" class="section"><h2><a name="section3">Language Reference</a></h2>
<dl class="definitions">
<dt><a name="1"><b class="cmd">alias</b> <i class="arg">name</i> <b class="const">=</b> <i class="arg">name'</i>...</a></dt>
<dd></dd>
<dt><a name="2"><b class="cmd">alias</b> <i class="arg">name</i></a></dt>
<dd><p>This is a structuring command, for the command hierarchy. Its main
uses are the creation of alternate command names, and of shortcuts
through the command hierarchy.</p>
<p>For example, <b class="syscmd">stackato</b>'s command specification for
alias management is written using deep nesting and uses aliases to
provide the look of a flat namespace to application users.</p>
<p>In the first form the <i class="arg">name</i> is given the explicit path to
the actor the name is an alias for.
In the second form the alias implicitly refers to the immediately
preceding <i class="term">officer</i> or <i class="term">private</i>.
Note that &quot;immediately&quot; is interpreted at the current level. The
system is <em>not</em> looking into a nested specification for its last
command.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The name of the alias.</p></dd>
<dt>string <i class="arg">name'...</i></dt>
<dd><p>The path to the actor, as list of names.</p></dd>
</dl></dd>
<dt><a name="3"><b class="cmd">common</b> <i class="arg">name</i> <i class="arg">text</i></a></dt>
<dd><p>This is another structuring command, for structuring the specification
itself instead of the command tree it declares.</p>
<p>It creates named values, usually code blocks, which can be
shared between specifications. Note that while each block is visible
in the current <i class="term">officer</i> and its subordinates, parents and
siblings have no access.</p>
<p>An example of such a block would be</p>
<pre class="example">
common *all* {
    option debug {
	Activate client internal tracing.
    } {
	undocumented
	list
	when-complete [lambda {p tags} {
	    foreach t $tags { debug on $t }
	}]
    }
}
</pre>
<p>This example defines an option to access the subsystem for debug
narative (See package <b class="package">Tcllib</b>).
The example is actually special, as the block named <b class="const">*all*</b> is
reserved by the framework.
This block, if defined, is automatically included at the front of all
<i class="term">private</i> specifications, i.e. shared across all the privates
specified underneath this <i class="term">officer</i>. A very important trait for
the <i class="term">option</i> in the example, as it makes the debug setup
available to all privates without having to explicitly include the
block, and possibly forgetting such.</p>
<p>Generally speaking, the framework reserves all blocks whose
name begins with a star, i.e <b class="const">*</b>, for its own use.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></dt>
<dd><p>The name of the common block.</p></dd>
<dt>string <i class="arg">text</i></dt>
<dd><p>The text of the block.</p></dd>
</dl></dd>
<dt><a name="4"><b class="cmd">default</b></a></dt>
<dd><p>This command sets up a special kind of alias.
The last <i class="term">private</i> or <i class="term">officer</i> is set as the default
command to use at runtime.
This means that if during &quot;Dispatch&quot; phase the currently processed
word does not match any of the commands known to this <i class="term">officer</i>
this default is used. If no default is specified an error will be
thrown instead.</p></dd>
<dt><a name="5"><b class="cmd">description</b> <i class="arg">text</i></a></dt>
<dd><p>This command declares the help text of the <i class="term">officer</i>.</p></dd>
<dt><a name="6"><b class="cmd">ehandler</b> <i class="arg">cmdprefix</i></a></dt>
<dd><p>This is an advanced command which should normally only be specified at
the top of the whole hierarchy (from which its value will
automatically propagate to all subordinates).</p>
<p>At runtime the framework will call the specified command prefix
with a single argument, a script whose execution is equivalent to the
phases &quot;Parsing&quot;, &quot;Completion&quot;, and &quot;Execution&quot; of the framework, as
described in --TODO--(sectref:flow/phases)--. The handler <em>must</em>
call this script, and can perform any application-specific actions
before and after.</p>
<p>This handler's main uses are two-fold:</p>
<ol class="enumerated">
<li><p>Capture and hande application-specific errors which should not
abort the application, nor shown as Tcl stacktrace.</p></li>
<li><p>Cleanup of application-specific transient state the
<i class="term">parameter</i> callbacks (See <i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i>)
and/or actions may have set during their execution.
This is especially important if the interactive command line shells of
the framework are enabled. Without such a handler and its bespoke
cleanup code transient state <em>will</em> leak between multiple
commands run from such a shell, something which is definitely not
wanted.</p></li>
</ol></dd>
<dt><a name="7"><b class="cmd">officer</b> <i class="arg">name</i> <i class="arg">script</i></a></dt>
<dd><p>This command creates a named subordinate <i class="term">officer</i> with its
specification <i class="arg">script</i> of officer commands as described here.</p></dd>
<dt><a name="8"><b class="cmd">private</b> <i class="arg">name</i> <i class="arg">script</i> <i class="arg">cmdprefix</i></a></dt>
<dd><p>This command creates a named subordinate <i class="term">private</i> with its
specification <i class="arg">script</i> of private commands
(See <i class="term"><a href="cmdr_dsl_private.html">Cmdr - Private Specification Language</a></i>), and a command prefix to invoke
when it is chosen.</p>
<p>This command prefix is called with a single argument, the
<b class="package"><a href="cmdr_config.html">cmdr::config</a></b> instance holding the <i class="term">parameter</i>s of the
private.
--TODO--(ref:backend-example-code)--</p></dd>
<dt><a name="9"><b class="cmd">undocumented</b></a></dt>
<dd><p>This command excludes the <i class="term">officer</i> (and its subordinates) from
the generated help.
Note that subordinates reachable through aliases may be included,
under the alias name, if they are not explicitly excluded themselves.</p></dd>
</dl>
<p>Please continue reading with <i class="term"><a href="cmdr_dsl_private.html">Cmdr - Private Specification Language</a></i>.</p>
</div>
<div id="section4" class="section"><h2><a name="section4">Related Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term"><a href="cmdr_introduction.html">Cmdr - Introduction to the project</a></i></p></li>
<li><p><i class="term"><a href="cmdr_license.html">Cmdr - License</a></i></p></li>
<li><p><i class="term"><a href="cmdr_changes.html">Cmdr - Log of Changes</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_installation.html">Cmdr - The Installer's Guide</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_development.html">Cmdr - The Developer's Guide</a></i></p></li>
</ol>
</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>

<html><head>
<title>cmdr_dsl_parameter - Cmdr, a framework for command line parsing and dispatch</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_dsl_parameter.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_dsl_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_dsl_parameter(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>cmdr_dsl_parameter - Cmdr - Parameter Specification Language</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">Related Specification Documents</a></li>
<li class="section"><a href="#section3">Language Reference</a>
<ul>
<li class="subsection"><a href="#subsection1">Naming</a></li>
<li class="subsection"><a href="#subsection2">General control</a></li>
<li class="subsection"><a href="#subsection3">Representations</a></li>
<li class="subsection"><a href="#subsection4">Validation</a></li>
<li class="subsection"><a href="#subsection5">Signaling</a></li>
</ul>
</li>
<li class="section"><a href="#section4">Related Documents</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="syntax">
<li><a href="#1"><b class="cmd">label</b> <i class="arg">text</i></a></li>
<li><a href="#2"><b class="cmd">alias</b> <i class="arg">name</i></a></li>
<li><a href="#3"><b class="cmd">optional</b></a></li>
<li><a href="#4"><b class="cmd">test</b></a></li>
<li><a href="#5"><b class="cmd">undocumented</b></a></li>
<li><a href="#6"><b class="cmd">default</b> <i class="arg">value</i></a></li>
<li><a href="#7"><b class="cmd">generate</b> <i class="arg">cmdprefix</i></a></li>
<li><a href="#8"><b class="cmd">interact</b> <span class="opt">?<i class="arg">prompt</i>?</span></a></li>
<li><a href="#9"><b class="cmd">list</b></a></li>
<li><a href="#10"><b class="cmd">defered</b></a></li>
<li><a href="#11"><b class="cmd">immediate</b></a></li>
<li><a href="#12"><b class="cmd">validate</b> <i class="arg">cmdprefix</i></a></li>
<li><a href="#13"><b class="cmd">presence</b></a></li>
<li><a href="#14"><b class="cmd">when-complete</b> <i class="arg">cmdprefix</i></a></li>
<li><a href="#15"><b class="cmd">when-set</b> <i class="arg">cmdprefix</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 document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of parameters in
detail.</p>
</div>
<div id="section2" class="section"><h2><a name="section2">Related Specification Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term"><a href="cmdr_dsl.html">Cmdr - Introduction to the Specification Language</a></i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_private.html">Cmdr - Private Specification Language</a></i></p></li>
<li><p><i class="term">Cmdr - Parameter Specification Language</i></p></li>
</ol>
</div>
<div id="section3" class="section"><h2><a name="section3">Language Reference</a></h2>
<p>The <i class="term">parameter</i>s of <i class="term">private</i>s are the heart of the
system, providing the space needed to transfer command arguments to
their implementations, and having the most attributes controlling
their behaviour.</p>
<p>This complexity is strongly mitigated by the use of sensible
defaults for each of the three possible kinds of parameter, i.e.
positional <i class="term">input</i>s, named <i class="term">option</i>s&quot;, and <i class="term">state</i>
hidden from the command line.</p>
<p>Each kind has its own construction command in the language for
<i class="term">private</i>s (See <i class="term"><a href="cmdr_dsl_private.html">Cmdr - Private Specification Language</a></i>) which specifies
the common information which cannot have defaults, i.e.</p>
<ol class="enumerated">
<li><p>the name identifying it to the system,</p></li>
<li><p>the help text describing it in informal speech, and, of course,</p></li>
<li><p>the parameter specification itself, using the commands of this section.</p></li>
</ol>
<div id="subsection1" class="subsection"><h3><a name="subsection1">Naming</a></h3>
<p>We have two commands to influence the visible naming of all
<i class="term">parameter</i>s.</p>
<p>As background, all <i class="term">parameter</i>s are named, to properly
identify them within the framework and other Tcl code, i.e. in the
various callbacks and the <i class="term">private</i>'s action.
This <i class="term">system name</i> has to be unique within the <i class="term">private</i> a
<i class="term">parameter</i> belongs to.
Beyond that however the visible (i.e. non-term state])
<i class="term">parameter</i>s have to be identified by users within help texts,
and, in the case of <i class="term">option</i>s, for detection during the
<i class="term">Parsing</i> phase.
That is the visible naming, seen by a user of any application whose
command line processing is based on the Cmdr framework.</p>
<dl class="definitions">
<dt><a name="1"><b class="cmd">label</b> <i class="arg">text</i></a></dt>
<dd><p>This command declares the <i class="term">parameter</i>'s visible name, if
different from the <i class="term">system name</i> used as the default. Note that
in most cases this default is good enough, obviating the need for this
command.</p>
<p>The only use case seen so far is when two semantically
equivalent <i class="term">input</i> and <i class="term">option</i> <i class="term">parameter</i>s clash,
forcing the use of different system names due to the requirement for
their uniqueness, yet also use the same visible name and flag within
the help to highlight their connection and equivalence.</p></dd>
<dt><a name="2"><b class="cmd">alias</b> <i class="arg">name</i></a></dt>
<dd><p>For <i class="term">option</i>s the <b class="cmd">label</b> command and its default specifies
the name of the <i class="term">primary flag</i> recognized during the
<i class="term">Parsing</i> phase.
If that is not enough for a specific <i class="term">option</i> this command allows
the specification of any number additional flags to be recognized.</p>
<p>Note however that the framework automatically recognizes not
only the specified flag(s), but also all their unique prefixes,
obviating the need for this command in many cases.</p></dd>
</dl>
</div>
<div id="subsection2" class="subsection"><h3><a name="subsection2">General control</a></h3>
<p>The general handling of a <i class="term">parameter</i> is influenced by
three commands:</p>
<dl class="definitions">
<dt><a name="3"><b class="cmd">optional</b></a></dt>
<dd><p>This command marks the parameter as <i class="term">optional</i>, i.e. as something
the user may skip on the command line, with the application supplying
sensible defaults (See section <span class="sectref"><a href="#subsection3">Representations</a></span>).
This causes the framework to expend some effort in the <i class="term">Parsing</i>
phase to determine whether an argument word should be assigned to the
parameter, or not.</p>
<p>This setting is only applicable to <i class="term">input</i>s, as
<i class="term">option</i>s are optional by definition, and <i class="term">state</i> is hidden.</p></dd>
<dt><a name="4"><b class="cmd">test</b></a></dt>
<dd><p>This command is related to the above, switching the runtime from the
standard regime for acceptance (based on counting and thresholds) to a
different regime based on validation.
The details are explained in --TODO--(sectref:flow/parsing,flow/optional)--.</p></dd>
<dt><a name="5"><b class="cmd">undocumented</b></a></dt>
<dd><p>This command excludes the <i class="term">parameter</i> from the generated help.</p>
<p>Its main use case is the hiding of <i class="term">option</i>s giving an
application developer access to the internals of their application,
something a regular user has no need of, and doesn't have to know
about.</p></dd>
</dl>
</div>
<div id="subsection3" class="subsection"><h3><a name="subsection3">Representations</a></h3>
<p>An important concept of <i class="term">parameter</i>s is something taken up
from Tcl itself.
The differentation between <i class="term">string</i> and <i class="term">internal representations</i>.
Where Tcl uses <i class="term">internal representations</i> to speed up its
execution here this separation is that of between the information
delivered to the application by a user, and the application-specific
data structures behind them.</p>
<p>All <i class="term">parameter</i>s will have an <i class="term">internal representation</i>.
This is usually derived from the <i class="term">string representation</i>
provided by the user.
The details of that process are explained in section <span class="sectref"><a href="#subsection4">Validation</a></span>.
However we have cases where the user cannot specify a string
representation (<i class="term">state</i>s), or is allowed to choose not to
(optional <i class="term">input</i>s, <i class="term">option</i>s).
For these cases three specification commands are made available
enabling us to programmatically choose the internal representation.</p>
<dl class="definitions">
<dt><a name="6"><b class="cmd">default</b> <i class="arg">value</i></a></dt>
<dd><p>This command specifies a constant default value for the internal
representation.</p></dd>
<dt><a name="7"><b class="cmd">generate</b> <i class="arg">cmdprefix</i></a></dt>
<dd><p>This command specifies a callback to compute the default internal
representation at runtime. This is useful if the default is something
which cannot be captured as a fixed value. An example would be a
handle to some resource, or a dynamically created object.</p>
<p>The command prefix is invoked with a single argument, the
<b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instance for which to generate the internal
representation.</p></dd>
</dl>
<p>The commands <b class="cmd">default</b> and <b class="cmd">generate</b> exclude each
other, i.e. only of them can be specified, but not both.
If neither are specified, and we need a default (see the cases above)
then a default is chosen by the framework itself, as per the two rules
below:</p>
<ol class="enumerated">
<li><p>Use the empty string for a <b class="cmd">list</b> parameter.</p></li>
<li><p>Use the default value supplied by the chosen
<i class="term">validation type</i> (See section <span class="sectref"><a href="#subsection4">Validation</a></span>).</p></li>
</ol>
<dl class="definitions">
<dt><a name="8"><b class="cmd">interact</b> <span class="opt">?<i class="arg">prompt</i>?</span></a></dt>
<dd><p>This command actually does not specify an
<i class="term">internal representation</i>, but activates another method for the
user to specify the <i class="term">string representation</i> of the
<i class="term">parameter</i>, outside of the command line.
As such it has priority over either <b class="cmd">default</b> and <b class="cmd">generate</b>,
and can be specified with either. A <i class="term">parameter</i> marked with it
will interactively ask the user for a value if none was specified on
the command line.</p>
<p>The default for the <i class="arg">prompt</i> is derived from the
<i class="term">parameter</i>'s <i class="term">system name</i>.</p></dd>
</dl>
<p>To recapitulate:</p>
<ol class="enumerated">
<li><p>A <i class="term">string representation</i> specified on the command line
has the highest priority and goes through the chosen
<i class="term">validation type</i> to get the associated
<i class="term">internal representation</i>.</p></li>
<li><p>If activated via <b class="cmd">interact</b> a small shell is run asking the
user for a value (or more, as per <b class="cmd">list</b>, see below). The result
goes through the chosen <i class="term">validation type</i> to get the associated
<i class="term">internal representation</i>.</p></li>
<li><p>After that the <i class="term">internal representation</i> is either the
declared <b class="cmd">default</b> value, or the result of invoking the
<b class="cmd">generate</b> callback.
As <i class="term">internal representation</i>s the resulting values are
<em>not</em> run through the chosen <i class="term">validation type</i>.</p></li>
</ol>
<dl class="definitions">
<dt><a name="9"><b class="cmd">list</b></a></dt>
<dd><p>This command marks the <i class="term">parameter</i> as a list. In other words, its
<i class="term">string</i> and <i class="term">internal representation</i> is actually a list
of such, instead of a single value.
By default all parameters are scalar.</p>
<p>This affects the handling of the parameter by the
<i class="term">Parsing</i> phase, by <b class="cmd">interact</b> above, and the use of the
<i class="term">validation type</i>.
The last two ask for multiple values, and feed the elements of the
<i class="term">string representation</i> separately through validation instead
of just the string value in one. 
In the <i class="term">Parsing</i> phase treatment of <i class="term">option</i>s changes from
keeping only the last assigned value to the accumulation of all
values.
Similarly a list-<i class="term">input</i> takes all the remaining words on the
command line for itself instead of just the current word. Because of
this list-<i class="term">inputs</i> are only allowed as the last <i class="term">parameter</i>
of a <i class="term">private</i>.</p></dd>
</dl>
<p>The last two specification commands dealing with the
representations control <em>when</em> the
<i class="term">internal representation</i> is created.</p>
<dl class="definitions">
<dt><a name="10"><b class="cmd">defered</b></a></dt>
<dd><p>This command marks a <i class="term">parameter</i> as <i class="term">defered</i>, causing its
<i class="term">internal representation</i> to be computed on first access to its
value. This is the default for <i class="term">state</i> parameters.</p></dd>
<dt><a name="11"><b class="cmd">immediate</b></a></dt>
<dd><p>This command marks a <i class="term">parameter</i> as <i class="term">immediate</i>, causing its
<i class="term">internal representation</i> to be computed in the
<i class="term">Completion</i> phase.
This is the default for <i class="term">input</i> and <i class="term">option</i> parameters.</p></dd>
</dl>
</div>
<div id="subsection4" class="subsection"><h3><a name="subsection4">Validation</a></h3>
<p>The answer to the necessity of moving between the <i class="term">string</i>
and <i class="term">internal representations</i> described in the previous
section are the <i class="term">validation types</i>.
Given a <i class="term">string representation</i> they either return the
associated <i class="term">internal representation</i> or raise an error,
signaling that the string was illegal. This part of their work, the
verification of the legality of the input string gave them their name.</p>
<p>The general concept of <i class="term">validation types</i> was taken from
<b class="package">snit</b>, and modified to suit Cmdr.
Where snit's types expect only a single method to validate the input
Cmdr expects all types to support an ensemble of <em>four</em>
methods, one for the basic validation and transformation of the input,
another for the release of any internal representation so generated,
plus delivery of a default representation and support for command line
completion.</p>
<dl class="definitions">
<dt><a name="12"><b class="cmd">validate</b> <i class="arg">cmdprefix</i></a></dt>
<dd><p>This command specifies a <i class="term">validation type</i> for the
<i class="term">parameter</i>, in the form of a command prefix (or the name of one
of the builtin types, see package <b class="package"><a href="cmdr_validate.html">cmdr::validate</a></b>).
The set of methods this callback has to support, their signatures,
etc. are all explained in <i class="term"><a href="cmdr_vtypes.html">Cmdr - Writing custom validation types</a></i>. This document
contains the implementation of the standard boolean validation type as
an example as well.</p>
<p>Because of the same necessity all <i class="term">parameter</i>s must have a
<i class="term">validation type</i> assigned to them, and the system will choose
which, if the user did not. This choice is made as per the six rules
below and always returns one of the standard types implemented by
package <b class="package"><a href="cmdr_validate.html">cmdr::validate</a></b>.</p>
<ol class="enumerated">
<li><p>Use <b class="const">identity</b> if a <b class="cmd">generate</b> callback is specified.</p></li>
<li><p>Use <b class="const">boolean</b>  if no <b class="cmd">default</b> is specified and the parameter is an <i class="term">option</i>.</p></li>
<li><p>Use <b class="const">identity</b> if no <b class="cmd">default</b> is specified and the parameter is an <i class="term">input</i>.</p></li>
<li><p>Use <b class="const">boolean</b>  if the specified <b class="cmd">default</b> value is a Tcl boolean.</p></li>
<li><p>Use <b class="const">integer</b>  if the specified <b class="cmd">default</b> value is a Tcl integer.</p></li>
<li><p>Use <b class="const">identity</b> as fallback of last resort.</p></li>
</ol></dd>
<dt><a name="13"><b class="cmd">presence</b></a></dt>
<dd><p>This command is best discussed as part of the wider area of
<i class="term">boolean</i> <i class="term">option</i>s, i.e. <i class="term">option</i>s with the standard
<i class="term">validation type</i> <b class="const">boolean</b> assigned to them. These have
associated special behaviours, both in the handling of the
specification, and in the <i class="term">Parsing</i> phase.</p>
<p>First, normal boolean options.
They have automatic aliases declared for them, derived from their
primary flag.
An option named &quot;foo&quot; will have an alias of &quot;no-foo&quot;, and the
reverse.
In the <i class="term">Parsing</i> phase the &quot;foo&quot; and &quot;no-foo&quot; flags have inverse
semantics, and both are allowed to occur without option argument
following the flag.
This is in contrast to all other <i class="term">option</i>s which must have such
an argument. The parser essentially uses the <i class="term">validation type</i>
to decide if the word after the flag is a proper boolean value, or
not, i.e. an argument to assign to the <i class="term">parameter</i>, or not.</p>
<p>Now <b class="cmd">presence</b> declares a variant of the above, a boolean
option <em>without</em> the automatic aliases, and <em>never</em> taking
an argument during parsing.
Its mere <em>presence</em> on the command line will set its
<i class="term">parameter</i>.
Their <b class="cmd">default</b> value is consequently fixed to <b class="const">false</b> as
well.</p></dd>
</dl>
</div>
<div id="subsection5" class="subsection"><h3><a name="subsection5">Signaling</a></h3>
<p>Of the four callbacks supported by parameters the first two,
<b class="cmd">generate</b> and <b class="cmd">validate</b> have been described already, in the
sections <span class="sectref"><a href="#subsection3">Representations</a></span> and <span class="sectref"><a href="#subsection4">Validation</a></span>,
respectively.</p>
<p>This section explains the commonalities between the callbacks
in general, and the last two, for notifications about state changes in
detail.</p>
<p>All callbacks are treated as command prefixes, not scripts.
There are no placeholder substitutions, only arguments added to each
command prefix on invokation. This does not harm the generality of the
system, as complex scripts can be used via procedures or equivalents
(i.e. <b class="cmd">apply</b>).</p>
<p>The two callbacks not yet described are the state-change
callbacks through which the framework can actively drive parts of the
application while processing the command line, whereas normally the
application drives access to parameters through their methods.</p>
<dl class="definitions">
<dt><a name="14"><b class="cmd">when-complete</b> <i class="arg">cmdprefix</i></a></dt>
<dd><p>This command declares the state-change callback to invoke when the
<i class="term">internal representation</i> of the <i class="term">parameter</i> is generated
from the <i class="term">string representation</i>, or the various ways of
getting a default.</p>
<p>The callback is invoked with two arguments, the
<b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instance of the changed <i class="term">parameter</i>,
and its <i class="term">internal representation</i>, in this order.</p></dd>
<dt><a name="15"><b class="cmd">when-set</b> <i class="arg">cmdprefix</i></a></dt>
<dd><p>This command declares the state-change callback to invoke when the
<i class="term">string representation</i> of the <i class="term">parameter</i> is set during
command line parsing.</p>
<p>The callback is invoked with two arguments, the
<b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instance of the changed <i class="term">parameter</i>,
and its <i class="term">string representation</i>, in this order.</p></dd>
</dl>
<p>Due to their nature these callbacks are invoked at runtime during
either the <i class="term">Parsing</i>, <i class="term">Completion</i>, or <i class="term">Execution</i>
phases.
The details are shown in the table below. The specification commands
influencing the timing, i.e. forcing the use in a specific phase are
shown in the intersection of callback and phase.</p>
<pre class="example">
                    | Dispatch | Parsing | Completion  | Execution
--------------------+----------+---------+-------------+-----------
validate (default)  | *        |         |             |          
--------------------+----------+---------+-------------+-----------
validate (complete) |          | *       | immediate   | defered
when-set            |          | *       |             |          
--------------------+----------+---------+-------------+-----------
generate            |          |         | immediate   | defered
validate (validate) |          | test    | immediate   | defered
validate (release)  |          | test    | immediate   | defered
--------------------+----------+---------+-------------+-----------
when-complete       |          |         | immediate   | defered
--------------------+----------+---------+-------------+-----------
</pre>
</div>
</div>
<div id="section4" class="section"><h2><a name="section4">Related Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term"><a href="cmdr_introduction.html">Cmdr - Introduction to the project</a></i></p></li>
<li><p><i class="term"><a href="cmdr_license.html">Cmdr - License</a></i></p></li>
<li><p><i class="term"><a href="cmdr_changes.html">Cmdr - Log of Changes</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_installation.html">Cmdr - The Installer's Guide</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_development.html">Cmdr - The Developer's Guide</a></i></p></li>
</ol>
</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>

<html><head>
<title>cmdr_dsl_private - Cmdr, a framework for command line parsing and dispatch</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_dsl_private.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_dsl_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_dsl_private(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>cmdr_dsl_private - Cmdr - Private Specification Language</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">Related Specification Documents</a></li>
<li class="section"><a href="#section3">Language Reference</a></li>
<li class="section"><a href="#section4">Related Documents</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="syntax">
<li><a href="#1"><b class="cmd">description</b> <i class="arg">text</i></a></li>
<li><a href="#2"><b class="cmd">input</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></a></li>
<li><a href="#3"><b class="cmd">interactive</b></a></li>
<li><a href="#4"><b class="cmd">option</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></a></li>
<li><a href="#5"><b class="cmd">state</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></a></li>
<li><a href="#6"><b class="cmd">undocumented</b></a></li>
<li><a href="#7"><b class="cmd">use</b> <i class="arg">name</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 document is for users of the cmdr framework. It introduces the
domain-specific language for the specification of privates in detail.</p>
</div>
<div id="section2" class="section"><h2><a name="section2">Related Specification Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term"><a href="cmdr_dsl.html">Cmdr - Introduction to the Specification Language</a></i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i></p></li>
<li><p><i class="term">Cmdr - Private Specification Language</i></p></li>
<li><p><i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i></p></li>
</ol>
</div>
<div id="section3" class="section"><h2><a name="section3">Language Reference</a></h2>
<p>The specification of <i class="term">private</i>s is quite easy, with only
seven commands. The important parts are found in the <i class="term">parameter</i>
specifications, explained in <i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i>.</p>
<dl class="definitions">
<dt><a name="1"><b class="cmd">description</b> <i class="arg">text</i></a></dt>
<dd><p>This command declares the help text for the <i class="term">private</i>.</p></dd>
<dt><a name="2"><b class="cmd">input</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></a></dt>
<dd><p>This command adds an <i class="term">input</i> (i.e. positional) <i class="term">parameter</i>
to the <i class="term">private</i>, with description <i class="arg">help</i> and its
specification <i class="arg">script</i> of parameter commands as described in
<i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i>.</p></dd>
<dt><a name="3"><b class="cmd">interactive</b></a></dt>
<dd><p>This command activates a mini-shell for this <i class="term">private</i> which will
be invoked when required <i class="term">parameter</i>s do not have a value after
argument extraction and matching.</p>
<p>By default the only interactive command line shells are
associated with the <i class="term">officer</i>s.</p>
<p>The command <b class="cmd">cmdr::config interactive</b> provided by the
package <b class="package"><a href="cmdr_config.html">cmdr::config</a></b> can be used to globally activate this
type of shell for all <i class="term">private</i>s.</p></dd>
<dt><a name="4"><b class="cmd">option</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></a></dt>
<dd><p>This command adds an <i class="term">option</i> (i.e. named) <i class="term">parameter</i> to
the <i class="term">private</i>, with description <i class="arg">help</i> and its specification
<i class="arg">script</i> of parameter commands as described in
<i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i>.</p></dd>
<dt><a name="5"><b class="cmd">state</b> <i class="arg">name</i> <i class="arg">help</i> <i class="arg">script</i></a></dt>
<dd><p>This command adds a <i class="term">state</i> (i.e. hidden) <i class="term">parameter</i> to the
<i class="term">private</i>, with description <i class="arg">help</i> and its specification
<i class="arg">script</i> of parameter commands as described in
<i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i>.</p></dd>
<dt><a name="6"><b class="cmd">undocumented</b></a></dt>
<dd><p>This command excludes the <i class="term">private</i> from the generated help.</p></dd>
<dt><a name="7"><b class="cmd">use</b> <i class="arg">name</i></a></dt>
<dd><p>This command is the counterpart to <b class="cmd">common</b> of <i class="term">officer</i>s
(See <i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i>).
It inserts the named block into the specification, executing it in
place. As such it expects the contents to be a script of private
commands as described in this section.</p></dd>
</dl>
<p>Please continue reading with <i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i>.</p>
</div>
<div id="section4" class="section"><h2><a name="section4">Related Documents</a></h2>
<ol class="enumerated">
<li><p><i class="term"><a href="cmdr_introduction.html">Cmdr - Introduction to the project</a></i></p></li>
<li><p><i class="term"><a href="cmdr_license.html">Cmdr - License</a></i></p></li>
<li><p><i class="term"><a href="cmdr_changes.html">Cmdr - Log of Changes</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_installation.html">Cmdr - The Installer's Guide</a></i></p></li>
<li><p><i class="term"><a href="cmdr_howto_development.html">Cmdr - The Developer's Guide</a></i></p></li>
</ol>
</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>

<html><head>
<title>cmdr_help - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></style>
</head>
<! -- Generated from file 'cmdr_help.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_help.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_help(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&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>
................................................................................
<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 four standard help formats
<b class="const">full</b>, <b class="const">short</b>, <b class="const">list</b>, and <b class="const">by-category</b>.</p>
<p>It provides a single utility command used by the other parts of
the framework to add a <b class="syscmd">help</b> command to any
<b class="package">cmdr::actor</b> requiring such.</p>
</div>
<div id="section2" class="section"><h2><a name="section2">API</a></h2>
<dl class="definitions">
<dt><a name="1"><b class="cmd">::cmdr::help</b> <b class="method">auto</b> <i class="arg">actor</i></a></dt>
<dd><p>When invoked this command extends the <i class="arg">actor</i> with a <b class="const">help</b>
command. The result of the command is the empty string.</p>
<p>The inserted command will accept all known format names as
................................................................................
the format <b class="const">by-category</b> will be used, except if a command name
was given to <b class="syscmd">help</b>, then the default will be <b class="const">full</b>.</p>
<p>An additional option accepted by <b class="syscmd">help</b> is
<b class="const">--width</b>, giving the user control over the length of lines
in the help. By default help will be formatted to the width of the
terminal.</p>
<dl class="arguments">
<dt><b class="package">cmdr::actor</b> <i class="arg">actor</i></dt>
<dd><p>The <b class="package">cmdr::actor</b> instance to be extended with <b class="syscmd">help</b>.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section3" class="section"><h2><a name="section3">Bugs, Ideas, Feedback</a></h2>
<p>Both the package(s) and this documentation will undoubtedly contain
bugs and other problems.
Please report such at

<html><head>
<title>cmdr::help - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></style>
</head>
<! -- Generated from file 'cmdr_help.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr::help.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::help(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&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>
................................................................................
<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 four standard help formats
<b class="const">full</b>, <b class="const">short</b>, <b class="const">list</b>, and <b class="const">by-category</b>.</p>
<p>It provides a single utility command used by the other parts of
the framework to add a <b class="syscmd">help</b> command to any
<b class="package"><a href="cmdr_actor.html">cmdr::actor</a></b> requiring such.</p>
</div>
<div id="section2" class="section"><h2><a name="section2">API</a></h2>
<dl class="definitions">
<dt><a name="1"><b class="cmd">::cmdr::help</b> <b class="method">auto</b> <i class="arg">actor</i></a></dt>
<dd><p>When invoked this command extends the <i class="arg">actor</i> with a <b class="const">help</b>
command. The result of the command is the empty string.</p>
<p>The inserted command will accept all known format names as
................................................................................
the format <b class="const">by-category</b> will be used, except if a command name
was given to <b class="syscmd">help</b>, then the default will be <b class="const">full</b>.</p>
<p>An additional option accepted by <b class="syscmd">help</b> is
<b class="const">--width</b>, giving the user control over the length of lines
in the help. By default help will be formatted to the width of the
terminal.</p>
<dl class="arguments">
<dt><b class="package"><a href="cmdr_actor.html">cmdr::actor</a></b> <i class="arg">actor</i></dt>
<dd><p>The <b class="package"><a href="cmdr_actor.html">cmdr::actor</a></b> instance to be extended with <b class="syscmd">help</b>.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section3" class="section"><h2><a name="section3">Bugs, Ideas, Feedback</a></h2>
<p>Both the package(s) and this documentation will undoubtedly contain
bugs and other problems.
Please report such at

<html><head>
<title>cmdr_help_json - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></style>
</head>
<! -- Generated from file 'cmdr_help_json.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_help_json.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_help_json(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&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>

<html><head>
<title>cmdr::help::json - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></style>
</head>
<! -- Generated from file 'cmdr_help_json.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr::help::json.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::help::json(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&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>

<html><head>
<title>cmdr_help_sql - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></style>
</head>
<! -- Generated from file 'cmdr_help_sql.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_help_sql.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_help_sql(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&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>

<html><head>
<title>cmdr::help::sql - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></style>
</head>
<! -- Generated from file 'cmdr_help_sql.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr::help::sql.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::help::sql(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&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>

<html><head>
<title>cmdr_officer - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></style>
</head>
<! -- Generated from file 'cmdr_officer.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr_officer.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_officer(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>cmdr_officer - Cmdr - Aggregation of multiple commands for dispatch.</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="#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::officer</b> <b class="method">new</b> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">actions</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr::officer</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">actions</i></a></li>
<li><a href="#3"><b class="cmd">&lt;officer&gt;</b> <b class="method">children</b></a></li>
<li><a href="#4"><b class="cmd">&lt;officer&gt;</b> <b class="method">complete</b> <i class="arg">line</i></a></li>
<li><a href="#5"><b class="cmd">&lt;officer&gt;</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></li>
................................................................................
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This package implements <em>officers</em>, the inner nodes of command
hierarchies.  Each officer can execute many actions, by delegating
them to their sub-ordinate actors, officers and privates.</p>
<p>This class is sub-class of <b class="package">cmdr::actor</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
officer instances.</p>
<p>It is described here for use by developers maintaining,
modifying and extending the framework itself. A user of the framework
................................................................................
<dl class="arguments">
<dt>object <i class="arg">super</i></dt>
<dd><p>The instance command of the actor (officer actually) which contains the new officer.</p></dd>
<dt>string <i class="arg">name</i></dt>
<dd><p>The user-visible name of the command.</p></dd>
<dt>script <i class="arg">actions</i></dt>
<dd><p>The specification of the officer's subordinates.
Please read <i class="term"><a href="cmdr_dsl.html">Cmdr - Specification Language</a></i> (section &quot;Officers&quot;) for the details.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section3" class="section"><h2><a name="section3">Instance API</a></h2>
<p>The instance API is not public. It is used internally by the framework
during the parsing of a command hierarchy specification to configure
the officer instances, and when processing a command line at runtime
................................................................................
<dl class="arguments">
<dt>script <i class="arg">path</i></dt>
<dd><p>The list of names specifying the route from this officer to the new
private. The last element is the name of the private command, while
the preceding names specify the intermediate officers.</p></dd>
<dt>script <i class="arg">arguments</i></dt>
<dd><p>The specification of the private's parameters.
Please read <i class="term"><a href="cmdr_dsl.html">Cmdr - Specification Language</a></i> (section &quot;Parameters&quot;) for the details.</p></dd>
<dt>cmd-prefix <i class="arg">action</i></dt>
<dd><p>The command prefix to invoke when this private is selected for
execution.  It takes a single argument, the instance command of the
hidden <b class="package">cmdr::config</b> container holding the private's
parameters. The result of the action, if there is any, is ignored by
the framework.</p></dd>
</dl></dd>
<dt><a name="13"><b class="cmd">&lt;officer&gt;</b> <b class="method">has</b> <i class="arg">name</i></a></dt>
<dd><p>This method returns a boolean value indicating if this officer has a
sub-ordinate of the given <i class="arg">name</i> (<b class="const">true</b>), or not
(<b class="const">false</b>). See also method <b class="method">lookup</b>.</p>
................................................................................
<dd><p>This method takes a regular specification script and uses it to extend
the set of subordinates known to this officer. This is the same type
of script as used during construction, except here we dynamically
extend the officer.</p>
<dl class="arguments">
<dt>script <i class="arg">actions</i></dt>
<dd><p>The specification of the officer's additional subordinates.
Please read <i class="term"><a href="cmdr_dsl.html">Cmdr - Specification Language</a></i> (section &quot;Officers&quot;) for the details.</p></dd>
</dl></dd>
<dt><a name="18"><b class="cmd">&lt;officer&gt;</b> <b class="method">lookup</b> <i class="arg">name</i></a></dt>
<dd><p>This method returns the instance command of the sub-ordinate with the
given <i class="arg">name</i>. An error is thrown if such a sub-ordinate does not
exist. See also method <b class="method">has</b>.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></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>

<html><head>
<title>cmdr::officer - Cmdr, a framework for command line parsing and dispatch</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
................................................................................
    }
--></style>
</head>
<! -- Generated from file 'cmdr_officer.man' by tcllib/doctools with format 'html'
   -->
<! -- Copyright &copy; 2013 Andreas Kupries   -- Copyright &copy; 2013 Documentation, Andreas Kupries
   -->
<! -- CVS: $Id$ cmdr::officer.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::officer(n) 0 doc &quot;Cmdr, a framework for command line parsing and dispatch&quot;</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>cmdr::officer - Cmdr - Aggregation of multiple commands for dispatch.</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="#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::officer</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::cmdr::officer</b> <b class="method">new</b> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">actions</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr::officer</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">actions</i></a></li>
<li><a href="#3"><b class="cmd">&lt;officer&gt;</b> <b class="method">children</b></a></li>
<li><a href="#4"><b class="cmd">&lt;officer&gt;</b> <b class="method">complete</b> <i class="arg">line</i></a></li>
<li><a href="#5"><b class="cmd">&lt;officer&gt;</b> <b class="method">complete-words</b> <i class="arg">parse</i></a></li>
................................................................................
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This package implements <em>officers</em>, the inner nodes of command
hierarchies.  Each officer can execute many actions, by delegating
them to their sub-ordinate actors, officers and privates.</p>
<p>This class is sub-class of <b class="package"><a href="cmdr_actor.html">cmdr::actor</a></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
officer instances.</p>
<p>It is described here for use by developers maintaining,
modifying and extending the framework itself. A user of the framework
................................................................................
<dl class="arguments">
<dt>object <i class="arg">super</i></dt>
<dd><p>The instance command of the actor (officer actually) which contains the new officer.</p></dd>
<dt>string <i class="arg">name</i></dt>
<dd><p>The user-visible name of the command.</p></dd>
<dt>script <i class="arg">actions</i></dt>
<dd><p>The specification of the officer's subordinates.
Please read <i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i> for the details.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section3" class="section"><h2><a name="section3">Instance API</a></h2>
<p>The instance API is not public. It is used internally by the framework
during the parsing of a command hierarchy specification to configure
the officer instances, and when processing a command line at runtime
................................................................................
<dl class="arguments">
<dt>script <i class="arg">path</i></dt>
<dd><p>The list of names specifying the route from this officer to the new
private. The last element is the name of the private command, while
the preceding names specify the intermediate officers.</p></dd>
<dt>script <i class="arg">arguments</i></dt>
<dd><p>The specification of the private's parameters.
Please read <i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter Specification Language</a></i> for the details.</p></dd>
<dt>cmd-prefix <i class="arg">action</i></dt>
<dd><p>The command prefix to invoke when this private is selected for
execution.  It takes a single argument, the instance command of the
hidden <b class="package"><a href="cmdr_config.html">cmdr::config</a></b> container holding the private's
parameters. The result of the action, if there is any, is ignored by
the framework.</p></dd>
</dl></dd>
<dt><a name="13"><b class="cmd">&lt;officer&gt;</b> <b class="method">has</b> <i class="arg">name</i></a></dt>
<dd><p>This method returns a boolean value indicating if this officer has a
sub-ordinate of the given <i class="arg">name</i> (<b class="const">true</b>), or not
(<b class="const">false</b>). See also method <b class="method">lookup</b>.</p>
................................................................................
<dd><p>This method takes a regular specification script and uses it to extend
the set of subordinates known to this officer. This is the same type
of script as used during construction, except here we dynamically
extend the officer.</p>
<dl class="arguments">
<dt>script <i class="arg">actions</i></dt>
<dd><p>The specification of the officer's additional subordinates.
Please read <i class="term"><a href="cmdr_dsl_officer.html">Cmdr - Officer Specification Language</a></i> for the details.</p></dd>
</dl></dd>
<dt><a name="18"><b class="cmd">&lt;officer&gt;</b> <b class="method">lookup</b> <i class="arg">name</i></a></dt>
<dd><p>This method returns the instance command of the sub-ordinate with the
given <i class="arg">name</i>. An error is thrown if such a sub-ordinate does not
exist. See also method <b class="method">has</b>.</p>
<dl class="arguments">
<dt>string <i class="arg">name</i></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"><a href="cmdr_parameter.html">cmdr::parameter</a></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>

<html><head>
<title>cmdr_parameter - Cmdr, a framework for command line parsing and dispatch</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;Cmdr, a framework for command line parsing and dispatch&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>
................................................................................
<li class="section"><a href="#keywords">Keywords</a></li>
<li class="section"><a href="#copyright">Copyright</a></li>
</ul>
</div>
<div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="synopsis">
<ul class="requirements">
<li>package require <b class="pkgname">cmdr::util</b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::cmdr::parameter</b> <b class="method">new</b> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></li>
<li><a href="#2"><b class="cmd">::cmdr::parameter</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></li>
<li><a href="#3"><b class="cmd">&lt;parameter&gt;</b> <b class="method">accept</b> <i class="arg">x</i></a></li>
<li><a href="#4"><b class="cmd">&lt;parameter&gt;</b> <b class="method">cmdline</b></a></li>
<li><a href="#5"><b class="cmd">&lt;parameter&gt;</b> <b class="method">code</b></a></li>
................................................................................
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>Welcome to the Cmdr project, written by Andreas Kupries.</p>
<p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p>
<p>This package implements <em>parameters</em>, collections of which (see
<b class="package">cmdr::config</b>) serve as the configuration of privates (see
<b class="package">cmdr::private</b>).</p>
</div>
<div id="section2" class="section"><h2><a name="section2">Class API</a></h2>
<p>The class API is not public. It is used internally by the framework
when parsing a command hierarchy specification to create the necessary
parameter instances.</p>
<p>It is described here for use by developers maintaining,
modifying and extending the framework itself. A user of the framework
................................................................................
<dt><a name="2"><b class="cmd">::cmdr::parameter</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></dt>
<dd><p>Create a new instance of <b class="class">cmdr::parameter</b>, named <i class="arg">obj</i>.
Used by the DSL processing parts of the framework to instantiate parameters.</p>
<dl class="arguments">
<dt>string <i class="arg">obj</i></dt>
<dd><p>The (command) name of the new parameter instance.</p></dd>
<dt>cmdr::config <i class="arg">config</i></dt>
<dd><p>The instance command of the <b class="package">cmdr::config</b> instance
holding the parameter.</p></dd>
<dt>boolean <i class="arg">order</i></dt>
<dd><p>Flag. Parameter is specified by order (<b class="const">true</b>: argument),
or name (<b class="const">false</b>: option).</p></dd>
<dt>boolean <i class="arg">cmdline</i></dt>
<dd><p>Flag. Parameter is visible on the command line (<b class="const">true</b>:
option, or argument), or not (<b class="const">false</b>: state).</p></dd>
................................................................................
<dt>string <i class="arg">name</i></dt>
<dd><p>Internal name of the parameter. Also the name used in the
help, if not overridden by a <b class="cmd">label</b> declaration
(in <i class="arg">spec</i>).</p></dd>
<dt>string <i class="arg">description</i></dt>
<dd><p>Human-readable help text for the parameter.</p></dd>
<dt>script <i class="arg">spec</i></dt>
<dd><p>Tcl-script specifying the parameter in detail. Please read
<i class="term"><a href="cmdr_dsl.html">Cmdr - Specification Language</a></i> (section &quot;Parameters&quot;) for the details.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section3" class="section"><h2><a name="section3">Instance API</a></h2>
<p>Most of the instance API is not public.</p>
<p>It is described here for use by developers maintaining,
modifying and extending the framework itself. A user of the framework
................................................................................
<dl class="arguments">
<dt>dict <i class="arg">parse</i></dt>
<dd><p>A dictionary holding the current completion state of a partial command
line.</p>
<p>--TODO-- Describe the state fields and their meaning.</p></dd>
</dl></dd>
<dt><a name="7"><b class="cmd">&lt;parameter&gt;</b> <b class="method">config</b> <i class="arg">word...</i></a></dt>
<dd><p>This method either returns the <b class="package">cmdr::config</b> instance
containing the parameter, or the result of applying the words to that config
instance. It is through this method that any script with access to a single
parameter instance of a private will have access to all its parameters.</p>
<dl class="arguments">
<dt>string <i class="arg">word...</i></dt>
<dd><p>The method and its arguments to apply to the config instance holding
the parameter. If none are specified the method <b class="method">self</b> is