generateManPage

Constructs a roff man page based on the funopt usage.

string

generateManPage

(

)

(

string programName = null

string longDescription = null

string footer = null

int section = 1

)

Parameters

programName string: Program name, as it should appear in the header, synopsis etc. If not specified, the identifier name of FUN is used.
longDescription string: Long description for the DESCRIPTION section. If not specified, we either use the function string UDA, or omit the section entirely.
shortDescription string: Short description for the NAME section. If not specified, generated from the function string UDA.
footer string: Additional sections (BUGS, AUTHORS) to add at the end.
section int: Manual section