Index: color.tcl ================================================================== --- color.tcl +++ color.tcl @@ -43,11 +43,11 @@ # treated as (list of) color codes to apply to some text, # effectively creating the virtual command # # ::cmdr::color # - # The -prefix 0 option ensures that we canuse the 'name' + # The -prefix 0 option ensures that we can use the 'name' # color-code, without it will go to 'names' and then fail with # wrong#args due to the different expected syntax. ## namespace import ::cmdr::tty @@ -64,11 +64,11 @@ ## TODO officer and private for std commands (show, define). proc ::cmdr::color::activate {{flag 1}} { debug.cmdr/color {} variable active $flag - return + return $active } proc ::cmdr::color::active {} { debug.cmdr/color {} variable active ADDED doc/cmdr_ask.man Index: doc/cmdr_ask.man ================================================================== --- /dev/null +++ doc/cmdr_ask.man @@ -0,0 +1,119 @@ +[comment {-*- tcl -*- doctools manpage}] +[include parts/definitions.inc] +[manpage_begin [vset LABEL_ASK] [vset MAN_SECTION] [vset VERSION]] +[include parts/module.inc] +[require cmdr::color] +[require linenoise] +[require struct::matrix] +[require textutil::adjust] +[require try] +[require cmdr::ask] +[titledesc [vset TITLE_ASK]] +[description] +[include parts/welcome.inc] + +This package provides a few utility commands implementing a few simple +terminal-based interactions with the user. + +[section API] +[list_begin definitions] +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::ask] [method string] [arg query] [opt [arg default]]] + +When invoked this command prompts the user with [arg query] for a string. +If the [arg default] is specified and not the empty string it is also +shown as part of the prompt. Note that [arg default] defaults to the +empty string. + +[para] The interactively entered string is returned as the result of the +command. The [arg default] is returned as the result if the user entered +an empty string and the [arg default] is not empty. + +[list_begin arguments] +[arg_def string query] The prompt to show to the user before interaction begins. +[arg_def string default] The default to return if the user enters nothing. +[list_end] + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::ask] [method string/extended] [arg query] [opt options...]] + +This command is similar to [cmd {::cmdr::ask string}], except it allows for +more customization of the interaction through options. + +[para] The accepted options are +[list_begin options] +[opt_def -history boolean] If [const true], save user input into [package linenoise]'s in-memory history. Default is [const false]. +[opt_def -hidden boolean] If [const true], input is hidden. Default is [const false], visible echo. +[opt_def -complete cmdprefix] If not empty, installed as completion callback. +[opt_def -default string] If not empty the string to return if the user enters the empty string. +[list_end] + +[list_begin arguments] +[arg_def string query] The prompt to show to the user before interaction begins. +[list_end] + + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::ask] [method string*] [arg query]] + +Behaves like [cmd {::cmdr::ask string}] without a default, except that the user's +input is not echoed back to the terminal. This command is for the entry of hidden +strings, i.e. passwords, and the like. + +[list_begin arguments] +[arg_def string query] The prompt to show to the user before interaction begins. +[list_end] + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::ask] [method yn] [arg query] [opt [arg default]]] + +When invoked this command prompts the user with [arg query] for a [emph boolean] +value/string. If the [arg default] is specified and not the empty string it is +also shown as part of the prompt. Note that [arg default] defaults to the empty +string. + +[para] The interactively entered boolean is returned as the result of the command. +The [arg default] boolean is returned as the result if the user entered an empty +string and the [arg default] is not empty. + +[para] Note that the command will not return until the user entered a valid +boolean value. Entering a non-boolean string causes the command to loop internally +and re-prompt. + +[list_begin arguments] +[arg_def string query] The prompt to show to the user before interaction begins. +[arg_def string default] The default boolean to return if the user enters nothing. +[list_end] + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::ask] [method choose] [arg query] [arg choices] [opt [arg default]]] + +When invoked this command prompts the user with [arg query] for one of the +[arg choices], entered as string. Prompt and input happen on a single line. + +[para] The interactively entered choice is returned as the result of the command. +The [arg default] choice is returned as the result if the user entered an empty +string and the [arg default] is not empty. + +[para] Note that the command will not return until the user entered a valid +choice. Entering a non-choice causes the command to loop internally and re-prompt. +The user is supported in entry by an internal completion callback. + +[list_begin arguments] +[arg_def string query] The prompt to show to the user before interaction begins. +[arg_def string default] The default boolean to return if the user enters nothing. +[list_end] + + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::ask] [method menu] [arg header] [arg prompt] [arg choices] [opt [arg default]]] + +Similar to [cmd {::cmdr::ask choose}], except that the [arg choices] are shown +as an enumerated menu, one per line, with a leading [arg header]. + +Furthermore the command accepts not only the choices as input, but also their +numeric indices in the menu. The result however is always the relevant chosen string. + +[list_end] +[include parts/feedback.inc] +[manpage_end] ADDED doc/cmdr_color.man Index: doc/cmdr_color.man ================================================================== --- /dev/null +++ doc/cmdr_color.man @@ -0,0 +1,181 @@ +[comment {-*- tcl -*- doctools manpage}] +[include parts/definitions.inc] +[manpage_begin [vset LABEL_COLOR] [vset MAN_SECTION] [vset VERSION]] +[include parts/module.inc] +[require cmdr::tty] +[require cmdr::color] +[titledesc [vset TITLE_COLOR]] +[description] +[include parts/welcome.inc] + +This package provides a few utility commands implementing +the management of terminal colors. + +[section API] +[list_begin definitions] +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method activate] [opt [arg enable]]] + +When invoked this command enables or disables color handling, +as per the boolean flag [arg enable]. If [arg enable] is not +specified the action defaults to activation. + +[para] The result of the command is the new activation state. + +[para] The default activation state of the package after loading +depends on [const stdout]. The package is active if [const stdout] +is a terminal, and inactive otherwise. + +[list_begin arguments] +[arg_def boolean enable] If set, enable color handling, else disable it. +[list_end] + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method active]] + +The result of this command is the current activation state +of the package. + +[para] The default activation state of the package after loading +depends on [const stdout]. The package is active if [const stdout] +is a terminal, and inactive otherwise. + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method names]] + +When invoked this command returns a list of the symbolic color +names known to the package. + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method get] [arg name]] + +When invoked this command returns the character sequence +associated with the symbolic color [arg name]. An error +is thrown if [arg name] is not a known symbol. + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method get-def] [arg name]] + +When invoked this command returns the specification +associated with the symbolic color [arg name]. An error +is thrown if [arg name] is not a known symbol. + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method define] [arg name] [arg spec]] + +When invoked this command defines the color [arg name]. If [arg name] +exists already its previous specification is overwritten. + +The command accepts four forms of [arg spec]ifications, namely: + +[list_begin definitions] +[def "=[var rname]"] +The [arg rname] must be the name of a known color. +The [arg name] itself is not allowed, i.e. self-references are forbidden. + +[def "%[var R],[var G],[var B]"] + +The [arg R], [arg G], and [arg B] values are integers in the range +[const 0]...[const 5] directly specifying the chosen color. These +specifications may not work if the terminal is not configured to +support 256 colors. + +[def "[lb]Ee[rb][var code](,...)"] +The value is a comma-separated list of ANSI color control characters. + +[def "*"] +Any other string is acceptable too, and used as is. + +[list_end] + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method exists] [arg name]] + +When invoked this command tests if the symbolic color [arg name] +is known, returns the boolean value [const true] if so, and +[const false] else. + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method unset] [arg name]] + +When invoked this command deletes the symbolic color [arg name]. +An error is thrown if [arg name] is not a known symbol. + +The command returns the empty string as its result. + +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::color] [method ...] [arg text]] + +When [cmd ::cmdr::color] is invoked with an unknown method name +then this name is expected to be and treated as a list of known +symbolic color names. These colors are applied to the [arg text] +and the modified text is returned as the result of the command. + +[para] An error is thrown if any of the specified color symbols +are not known. + +[list_end] + +[section {Predefined colors}] + +The following colors are defined by the package itself: + +[list_begin definitions] +[def black ] e30 +[def red ] e31 +[def green ] e32 +[def yellow ] e33 +[def blue ] e34 +[def magenta] e35 +[def cyan ] e36 +[def white ] e37 +[def default] e39 + +[def bg-black ] e40 +[def bg-red ] e41 +[def bg-green ] e42 +[def bg-yellow ] e43 +[def bg-blue ] e44 +[def bg-magenta] e45 +[def bg-cyan ] e46 +[def bg-white ] e47 +[def bg-default] e49 + +[def bold ] e1 +[def dim ] e2 +[def italic ] e3 +[def underline] e4 +[def blink ] e5 +[def revers ] e7 +[def hidden ] e8 +[def strike ] e9 + +[def no-bold ] e21 +[def no-dim ] e22 +[def no-italic ] e23 +[def no-underline] e24 +[def no-blink ] e25 +[def no-revers ] e27 +[def no-hidden ] e28 +[def no-strike ] e29 + +[def reset] e0 + +[def advisory] =yellow +[def bad ] =red +[def confirm ] =red +[def error ] =magenta +[def good ] =green +[def name ] =blue +[def neutral ] =blue +[def no ] =red +[def note ] =blue +[def number ] =green +[def prompt ] =blue +[def unknown ] =cyan +[def warning ] =yellow +[def yes ] =green +[list_end] + +[include parts/feedback.inc] +[manpage_end] ADDED doc/cmdr_pager.man Index: doc/cmdr_pager.man ================================================================== --- /dev/null +++ doc/cmdr_pager.man @@ -0,0 +1,46 @@ +[comment {-*- tcl -*- doctools manpage}] +[include parts/definitions.inc] +[manpage_begin [vset LABEL_PAGER] [vset MAN_SECTION] [vset VERSION]] +[include parts/module.inc] +[require linenoise] +[require cmdr::tty] +[require cmdr::pager] +[titledesc [vset TITLE_PAGER]] +[description] +[include parts/welcome.inc] + +This package provides a single utility command to manage the automatic +paging of long output, like [vset PROJECT]'s automatic help. + +[section API] +[list_begin definitions] +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::pager] [method text]] + +When invoked this command either simply prints the [arg text] to stdout, +or invokes an external pager application to manage the output. + +[para] The pager is only invoked when + +[list_begin enumerated] +[enum] Stdout is a terminal, and +[enum] The text does not fit into the height of the terminal, and +[enum] a pager application could be found. +[list_end] + +[para] If any of the above conditions fail the text is simply printed. + +[para] When the command comes to the third condition above it will look +for the pager specified in the environment variable [const PAGER] first, +and then [const less] and [const more], in this order. + +[list_begin arguments] +[arg_def string text] +The text to print or page. +[list_end] + +[para] The result of the command is the empty string. + +[list_end] +[include parts/feedback.inc] +[manpage_end] ADDED doc/cmdr_tty.man Index: doc/cmdr_tty.man ================================================================== --- /dev/null +++ doc/cmdr_tty.man @@ -0,0 +1,26 @@ +[comment {-*- tcl -*- doctools manpage}] +[include parts/definitions.inc] +[manpage_begin [vset LABEL_TTY] [vset MAN_SECTION] [vset VERSION]] +[include parts/module.inc] +[require Tclx] +[require cmdr::tty] +[titledesc [vset TITLE_TTY]] +[description] +[include parts/welcome.inc] + +This package provides a single utility command testing if the +[const stdout] [term channel] is a tty or not, and reporting +the result. + +[section API] +[list_begin definitions] +[comment {- - -- --- ----- -------- -------------}] +[call [cmd ::cmdr::tty] [method stdout]] + +When invoked this command returns a boolean value indicating +if the [const stdout] [term channel] is a tty ([const true]), +or not ([const false]). + +[list_end] +[include parts/feedback.inc] +[manpage_end] Index: doc/parts/definitions.inc ================================================================== --- doc/parts/definitions.inc +++ doc/parts/definitions.inc @@ -7,10 +7,12 @@ [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] - (Internal) Base class for officers and privates"] +[vset TITLE_ASK "[vset PTITLE] - Terminal-based simple user interactions"] +[vset TITLE_COLOR "[vset PTITLE] - Terminal colors"] [vset TITLE_CONFIG "[vset PTITLE] - (Partially internal) Collection of parameters for privates"] [vset TITLE_DEV_COMPLETE "[vset PTITLE] - Internals of command line completion"] [vset TITLE_DEV_DSL "[vset PTITLE] - Internals of DSL handling"] [vset TITLE_DEV_HF "[vset PTITLE] - Writing custom help formats"] [vset TITLE_DEV_VT "[vset PTITLE] - Writing custom validation types"] @@ -21,12 +23,14 @@ [vset TITLE_HELP "[vset PTITLE] - (Internal) Utilities for help text formatting and setup"] [vset TITLE_HELP_JSON "[vset PTITLE] - Formatting help as JSON object"] [vset TITLE_HELP_SQL "[vset PTITLE] - Formatting help as series of SQL commands"] [vset TITLE_HELP_TCL "[vset PTITLE] - Formatting help as Tcl data structure"] [vset TITLE_OFFICER "[vset PTITLE] - (Internal) Aggregation of multiple commands for dispatch."] +[vset TITLE_PAGER "[vset PTITLE] - Paging long output"] [vset TITLE_PARAMETER "[vset PTITLE] - (Partially internal) Command parameters"] [vset TITLE_PRIVATE "[vset PTITLE] - (Internal) Single command handling, options, and arguments"] +[vset TITLE_TTY "[vset PTITLE] - Check if stdin is a tty, i.e. terminal"] [vset TITLE_UTIL "[vset PTITLE] - (Internal) General Utilities"] [vset TITLE_VALIDATE "[vset PTITLE] - Standard validation types for parameters"] [vset TITLE_VCOMMON "[vset PTITLE] - Utilities for Validation Types"] [vset TITLE_FLOW "[vset PTITLE] - Runtime Processing Flow"] @@ -38,10 +42,12 @@ [vset LABEL_INSTALL [vset PROJECT]-installation] [vset LABEL_DEV [vset PROJECT]_development] [vset LABEL_MAIN [vset PROJECT]] [vset LABEL_ACTOR [vset PROJECT]::actor] +[vset LABEL_ASK [vset PROJECT]::ask] +[vset LABEL_COLOR [vset PROJECT]::color] [vset LABEL_CONFIG [vset PROJECT]::config] [vset LABEL_DEV_COMPLETE [vset PROJECT]_dev~completion] [vset LABEL_DEV_DSL [vset PROJECT]_dev~dsl] [vset LABEL_HELPFORMATS [vset PROJECT]-user-helpformats] [vset LABEL_VTYPES [vset PROJECT]-user-vtypes] @@ -52,11 +58,13 @@ [vset LABEL_HELP [vset PROJECT]::help] [vset LABEL_HELP_JSON [vset PROJECT]::help::json] [vset LABEL_HELP_SQL [vset PROJECT]::help::sql] [vset LABEL_HELP_TCL [vset PROJECT]::help::tcl] [vset LABEL_OFFICER [vset PROJECT]::officer] +[vset LABEL_PAGER [vset PROJECT]::pager] [vset LABEL_PARAMETER [vset PROJECT]::parameter] [vset LABEL_PRIVATE [vset PROJECT]::private] +[vset LABEL_TTY [vset PROJECT]::tty] [vset LABEL_UTIL [vset PROJECT]::util] [vset LABEL_VALIDATE [vset PROJECT]::validate] [vset LABEL_VCOMMON [vset PROJECT]::validate::common] [vset LABEL_FLOW [vset PROJECT]-spec-flow] Index: embedded/man/files/cmdr.n ================================================================== --- embedded/man/files/cmdr.n +++ embedded/man/files/cmdr.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr\&.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. +.TH "cmdr" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr \- Cmdr - Main package and API .SH SYNOPSIS package require \fBcmdr \fR Index: embedded/man/files/cmdr_actor.n ================================================================== --- embedded/man/files/cmdr_actor.n +++ embedded/man/files/cmdr_actor.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_actor\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2013 Andreas Kupries '\" Copyright (c) 2013 Documentation, Andreas Kupries '\" -'\" The definitions below are for supplemental macros used in Tcl/Tk -'\" manual entries. -'\" -'\" .AP type name in/out ?indent? -'\" Start paragraph describing an argument to a library procedure. -'\" type is type of argument (int, etc.), in/out is either "in", "out", -'\" or "in/out" to describe whether procedure reads or modifies arg, -'\" and indent is equivalent to second arg of .IP (shouldn't ever be -'\" needed; use .AS below instead) -'\" -'\" .AS ?type? ?name? -'\" Give maximum sizes of arguments for setting tab stops. Type and -'\" name are examples of largest possible arguments that will be passed -'\" to .AP later. If args are omitted, default tab stops are used. -'\" -'\" .BS -'\" Start box enclosure. From here until next .BE, everything will be -'\" enclosed in one large box. -'\" -'\" .BE -'\" End of box enclosure. -'\" -'\" .CS -'\" Begin code excerpt. -'\" -'\" .CE -'\" End code excerpt. -'\" -'\" .VS ?version? ?br? -'\" Begin vertical sidebar, for use in marking newly-changed parts -'\" of man pages. The first argument is ignored and used for recording -'\" the version when the .VS was added, so that the sidebars can be -'\" found and removed when they reach a certain age. If another argument -'\" is present, then a line break is forced before starting the sidebar. -'\" -'\" .VE -'\" End of vertical sidebar. -'\" -'\" .DS -'\" Begin an indented unfilled display. -'\" -'\" .DE -'\" End of indented unfilled display. -'\" -'\" .SO -'\" Start of list of standard options for a Tk widget. The -'\" options follow on successive lines, in four columns separated -'\" by tabs. -'\" -'\" .SE -'\" End of list of standard options for a Tk widget. -'\" -'\" .OP cmdName dbName dbClass -'\" Start of description of a specific option. cmdName gives the -'\" option's name as specified in the class command, dbName gives -'\" the option's name in the option database, and dbClass gives -'\" the option's class in the option database. -'\" -'\" .UL arg1 arg2 -'\" Print arg1 underlined, then print arg2 normally. -'\" -'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $ -'\" -'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.TH "cmdr::actor" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::actor" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::actor \- Cmdr - (Internal) Base class for officers and privates .SH SYNOPSIS package require \fBcmdr::actor \fR ADDED embedded/man/files/cmdr_ask.n Index: embedded/man/files/cmdr_ask.n ================================================================== --- /dev/null +++ embedded/man/files/cmdr_ask.n @@ -0,0 +1,429 @@ +'\" +'\" Generated from file 'cmdr_ask\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2013 Andreas Kupries +'\" Copyright (c) 2013 Documentation, Andreas Kupries +'\" +.TH "cmdr::ask" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So 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 +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +cmdr::ask \- Cmdr - Terminal-based simple user interactions +.SH SYNOPSIS +package require \fBcmdr::color \fR +.sp +package require \fBlinenoise \fR +.sp +package require \fBstruct::matrix \fR +.sp +package require \fBtextutil::adjust \fR +.sp +package require \fBtry \fR +.sp +package require \fBcmdr::ask \fR +.sp +\fB::cmdr::ask\fR \fBstring\fR \fIquery\fR ?\fIdefault\fR? +.sp +\fB::cmdr::ask\fR \fBstring/extended\fR \fIquery\fR ?options\&.\&.\&.? +.sp +\fB::cmdr::ask\fR \fBstring*\fR \fIquery\fR +.sp +\fB::cmdr::ask\fR \fByn\fR \fIquery\fR ?\fIdefault\fR? +.sp +\fB::cmdr::ask\fR \fBchoose\fR \fIquery\fR \fIchoices\fR ?\fIdefault\fR? +.sp +\fB::cmdr::ask\fR \fBmenu\fR \fIheader\fR \fIprompt\fR \fIchoices\fR ?\fIdefault\fR? +.sp +.BE +.SH DESCRIPTION +.PP +Welcome to the Cmdr project, written by Andreas Kupries\&. +.PP +For availability please read \fICmdr - How To Get The Sources\fR\&. +.PP +This package provides a few utility commands implementing a few simple +terminal-based interactions with the user\&. +.SH API +.TP +\fB::cmdr::ask\fR \fBstring\fR \fIquery\fR ?\fIdefault\fR? +When invoked this command prompts the user with \fIquery\fR for a string\&. +If the \fIdefault\fR is specified and not the empty string it is also +shown as part of the prompt\&. Note that \fIdefault\fR defaults to the +empty string\&. +.sp +The interactively entered string is returned as the result of the +command\&. The \fIdefault\fR is returned as the result if the user entered +an empty string and the \fIdefault\fR is not empty\&. +.RS +.TP +string \fIquery\fR +The prompt to show to the user before interaction begins\&. +.TP +string \fIdefault\fR +The default to return if the user enters nothing\&. +.RE +.TP +\fB::cmdr::ask\fR \fBstring/extended\fR \fIquery\fR ?options\&.\&.\&.? +This command is similar to \fB::cmdr::ask string\fR, except it allows for +more customization of the interaction through options\&. +.sp +The accepted options are +.RS +.TP +\fB-history\fR boolean +If \fBtrue\fR, save user input into \fBlinenoise\fR's in-memory history\&. Default is \fBfalse\fR\&. +.TP +\fB-hidden\fR boolean +If \fBtrue\fR, input is hidden\&. Default is \fBfalse\fR, visible echo\&. +.TP +\fB-complete\fR cmdprefix +If not empty, installed as completion callback\&. +.TP +\fB-default\fR string +If not empty the string to return if the user enters the empty string\&. +.RE +.RS +.TP +string \fIquery\fR +The prompt to show to the user before interaction begins\&. +.RE +.TP +\fB::cmdr::ask\fR \fBstring*\fR \fIquery\fR +Behaves like \fB::cmdr::ask string\fR without a default, except that the user's +input is not echoed back to the terminal\&. This command is for the entry of hidden +strings, i\&.e\&. passwords, and the like\&. +.RS +.TP +string \fIquery\fR +The prompt to show to the user before interaction begins\&. +.RE +.TP +\fB::cmdr::ask\fR \fByn\fR \fIquery\fR ?\fIdefault\fR? +When invoked this command prompts the user with \fIquery\fR for a \fIboolean\fR +value/string\&. If the \fIdefault\fR is specified and not the empty string it is +also shown as part of the prompt\&. Note that \fIdefault\fR defaults to the empty +string\&. +.sp +The interactively entered boolean is returned as the result of the command\&. +The \fIdefault\fR boolean is returned as the result if the user entered an empty +string and the \fIdefault\fR is not empty\&. +.sp +Note that the command will not return until the user entered a valid +boolean value\&. Entering a non-boolean string causes the command to loop internally +and re-prompt\&. +.RS +.TP +string \fIquery\fR +The prompt to show to the user before interaction begins\&. +.TP +string \fIdefault\fR +The default boolean to return if the user enters nothing\&. +.RE +.TP +\fB::cmdr::ask\fR \fBchoose\fR \fIquery\fR \fIchoices\fR ?\fIdefault\fR? +When invoked this command prompts the user with \fIquery\fR for one of the +\fIchoices\fR, entered as string\&. Prompt and input happen on a single line\&. +.sp +The interactively entered choice is returned as the result of the command\&. +The \fIdefault\fR choice is returned as the result if the user entered an empty +string and the \fIdefault\fR is not empty\&. +.sp +Note that the command will not return until the user entered a valid +choice\&. Entering a non-choice causes the command to loop internally and re-prompt\&. +The user is supported in entry by an internal completion callback\&. +.RS +.TP +string \fIquery\fR +The prompt to show to the user before interaction begins\&. +.TP +string \fIdefault\fR +The default boolean to return if the user enters nothing\&. +.RE +.TP +\fB::cmdr::ask\fR \fBmenu\fR \fIheader\fR \fIprompt\fR \fIchoices\fR ?\fIdefault\fR? +Similar to \fB::cmdr::ask choose\fR, except that the \fIchoices\fR are shown +as an enumerated menu, one per line, with a leading \fIheader\fR\&. +Furthermore the command accepts not only the choices as input, but also their +numeric indices in the menu\&. The result however is always the relevant chosen string\&. +.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 Index: embedded/man/files/cmdr_changes.n ================================================================== --- embedded/man/files/cmdr_changes.n +++ embedded/man/files/cmdr_changes.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_changes\&.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. +.TH "cmdr-changes" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr-changes" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-changes \- Cmdr - Log of Changes .SH DESCRIPTION .PP ADDED embedded/man/files/cmdr_color.n Index: embedded/man/files/cmdr_color.n ================================================================== --- /dev/null +++ embedded/man/files/cmdr_color.n @@ -0,0 +1,556 @@ +'\" +'\" Generated from file 'cmdr_color\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2013 Andreas Kupries +'\" Copyright (c) 2013 Documentation, Andreas Kupries +'\" +.TH "cmdr::color" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So 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 +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +cmdr::color \- Cmdr - Terminal colors +.SH SYNOPSIS +package require \fBcmdr::tty \fR +.sp +package require \fBcmdr::color \fR +.sp +\fB::cmdr::color\fR \fBactivate\fR ?\fIenable\fR? +.sp +\fB::cmdr::color\fR \fBactive\fR +.sp +\fB::cmdr::color\fR \fBnames\fR +.sp +\fB::cmdr::color\fR \fBget\fR \fIname\fR +.sp +\fB::cmdr::color\fR \fBget-def\fR \fIname\fR +.sp +\fB::cmdr::color\fR \fBdefine\fR \fIname\fR \fIspec\fR +.sp +\fB::cmdr::color\fR \fBexists\fR \fIname\fR +.sp +\fB::cmdr::color\fR \fBunset\fR \fIname\fR +.sp +\fB::cmdr::color\fR \fB\&.\&.\&.\fR \fItext\fR +.sp +.BE +.SH DESCRIPTION +.PP +Welcome to the Cmdr project, written by Andreas Kupries\&. +.PP +For availability please read \fICmdr - How To Get The Sources\fR\&. +.PP +This package provides a few utility commands implementing +the management of terminal colors\&. +.SH API +.TP +\fB::cmdr::color\fR \fBactivate\fR ?\fIenable\fR? +When invoked this command enables or disables color handling, +as per the boolean flag \fIenable\fR\&. If \fIenable\fR is not +specified the action defaults to activation\&. +.sp +The result of the command is the new activation state\&. +.sp +The default activation state of the package after loading +depends on \fBstdout\fR\&. The package is active if \fBstdout\fR +is a terminal, and inactive otherwise\&. +.RS +.TP +boolean \fIenable\fR +If set, enable color handling, else disable it\&. +.RE +.TP +\fB::cmdr::color\fR \fBactive\fR +The result of this command is the current activation state +of the package\&. +.sp +The default activation state of the package after loading +depends on \fBstdout\fR\&. The package is active if \fBstdout\fR +is a terminal, and inactive otherwise\&. +.TP +\fB::cmdr::color\fR \fBnames\fR +When invoked this command returns a list of the symbolic color +names known to the package\&. +.TP +\fB::cmdr::color\fR \fBget\fR \fIname\fR +When invoked this command returns the character sequence +associated with the symbolic color \fIname\fR\&. An error +is thrown if \fIname\fR is not a known symbol\&. +.TP +\fB::cmdr::color\fR \fBget-def\fR \fIname\fR +When invoked this command returns the specification +associated with the symbolic color \fIname\fR\&. An error +is thrown if \fIname\fR is not a known symbol\&. +.TP +\fB::cmdr::color\fR \fBdefine\fR \fIname\fR \fIspec\fR +When invoked this command defines the color \fIname\fR\&. If \fIname\fR +exists already its previous specification is overwritten\&. +The command accepts four forms of \fIspec\fRifications, namely: +.RS +.TP +=\fBrname\fR +The \fIrname\fR must be the name of a known color\&. +The \fIname\fR itself is not allowed, i\&.e\&. self-references are forbidden\&. +.TP +%\fBR\fR,\fBG\fR,\fBB\fR +The \fIR\fR, \fIG\fR, and \fIB\fR values are integers in the range +\fB0\fR\&.\&.\&.\fB5\fR directly specifying the chosen color\&. These +specifications may not work if the terminal is not configured to +support 256 colors\&. +.TP +[Ee]\fBcode\fR(,\&.\&.\&.) +The value is a comma-separated list of ANSI color control characters\&. +.TP +* +Any other string is acceptable too, and used as is\&. +.RE +.TP +\fB::cmdr::color\fR \fBexists\fR \fIname\fR +When invoked this command tests if the symbolic color \fIname\fR +is known, returns the boolean value \fBtrue\fR if so, and +\fBfalse\fR else\&. +.TP +\fB::cmdr::color\fR \fBunset\fR \fIname\fR +When invoked this command deletes the symbolic color \fIname\fR\&. +An error is thrown if \fIname\fR is not a known symbol\&. +The command returns the empty string as its result\&. +.TP +\fB::cmdr::color\fR \fB\&.\&.\&.\fR \fItext\fR +When \fB::cmdr::color\fR is invoked with an unknown method name +then this name is expected to be and treated as a list of known +symbolic color names\&. These colors are applied to the \fItext\fR +and the modified text is returned as the result of the command\&. +.sp +An error is thrown if any of the specified color symbols +are not known\&. +.PP +.SH "PREDEFINED COLORS" +The following colors are defined by the package itself: +.TP +black +e30 +.TP +red +e31 +.TP +green +e32 +.TP +yellow +e33 +.TP +blue +e34 +.TP +magenta +e35 +.TP +cyan +e36 +.TP +white +e37 +.TP +default +e39 +.TP +bg-black +e40 +.TP +bg-red +e41 +.TP +bg-green +e42 +.TP +bg-yellow +e43 +.TP +bg-blue +e44 +.TP +bg-magenta +e45 +.TP +bg-cyan +e46 +.TP +bg-white +e47 +.TP +bg-default +e49 +.TP +bold +e1 +.TP +dim +e2 +.TP +italic +e3 +.TP +underline +e4 +.TP +blink +e5 +.TP +revers +e7 +.TP +hidden +e8 +.TP +strike +e9 +.TP +no-bold +e21 +.TP +no-dim +e22 +.TP +no-italic +e23 +.TP +no-underline +e24 +.TP +no-blink +e25 +.TP +no-revers +e27 +.TP +no-hidden +e28 +.TP +no-strike +e29 +.TP +reset +e0 +.TP +advisory +=yellow +.TP +bad +=red +.TP +confirm +=red +.TP +error +=magenta +.TP +good +=green +.TP +name +=blue +.TP +neutral +=blue +.TP +no +=red +.TP +note +=blue +.TP +number +=green +.TP +prompt +=blue +.TP +unknown +=cyan +.TP +warning +=yellow +.TP +yes +=green +.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 Index: embedded/man/files/cmdr_config.n ================================================================== --- embedded/man/files/cmdr_config.n +++ embedded/man/files/cmdr_config.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_config\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2013 Andreas Kupries '\" Copyright (c) 2013 Documentation, Andreas Kupries '\" -'\" The definitions below are for supplemental macros used in Tcl/Tk -'\" manual entries. -'\" -'\" .AP type name in/out ?indent? -'\" Start paragraph describing an argument to a library procedure. -'\" type is type of argument (int, etc.), in/out is either "in", "out", -'\" or "in/out" to describe whether procedure reads or modifies arg, -'\" and indent is equivalent to second arg of .IP (shouldn't ever be -'\" needed; use .AS below instead) -'\" -'\" .AS ?type? ?name? -'\" Give maximum sizes of arguments for setting tab stops. Type and -'\" name are examples of largest possible arguments that will be passed -'\" to .AP later. If args are omitted, default tab stops are used. -'\" -'\" .BS -'\" Start box enclosure. From here until next .BE, everything will be -'\" enclosed in one large box. -'\" -'\" .BE -'\" End of box enclosure. -'\" -'\" .CS -'\" Begin code excerpt. -'\" -'\" .CE -'\" End code excerpt. -'\" -'\" .VS ?version? ?br? -'\" Begin vertical sidebar, for use in marking newly-changed parts -'\" of man pages. The first argument is ignored and used for recording -'\" the version when the .VS was added, so that the sidebars can be -'\" found and removed when they reach a certain age. If another argument -'\" is present, then a line break is forced before starting the sidebar. -'\" -'\" .VE -'\" End of vertical sidebar. -'\" -'\" .DS -'\" Begin an indented unfilled display. -'\" -'\" .DE -'\" End of indented unfilled display. -'\" -'\" .SO -'\" Start of list of standard options for a Tk widget. The -'\" options follow on successive lines, in four columns separated -'\" by tabs. -'\" -'\" .SE -'\" End of list of standard options for a Tk widget. -'\" -'\" .OP cmdName dbName dbClass -'\" Start of description of a specific option. cmdName gives the -'\" option's name as specified in the class command, dbName gives -'\" the option's name in the option database, and dbClass gives -'\" the option's class in the option database. -'\" -'\" .UL arg1 arg2 -'\" Print arg1 underlined, then print arg2 normally. -'\" -'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $ -'\" -'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.TH "cmdr::config" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::config" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::config \- Cmdr - (Partially internal) Collection of parameters for privates .SH SYNOPSIS package require \fBcmdr::config \fR Index: embedded/man/files/cmdr_dev_completion.n ================================================================== --- embedded/man/files/cmdr_dev_completion.n +++ embedded/man/files/cmdr_dev_completion.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_dev_completion\&.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. +.TH "cmdr_dev~completion" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr_dev~completion" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr_dev~completion \- Cmdr - Internals of command line completion .SH SYNOPSIS package require \fBcmdr \fR Index: embedded/man/files/cmdr_dev_dsl.n ================================================================== --- embedded/man/files/cmdr_dev_dsl.n +++ embedded/man/files/cmdr_dev_dsl.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_dev_dsl\&.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. +.TH "cmdr_dev~dsl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr_dev~dsl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr_dev~dsl \- Cmdr - Internals of DSL handling .SH SYNOPSIS package require \fBcmdr \fR Index: embedded/man/files/cmdr_dsl.n ================================================================== --- embedded/man/files/cmdr_dsl.n +++ embedded/man/files/cmdr_dsl.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_dsl\&.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. +.TH "cmdr-spec-dsl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr-spec-dsl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-spec-dsl \- Cmdr - Introduction to the Specification Language .SH DESCRIPTION .PP @@ -446,13 +477,12 @@ } return } # # ## ### ##### ######## ############# ##################### -package provide \ - foo::backend::alias 0 -# 2 lines, hidden from kettle scanner. +package provide foo::backend::alias 0 +# 2 lines, hidden from kettle scanner\&. .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, Index: embedded/man/files/cmdr_dsl_officer.n ================================================================== --- embedded/man/files/cmdr_dsl_officer.n +++ embedded/man/files/cmdr_dsl_officer.n @@ -1,87 +1,94 @@ '\" '\" 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. +.TH "cmdr-spec-dsl-officer" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .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" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-spec-dsl-officer \- Cmdr - Officer Specification Language .SH SYNOPSIS \fBalias\fR \fIname\fR \fB=\fR \fIname'\fR\&.\&.\&. Index: embedded/man/files/cmdr_dsl_parameter.n ================================================================== --- embedded/man/files/cmdr_dsl_parameter.n +++ embedded/man/files/cmdr_dsl_parameter.n @@ -1,87 +1,94 @@ '\" '\" 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. +.TH "cmdr-spec-dsl-parameter" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .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" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-spec-dsl-parameter \- Cmdr - Parameter Specification Language .SH SYNOPSIS \fBlabel\fR \fItext\fR Index: embedded/man/files/cmdr_dsl_private.n ================================================================== --- embedded/man/files/cmdr_dsl_private.n +++ embedded/man/files/cmdr_dsl_private.n @@ -1,87 +1,94 @@ '\" '\" 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. +.TH "cmdr-spec-dsl-private" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .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" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-spec-dsl-private \- Cmdr - Private Specification Language .SH SYNOPSIS \fBdescription\fR \fItext\fR Index: embedded/man/files/cmdr_flow.n ================================================================== --- embedded/man/files/cmdr_flow.n +++ embedded/man/files/cmdr_flow.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_flow\&.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. +.TH "cmdr-spec-flow" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr-spec-flow" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-spec-flow \- Cmdr - Runtime Processing Flow .SH DESCRIPTION .PP @@ -458,10 +489,25 @@ .sp \fINote\fR that the block will not exist until after the first shell was active\&. This means that a missing \fB*in-shell*\fR block should be treated like \fBfalse\fR\&. .TP +\fB*config*\fR +This block is read-only, and only found in the root actor\&. +Its value is managed by the framework, specifically by privates\&. +.sp +It is a command name, i\&.e\&. object handle, to the active +instance of \fBcmdr::config\fR\&. For regular parameters that is the +same handle given to them in their various callbacks\&. For a global +parameter however the active config object is what the parameter is +currently used by, whereas the callback argument is where it was +defined in and inherited from\&. +.sp +This distinction is important when the global parameter has to +look at and work with non-global parameters of the active +private\&. These can only be found in the active context\&. +.TP \fB*prefix*\fR This block is read-only and found in the private actor for the currently executing action command prefix, accessible through the \fBcmdr::config\fR instance method \fBcontext\fR\&. Its value is managed by the framework\&. Index: embedded/man/files/cmdr_help.n ================================================================== --- embedded/man/files/cmdr_help.n +++ embedded/man/files/cmdr_help.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_help\&.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. +.TH "cmdr::help" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::help" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::help \- Cmdr - (Internal) Utilities for help text formatting and setup .SH SYNOPSIS package require \fBcmdr::help \fR Index: embedded/man/files/cmdr_help_json.n ================================================================== --- embedded/man/files/cmdr_help_json.n +++ embedded/man/files/cmdr_help_json.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_help_json\&.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. +.TH "cmdr::help::json" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::help::json" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::help::json \- Cmdr - Formatting help as JSON object .SH SYNOPSIS package require \fBcmdr::help::json \fR Index: embedded/man/files/cmdr_help_sql.n ================================================================== --- embedded/man/files/cmdr_help_sql.n +++ embedded/man/files/cmdr_help_sql.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_help_sql\&.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. +.TH "cmdr::help::sql" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::help::sql" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::help::sql \- Cmdr - Formatting help as series of SQL commands .SH SYNOPSIS package require \fBcmdr::help::sql \fR Index: embedded/man/files/cmdr_help_tcl.n ================================================================== --- embedded/man/files/cmdr_help_tcl.n +++ embedded/man/files/cmdr_help_tcl.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_help_tcl\&.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. +.TH "cmdr::help::tcl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::help::tcl" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::help::tcl \- Cmdr - Formatting help as Tcl data structure .SH SYNOPSIS package require \fBcmdr::help::tcl \fR Index: embedded/man/files/cmdr_helpformats.n ================================================================== --- embedded/man/files/cmdr_helpformats.n +++ embedded/man/files/cmdr_helpformats.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_helpformats\&.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. +.TH "cmdr-user-helpformats" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr-user-helpformats" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-user-helpformats \- Cmdr - Writing custom help formats .SH SYNOPSIS package require \fBcmdr::help \fR Index: embedded/man/files/cmdr_howto_development.n ================================================================== --- embedded/man/files/cmdr_howto_development.n +++ embedded/man/files/cmdr_howto_development.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_howto_development\&.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. +.TH "cmdr_development" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr_development" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr_development \- Cmdr - The Developer's Guide .SH DESCRIPTION .PP @@ -504,10 +535,25 @@ the help\&. .sp The details are explained in section \fIFormat Notes\fR of \fICmdr - (Internal) Utilities for help text formatting and setup\fR\&. .TP +\fB*config*\fR +Publicly documented for users as read-only this block's value is +managed by the framework, and only found in the root actor\&. +.sp +It is a command name, i\&.e\&. object handle, to the active +instance of \fBcmdr::config\fR\&. For regular parameters that is the +same handle given to them in their various callbacks\&. For a global +parameter however the active config object is what the parameter is +currently used by, whereas the callback argument is where it was +defined in and inherited from\&. +.sp +This distinction is important when the global parameter has to +look at and work with non-global parameters of the active +private\&. These can only be found in the active context\&. +.TP \fB*prefix*\fR Publicly documented for users as read-only this block's value is managed by the framework\&. Set during the \fIDispatch\fR phase it provides to access to the actual command name used to invoke a \fIprivate\fR\&. Index: embedded/man/files/cmdr_howto_get_sources.n ================================================================== --- embedded/man/files/cmdr_howto_get_sources.n +++ embedded/man/files/cmdr_howto_get_sources.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_howto_get_sources\&.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. +.TH "cmdr-howto-get-sources" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .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" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-howto-get-sources \- Cmdr - How To Get The Sources .SH DESCRIPTION .PP Index: embedded/man/files/cmdr_howto_installation.n ================================================================== --- embedded/man/files/cmdr_howto_installation.n +++ embedded/man/files/cmdr_howto_installation.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_howto_installation\&.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. +.TH "cmdr-installation" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr-installation" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-installation \- Cmdr - The Installer's Guide .SH DESCRIPTION .PP Index: embedded/man/files/cmdr_introduction.n ================================================================== --- embedded/man/files/cmdr_introduction.n +++ embedded/man/files/cmdr_introduction.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_introduction\&.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. +.TH "cmdr-introduction" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr-introduction" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-introduction \- Cmdr - Introduction to the project .SH DESCRIPTION .PP Index: embedded/man/files/cmdr_license.n ================================================================== --- embedded/man/files/cmdr_license.n +++ embedded/man/files/cmdr_license.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_license\&.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. +.TH "cmdr-license" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr-license" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-license \- Cmdr - License .SH DESCRIPTION .PP Index: embedded/man/files/cmdr_officer.n ================================================================== --- embedded/man/files/cmdr_officer.n +++ embedded/man/files/cmdr_officer.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_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. +.TH "cmdr::officer" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::officer" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::officer \- Cmdr - (Internal) Aggregation of multiple commands for dispatch\&. .SH SYNOPSIS package require \fBcmdr::officer \fR ADDED embedded/man/files/cmdr_pager.n Index: embedded/man/files/cmdr_pager.n ================================================================== --- /dev/null +++ embedded/man/files/cmdr_pager.n @@ -0,0 +1,339 @@ +'\" +'\" Generated from file 'cmdr_pager\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2013 Andreas Kupries +'\" Copyright (c) 2013 Documentation, Andreas Kupries +'\" +.TH "cmdr::pager" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So 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 +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +cmdr::pager \- Cmdr - Paging long output +.SH SYNOPSIS +package require \fBlinenoise \fR +.sp +package require \fBcmdr::tty \fR +.sp +package require \fBcmdr::pager \fR +.sp +\fB::cmdr::pager\fR \fBtext\fR +.sp +.BE +.SH DESCRIPTION +.PP +Welcome to the Cmdr project, written by Andreas Kupries\&. +.PP +For availability please read \fICmdr - How To Get The Sources\fR\&. +.PP +This package provides a single utility command to manage the automatic +paging of long output, like cmdr's automatic help\&. +.SH API +.TP +\fB::cmdr::pager\fR \fBtext\fR +When invoked this command either simply prints the \fItext\fR to stdout, +or invokes an external pager application to manage the output\&. +.sp +The pager is only invoked when +.RS +.IP [1] +Stdout is a terminal, and +.IP [2] +The text does not fit into the height of the terminal, and +.IP [3] +a pager application could be found\&. +.RE +.sp +If any of the above conditions fail the text is simply printed\&. +.sp +When the command comes to the third condition above it will look +for the pager specified in the environment variable \fBPAGER\fR first, +and then \fBless\fR and \fBmore\fR, in this order\&. +.RS +.TP +string \fItext\fR +The text to print or page\&. +.RE +.sp +The result of the command is the empty string\&. +.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 Index: embedded/man/files/cmdr_parameter.n ================================================================== --- embedded/man/files/cmdr_parameter.n +++ embedded/man/files/cmdr_parameter.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_parameter\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2013 Andreas Kupries '\" Copyright (c) 2013 Documentation, Andreas Kupries '\" -'\" The definitions below are for supplemental macros used in Tcl/Tk -'\" manual entries. -'\" -'\" .AP type name in/out ?indent? -'\" Start paragraph describing an argument to a library procedure. -'\" type is type of argument (int, etc.), in/out is either "in", "out", -'\" or "in/out" to describe whether procedure reads or modifies arg, -'\" and indent is equivalent to second arg of .IP (shouldn't ever be -'\" needed; use .AS below instead) -'\" -'\" .AS ?type? ?name? -'\" Give maximum sizes of arguments for setting tab stops. Type and -'\" name are examples of largest possible arguments that will be passed -'\" to .AP later. If args are omitted, default tab stops are used. -'\" -'\" .BS -'\" Start box enclosure. From here until next .BE, everything will be -'\" enclosed in one large box. -'\" -'\" .BE -'\" End of box enclosure. -'\" -'\" .CS -'\" Begin code excerpt. -'\" -'\" .CE -'\" End code excerpt. -'\" -'\" .VS ?version? ?br? -'\" Begin vertical sidebar, for use in marking newly-changed parts -'\" of man pages. The first argument is ignored and used for recording -'\" the version when the .VS was added, so that the sidebars can be -'\" found and removed when they reach a certain age. If another argument -'\" is present, then a line break is forced before starting the sidebar. -'\" -'\" .VE -'\" End of vertical sidebar. -'\" -'\" .DS -'\" Begin an indented unfilled display. -'\" -'\" .DE -'\" End of indented unfilled display. -'\" -'\" .SO -'\" Start of list of standard options for a Tk widget. The -'\" options follow on successive lines, in four columns separated -'\" by tabs. -'\" -'\" .SE -'\" End of list of standard options for a Tk widget. -'\" -'\" .OP cmdName dbName dbClass -'\" Start of description of a specific option. cmdName gives the -'\" option's name as specified in the class command, dbName gives -'\" the option's name in the option database, and dbClass gives -'\" the option's class in the option database. -'\" -'\" .UL arg1 arg2 -'\" Print arg1 underlined, then print arg2 normally. -'\" -'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $ -'\" -'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.TH "cmdr::parameter" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::parameter" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::parameter \- Cmdr - (Partially internal) Command parameters .SH SYNOPSIS package require \fBcmdr::parameter \fR Index: embedded/man/files/cmdr_private.n ================================================================== --- embedded/man/files/cmdr_private.n +++ embedded/man/files/cmdr_private.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_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. +.TH "cmdr::private" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::private" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::private \- Cmdr - (Internal) Single command handling, options, and arguments .SH SYNOPSIS package require \fBcmdr::private \fR ADDED embedded/man/files/cmdr_tty.n Index: embedded/man/files/cmdr_tty.n ================================================================== --- /dev/null +++ embedded/man/files/cmdr_tty.n @@ -0,0 +1,316 @@ +'\" +'\" Generated from file 'cmdr_tty\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2013 Andreas Kupries +'\" Copyright (c) 2013 Documentation, Andreas Kupries +'\" +.TH "cmdr::tty" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 5.5c 11c +.ft B +.. +.\" # SE - end of list of standard options +.de SE +.fi +.ft R +.LP +See the \\*(So 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 +.. +.\" # UL - underline word +.de UL +\\$1\l'|0\(ul'\\$2 +.. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. +.BS +.SH NAME +cmdr::tty \- Cmdr - Check if stdin is a tty, i\&.e\&. terminal +.SH SYNOPSIS +package require \fBTclx \fR +.sp +package require \fBcmdr::tty \fR +.sp +\fB::cmdr::tty\fR \fBstdout\fR +.sp +.BE +.SH DESCRIPTION +.PP +Welcome to the Cmdr project, written by Andreas Kupries\&. +.PP +For availability please read \fICmdr - How To Get The Sources\fR\&. +.PP +This package provides a single utility command testing if the +\fBstdout\fR \fIchannel\fR is a tty or not, and reporting +the result\&. +.SH API +.TP +\fB::cmdr::tty\fR \fBstdout\fR +When invoked this command returns a boolean value indicating +if the \fBstdout\fR \fIchannel\fR is a tty (\fBtrue\fR), +or not (\fBfalse\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 Index: embedded/man/files/cmdr_util.n ================================================================== --- embedded/man/files/cmdr_util.n +++ embedded/man/files/cmdr_util.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_util\&.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. +.TH "cmdr::util" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::util" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::util \- Cmdr - (Internal) General Utilities .SH SYNOPSIS package require \fBcmdr::util \fR Index: embedded/man/files/cmdr_validate.n ================================================================== --- embedded/man/files/cmdr_validate.n +++ embedded/man/files/cmdr_validate.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_validate\&.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. +.TH "cmdr::validate" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::validate" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::validate \- Cmdr - Standard validation types for parameters .SH SYNOPSIS package require \fBcmdr::validate \fR Index: embedded/man/files/cmdr_vcommon.n ================================================================== --- embedded/man/files/cmdr_vcommon.n +++ embedded/man/files/cmdr_vcommon.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_vcommon\&.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. +.TH "cmdr::validate::common" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr::validate::common" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr::validate::common \- Cmdr - Utilities for Validation Types .SH SYNOPSIS package require \fBcmdr::validate::common \fR Index: embedded/man/files/cmdr_vtypes.n ================================================================== --- embedded/man/files/cmdr_vtypes.n +++ embedded/man/files/cmdr_vtypes.n @@ -1,87 +1,94 @@ '\" '\" Generated from file 'cmdr_vtypes\&.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. +.TH "cmdr-user-vtypes" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -90,33 +97,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -132,20 +139,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -156,13 +163,13 @@ .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. +.\" # 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 @@ -185,38 +192,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -223,25 +232,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "cmdr-user-vtypes" n 1\&.1 doc "Cmdr, a framework for command line parsing and dispatch" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME cmdr-user-vtypes \- Cmdr - Writing custom validation types .SH SYNOPSIS package require \fBcmdr::validate \fR Index: embedded/man/index.n ================================================================== --- embedded/man/index.n +++ embedded/man/index.n @@ -1,84 +1,91 @@ '\" '\" Generated by tcllib/doctools/idx with format 'nroff' -'\" 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. +.TH "Keyword Index" n +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -87,33 +94,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -129,20 +136,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -153,13 +160,13 @@ .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. +.\" # 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 @@ -182,38 +189,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -220,25 +229,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "Keyword Index" n +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH INDEX doc .RS arguments @@ -283,10 +314,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -301,16 +338,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -370,10 +413,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -388,16 +437,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -457,10 +512,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -475,16 +536,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -544,10 +611,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -562,16 +635,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -631,10 +710,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -649,16 +734,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -718,10 +809,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -736,16 +833,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -805,10 +908,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -823,16 +932,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -892,10 +1007,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -910,16 +1031,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -979,10 +1106,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -997,16 +1130,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -1066,10 +1205,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -1084,16 +1229,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -1153,10 +1304,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -1171,16 +1328,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -1240,10 +1403,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -1258,16 +1427,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -1327,10 +1502,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -1345,16 +1526,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR @@ -1414,10 +1601,16 @@ \fBfiles/cmdr_vtypes\&.n\fR cmdr-user-vtypes .TP \fBfiles/cmdr_actor\&.n\fR cmdr::actor +.TP +\fBfiles/cmdr_ask\&.n\fR +cmdr::ask +.TP +\fBfiles/cmdr_color\&.n\fR +cmdr::color .TP \fBfiles/cmdr_config\&.n\fR cmdr::config .TP \fBfiles/cmdr_help\&.n\fR @@ -1432,16 +1625,22 @@ \fBfiles/cmdr_help_tcl\&.n\fR cmdr::help::tcl .TP \fBfiles/cmdr_officer\&.n\fR cmdr::officer +.TP +\fBfiles/cmdr_pager\&.n\fR +cmdr::pager .TP \fBfiles/cmdr_parameter\&.n\fR cmdr::parameter .TP \fBfiles/cmdr_private\&.n\fR cmdr::private +.TP +\fBfiles/cmdr_tty\&.n\fR +cmdr::tty .TP \fBfiles/cmdr_util\&.n\fR cmdr::util .TP \fBfiles/cmdr_validate\&.n\fR Index: embedded/man/toc.n ================================================================== --- embedded/man/toc.n +++ embedded/man/toc.n @@ -1,84 +1,91 @@ '\" '\" Generated by tcllib/doctools/toc with format 'nroff' -'\" 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. +.TH "Table Of Contents" n +.\" The -*- nroff -*- 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 ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three 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. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # 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 +.\" # 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) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ @@ -87,33 +94,33 @@ .el \{\ \&\\fI\\$1\\fP .\} .\} .. -'\" # define tabbing values for .AP +.\" # 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 +.\" # 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) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' @@ -129,20 +136,20 @@ .\} .fi .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # 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 +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf @@ -153,13 +160,13 @@ .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. +.\" # 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 @@ -182,38 +189,40 @@ .\} .if \\n(^v \{\ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # 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. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR @@ -220,25 +229,47 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "Table Of Contents" n +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH CONTENTS doc .RS .TP @@ -282,10 +313,16 @@ \fIfiles/cmdr_vtypes\&.n\fR: Cmdr - Writing custom validation types .TP \fBcmdr::actor\fR \fIfiles/cmdr_actor\&.n\fR: Cmdr - (Internal) Base class for officers and privates .TP +\fBcmdr::ask\fR +\fIfiles/cmdr_ask\&.n\fR: Cmdr - Terminal-based simple user interactions +.TP +\fBcmdr::color\fR +\fIfiles/cmdr_color\&.n\fR: Cmdr - Terminal colors +.TP \fBcmdr::config\fR \fIfiles/cmdr_config\&.n\fR: Cmdr - (Partially internal) Collection of parameters for privates .TP \fBcmdr::help\fR \fIfiles/cmdr_help\&.n\fR: Cmdr - (Internal) Utilities for help text formatting and setup @@ -300,16 +337,22 @@ \fIfiles/cmdr_help_tcl\&.n\fR: Cmdr - Formatting help as Tcl data structure .TP \fBcmdr::officer\fR \fIfiles/cmdr_officer\&.n\fR: Cmdr - (Internal) Aggregation of multiple commands for dispatch\&. .TP +\fBcmdr::pager\fR +\fIfiles/cmdr_pager\&.n\fR: Cmdr - Paging long output +.TP \fBcmdr::parameter\fR \fIfiles/cmdr_parameter\&.n\fR: Cmdr - (Partially internal) Command parameters .TP \fBcmdr::private\fR \fIfiles/cmdr_private\&.n\fR: Cmdr - (Internal) Single command handling, options, and arguments .TP +\fBcmdr::tty\fR +\fIfiles/cmdr_tty\&.n\fR: Cmdr - Check if stdin is a tty, i\&.e\&. terminal +.TP \fBcmdr::util\fR \fIfiles/cmdr_util\&.n\fR: Cmdr - (Internal) General Utilities .TP \fBcmdr::validate\fR \fIfiles/cmdr_validate\&.n\fR: Cmdr - Standard validation types for parameters ADDED embedded/www/doc/files/cmdr_ask.html Index: embedded/www/doc/files/cmdr_ask.html ================================================================== --- /dev/null +++ embedded/www/doc/files/cmdr_ask.html @@ -0,0 +1,245 @@ + + +cmdr::ask - Cmdr, a framework for command line parsing and dispatch + + + + + +
+
[ + Home +| Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+

cmdr::ask(n) 1.1 doc "Cmdr, a framework for command line parsing and dispatch"

+

Name

+

cmdr::ask - Cmdr - Terminal-based simple user interactions

+
+ +

Synopsis

+
+
    +
  • package require cmdr::color
  • +
  • package require linenoise
  • +
  • package require struct::matrix
  • +
  • package require textutil::adjust
  • +
  • package require try
  • +
  • package require cmdr::ask
  • +
+ +
+
+

Description

+

Welcome to the Cmdr project, written by Andreas Kupries.

+

For availability please read Cmdr - How To Get The Sources.

+

This package provides a few utility commands implementing a few simple +terminal-based interactions with the user.

+
+

API

+
+
::cmdr::ask string query ?default?
+

When invoked this command prompts the user with query for a string. +If the default is specified and not the empty string it is also +shown as part of the prompt. Note that default defaults to the +empty string.

+

The interactively entered string is returned as the result of the +command. The default is returned as the result if the user entered +an empty string and the default is not empty.

+
+
string query
+

The prompt to show to the user before interaction begins.

+
string default
+

The default to return if the user enters nothing.

+
+
::cmdr::ask string/extended query ?options...?
+

This command is similar to ::cmdr::ask string, except it allows for +more customization of the interaction through options.

+

The accepted options are

+
+
-history boolean
+

If true, save user input into linenoise's in-memory history. Default is false.

+
-hidden boolean
+

If true, input is hidden. Default is false, visible echo.

+
-complete cmdprefix
+

If not empty, installed as completion callback.

+
-default string
+

If not empty the string to return if the user enters the empty string.

+
+
+
string query
+

The prompt to show to the user before interaction begins.

+
+
::cmdr::ask string* query
+

Behaves like ::cmdr::ask string without a default, except that the user's +input is not echoed back to the terminal. This command is for the entry of hidden +strings, i.e. passwords, and the like.

+
+
string query
+

The prompt to show to the user before interaction begins.

+
+
::cmdr::ask yn query ?default?
+

When invoked this command prompts the user with query for a boolean +value/string. If the default is specified and not the empty string it is +also shown as part of the prompt. Note that default defaults to the empty +string.

+

The interactively entered boolean is returned as the result of the command. +The default boolean is returned as the result if the user entered an empty +string and the default is not empty.

+

Note that the command will not return until the user entered a valid +boolean value. Entering a non-boolean string causes the command to loop internally +and re-prompt.

+
+
string query
+

The prompt to show to the user before interaction begins.

+
string default
+

The default boolean to return if the user enters nothing.

+
+
::cmdr::ask choose query choices ?default?
+

When invoked this command prompts the user with query for one of the +choices, entered as string. Prompt and input happen on a single line.

+

The interactively entered choice is returned as the result of the command. +The default choice is returned as the result if the user entered an empty +string and the default is not empty.

+

Note that the command will not return until the user entered a valid +choice. Entering a non-choice causes the command to loop internally and re-prompt. +The user is supported in entry by an internal completion callback.

+
+
string query
+

The prompt to show to the user before interaction begins.

+
string default
+

The default boolean to return if the user enters nothing.

+
+
::cmdr::ask menu header prompt choices ?default?
+

Similar to ::cmdr::ask choose, except that the choices are shown +as an enumerated menu, one per line, with a leading header. +Furthermore the command accepts not only the choices as input, but also their +numeric indices in the menu. The result however is always the relevant chosen string.

+
+
+

Bugs, Ideas, Feedback

+

Both the package(s) and this documentation will undoubtedly contain +bugs and other problems. +Please report such at +Cmdr Tickets.

+

Please also report any ideas you may have for enhancements of +either package(s) and/or documentation.

+
+ + +
ADDED embedded/www/doc/files/cmdr_color.html Index: embedded/www/doc/files/cmdr_color.html ================================================================== --- /dev/null +++ embedded/www/doc/files/cmdr_color.html @@ -0,0 +1,333 @@ + + +cmdr::color - Cmdr, a framework for command line parsing and dispatch + + + + + +
+
[ + Home +| Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+

cmdr::color(n) 1.1 doc "Cmdr, a framework for command line parsing and dispatch"

+

Name

+

cmdr::color - Cmdr - Terminal colors

+
+ + +

Description

+

Welcome to the Cmdr project, written by Andreas Kupries.

+

For availability please read Cmdr - How To Get The Sources.

+

This package provides a few utility commands implementing +the management of terminal colors.

+
+

API

+
+
::cmdr::color activate ?enable?
+

When invoked this command enables or disables color handling, +as per the boolean flag enable. If enable is not +specified the action defaults to activation.

+

The result of the command is the new activation state.

+

The default activation state of the package after loading +depends on stdout. The package is active if stdout +is a terminal, and inactive otherwise.

+
+
boolean enable
+

If set, enable color handling, else disable it.

+
+
::cmdr::color active
+

The result of this command is the current activation state +of the package.

+

The default activation state of the package after loading +depends on stdout. The package is active if stdout +is a terminal, and inactive otherwise.

+
::cmdr::color names
+

When invoked this command returns a list of the symbolic color +names known to the package.

+
::cmdr::color get name
+

When invoked this command returns the character sequence +associated with the symbolic color name. An error +is thrown if name is not a known symbol.

+
::cmdr::color get-def name
+

When invoked this command returns the specification +associated with the symbolic color name. An error +is thrown if name is not a known symbol.

+
::cmdr::color define name spec
+

When invoked this command defines the color name. If name +exists already its previous specification is overwritten. +The command accepts four forms of specifications, namely:

+
+
=rname
+

The rname must be the name of a known color. +The name itself is not allowed, i.e. self-references are forbidden.

+
%R,G,B
+

The R, G, and B values are integers in the range +0...5 directly specifying the chosen color. These +specifications may not work if the terminal is not configured to +support 256 colors.

+
[Ee]code(,...)
+

The value is a comma-separated list of ANSI color control characters.

+
*
+

Any other string is acceptable too, and used as is.

+
+
::cmdr::color exists name
+

When invoked this command tests if the symbolic color name +is known, returns the boolean value true if so, and +false else.

+
::cmdr::color unset name
+

When invoked this command deletes the symbolic color name. +An error is thrown if name is not a known symbol. +The command returns the empty string as its result.

+
::cmdr::color ... text
+

When ::cmdr::color is invoked with an unknown method name +then this name is expected to be and treated as a list of known +symbolic color names. These colors are applied to the text +and the modified text is returned as the result of the command.

+

An error is thrown if any of the specified color symbols +are not known.

+
+
+

Predefined colors

+

The following colors are defined by the package itself:

+
+
black
+

e30

+
red
+

e31

+
green
+

e32

+
yellow
+

e33

+
blue
+

e34

+
magenta
+

e35

+
cyan
+

e36

+
white
+

e37

+
default
+

e39

+
bg-black
+

e40

+
bg-red
+

e41

+
bg-green
+

e42

+
bg-yellow
+

e43

+
bg-blue
+

e44

+
bg-magenta
+

e45

+
bg-cyan
+

e46

+
bg-white
+

e47

+
bg-default
+

e49

+
bold
+

e1

+
dim
+

e2

+
italic
+

e3

+
underline
+

e4

+
blink
+

e5

+
revers
+

e7

+
hidden
+

e8

+
strike
+

e9

+
no-bold
+

e21

+
no-dim
+

e22

+
no-italic
+

e23

+
no-underline
+

e24

+
no-blink
+

e25

+
no-revers
+

e27

+
no-hidden
+

e28

+
no-strike
+

e29

+
reset
+

e0

+
advisory
+

=yellow

+
bad
+

=red

+
confirm
+

=red

+
error
+

=magenta

+
good
+

=green

+
name
+

=blue

+
neutral
+

=blue

+
no
+

=red

+
note
+

=blue

+
number
+

=green

+
prompt
+

=blue

+
unknown
+

=cyan

+
warning
+

=yellow

+
yes
+

=green

+
+
+

Bugs, Ideas, Feedback

+

Both the package(s) and this documentation will undoubtedly contain +bugs and other problems. +Please report such at +Cmdr Tickets.

+

Please also report any ideas you may have for enhancements of +either package(s) and/or documentation.

+
+ + +
Index: embedded/www/doc/files/cmdr_dsl.html ================================================================== --- embedded/www/doc/files/cmdr_dsl.html +++ embedded/www/doc/files/cmdr_dsl.html @@ -293,12 +293,11 @@ say [color green "Successfully unaliased '$name'"] } return } # # ## ### ##### ######## ############# ##################### -package provide \ - foo::backend::alias 0 +package provide foo::backend::alias 0 # 2 lines, hidden from kettle scanner.

