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

cmdr::validate::time(n) 1 doc "Cmdr, a framework for command line parsing and dispatch"

Name

cmdr::validate::time - Cmdr - Validation type for times (to the second)

Table Of Contents

Synopsis

  • package require try
  • package require clock::iso8601
  • package require cmdr::validate::common
  • package require cmdr::validate::time

Description

Welcome to the Cmdr project, written by Andreas Kupries.

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

This package provides the validation type ::cmdr::validate::time which accepts timestamps in both ISO 8601 syntax and as epoch values, i.e. positive integer seconds since the beginning of unix time.

The internal, canonical representation is the epoch for the validated input.

The type has no input completion.

The details of the exported standard API can be found in Cmdr - Writing custom validation types. The chosen default is "now".

A single non-standard method is provided:

::cmdr::validate::time 2external epoch

This method converts the epoch of a time to the form %Y-%m-%dT%H:%M:%S and returns the conversion result as its own.

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