Print Usage Syntax

[columb]

A question came up at work this morning about the syntax to use in the 'print usage' section of a program. This led on to a discussion on the usage syntax on man pages. Whilst we have all read enough man pages to know how it's done I wondered if anyone knew of a documented set of rules anywhere. I believe that the Open Source movement have such a document but I can't find it using Google - it gets lost in the noise!

Ceci n'est pas une signature
Columb Healy

 

[gbaughma]

I find it rather ironic, that you can't find the standardized documentation on proper documentation standards.

<hehehe>



Just my 2¢
-ARRGH! All my clothes are wrinkled! Oh, the irony!

--Greg

http://parallel.tzo.com

 

[columb]

Here are two options to mull over

Usage:- program parameter_with_spaces

or

Usage:- program <parameter with spaces>

Ceci n'est pas une signature
Columb Healy

 

[LNBruno]

The nice thing about standards is that there are so many of them to choose from.

< M!ke >

 

[xwb]

The one I normally see is one word parameters with an explanation of what each parameter means below.