man clig_Usage (Conventions) - declare single line usage-string


::clig::Usage - declare single line usage-string


package require clig
namespace import ::clig::*
setSpec db

Usage one-liner


The Usage command specifies a one line description of the program's intent and function. The string one-liner is printed --- besides other sutff --- if the parser encounters an unknown option. Remember to enclose one-liner in braces. A (not so) typical example would be

Usage {program to delete your home directory}

In fact, the one-liner can be longer than one line. Best results are obtained, if one-liner is not put in braces but is surrounded by double quotes. The quoted string may than contain newlines. Clig automatically adds backslashes where necessary in the generated C-code so that the C-compiler does not go wild.