User Procs with Command Line Argument - 2023.1 English

Like any Tcl proc, the arguments definition of the user procs can be either position-based or accept a variable list of arguments through the args variable.

proc ::tclapp::mycompany::template::my_command2 { arg1 {optional1 ,} } {
…
}

or,

proc ::tclapp::mycompany::template::my_command2 { args } {
…
}

In both cases, it is up to the developer to define the meta-comment Argument Usage to reflect the list of command line arguments accepted by the proc. The system does not check the consistency between the list of arguments from the meta-comment Argument Usage with the actual arguments definition.

Because the meta-comment Argument Usage is used to build the Help message, whatever above form is used for the proc to pass argument, the meta-comment must be updated accordingly. For example:

proc ::tclapp::mycompany::template::my_command2 { arg1 {optional1 ,} } {
    # Summary : A one line summary of what this proc does
    # Argument Usage:
    # arg1 : A one line summary of this argument
    # [optional1=,] : A one line summary of this argument
    # Return Value: 
    # TCL_OK is returned with result set to a string
    # Categories: xilinxtclstore, template
…
}

or,

proc ::tclapp::mycompany::template::my_command2 { args } {
    # Summary : A one line summary of what this proc does
    # Argument Usage:
    # arg1 : A one line summary of this argument
    # [optional1=,] : A one line summary of this argument
    # Return Value: 
    # TCL_OK is returned with result set to a string
    # Categories: xilinxtclstore, template
…
}