template
filename
Purpose:
-
This section should contain a brief description of the command and why is it used.
Enter:
-
command <argument1> <argument2> [optional_argument1] [optional_argument2]
Where:
-
argument1
Description for argument1
argument2
Description for argument2
optional_argument1
Description for optional argument1
optional_argument2
Description for optional argument2
Example:
-
command argument1 argument2 optional_argument1
Descritption of output or expected result of the command when used with optional argument1command argument1 argument2 optional_argument2
Descritption of output or expected result of the command when used with optional argument2
Notes:
-
This section can be used to enumerate any special procedures that have to be followed when executing the command or anything in specific that the user may have to be aware when executing a command.
This section is enclosed within verbatim tags.
See Also:
-
This section should provide external references or links ,if any, to related commands or default specification file that would help the user better understand.