DragonFly On-Line Manual Pages

CLIG(1)                       Programmer's Manual                      CLIG(1)

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

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

       Usage one-liner

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

SEE ALSO
       clig_Version(n), clig_Float(n), clig(1), clig_Int(n),
       clig_Commandline(n), clig_Long(n), clig_Flag(n), clig_String(n),
       clig_Double(n), clig_Name(n), clig_Rest(n), clig_Description(n),
       clig_parseCmdline(n)

Kir                                1.9.11.1                            CLIG(1)