Language Reference

Index: embedded/www/doc/files/cmdr_flow.html ================================================================== --- embedded/www/doc/files/cmdr_flow.html +++ embedded/www/doc/files/cmdr_flow.html @@ -314,10 +314,22 @@ This can be used to modulate command messages and other context-dependent things.

Note that the block will not exist until after the first shell was active. This means that a missing *in-shell* block should be treated like false.

+
*config*
+

This block is read-only, and only found in the root actor. +Its value is managed by the framework, specifically by privates.

+

It is a command name, i.e. object handle, to the active +instance of cmdr::config. For regular parameters that is the +same handle given to them in their various callbacks. For a global +parameter however the active config object is what the parameter is +currently used by, whereas the callback argument is where it was +defined in and inherited from.

+

This distinction is important when the global parameter has to +look at and work with non-global parameters of the active +private. These can only be found in the active context.

*prefix*

This block is read-only and found in the private actor for the currently executing action command prefix, accessible through the cmdr::config instance method context. Its value is managed by the framework. Index: embedded/www/doc/files/cmdr_howto_development.html ================================================================== --- embedded/www/doc/files/cmdr_howto_development.html +++ embedded/www/doc/files/cmdr_howto_development.html @@ -318,10 +318,22 @@ dictionary mapping from toplevel section/category names to an integer number to override the natural order of displaying these sections in the help.

