clig_Description

Langue: en

Version: 1.9.11.1 (ubuntu - 08/07/09)

Section: 7 (Divers)

NAME

::clig::Description - set long description text to be included in a manual page

SYNOPSIS

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

DESCRIPTION

The Description command should not be used. Instead, the respective section in the generated manual page should be filled out. The main reason for this advice is, that clig copies description AS IS into the manual page, so it can be typed into the manual page file in the first place. Please remember that the generated manual page needs some hand-tuning anyway, because for example the `SEE ALSO'-section cannot be generated. Since this command should not be used, no example is given.

SEE ALSO

clig(1), clig_Commandline(7), clig_Double(7), clig_Flag(7), clig_Float(7), clig_Int(7), clig_Long(7), clig_Name(7), clig_Rest(7), clig_String(7), clig_Usage(7), clig_Version(7), clig_parseCmdline(7)