: Re: Documenting the no-args call of a command line program I am writing the built-in help for a command line program. The exact name is irrelevant, so let's use foo as a placeholder. This utility

@Dunderdale623

Vote Up Vote Down

Usually, your first line takes care of that:

Do FOO in the most awesome way possible

Square braces for [OPTIONS] imply all options are optional.

If arguments modify the behavior, give the default behavior in absence of an argument.

-f filename Perform FOO on file given, instead of standard input.

If parameters were not optional, you put them in <>.

foo [OPTIONS] <URL>

Process FOO of the URL in the most awesome way possible.

In this case, if this use is standard, but you may allow exceptional use without the URL, you detail this in the last line, apart from the options:

Called without arguments, foo displays this help, same as -h.

(0)

Login to post a comment!