Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Completed the split of the DSL documents. Regenerated the embedded docs. |
---|---|
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
b7d756fe00bcc5cd3beb4322ef0659ab |
User & Date: | aku 2013-11-15 07:41:12.803 |
Context
2013-11-15
| ||
23:10 | Extended the shells to note their activity in a root common block named *in-shell*. Bumped version to 0.11. check-in: 5a480bf9d8 user: andreask tags: trunk | |
07:41 | Completed the split of the DSL documents. Regenerated the embedded docs. check-in: b7d756fe00 user: aku tags: trunk | |
00:51 | Split the large DSL document into several smaller pieces: introduction, officer, private, parameter check-in: daa000e429 user: andreask tags: trunk | |
Changes
Changes to doc/cmdr.man.
1 2 3 4 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] [manpage_begin [vset PROJECT] [vset MAN_SECTION] [vset VERSION]] [include parts/module.inc] | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [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 |
︙ | ︙ | |||
33 34 35 36 37 38 39 40 41 | [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 | > | | | 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | [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 |
︙ | ︙ |
Changes to doc/cmdr_actor.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [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]. |
︙ | ︙ |
Changes to doc/cmdr_config.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [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]). |
︙ | ︙ | |||
41 42 43 44 45 46 47 | [arg_def cmdr::config context] The instance command of the [package cmdr::private] instance the configuration will belong to. [arg_def script spec] | | | | 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | [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 |
︙ | ︙ |
Changes to doc/cmdr_dsl.man.
1 2 3 4 5 6 7 8 9 10 11 12 | [include parts/definitions.inc] [manpage_begin [vset PROJECT]_dsl [vset MAN_SECTION] [vset VERSION]] [include parts/module.inc] [titledesc [vset TITLE_DSL]] [description] [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. | < < | | | < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | [include parts/definitions.inc] [manpage_begin [vset PROJECT]_dsl [vset MAN_SECTION] [vset VERSION]] [include parts/module.inc] [titledesc [vset TITLE_DSL]] [description] [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] |
Changes to doc/cmdr_dsl_officer.man.
1 2 3 4 5 6 7 8 | [include parts/definitions.inc] [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 | | | < > > | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | [include parts/definitions.inc] [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] |
Changes to doc/cmdr_dsl_parameter.man.
1 2 3 4 5 6 7 8 9 10 11 | [include parts/definitions.inc] [manpage_begin [vset PROJECT]_dsl_parameter [vset MAN_SECTION] [vset VERSION]] [include parts/module.inc] [titledesc [vset TITLE_DSL_PARAMETER]] [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. | < < > < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | [include parts/definitions.inc] [manpage_begin [vset PROJECT]_dsl_parameter [vset MAN_SECTION] [vset VERSION]] [include parts/module.inc] [titledesc [vset TITLE_DSL_PARAMETER]] [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] |
Changes to doc/cmdr_dsl_private.man.
1 2 3 4 5 6 7 8 9 10 | [include parts/definitions.inc] [manpage_begin [vset PROJECT]_dsl_private [vset MAN_SECTION] [vset VERSION]] [include parts/module.inc] [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. | < < > > | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | [include parts/definitions.inc] [manpage_begin [vset PROJECT]_dsl_private [vset MAN_SECTION] [vset VERSION]] [include parts/module.inc] [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] |
Changes to doc/cmdr_help.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | 1 2 3 4 5 6 7 8 9 10 | [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 |
︙ | ︙ |
Changes to doc/cmdr_help_json.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | 1 2 3 4 5 6 7 8 9 10 | [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 |
︙ | ︙ |
Changes to doc/cmdr_help_sql.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | 1 2 3 4 5 6 7 8 9 10 | [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 |
︙ | ︙ |
Changes to doc/cmdr_officer.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [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. |
︙ | ︙ | |||
42 43 44 45 46 47 48 | 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. | | | 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | 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}] |
︙ | ︙ | |||
185 186 187 188 189 190 191 | 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. | | | 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | 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. |
︙ | ︙ | |||
252 253 254 255 256 257 258 | 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. | | | 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | 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 |
︙ | ︙ |
Changes to doc/cmdr_parameter.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [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]). |
︙ | ︙ | |||
65 66 67 68 69 70 71 | 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] | | | | 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | 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}] |
︙ | ︙ |
Changes to doc/cmdr_private.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | | 1 2 3 4 5 6 7 8 9 10 11 12 | [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 |
︙ | ︙ | |||
44 45 46 47 48 49 50 | [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. | | | 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | [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. |
︙ | ︙ |
Changes to doc/cmdr_util.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | 1 2 3 4 5 6 7 8 9 10 | [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. |
︙ | ︙ |
Changes to doc/cmdr_validate.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | 1 2 3 4 5 6 7 8 9 10 | [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 |
︙ | ︙ |
Changes to doc/cmdr_vcommon.man.
1 2 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] | | | 1 2 3 4 5 6 7 8 9 10 | [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 |
︙ | ︙ |
Changes to doc/cmdr_vtypes.man.
1 2 3 4 5 6 7 8 9 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] [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] | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | [comment {-*- tcl -*- doctools manpage}] [include parts/definitions.inc] [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 |
︙ | ︙ | |||
28 29 30 31 32 33 34 | [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. | | | | | > | | > > | | | > > | | > > | | | | | | > > | > | | | > > | | < | | | < | | 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | [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. [list_begin arguments] [arg_def [package cmdr::parameter] p] The [package cmdr::parameter] instance governing the completion 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. [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]. [list_begin arguments] [arg_def [package cmdr::parameter] p] The [package cmdr::parameter] instance whose default internal representation is to be computed. While the standard validation types 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]. |
︙ | ︙ | |||
151 152 153 154 155 156 157 | of the completion. [arg_def string x] The internal representation to release. [list_end] [comment {- - -- --- ----- -------- -------------}] | | | 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 | 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. |
︙ | ︙ |
Changes to doc/parts/definitions.inc.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | [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"] | > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | [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"] |
︙ | ︙ |
Changes to doc/parts/dsl_general.inc.
1 2 3 4 5 | [para] The conceptual model underneath the command hierarchy is that of a tree. [para] The inner nodes of the tree represent command ensembles, here | | | | | | > > | | | | | > | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | [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. |
Changes to doc/parts/dsl_officer.inc.
1 |
| < < < < < < < < < < < < < < < < > | | | | < | | | > | > > > > > > > > > > | | | | | > > | | | | | > > > > > > > > > | > | > > | | | | > > | > | > | | > > | | > | > | | | | | > > | > | > | > | | | > | > > | | > > | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | [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. } { undocumented list when-complete [lambda {p tags} { 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] |
Changes to doc/parts/dsl_para_callbacks.inc.
1 2 | Of the four callbacks supported by parameters the first two, | | | | | < > > | | > | | | > | | | | | < > > | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | 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 |
︙ | ︙ |
Changes to doc/parts/dsl_para_general.inc.
1 |
| | | > > | | | | | | > | | > | | | | > | > | < | < | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | [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] |
︙ | ︙ |
Changes to doc/parts/dsl_para_naming.inc.
1 2 | [para] We have two commands to influence the visible naming of all | | | | > | | > > | | > > > > | | > | > | | | > | | | | > | | > > > | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | [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] |
Changes to doc/parts/dsl_para_reps.inc.
1 |
| | | | | | | | | | | | < < | | > > | | > | | | | | | | | | > | | | > | > | | > | | | | | | > | | > | | | | | | | > > | | > > | | > > > > | | | > > | > | | > | > | > | | > | > > > | | > | | > | | > | > | > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | [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] |
Changes to doc/parts/dsl_para_validation.inc.
1 |
| | | > | > | | | < | | > | | | | | | > > | | > | > | | | | | | | | | | | > | > | | > > | | | > | > > | > > | | > > | | | | | | > > | > > | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 | [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] |
Changes to doc/parts/dsl_parameter.inc.
1 |
| | | | | | | | | | | < < < | < < < < < < < < < < < < < < < < < < | < < < < | < | < | | | < < < < < < < < | < | | < < < < < < < < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | [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] |
Changes to doc/parts/dsl_private.inc.
1 |
| | < | < | < < < < < < < < < < < < < > > | | | > | | > | | > > | | | | > | > > | | | > | | > | | > > | | > | | > > | | < | > | > | > > | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | [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] |
Changes to embedded/man/files/cmdr.n.
︙ | ︙ | |||
240 241 242 243 244 245 246 | \\$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 | | | 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | \\$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 |
︙ | ︙ | |||
283 284 285 286 287 288 289 | .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 | | | | 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | .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\&. |
︙ | ︙ |
Changes to embedded/man/files/cmdr_actor.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | .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 |
︙ | ︙ |
Changes to embedded/man/files/cmdr_config.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | .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 |
︙ | ︙ | |||
353 354 355 356 357 358 359 | 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 | | | | 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | 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\&. |
︙ | ︙ |
Changes to embedded/man/files/cmdr_dsl.n.
︙ | ︙ | |||
238 239 240 241 242 243 244 | .. .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 | | | | > > > > > > > > > > > | | 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 | .. .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, |
︙ | ︙ | |||
318 319 320 321 322 323 324 | .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\&. | | | 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 | .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 |
︙ | ︙ | |||
365 366 367 368 369 370 371 | \&.\&.\&. .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\&. | < | | | > | | | | | | < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < | 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 | \&.\&.\&. .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-\\ / \\ officer ---1:(0-n)--> private --1:1-> config --1:(0-n)-> parameter | ^ has has has | | \\--/ 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 |
︙ | ︙ |
Added embedded/man/files/cmdr_dsl_officer.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | '\" '\" 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 |
Added embedded/man/files/cmdr_dsl_parameter.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 | '\" '\" 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 |
Added embedded/man/files/cmdr_dsl_private.n.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 | '\" '\" 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 |
Changes to embedded/man/files/cmdr_help.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::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 |
︙ | ︙ |
Changes to embedded/man/files/cmdr_help_json.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::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\&. |
︙ | ︙ |
Changes to embedded/man/files/cmdr_help_sql.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::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\&. |
︙ | ︙ |
Changes to embedded/man/files/cmdr_officer.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | .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 |
︙ | ︙ | |||
323 324 325 326 327 328 329 | 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\&. | | | 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 | 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\&. |
︙ | ︙ | |||
438 439 440 441 442 443 444 | 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\&. | | | 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | 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\&. |
︙ | ︙ | |||
491 492 493 494 495 496 497 | 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\&. | | | 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 | 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 |
︙ | ︙ |
Changes to embedded/man/files/cmdr_parameter.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | .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 |
︙ | ︙ | |||
397 398 399 400 401 402 403 | 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 | | | | 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 | 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 |
︙ | ︙ |
Changes to embedded/man/files/cmdr_private.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | .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 |
︙ | ︙ | |||
296 297 298 299 300 301 302 | 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\&. | | | 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | 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\&. |
︙ | ︙ |
Changes to embedded/man/files/cmdr_util.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::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 |
︙ | ︙ |
Changes to embedded/man/files/cmdr_validate.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::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\&. |
︙ | ︙ |
Changes to embedded/man/files/cmdr_vcommon.n.
︙ | ︙ | |||
235 236 237 238 239 240 241 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. | | | | 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::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 |
︙ | ︙ |
Changes to embedded/man/files/cmdr_vtypes.n.
︙ | ︙ | |||
242 243 244 245 246 247 248 | .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 | | | | | | | | | | | | | | > | | | > | | > | | | | | | > | | | | > | | < | | | | | | 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 | .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\&. 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 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 \fBcmdr::parameter\fR \fIp\fR The \fBcmdr::parameter\fR instance governing the completion 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 .TP \fBcmdr::parameter\fR \fIp\fR The \fBcmdr::parameter\fR instance whose default internal representation is to be computed\&. While the standard validation types 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 ignored by the framework\&. .RS .TP \fBcmdr::parameter\fR \fIp\fR The \fBcmdr::parameter\fR instance holding the internal representation to release\&. 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 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 |
︙ | ︙ |
Changes to embedded/man/index.n.
︙ | ︙ | |||
244 245 246 247 248 249 250 | arguments .RS .TP \fBfiles/cmdr\&.n\fR cmdr .TP \fBfiles/cmdr_actor\&.n\fR | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > < < < | | | | | | < < < < < < < < < < < < < < < < < < | | | > > > | > > > > > > > > > > > > > > > > > > > > > > > > | | | | | | | | < < < < < < < < < < < < < < < < < < | | | > > > | > > > > > > > > > > > > > > > > > > > > > > > > | | | | | | | | < < < < < < < < < < < < < < < < < < | | | > > > | > > > > > > > > > > > > > > > > > > > > > > > > | | | < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | | < < < < < < < < < < < < < < < < < < < < < < < < | | | > > > | > > > > > > > > > > > > > > > > > > > > > > > > | | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | > > > | > > > > > > > > > > > > > > > > > > > > > > > > | | | < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 | 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 |
Changes to embedded/man/toc.n.
︙ | ︙ | |||
241 242 243 244 245 246 247 | .SH CONTENTS doc .RS .TP \fBcmdr\fR \fIfiles/cmdr\&.n\fR: Cmdr - Main package and API .TP | | > > > | > > > > > > > > > > > > | > > > > > > > > > > > > | | | | | | | | | < < < < < < < < < < < < < < < < < < | 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | .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 |
Changes to embedded/www/doc/files/cmdr.html.
︙ | ︙ | |||
119 120 121 122 123 124 125 | <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"> | | | 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | <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> |
︙ | ︙ | |||
154 155 156 157 158 159 160 | <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 | | | | 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | <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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_actor.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <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; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_actor.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | } --></style> </head> <! -- Generated from file 'cmdr_actor.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> <p>cmdr::actor - Cmdr - Base class for officers and privates - Internal</p> </div> <div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="toc"> <li class="section"><a href="#toc">Table Of Contents</a></li> <li class="section"><a href="#synopsis">Synopsis</a></li> <li class="section"><a href="#section1">Description</a></li> <li class="section"><a href="#section2">Class API</a></li> <li class="section"><a href="#section3">Instance API</a></li> <li class="section"><a href="#section4">Help Information</a></li> <li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="section"><a href="#keywords">Keywords</a></li> <li class="section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2> <div class="synopsis"> <ul class="requirements"> <li>package require <b class="pkgname">cmdr::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"><actor></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"><actor></b> <b class="method">description</b></a></li> <li><a href="#5"><b class="cmd"><actor></b> <b class="method">description:</b> <i class="arg">text</i></a></li> |
︙ | ︙ | |||
155 156 157 158 159 160 161 | </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 | | | 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | </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, |
︙ | ︙ | |||
336 337 338 339 340 341 342 | <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. | | | 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | <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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_config.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <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; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_config.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | } --></style> </head> <! -- Generated from file 'cmdr_config.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> <p>cmdr::config - Cmdr - Collection of parameters for privates</p> </div> <div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="toc"> <li class="section"><a href="#toc">Table Of Contents</a></li> <li class="section"><a href="#synopsis">Synopsis</a></li> <li class="section"><a href="#section1">Description</a></li> <li class="section"><a href="#section2">Class API</a></li> <li class="section"><a href="#section3">Instance API</a></li> <li class="section"><a href="#section4">Help Information</a></li> <li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="section"><a href="#keywords">Keywords</a></li> <li class="section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2> <div class="synopsis"> <ul class="requirements"> <li>package require <b class="pkgname">cmdr::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"><config></b> <b class="method">@...</b> <i class="arg">...</i></a></li> |
︙ | ︙ | |||
169 170 171 172 173 174 175 | </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> | | | | | | 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | </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 has no need for it.</p> <dl class="definitions"> <dt><a name="1"><b class="cmd">::cmdr::config</b> <b class="method">new</b> <i class="arg">context</i> <i class="arg">spec</i></a></dt> <dd><p>Create an auto-named instance of <b class="class">cmdr::config</b>.</p> <p><em>Not used</em>.</p></dd> <dt><a name="2"><b class="cmd">::cmdr::config</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">context</i> <i class="arg">spec</i></a></dt> <dd><p>Create a new instance of <b class="class">cmdr::config</b>, named <i class="arg">obj</i>.</p> <dl class="arguments"> <dt>string <i class="arg">obj</i></dt> <dd><p>The (command) name of the new config instance.</p></dd> <dt>cmdr::config <i class="arg">context</i></dt> <dd><p>The instance command of the <b class="package"><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"> |
︙ | ︙ | |||
472 473 474 475 476 477 478 | <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. | | | 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 | <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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_dsl.html.
︙ | ︙ | |||
103 104 105 106 107 108 109 | <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 "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> | | | < < < < < | | | < < | | > | | > | > > > > > > > > | | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | <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 "Cmdr, a framework for command line parsing and dispatch"</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 "privates" with "input" parameters.</p> |
︙ | ︙ | |||
197 198 199 200 201 202 203 | 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> | | | 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | 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 "privates" into an "officer" and renaming them, without changing the actions. Note that the parameter specifications were removed for |
︙ | ︙ | |||
233 234 235 236 237 238 239 | } ::foo::backend::alias::list } } ... </pre> </div> </div> | | < | | | > | | | | | | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < | < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | } ::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> |
︙ | ︙ |
Added embedded/www/doc/files/cmdr_dsl_officer.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | <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 © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</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 "immediately" 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 "Dispatch" 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 "Parsing", "Completion", and "Execution" 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 © 2013 Andreas Kupries<br> Copyright © 2013 Documentation, Andreas Kupries</p> </div> </div></body></html> |
Added embedded/www/doc/files/cmdr_dsl_parameter.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 | <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 © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</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", 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 "foo" will have an alias of "no-foo", and the reverse. In the <i class="term">Parsing</i> 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 <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 © 2013 Andreas Kupries<br> Copyright © 2013 Documentation, Andreas Kupries</p> </div> </div></body></html> |
Added embedded/www/doc/files/cmdr_dsl_private.html.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | <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 © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</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 © 2013 Andreas Kupries<br> Copyright © 2013 Documentation, Andreas Kupries</p> </div> </div></body></html> |
Changes to embedded/www/doc/files/cmdr_help.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <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; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_help.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | } --></style> </head> <! -- Generated from file 'cmdr_help.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</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> |
︙ | ︙ | |||
133 134 135 136 137 138 139 | <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 | | | | | 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | <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 options, enabling the user to choose the form of the help. By default 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 |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_help_json.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <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; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_help_json.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | } --></style> </head> <! -- Generated from file 'cmdr_help_json.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> <p>cmdr::help::json - Cmdr - Formatting help as JSON object</p> </div> <div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="toc"> <li class="section"><a href="#toc">Table Of Contents</a></li> <li class="section"><a href="#synopsis">Synopsis</a></li> <li class="section"><a href="#section1">Description</a></li> <li class="section"><a href="#section2">Bugs, Ideas, Feedback</a></li> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_help_sql.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <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; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_help_sql.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | } --></style> </head> <! -- Generated from file 'cmdr_help_sql.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> <p>cmdr::help::sql - Cmdr - Formatting help as series of SQL commands</p> </div> <div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="toc"> <li class="section"><a href="#toc">Table Of Contents</a></li> <li class="section"><a href="#synopsis">Synopsis</a></li> <li class="section"><a href="#section1">Description</a></li> <li class="section"><a href="#section2">Bugs, Ideas, Feedback</a></li> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_officer.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <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; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_officer.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | } --></style> </head> <! -- Generated from file 'cmdr_officer.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</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="#section3">Instance API</a></li> <li class="section"><a href="#section4">Help Information</a></li> <li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="section"><a href="#keywords">Keywords</a></li> <li class="section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2> <div class="synopsis"> <ul class="requirements"> <li>package require <b class="pkgname">cmdr::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"><officer></b> <b class="method">children</b></a></li> <li><a href="#4"><b class="cmd"><officer></b> <b class="method">complete</b> <i class="arg">line</i></a></li> <li><a href="#5"><b class="cmd"><officer></b> <b class="method">complete-words</b> <i class="arg">parse</i></a></li> |
︙ | ︙ | |||
154 155 156 157 158 159 160 | </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> | | | 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | </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 |
︙ | ︙ | |||
177 178 179 180 181 182 183 | <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. | | | 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | <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 |
︙ | ︙ | |||
273 274 275 276 277 278 279 | <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. | | | | 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | <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"><officer></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> |
︙ | ︙ | |||
317 318 319 320 321 322 323 | <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. | | | 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 | <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"><officer></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> |
︙ | ︙ | |||
364 365 366 367 368 369 370 | <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. | | | 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | <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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_parameter.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <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; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_parameter.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | } --></style> </head> <! -- Generated from file 'cmdr_parameter.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 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 "Cmdr, a framework for command line parsing and dispatch"</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="#section3">Instance API</a></li> <li class="section"><a href="#section4">Help Information</a></li> <li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="section"><a href="#keywords">Keywords</a></li> <li class="section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2> <div class="synopsis"> <ul class="requirements"> <li>package require <b class="pkgname">cmdr::parameter</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"><parameter></b> <b class="method">accept</b> <i class="arg">x</i></a></li> <li><a href="#4"><b class="cmd"><parameter></b> <b class="method">cmdline</b></a></li> <li><a href="#5"><b class="cmd"><parameter></b> <b class="method">code</b></a></li> |
︙ | ︙ | |||
178 179 180 181 182 183 184 | </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 | | | | | | | 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | </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"><a href="cmdr_config.html">cmdr::config</a></b>) serve 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 parameter instances.</p> <p>It is described here for use by developers maintaining, modifying and extending the framework itself. A user of the framework has no need for it.</p> <dl class="definitions"> <dt><a name="1"><b class="cmd">::cmdr::parameter</b> <b class="method">new</b> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></dt> <dd><p>Create an auto-named instance of <b class="class">cmdr::parameter</b>.</p> <p><em>Not used</em>.</p></dd> <dt><a name="2"><b class="cmd">::cmdr::parameter</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">config</i> <i class="arg">order</i> <i class="arg">cmdline</i> <i class="arg">required</i> <i class="arg">defered</i> <i class="arg">name</i> <i class="arg">description</i> <i class="arg">spec</i></a></dt> <dd><p>Create a new instance of <b class="class">cmdr::parameter</b>, named <i class="arg">obj</i>. Used by the DSL processing parts of the framework to instantiate parameters.</p> <dl class="arguments"> <dt>string <i class="arg">obj</i></dt> <dd><p>The (command) name of the new parameter instance.</p></dd> <dt>cmdr::config <i class="arg">config</i></dt> <dd><p>The instance command of the <b class="package"><a href="cmdr_config.html">cmdr::config</a></b> instance holding the parameter.</p></dd> <dt>boolean <i class="arg">order</i></dt> <dd><p>Flag. Parameter is specified by order (<b class="const">true</b>: argument), or name (<b class="const">false</b>: option).</p></dd> <dt>boolean <i class="arg">cmdline</i></dt> <dd><p>Flag. Parameter is visible on the command line (<b class="const">true</b>: option, or argument), or not (<b class="const">false</b>: state).</p></dd> <dt>boolean <i class="arg">required</i></dt> <dd><p>Flag. Parameter is must be specified by the user at runtime (<b class="const">true</b>), or not (<b class="const">false</b>).</p></dd> <dt>boolean <i class="arg">defered</i></dt> <dd><p>Flag. The internal representation is computed on-demand (<b class="const">true</b>), or in the completion phase (<b class="const">false</b>).</p></dd> <dt>string <i class="arg">name</i></dt> <dd><p>Internal name of the parameter. Also the name used in the help, if not overridden by a <b class="cmd">label</b> declaration (in <i class="arg">spec</i>).</p></dd> <dt>string <i class="arg">description</i></dt> <dd><p>Human-readable help text for the parameter.</p></dd> <dt>script <i class="arg">spec</i></dt> <dd><p>Tcl-script specifying the parameter in detail. Please read <i class="term"><a href="cmdr_dsl_parameter.html">Cmdr - Parameter 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>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 |
︙ | ︙ | |||
276 277 278 279 280 281 282 | <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"><parameter></b> <b class="method">config</b> <i class="arg">word...</i></a></dt> | | | 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 | <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"><parameter></b> <b class="method">config</b> <i class="arg">word...</i></a></dt> <dd><p>This method either returns the <b class="package"><a href="cmdr_config.html">cmdr::config</a></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 |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_private.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <html><head> <title>cmdr::private - Cmdr, a framework for command line parsing and dispatch</title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_private.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | } --></style> </head> <! -- Generated from file 'cmdr_private.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> <! -- CVS: $Id$ cmdr::private.n --> <body><div class="doctools"> <hr> [ <a href="../../../../../../home">Home</a> | <a href="../../toc.html">Main Table Of Contents</a> | <a href="../toc.html">Table Of Contents</a> | <a href="../../index.html">Keyword Index</a> ] <hr> <h1 class="title">cmdr::private(n) 0 doc "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> <p>cmdr::private - Cmdr - Single command handling, options, and arguments</p> </div> <div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="toc"> <li class="section"><a href="#toc">Table Of Contents</a></li> <li class="section"><a href="#synopsis">Synopsis</a></li> <li class="section"><a href="#section1">Description</a></li> <li class="section"><a href="#section2">Class API</a></li> <li class="section"><a href="#section3">Instance API</a></li> <li class="section"><a href="#section4">Help Information</a></li> <li class="section"><a href="#section5">Bugs, Ideas, Feedback</a></li> <li class="section"><a href="#keywords">Keywords</a></li> <li class="section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2> <div class="synopsis"> <ul class="requirements"> <li>package require <b class="pkgname">cmdr::private</b></li> </ul> <ul class="syntax"> <li><a href="#1"><b class="cmd">::cmdr::private</b> <b class="method">new</b> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">arguments</i> <i class="arg">action</i></a></li> <li><a href="#2"><b class="cmd">::cmdr::private</b> <b class="method">create</b> <i class="arg">obj</i> <i class="arg">super</i> <i class="arg">name</i> <i class="arg">arguments</i> <i class="arg">action</i></a></li> <li><a href="#3"><b class="cmd"><private></b> <b class="method">complete-words</b> <i class="arg">parse</i></a></li> <li><a href="#4"><b class="cmd"><private></b> <b class="method">do</b> <span class="opt">?<i class="arg">word</i>...?</span></a></li> <li><a href="#5"><b class="cmd"><private></b> <b class="method">ehandler</b> <i class="arg">cmd</i></a></li> <li><a href="#6"><b class="cmd"><private></b> <b class="method">help</b> <span class="opt">?<i class="arg">prefix</i>?</span></a></li> <li><a href="#7"><b class="cmd"><private></b> <b class="method">unknown</b> <i class="arg">m</i> <span class="opt">?<i class="arg">word</i>...?</span></a></li> </ul> </div> </div> <div id="section1" class="section"><h2><a name="section1">Description</a></h2> <p>Welcome to the Cmdr project, written by Andreas Kupries.</p> <p>For availability please read <i class="term"><a href="cmdr_howto_get_sources.html">Cmdr - How To Get The Sources</a></i>.</p> <p>This package implements <em>privates</em>, the leaves of command hierarchies. While each private can execute only a single action they have parameters, i.e. arguments and options with which to configure the behaviour of their action.</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 private instances.</p> <p>It is described here for use by developers maintaining, modifying and extending the framework itself. A user of the framework |
︙ | ︙ | |||
164 165 166 167 168 169 170 | <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 private.</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">arguments</i></dt> <dd><p>The specification of the private's parameters. | | | | 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | <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 private.</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">arguments</i></dt> <dd><p>The specification of the private's parameters. Please read <i class="term"><a href="cmdr_dsl_private.html">Cmdr - Private 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> </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 |
︙ | ︙ | |||
229 230 231 232 233 234 235 | <dl class="arguments"> <dt>string <i class="arg">prefix</i></dt> <dd><p>The name to use for the private within the generated help.</p></dd> </dl></dd> <dt><a name="7"><b class="cmd"><private></b> <b class="method">unknown</b> <i class="arg">m</i> <span class="opt">?<i class="arg">word</i>...?</span></a></dt> <dd><p>This method overrides the standard behaviour for unknown methods. Instead of throwing an error they are routed to the hidden container | | | 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | <dl class="arguments"> <dt>string <i class="arg">prefix</i></dt> <dd><p>The name to use for the private within the generated help.</p></dd> </dl></dd> <dt><a name="7"><b class="cmd"><private></b> <b class="method">unknown</b> <i class="arg">m</i> <span class="opt">?<i class="arg">word</i>...?</span></a></dt> <dd><p>This method overrides the standard behaviour for unknown methods. Instead of throwing an error they are routed to the hidden container of the private's parameters, of class <b class="package"><a href="cmdr_config.html">cmdr::config</a></b>.</p> <dl class="arguments"> <dt>string <i class="arg">m</i></dt> <dd><p>The name of the unknown method.</p></dd> <dt>string <i class="arg">word</i></dt> <dd><p>The argument (one or more) of the unknown method.</p></dd> </dl></dd> </dl> |
︙ | ︙ | |||
255 256 257 258 259 260 261 | <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. | | | 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | <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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_util.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <html><head> <title>cmdr::util - Cmdr, a framework for command line parsing and dispatch</title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_util.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | } --></style> </head> <! -- Generated from file 'cmdr_util.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> <! -- CVS: $Id$ cmdr::util.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::util(n) 0 doc "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> <p>cmdr::util - Cmdr - General Utilities - Internal</p> </div> <div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="toc"> <li class="section"><a href="#toc">Table Of Contents</a></li> <li class="section"><a href="#synopsis">Synopsis</a></li> <li class="section"><a href="#section1">Description</a></li> <li class="section"><a href="#section2">API</a></li> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_validate.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <html><head> <title>cmdr::validate - Cmdr, a framework for command line parsing and dispatch</title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_validate.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | } --></style> </head> <! -- Generated from file 'cmdr_validate.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> <! -- CVS: $Id$ cmdr::validate.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::validate(n) 0 doc "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> <p>cmdr::validate - Cmdr - Standard validation types for 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">Bugs, Ideas, Feedback</a></li> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_vcommon.html.
1 2 | <html><head> | | | 1 2 3 4 5 6 7 8 9 10 | <html><head> <title>cmdr::validate::common - Cmdr, a framework for command line parsing and dispatch</title> <style type="text/css"><!-- HTML { background: #FFFFFF; color: black; } BODY { background: #FFFFFF; |
︙ | ︙ | |||
92 93 94 95 96 97 98 | } --></style> </head> <! -- Generated from file 'cmdr_vcommon.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> | | | | | 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | } --></style> </head> <! -- Generated from file 'cmdr_vcommon.man' by tcllib/doctools with format 'html' --> <! -- Copyright © 2013 Andreas Kupries -- Copyright © 2013 Documentation, Andreas Kupries --> <! -- CVS: $Id$ cmdr::validate::common.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::validate::common(n) 0 doc "Cmdr, a framework for command line parsing and dispatch"</h1> <div id="name" class="section"><h2><a name="name">Name</a></h2> <p>cmdr::validate::common - Cmdr - Utilities for Validation Types</p> </div> <div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2> <ul class="toc"> <li class="section"><a href="#toc">Table Of Contents</a></li> <li class="section"><a href="#synopsis">Synopsis</a></li> <li class="section"><a href="#section1">Description</a></li> <li class="section"><a href="#section2">API</a></li> |
︙ | ︙ | |||
134 135 136 137 138 139 140 | </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 publicly exports three commands for use in the implementation of validation types. The standard validation types defined in package | | | | | 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | </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 publicly exports three commands for use in the implementation of validation types. The standard validation types defined in package <b class="package"><a href="cmdr_validate.html">cmdr::validate</a></b> make use of these commands.</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::validate::common</b> <b class="method">fail</b> <i class="arg">p</i> <i class="arg">code</i> <i class="arg">type</i> <i class="arg">x</i></a></dt> <dd><p>When invoked this command throws an error indicating a validation type failure. The arguments provide the information used to construct both error message and code.</p> <dl class="arguments"> <dt><b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> <i class="arg">p</i></dt> <dd><p>The <b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instance whose validation failed. The error message will contain this parameter's type and label (flag in case of an option).</p></dd> <dt>list <i class="arg">code</i></dt> <dd><p>A list providing additional elements for the error code, detailing the internal name of the validation type triggering the error.</p></dd> <dt>string <i class="arg">type</i></dt> <dd><p>A string providing the human-readable name of the validation type |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_vtypes.html.
︙ | ︙ | |||
124 125 126 127 128 129 130 | </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::validate</b></li> </ul> <ul class="syntax"> | | | | | | | | | | | | | | | > | | | > | | > | | | | | > | | | | | > | | < | | | | | | | | | | | | | | 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | </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::validate</b></li> </ul> <ul class="syntax"> <li><a href="#1"><b class="cmd"><v-type></b> <b class="method">complete</b> <i class="arg">p</i> <i class="arg">x</i></a></li> <li><a href="#2"><b class="cmd"><v-type></b> <b class="method">default</b> <i class="arg">p</i></a></li> <li><a href="#3"><b class="cmd"><v-type></b> <b class="method">release</b> <i class="arg">p</i> <i class="arg">x</i></a></li> <li><a href="#4"><b class="cmd"><v-type></b> <b class="method">validate</b> <i class="arg">p</i> <i class="arg">x</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 describes the API expected of <i class="term">validation types</i> to make them usable within the Cmdr framework, and how to write a custom validation type.</p> <p>Readers interested in the standard validation types of the framework should read <i class="term"><a href="cmdr_validate.html">Cmdr - Standard validation types for parameters</a></i>.</p> </div> <div id="section2" class="section"><h2><a name="section2">Background</a></h2> <p>Validation types are Cmdr's answer to the necessity of moving between the string and internal representations of <b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instances. 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>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 <i class="term"><a href="cmdr_validate.html">Cmdr - Standard validation types for parameters</a></i>.</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> <p>The general concept of <i class="term">validation types</i> was taken from package <b class="package">snit</b>, and modified to suit Cmdr. Where <b class="package">snit</b>'s types expect only a single method to validate the input we expect all types to support an ensemble of <em>four</em> 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 <span class="sectref"><a href="#section3">API</a></span> below.</p> <p>As an example the implementation of the standard boolean validation type is shown in section <span class="sectref"><a href="#section4">Example</a></span>.</p> <p>It should be noted that while <b class="package">snit</b>'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.</p> <p>The <b class="cmd">validate</b> and <b class="cmd">release</b> methods are primarily used during either <i class="term">Completion</i> or <i class="term">Execution</i> phases, depending on the chosen deferal state. They may also be used during the <i class="term">Parsing</i> phase, for optional <i class="term">inputs</i> under the <b class="cmd">test</b>-regime].</p> <p>The <b class="cmd">complete</b> method will be used whereever the system activates an interactive command line shell where arguments may be assigned to parameters.</p> <p>The <b class="cmd">default</b> method on the other hand can expect to be invoked during the <i class="term">Dispatch</i> phase, as part of the system's declaration processing, if not preempted by <b class="cmd">default</b> and <b class="cmd">generate</b> declarations for the parameter. Note here that the <b class="cmd">default</b> method has the same signature as a paramete's <b class="cmd">generate</b> 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 <b class="cmd">generate</b> to change the timing of its invokation.</p> </div> <div id="section3" class="section"><h2><a name="section3">API</a></h2> <p>In the descriptions below the <b class="cmd"><v-type></b> is a placeholder for the actual command prefix, most often a main command, of the validation type.</p> <dl class="definitions"> <dt><a name="1"><b class="cmd"><v-type></b> <b class="method">complete</b> <i class="arg">p</i> <i class="arg">x</i></a></dt> <dd><p>This method is invoked during command completion done by the framework.</p> <p>It has to return the list of legal string representations for the type and parameter instance <i class="arg">p</i> which have the incomplete word <i class="arg">x</i> as their prefix.</p> <dl class="arguments"> <dt><b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> <i class="arg">p</i></dt> <dd><p>The <b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instance governing the completion 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.</p></dd> <dt>string <i class="arg">x</i></dt> <dd><p>The string value to complete.</p></dd> </dl></dd> <dt><a name="2"><b class="cmd"><v-type></b> <b class="method">default</b> <i class="arg">p</i></a></dt> <dd><p>This method is invoked when the framework has to determine the internal representation of a parameter which has no user-specified string representation.</p> <p>It has to return the default internal representation for the type and parameter instance <i class="arg">p</i>.</p> <dl class="arguments"> <dt><b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> <i class="arg">p</i></dt> <dd><p>The <b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instance whose default internal representation is to be computed. While the standard validation types do not make use of it a custom type may have need for access to the context.</p></dd> <dt>string <i class="arg">x</i></dt> <dd><p>The string value to complete.</p></dd> </dl></dd> <dt><a name="3"><b class="cmd"><v-type></b> <b class="method">release</b> <i class="arg">p</i> <i class="arg">x</i></a></dt> <dd><p>This method is invoked when the framework has to get rid of an internal representation for a parameter.</p> <p>It has to release any resources associated with the internal representation <i class="arg">x</i> of parameter instance <i class="arg">p</i>.</p> <p>Note that the result of this method, if there is any, is ignored by the framework.</p> <dl class="arguments"> <dt><b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> <i class="arg">p</i></dt> <dd><p>The <b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instance holding the internal representation to release. 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.</p></dd> <dt>string <i class="arg">x</i></dt> <dd><p>The internal representation to release.</p></dd> </dl></dd> <dt><a name="4"><b class="cmd"><v-type></b> <b class="method">validate</b> <i class="arg">p</i> <i class="arg">x</i></a></dt> <dd><p>This method is invoked during to validate and convert a string representation.</p> <p>It has to verify that <i class="arg">x</i> is a legal string representation for the parameter instance <i class="arg">p</i>, and return the associated internal representation.</p> <dl class="arguments"> <dt><b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> <i class="arg">p</i></dt> <dd><p>The <b class="package"><a href="cmdr_parameter.html">cmdr::parameter</a></b> instance governing the validation process. The standard validation types make use of it in case of a validation failure to generate a proper error message. See also <i class="term">Utilities for Validation Types</i> for commands helping with keeping validation error messages uniform.</p></dd> <dt>string <i class="arg">x</i></dt> <dd><p>The string value to validate cand convert.</p></dd> </dl></dd> |
︙ | ︙ |
Changes to embedded/www/doc/toc.html.
︙ | ︙ | |||
14 15 16 17 18 19 20 | <hr><dl><dt><h2> doc </h2><dd> <table class="#toc"> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr.html">cmdr</a></td> <td class="#tocright">Cmdr - Main package and API</td> </tr> <tr class="#tocodd" > | | > > > > | > > > > | > > > > | > > > > | > > > > > > > > > > > > > > > > > > > > | | | | | | | | | | | | | | | < < < < < < < < < < < < < < < < < < < < < < < < | 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | <hr><dl><dt><h2> doc </h2><dd> <table class="#toc"> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr.html">cmdr</a></td> <td class="#tocright">Cmdr - Main package and API</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_actor.html">cmdr::actor</a></td> <td class="#tocright">Cmdr - Base class for officers and privates - Internal</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_config.html">cmdr::config</a></td> <td class="#tocright">Cmdr - Collection of parameters for privates</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_help.html">cmdr::help</a></td> <td class="#tocright">Cmdr - Utilities for help text formatting and setup - Internal</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_help_json.html">cmdr::help::json</a></td> <td class="#tocright">Cmdr - Formatting help as JSON object</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_help_sql.html">cmdr::help::sql</a></td> <td class="#tocright">Cmdr - Formatting help as series of SQL commands</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_officer.html">cmdr::officer</a></td> <td class="#tocright">Cmdr - Aggregation of multiple commands for dispatch.</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_parameter.html">cmdr::parameter</a></td> <td class="#tocright">Cmdr - Command parameters</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_private.html">cmdr::private</a></td> <td class="#tocright">Cmdr - Single command handling, options, and arguments</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_util.html">cmdr::util</a></td> <td class="#tocright">Cmdr - General Utilities - Internal</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_validate.html">cmdr::validate</a></td> <td class="#tocright">Cmdr - Standard validation types for parameters</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_vcommon.html">cmdr::validate::common</a></td> <td class="#tocright">Cmdr - Utilities for Validation Types</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_changes.html">cmdr_changes</a></td> <td class="#tocright">Cmdr - Log of Changes</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_howto_development.html">cmdr_development</a></td> <td class="#tocright">Cmdr - The Developer's Guide</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_dsl.html">cmdr_dsl</a></td> <td class="#tocright">Cmdr - Introduction to the Specification Language</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_dsl_officer.html">cmdr_dsl_officer</a></td> <td class="#tocright">Cmdr - Officer Specification Language</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_dsl_parameter.html">cmdr_dsl_parameter</a></td> <td class="#tocright">Cmdr - Parameter Specification Language</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_dsl_private.html">cmdr_dsl_private</a></td> <td class="#tocright">Cmdr - Private Specification Language</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_howto_get_sources.html">cmdr_howto_get_sources</a></td> <td class="#tocright">Cmdr - How To Get The Sources</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_howto_installation.html">cmdr_installation</a></td> <td class="#tocright">Cmdr - The Installer's Guide</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_introduction.html">cmdr_introduction</a></td> <td class="#tocright">Cmdr - Introduction to the project</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="files/cmdr_license.html">cmdr_license</a></td> <td class="#tocright">Cmdr - License</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="files/cmdr_vtypes.html">cmdr_vtypes</a></td> <td class="#tocright">Cmdr - Writing custom validation types</td> </tr> </table> </dl><hr></body></html> |
Changes to embedded/www/index.html.
︙ | ︙ | |||
18 19 20 21 22 23 24 | <hr><table class="#idx" width="100%"> <tr class="#idxheader"><th colspan="2"> <a name="c1">Keywords: A</a> </th></tr> <tr class="#idxeven" valign=top> <td class="#idxleft" width="35%"><a name="key4"> arguments </a></td> <td class="#idxright" width="65%"> | | | | | | | | | | | | | | | | 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | <hr><table class="#idx" width="100%"> <tr class="#idxheader"><th colspan="2"> <a name="c1">Keywords: A</a> </th></tr> <tr class="#idxeven" valign=top> <td class="#idxleft" width="35%"><a name="key4"> arguments </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxheader"><th colspan="2"> <a name="c2">Keywords: C</a> </th></tr> <tr class="#idxodd" valign=top> <td class="#idxleft" width="35%"><a name="key5"> command hierarchy </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxeven" valign=top> <td class="#idxleft" width="35%"><a name="key9"> command line completion </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxodd" valign=top> <td class="#idxleft" width="35%"><a name="key11"> command line handling </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxeven" valign=top> <td class="#idxleft" width="35%"><a name="key13"> command tree </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxheader"><th colspan="2"> <a name="c3">Keywords: E</a> </th></tr> <tr class="#idxodd" valign=top> <td class="#idxleft" width="35%"><a name="key0"> editing command line </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxheader"><th colspan="2"> <a name="c4">Keywords: H</a> </th></tr> <tr class="#idxeven" valign=top> <td class="#idxleft" width="35%"><a name="key8"> help for command line </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxodd" valign=top> <td class="#idxleft" width="35%"><a name="key6"> hierarchy of commands </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxheader"><th colspan="2"> <a name="c5">Keywords: I</a> </th></tr> <tr class="#idxeven" valign=top> <td class="#idxleft" width="35%"><a name="key3"> interactive command shell </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxheader"><th colspan="2"> <a name="c6">Keywords: O</a> </th></tr> <tr class="#idxodd" valign=top> <td class="#idxleft" width="35%"><a name="key1"> optional arguments </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxeven" valign=top> <td class="#idxleft" width="35%"><a name="key2"> options </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxheader"><th colspan="2"> <a name="c7">Keywords: P</a> </th></tr> <tr class="#idxodd" valign=top> <td class="#idxleft" width="35%"><a name="key12"> parameters </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxeven" valign=top> <td class="#idxleft" width="35%"><a name="key10"> processing command line </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> <tr class="#idxheader"><th colspan="2"> <a name="c8">Keywords: T</a> </th></tr> <tr class="#idxodd" valign=top> <td class="#idxleft" width="35%"><a name="key7"> tree of commands </a></td> <td class="#idxright" width="65%"> <a href="doc/files/cmdr.html"> cmdr </a> · <a href="doc/files/cmdr_actor.html"> cmdr::actor </a> · <a href="doc/files/cmdr_config.html"> cmdr::config </a> · <a href="doc/files/cmdr_help.html"> cmdr::help </a> · <a href="doc/files/cmdr_help_json.html"> cmdr::help::json </a> · <a href="doc/files/cmdr_help_sql.html"> cmdr::help::sql </a> · <a href="doc/files/cmdr_officer.html"> cmdr::officer </a> · <a href="doc/files/cmdr_parameter.html"> cmdr::parameter </a> · <a href="doc/files/cmdr_private.html"> cmdr::private </a> · <a href="doc/files/cmdr_util.html"> cmdr::util </a> · <a href="doc/files/cmdr_validate.html"> cmdr::validate </a> · <a href="doc/files/cmdr_vcommon.html"> cmdr::validate::common </a> · <a href="doc/files/cmdr_changes.html"> cmdr_changes </a> · <a href="doc/files/cmdr_howto_development.html"> cmdr_development </a> · <a href="doc/files/cmdr_dsl.html"> cmdr_dsl </a> · <a href="doc/files/cmdr_dsl_officer.html"> cmdr_dsl_officer </a> · <a href="doc/files/cmdr_dsl_parameter.html"> cmdr_dsl_parameter </a> · <a href="doc/files/cmdr_dsl_private.html"> cmdr_dsl_private </a> · <a href="doc/files/cmdr_howto_get_sources.html"> cmdr_howto_get_sources </a> · <a href="doc/files/cmdr_howto_installation.html"> cmdr_installation </a> · <a href="doc/files/cmdr_introduction.html"> cmdr_introduction </a> · <a href="doc/files/cmdr_license.html"> cmdr_license </a> · <a href="doc/files/cmdr_vtypes.html"> cmdr_vtypes </a> </td></tr> </table> </body></html> |
Changes to embedded/www/toc.html.
︙ | ︙ | |||
14 15 16 17 18 19 20 | <hr><dl><dt><h2> doc </h2><dd> <table class="#toc"> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr.html">cmdr</a></td> <td class="#tocright">Cmdr - Main package and API</td> </tr> <tr class="#tocodd" > | | | | | > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > | | | | | | | | | | | | | | | < < < < < < < < < < < < < < < < < < < < < < < < | 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | <hr><dl><dt><h2> doc </h2><dd> <table class="#toc"> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr.html">cmdr</a></td> <td class="#tocright">Cmdr - Main package and API</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_actor.html">cmdr::actor</a></td> <td class="#tocright">Cmdr - Base class for officers and privates - Internal</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_config.html">cmdr::config</a></td> <td class="#tocright">Cmdr - Collection of parameters for privates</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_help.html">cmdr::help</a></td> <td class="#tocright">Cmdr - Utilities for help text formatting and setup - Internal</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_help_json.html">cmdr::help::json</a></td> <td class="#tocright">Cmdr - Formatting help as JSON object</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_help_sql.html">cmdr::help::sql</a></td> <td class="#tocright">Cmdr - Formatting help as series of SQL commands</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_officer.html">cmdr::officer</a></td> <td class="#tocright">Cmdr - Aggregation of multiple commands for dispatch.</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_parameter.html">cmdr::parameter</a></td> <td class="#tocright">Cmdr - Command parameters</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_private.html">cmdr::private</a></td> <td class="#tocright">Cmdr - Single command handling, options, and arguments</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_util.html">cmdr::util</a></td> <td class="#tocright">Cmdr - General Utilities - Internal</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_validate.html">cmdr::validate</a></td> <td class="#tocright">Cmdr - Standard validation types for parameters</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_vcommon.html">cmdr::validate::common</a></td> <td class="#tocright">Cmdr - Utilities for Validation Types</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_changes.html">cmdr_changes</a></td> <td class="#tocright">Cmdr - Log of Changes</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_howto_development.html">cmdr_development</a></td> <td class="#tocright">Cmdr - The Developer's Guide</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_dsl.html">cmdr_dsl</a></td> <td class="#tocright">Cmdr - Introduction to the Specification Language</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_dsl_officer.html">cmdr_dsl_officer</a></td> <td class="#tocright">Cmdr - Officer Specification Language</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_dsl_parameter.html">cmdr_dsl_parameter</a></td> <td class="#tocright">Cmdr - Parameter Specification Language</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_dsl_private.html">cmdr_dsl_private</a></td> <td class="#tocright">Cmdr - Private Specification Language</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_howto_get_sources.html">cmdr_howto_get_sources</a></td> <td class="#tocright">Cmdr - How To Get The Sources</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_howto_installation.html">cmdr_installation</a></td> <td class="#tocright">Cmdr - The Installer's Guide</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_introduction.html">cmdr_introduction</a></td> <td class="#tocright">Cmdr - Introduction to the project</td> </tr> <tr class="#tocodd" > <td class="#tocleft" ><a href="doc/files/cmdr_license.html">cmdr_license</a></td> <td class="#tocright">Cmdr - License</td> </tr> <tr class="#toceven" > <td class="#tocleft" ><a href="doc/files/cmdr_vtypes.html">cmdr_vtypes</a></td> <td class="#tocright">Cmdr - Writing custom validation types</td> </tr> </table> </dl><hr></body></html> |