Examples
On Unix-like platforms, usage messages tend to follow the same commonly-used pattern users are familiar with. They often begin with "Usage:" (hence possibly the name), the command, followed by a list of arguments. To indicate optional arguments, Square brackets are commonly used, and can also be used to group parameters that must be specified together. Exclusive parameters can be indicated by separating them with vertical bars within groups.
Here is a thorough example based on the NetBSD source code style guide:
Usage: program req1 req2 ]This would indicate that "program" should be called with:
- options without operands: a, D, d, e (any of which may be omitted). Note that in this case some parameters are case-sensitive
- exclusive options: f, g (denoted by the vertical bar)
- options with operands: n
- exclusive options with operands: b, c
- required arguments: req1, req2
- optional argument opt1, which may be used with or without opt2 (marked optional within the group by using another set of square brackets)
- optional argument opt2, which requires opt1
Read more about this topic: Usage Message
Famous quotes containing the word examples:
“No rules exist, and examples are simply life-savers answering the appeals of rules making vain attempts to exist.”
—André Breton (1896–1966)
“It is hardly to be believed how spiritual reflections when mixed with a little physics can hold people’s attention and give them a livelier idea of God than do the often ill-applied examples of his wrath.”
—G.C. (Georg Christoph)
“There are many examples of women that have excelled in learning, and even in war, but this is no reason we should bring ‘em all up to Latin and Greek or else military discipline, instead of needle-work and housewifry.”
—Bernard Mandeville (1670–1733)