Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Regenerated embedded docs. |
---|---|
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
2659fd6b1329a9dc5bbce0ff62533266 |
User & Date: | aku 2014-02-06 18:35:12.830 |
Context
2014-02-07
| ||
18:23 | Oops. Have to export method "_find" for proper operation (in the recursion). check-in: 98315e9657 user: andreask tags: trunk | |
2014-02-06
| ||
18:35 | Regenerated embedded docs. check-in: 2659fd6b13 user: aku tags: trunk | |
18:05 | Updated the changes information in the documentation. check-in: 9e34d9687a user: andreask tags: trunk | |
Changes
Changes to doc/parts/changes1.1.inc.
︙ | ︙ | |||
17 18 19 20 21 22 23 | [enum] Fixed bad method scoping in method [method extend] of officers. [enum] Extended officer method [method extend] to return the created private, for immediate post-creation re-configuration. [enum] Extended system with new help format [term tcl], and associated | | | > | 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | [enum] Fixed bad method scoping in method [method extend] of officers. [enum] Extended officer method [method extend] to return the created private, for immediate post-creation re-configuration. [enum] Extended system with new help format [term tcl], and associated package [package cmdr::help::tcl]. Similar to format [term json] the help is printed as a nested data structure, just using Tcl syntax. [enum] Extended officers and privates with method [method find] for path lookup of sub-ordinates. [comment {- - -- --- ----- -------- ------------- ---------------------}] [list_end] |
Changes to embedded/man/files/cmdr.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr" n 1\&.1 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 |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::actor" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr::actor \- Cmdr - (Internal) Base class for officers and privates .SH SYNOPSIS package require \fBcmdr::actor \fR .sp \fB::cmdr::actor\fR \fBnew\fR |
︙ | ︙ |
Changes to embedded/man/files/cmdr_changes.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 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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-changes" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-changes \- Cmdr - Log of Changes .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 provides an overview of the changes \fBcmdr\fR underwent from version to version\&. .SH CHANGES .SS "CHANGES FOR VERSION 1\&.1" .IP [1] Fixed broken requirement references in the meta data of packages \fBcmdr::help::json\fR and \fBcmdr::help::sql\fR\&. .IP [2] Fixed initialization issues in the help generator\&. .IP [3] Fixed generated help, added the application name to the output when in a cmdr shell\&. .IP [4] Fixed the generation of help format by-categorized, when encountering sections with sub-sections and no commands of their own\&. .IP [5] Fixed bad method scoping in method \fBextend\fR of officers\&. .IP [6] Extended officer method \fBextend\fR to return the created private, for immediate post-creation re-configuration\&. .IP [7] Extended system with new help format \fItcl\fR, and associated package \fBcmdr::help::tcl\fR\&. Similar to format \fIjson\fR the help is printed as a nested data structure, just using Tcl syntax\&. .IP [8] Extended officers and privates with method \fBfind\fR for path lookup of sub-ordinates\&. .PP .SS "CHANGES FOR VERSION 1" This is the first release of cmdr\&. The changes therefore describe the initial features of the system\&. .PP In detail: .IP [1] cmdr requires Tcl 8\&.5 or higher\&. Tcl 8\&.4 or less is not supported\&. |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::config" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr::config \- Cmdr - (Partially internal) Collection of parameters for privates .SH SYNOPSIS package require \fBcmdr::config \fR .sp \fB::cmdr::config\fR \fBnew\fR \fIcontext\fR \fIspec\fR |
︙ | ︙ |
Changes to embedded/man/files/cmdr_dev_completion.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr_dev~completion" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr_dev~completion \- Cmdr - Internals of command line completion .SH SYNOPSIS package require \fBcmdr \fR .sp .BE |
︙ | ︙ |
Changes to embedded/man/files/cmdr_dev_dsl.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr_dev~dsl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr_dev~dsl \- Cmdr - Internals of DSL handling .SH SYNOPSIS package require \fBcmdr \fR .sp .BE |
︙ | ︙ |
Changes to embedded/man/files/cmdr_dsl.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-spec-dsl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-spec-dsl \- Cmdr - Introduction to the Specification Language .SH DESCRIPTION .PP Welcome to the Cmdr project, written by Andreas Kupries\&. .PP |
︙ | ︙ |
Changes to embedded/man/files/cmdr_dsl_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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-spec-dsl-officer" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-spec-dsl-officer \- Cmdr - Officer Specification Language .SH SYNOPSIS \fBalias\fR \fIname\fR \fB=\fR \fIname'\fR\&.\&.\&. .sp \fBalias\fR \fIname\fR |
︙ | ︙ |
Changes to embedded/man/files/cmdr_dsl_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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-spec-dsl-parameter" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-spec-dsl-parameter \- Cmdr - Parameter Specification Language .SH SYNOPSIS \fBlabel\fR \fItext\fR .sp \fBalias\fR \fIname\fR |
︙ | ︙ |
Changes to embedded/man/files/cmdr_dsl_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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-spec-dsl-private" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-spec-dsl-private \- Cmdr - Private Specification Language .SH SYNOPSIS \fBdescription\fR \fItext\fR .sp \fBinput\fR \fIname\fR \fIhelp\fR \fIscript\fR |
︙ | ︙ |
Changes to embedded/man/files/cmdr_flow.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-spec-flow" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-spec-flow \- Cmdr - Runtime Processing Flow .SH DESCRIPTION .PP Welcome to the Cmdr project, written by Andreas Kupries\&. .PP |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::help" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr::help \- Cmdr - (Internal) Utilities for help text formatting and setup .SH SYNOPSIS package require \fBcmdr::help \fR .sp \fB::cmdr::help\fR \fBauto\fR \fIactor\fR |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::help::json" n 1\&.1 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 |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::help::sql" n 1\&.1 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 |
︙ | ︙ |
Changes to embedded/man/files/cmdr_help_tcl.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::help::tcl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr::help::tcl \- Cmdr - Formatting help as Tcl data structure .SH SYNOPSIS package require \fBcmdr::help::tcl \fR .sp .BE |
︙ | ︙ |
Changes to embedded/man/files/cmdr_helpformats.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-user-helpformats" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-user-helpformats \- Cmdr - Writing custom help formats .SH SYNOPSIS package require \fBcmdr::help \fR .sp \fB::cmdr::help::format::<foo>\fR \fIroot\fR \fIwidth\fR \fIhelp\fR |
︙ | ︙ |
Changes to embedded/man/files/cmdr_howto_development.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr_development" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr_development \- Cmdr - The Developer's Guide .SH DESCRIPTION .PP Welcome to the Cmdr project, written by Andreas Kupries\&. .PP |
︙ | ︙ |
Changes to embedded/man/files/cmdr_howto_get_sources.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-howto-get-sources" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-howto-get-sources \- Cmdr - How To Get The Sources .SH DESCRIPTION .PP Welcome to the Cmdr project, written by Andreas Kupries\&. .PP |
︙ | ︙ |
Changes to embedded/man/files/cmdr_howto_installation.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-installation" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-installation \- Cmdr - The Installer's Guide .SH DESCRIPTION .PP Welcome to the Cmdr project, written by Andreas Kupries\&. .PP |
︙ | ︙ |
Changes to embedded/man/files/cmdr_introduction.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-introduction" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-introduction \- Cmdr - Introduction to the project .SH DESCRIPTION .PP Welcome to the Cmdr project, written by Andreas Kupries\&. .PP |
︙ | ︙ |
Changes to embedded/man/files/cmdr_license.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-license" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-license \- Cmdr - License .SH DESCRIPTION .PP Welcome to the Cmdr project, written by Andreas Kupries\&. .PP |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::officer" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr::officer \- Cmdr - (Internal) 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 |
︙ | ︙ | |||
456 457 458 459 460 461 462 | hidden \fBcmdr::config\fR container holding the private's parameters\&. The result of the action, if there is any, is ignored by the framework\&. .RE .TP \fB<officer>\fR \fBfind\fR \fIpath\fR This method returns the instance command of the sub-ordinate with the | | | > > | 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 | hidden \fBcmdr::config\fR container holding the private's parameters\&. The result of the action, if there is any, is ignored by the framework\&. .RE .TP \fB<officer>\fR \fBfind\fR \fIpath\fR This method returns the instance command of the sub-ordinate with the given \fIpath\fR (a list) of names\&. An error is thrown if such a sub-ordinate does not exist\&. This is an extension of \fBlookup\fR to paths of names\&. .sp An empty \fIpath\fR is allowed and refers to the officer itself\&. .RS .TP string \fIpath\fR The path of names to the sub-ordinate to look for\&. .RE .TP \fB<officer>\fR \fBhas\fR \fIname\fR |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::parameter" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr::parameter \- Cmdr - (Partially internal) 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 |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::private" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr::private \- Cmdr - (Internal) 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 |
︙ | ︙ | |||
363 364 365 366 367 368 369 | data between multiple commands executed one after the other (i\&.e\&. in an interactive shell run by the framework)\&. .RE .TP \fB<private>\fR \fBfind\fR \fIpath\fR This method returns the instance command of the sub-ordinate with the given \fIpath\fR of names\&. An error is thrown if such a sub-ordinate | > | > > > > | | 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 | data between multiple commands executed one after the other (i\&.e\&. in an interactive shell run by the framework)\&. .RE .TP \fB<private>\fR \fBfind\fR \fIpath\fR This method returns the instance command of the sub-ordinate with the given \fIpath\fR of names\&. An error is thrown if such a sub-ordinate does not exist, i\&.e\&. whenever \fIpath\fR is not empty, as a private has no sub-ordinates, ever\&. .sp Note, as implied above, an empty \fIpath\fR is allowed and refers to the private itself\&. .sp See also method \fBfind\fR of \fBcdmr::officer\fR for the high-end of the recursion which may end in this method\&. .RS .TP string \fIpath\fR The path of names to the sub-ordinate to look for\&. .RE .TP |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::util" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr::util \- Cmdr - (Internal) General Utilities .SH SYNOPSIS package require \fBcmdr::util \fR .sp \fB::cmdr::util\fR \fBpadr\fR \fIlist\fR |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::validate" n 1\&.1 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 |
︙ | ︙ |
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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr::validate::common" n 1\&.1 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 |
︙ | ︙ |
Changes to embedded/man/files/cmdr_vtypes.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 | .de CE .fi .RE .. .de UL \\$1\l'|0\(ul'\\$2 .. .TH "cmdr-user-vtypes" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" .BS .SH NAME cmdr-user-vtypes \- Cmdr - Writing custom validation types .SH SYNOPSIS package require \fBcmdr::validate \fR .sp \fB<v-type>\fR \fBcomplete\fR \fIp\fR \fIx\fR |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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(n) 1.1 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 - Cmdr - Main package and API</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_actor.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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 - (Internal) Base class for officers and 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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_changes.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <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-changes(n) 1.1 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-changes - Cmdr - Log of Changes</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">Changes</a> <ul> <li class="subsection"><a href="#subsection1">Changes for version 1.1</a></li> <li class="subsection"><a href="#subsection2">Changes for version 1</a></li> </ul> </li> <li class="section"><a href="#section3">Related Documents</a></li> <li class="section"><a href="#section4">Bugs, Ideas, Feedback</a></li> <li class="section"><a href="#keywords">Keywords</a></li> <li class="section"><a href="#copyright">Copyright</a></li> </ul> </div> <div id="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 provides an overview of the changes <b class="package"><a href="cmdr.html">cmdr</a></b> underwent from version to version.</p> </div> <div id="section2" class="section"><h2><a name="section2">Changes</a></h2> <div id="subsection1" class="subsection"><h3><a name="subsection1">Changes for version 1.1</a></h3> <ol class="enumerated"> <li><p>Fixed broken requirement references in the meta data of packages <b class="package"><a href="cmdr_help_json.html">cmdr::help::json</a></b> and <b class="package"><a href="cmdr_help_sql.html">cmdr::help::sql</a></b>.</p></li> <li><p>Fixed initialization issues in the help generator.</p></li> <li><p>Fixed generated help, added the application name to the output when in a cmdr shell.</p></li> <li><p>Fixed the generation of help format by-categorized, when encountering sections with sub-sections and no commands of their own.</p></li> <li><p>Fixed bad method scoping in method <b class="method">extend</b> of officers.</p></li> <li><p>Extended officer method <b class="method">extend</b> to return the created private, for immediate post-creation re-configuration.</p></li> <li><p>Extended system with new help format <i class="term">tcl</i>, and associated package <b class="package"><a href="cmdr_help_tcl.html">cmdr::help::tcl</a></b>. Similar to format <i class="term">json</i> the help is printed as a nested data structure, just using Tcl syntax.</p></li> <li><p>Extended officers and privates with method <b class="method">find</b> for path lookup of sub-ordinates.</p></li> </ol> </div> <div id="subsection2" class="subsection"><h3><a name="subsection2">Changes for version 1</a></h3> <p>This is the first release of cmdr. The changes therefore describe the initial features of the system.</p> <p>In detail:</p> <ol class="enumerated"> <li><p>cmdr requires Tcl 8.5 or higher. Tcl 8.4 or less is not supported.</p></li> <li><p>The framework provides a DSL for the declaration of a hierarchy of commands and their parameters (named options, positional arguments, hidden state), with help texts, type information, and various callbacks (command actions, parameter definition, parameter completion, type validation, command completion, etc.)</p></li> <li><p>At runtime the framework provides parsing and processing of command lines per specifications written in that DSL, determining the command to run, and the mapping from command line words to its parameters.</p></li> <li><p>The framework also provides shells for the interactive entry of commands and parameters, with command line completion.</p></li> <li><p>Last, but not least is the automatic generation of command line help for commands and parameters, based on the information provided in a specification.</p></li> </ol> </div> </div> <div id="section3" class="section"><h2><a name="section3">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">Cmdr - Log of Changes</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_config.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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 - (Partially internal) 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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_dev_completion.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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_dev~completion(n) 1.1 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_dev~completion - Cmdr - Internals of command line completion</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_dev_dsl.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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_dev~dsl(n) 1.1 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_dev~dsl - Cmdr - Internals of DSL handling</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_dsl.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-spec-dsl(n) 1.1 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-spec-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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_dsl_officer.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-spec-dsl-officer(n) 1.1 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-spec-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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_dsl_parameter.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-spec-dsl-parameter(n) 1.1 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-spec-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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_dsl_private.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-spec-dsl-private(n) 1.1 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-spec-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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_flow.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-spec-flow(n) 1.1 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-spec-flow - Cmdr - Runtime Processing Flow</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_help.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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 - (Internal) Utilities for help text formatting and setup</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_help_json.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_help_sql.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_help_tcl.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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::tcl(n) 1.1 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::tcl - Cmdr - Formatting help as Tcl data structure</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_helpformats.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-user-helpformats(n) 1.1 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-user-helpformats - Cmdr - Writing custom help formats</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_howto_development.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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_development(n) 1.1 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_development - Cmdr - The Developer's Guide</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_howto_get_sources.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-howto-get-sources(n) 1.1 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-howto-get-sources - Cmdr - How To Get The Sources</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_howto_installation.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-installation(n) 1.1 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-installation - Cmdr - The Installer's Guide</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_introduction.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-introduction(n) 1.1 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-introduction - Cmdr - Introduction to the project</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_license.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-license(n) 1.1 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-license - Cmdr - License</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_officer.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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 - (Internal) 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> |
︙ | ︙ | |||
287 288 289 290 291 292 293 | 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">find</b> <i class="arg">path</i></a></dt> <dd><p>This method returns the instance command of the sub-ordinate with the | | | > | 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 | 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">find</b> <i class="arg">path</i></a></dt> <dd><p>This method returns the instance command of the sub-ordinate with the given <i class="arg">path</i> (a list) of names. An error is thrown if such a sub-ordinate does not exist. This is an extension of <b class="method">lookup</b> to paths of names.</p> <p>An empty <i class="arg">path</i> is allowed and refers to the officer itself.</p> <dl class="arguments"> <dt>string <i class="arg">path</i></dt> <dd><p>The path of names to the sub-ordinate to look for.</p></dd> </dl></dd> <dt><a name="14"><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 |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_parameter.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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 - (Partially internal) 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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_private.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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 - (Internal) 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> |
︙ | ︙ | |||
222 223 224 225 226 227 228 | required by the application using the framework to prevent leakage of data between multiple commands executed one after the other (i.e. in an interactive shell run by the framework).</p></dd> </dl></dd> <dt><a name="6"><b class="cmd"><private></b> <b class="method">find</b> <i class="arg">path</i></a></dt> <dd><p>This method returns the instance command of the sub-ordinate with the given <i class="arg">path</i> of names. An error is thrown if such a sub-ordinate | > | > > | | 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | required by the application using the framework to prevent leakage of data between multiple commands executed one after the other (i.e. in an interactive shell run by the framework).</p></dd> </dl></dd> <dt><a name="6"><b class="cmd"><private></b> <b class="method">find</b> <i class="arg">path</i></a></dt> <dd><p>This method returns the instance command of the sub-ordinate with the given <i class="arg">path</i> of names. An error is thrown if such a sub-ordinate does not exist, i.e. whenever <i class="arg">path</i> is not empty, as a private has no sub-ordinates, ever.</p> <p>Note, as implied above, an empty <i class="arg">path</i> is allowed and refers to the private itself.</p> <p>See also method <b class="method">find</b> of <b class="package">cdmr::officer</b> for the high-end of the recursion which may end in this method.</p> <dl class="arguments"> <dt>string <i class="arg">path</i></dt> <dd><p>The path of names to the sub-ordinate to look for.</p></dd> </dl></dd> <dt><a name="7"><b class="cmd"><private></b> <b class="method">help</b> <span class="opt">?<i class="arg">prefix</i>?</span></a></dt> <dd><p>This method returns the help information for the private and its |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_util.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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 - (Internal) General Utilities</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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_validate.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_vcommon.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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) 1.1 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> |
︙ | ︙ |
Changes to embedded/www/doc/files/cmdr_vtypes.html.
︙ | ︙ | |||
101 102 103 104 105 106 107 | <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> | | | 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <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-user-vtypes(n) 1.1 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-user-vtypes - Cmdr - Writing custom 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> |
︙ | ︙ |