Syntax documentation software
The documentation of the software uses a syntax. This makes it possible to understand, without doubt, in a short line precise what the software can do. The Linux standard is used which is closed to the standard which is used how program languages are documented.
This page gives a brief information about the syntax.
This sysntax has nothing to do with the wiki syntax. This makes thinks a bit confusing. But there are to less specific characters on the keyboard so sometimes thinks are used for different purposes. The wiki standard is not defined by Wikiation nor is the software documentation standard. So allthough confusing do not blame Wikiation for this.
Optional parameters
Syntax :
[ ... ]
If parameters in a statement are possible but not required is is written in single square brackets. Mostly these parameters differs from the internal default parameter. Mostly it is used for less frequent behaviour of the statement.
Or parameter
Syntax :
|
You can use "or" the left option "or" the right option. It is your choise. But you can not use them both.
