[ Home | Main Table Of Contents | Table Of Contents | Keyword Index ]

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

## Name

cmdr - Cmdr - Main package and API

## Table Of Contents

## Synopsis

- package require cmdr

- ::cmdr new name specification
- ::cmdr create obj name specification
- ::cmdr interactive ?enable?
- ::cmdr interactive?

## Description

Welcome to the Cmdr project, written by Andreas Kupries.

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

This is the main package of the framework, its public entry point. It provides four commands for setup and configuration of command hierarchies.

## API

::cmdr new name specification

  This command creates an automatically-named officer instance which is the root of the command hierarchy given in the specification, and has the user-visible command name.

  The result of the command is the new instance command.

::cmdr create obj name specification

  This command creates the officer instance obj which is the root of the command hierarchy given in the specification, and has the user-visible command name.

  The result of the command is the new instance command.

  string name

    The user-visible name of the command (hierarchy).

  script actions

    The specification of the subordinate commands. On the command line these are the toplevel commands of the application using the hierarchy. Please read Cmdr - Officer Specification Language for the details.

::cmdr interactive ?enable?

  This command globally (de)activates the interactive parts of the framework, as per the value of enable.

  By default (initial state) the framework allows interaction.

  boolean enable

    If not specified defaults to true, globally enabling the interactive parts of the framework. The value false globally disables the interactive parts of the framework

::cmdr interactive?

  This method returns the state of the global interaction flag.

## 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.

## 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

## Copyright

Copyright © 2013-2016 Andreas Kupries
Copyright © 2013-2016 Documentation, Andreas Kupries