CommandsPageTemplate
Contents |
Syntax
> command <parameter1> <parameter2> ... [<optional parameter>]
or
> command alternate syntax, if any
Description
What that command is supposed to do, what parameters are for.
Tips and warnings.
Example(s)
> command parameter1 parameter2
sample output (and/or explanation of what happens)
(please make sure the sample is precise, i.e. you're not typing it off the top of your head, but actually copy and paste the output. Also it is recommended to "sanitize" the output, i.e. replace file names, IP addresses and hashes with simliar looking but bogus ones)
History
(this is an optional section)
Describe what changes this command has undergone over time (if any), when it first appeared, when it was deprecated.
See also
other_command, other_command, other_option, other_option, OtherPage, OtherPage
Anything below that point is not part of the template.
Since reformating every existing page is a significant work, I'd like the current template to get some approval first.