CommandLineParserWriteUsage Method (TextWriter, Int32) |
Namespace: Ookii.CommandLine
Exception | Condition |
---|---|
ArgumentNullException | writer is . |
The usage help consists of first the Description, followed by the usage syntax, followed by a description of all the arguments.
This method uses the default usage options, as specified by the default values of the WriteUsageOptions class.
You can add descriptions to the usage text by applying the DescriptionAttribute attribute to your command line arguments type, and the constructor parameters and properties defining command line arguments.
Line wrapping at word boundaries is applied to the output, wrapping at the specified line length. If the specified writer is an instance of the LineWrappingTextWriter class, its MaximumLineLength property is used and the maximumLineLength parameter is ignored.
This method indents additional lines for the usage syntax and argument descriptions, unless the maximum line length is less than 30.