The details are explained in section Format Notes of Cmdr - (Internal) Utilities for help text formatting and setup.

+
*config*
+

Publicly documented for users as read-only this block's value is +managed by the framework, and only found in the root actor.

+

It is a command name, i.e. object handle, to the active +instance of cmdr::config. For regular parameters that is the +same handle given to them in their various callbacks. For a global +parameter however the active config object is what the parameter is +currently used by, whereas the callback argument is where it was +defined in and inherited from.

+

This distinction is important when the global parameter has to +look at and work with non-global parameters of the active +private. These can only be found in the active context.

*prefix*

Publicly documented for users as read-only this block's value is managed by the framework. Set during the Dispatch phase it provides to access to the actual command name used to invoke a private.

ADDED embedded/www/doc/files/cmdr_pager.html Index: embedded/www/doc/files/cmdr_pager.html ================================================================== --- /dev/null +++ embedded/www/doc/files/cmdr_pager.html @@ -0,0 +1,178 @@ + + +cmdr::pager - Cmdr, a framework for command line parsing and dispatch + + + + + +
+
[ + Home +| Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+

cmdr::pager(n) 1.1 doc "Cmdr, a framework for command line parsing and dispatch"

+

Name

+

cmdr::pager - Cmdr - Paging long output

+
+ +

Synopsis

+
+
    +
  • package require linenoise
  • +
  • package require cmdr::tty
  • +
  • package require cmdr::pager
  • +
+ +
+
+

Description

+

Welcome to the Cmdr project, written by Andreas Kupries.

+

For availability please read Cmdr - How To Get The Sources.

+

This package provides a single utility command to manage the automatic +paging of long output, like cmdr's automatic help.

+
+

API

+
+
::cmdr::pager text
+

When invoked this command either simply prints the text to stdout, +or invokes an external pager application to manage the output.

+

The pager is only invoked when

+
    +
  1. Stdout is a terminal, and

  2. +
  3. The text does not fit into the height of the terminal, and

  4. +
  5. a pager application could be found.

  6. +
+

If any of the above conditions fail the text is simply printed.

+

When the command comes to the third condition above it will look +for the pager specified in the environment variable PAGER first, +and then less and more, in this order.

+
+
string text
+

The text to print or page.

+
+

The result of the command is the empty string.

+
+
+

Bugs, Ideas, Feedback

+

Both the package(s) and this documentation will undoubtedly contain +bugs and other problems. +Please report such at +Cmdr Tickets.

+

Please also report any ideas you may have for enhancements of +either package(s) and/or documentation.

+
+ + +
ADDED embedded/www/doc/files/cmdr_tty.html Index: embedded/www/doc/files/cmdr_tty.html ================================================================== --- /dev/null +++ embedded/www/doc/files/cmdr_tty.html @@ -0,0 +1,164 @@ + + +cmdr::tty - Cmdr, a framework for command line parsing and dispatch + + + + + +
+
[ + Home +| Main Table Of Contents +| Table Of Contents +| Keyword Index + ]
+

cmdr::tty(n) 1.1 doc "Cmdr, a framework for command line parsing and dispatch"

+

Name

+

cmdr::tty - Cmdr - Check if stdin is a tty, i.e. terminal

+
+ +

Synopsis

+
+
    +
  • package require Tclx
  • +
  • package require cmdr::tty
  • +
+ +
+
+

Description

+

Welcome to the Cmdr project, written by Andreas Kupries.

+

For availability please read Cmdr - How To Get The Sources.

+

This package provides a single utility command testing if the +stdout channel is a tty or not, and reporting +the result.

+
+

API

+
+
::cmdr::tty stdout
+

When invoked this command returns a boolean value indicating +if the stdout channel is a tty (true), +or not (false).

+
+
+

Bugs, Ideas, Feedback

+

Both the package(s) and this documentation will undoubtedly contain +bugs and other problems. +Please report such at +Cmdr Tickets.

+

Please also report any ideas you may have for enhancements of +either package(s) and/or documentation.

+
+ + +
Index: embedded/www/doc/toc.html ================================================================== --- embedded/www/doc/toc.html +++ embedded/www/doc/toc.html @@ -67,10 +67,18 @@ cmdr::actor Cmdr - (Internal) Base class for officers and privates + +cmdr::ask +Cmdr - Terminal-based simple user interactions + + +cmdr::color +Cmdr - Terminal colors + cmdr::config Cmdr - (Partially internal) Collection of parameters for privates @@ -92,17 +100,25 @@ cmdr::officer Cmdr - (Internal) Aggregation of multiple commands for dispatch. +cmdr::pager +Cmdr - Paging long output + + cmdr::parameter Cmdr - (Partially internal) Command parameters - + cmdr::private Cmdr - (Internal) Single command handling, options, and arguments + +cmdr::tty +Cmdr - Check if stdin is a tty, i.e. terminal + cmdr::util Cmdr - (Internal) General Utilities Index: embedded/www/index.html ================================================================== --- embedded/www/index.html +++ embedded/www/index.html @@ -20,95 +20,95 @@ Keywords: A arguments - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl Keywords: C command hierarchy - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl command line completion - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl command line handling - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl command tree - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl Keywords: E editing command line - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl Keywords: H help for command line - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl hierarchy of commands - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl Keywords: I interactive command shell - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl Keywords: O optional arguments - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl options - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl Keywords: P parameters - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl processing command line - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl Keywords: T tree of commands - cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::parameter · cmdr::private · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl + cmdr · cmdr-changes · cmdr-howto-get-sources · cmdr-installation · cmdr-introduction · cmdr-license · cmdr-spec-dsl · cmdr-spec-dsl-officer · cmdr-spec-dsl-parameter · cmdr-spec-dsl-private · cmdr-spec-flow · cmdr-user-helpformats · cmdr-user-vtypes · cmdr::actor · cmdr::ask · cmdr::color · cmdr::config · cmdr::help · cmdr::help::json · cmdr::help::sql · cmdr::help::tcl · cmdr::officer · cmdr::pager · cmdr::parameter · cmdr::private · cmdr::tty · cmdr::util · cmdr::validate · cmdr::validate::common · cmdr_development · cmdr_dev~completion · cmdr_dev~dsl Index: embedded/www/toc.html ================================================================== --- embedded/www/toc.html +++ embedded/www/toc.html @@ -67,10 +67,18 @@ cmdr::actor Cmdr - (Internal) Base class for officers and privates + +cmdr::ask +Cmdr - Terminal-based simple user interactions + + +cmdr::color +Cmdr - Terminal colors + cmdr::config Cmdr - (Partially internal) Collection of parameters for privates @@ -92,17 +100,25 @@ cmdr::officer Cmdr - (Internal) Aggregation of multiple commands for dispatch. +cmdr::pager +Cmdr - Paging long output + + cmdr::parameter Cmdr - (Partially internal) Command parameters - + cmdr::private Cmdr - (Internal) Single command handling, options, and arguments + +cmdr::tty +Cmdr - Check if stdin is a tty, i.e. terminal + cmdr::util Cmdr - (Internal) General Utilities