cmdr: Artifact Content

Artifact 2379bfb913d8d7bb26e0cb9e3e933fcf07ec71de:

File doc/cmdr_util.man — part of check-in [c8ea7fb2f9] at 2015-04-17 22:18:38 on branch trunk — Docs - Separate package version information from the project version number. Regenerated docs. (user: andreask size: 1284)

[comment {-*- tcl -*- doctools manpage}]
[include parts/definitions.inc]
[vset VERSION 1.1]
[manpage_begin [vset LABEL_UTIL] [vset MAN_SECTION] [vset VERSION]]
[include parts/module.inc]
[require cmdr::util]
[titledesc [vset TITLE_UTIL]]
[description]
[include parts/welcome.inc]

This internal package provides a few utility commands.

[section API]
[list_begin definitions]
[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr::util] [method padr] [arg list]]

When invoked this command pads all elements of the specified
[arg list] at their end with space (ASCII 32 decimal) characters to
make them all the same length, the length of the longest element in
the list.

[para] The modified list is returned as the result of the command.

[list_begin arguments]
[arg_def list list]
A list of strings to normalize in length by appending space characters
as needed.
[list_end]

[comment {- - -- --- ----- -------- -------------}]
[call [cmd ::cmdr::util] [method dictsort] [arg dict]]

When invoked this command sorts the provided dictionary by its keys.

[para] The modified dictionary is returned as the result of the command.

[list_begin arguments]
[arg_def dictionary dict] The dictionary to sort.
[list_end]

[list_end]
[include parts/feedback.inc]
[manpage_end]