Template:RootCmd/doc

Note

This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.

As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements, fixes or voice your opinion.

Use this template to show a shell box with a root command.

Usage

For one command add this code to the page text:

{{RootCmd|a command}}

root # a command

One command with output:

{{RootCmd|a command
|output=Some output}}

root # a command

---

Some output

Note

output - as a named parameter - is optional and can additional be used in the following examples. This is also true for all following named parameters.

One command with user defined prompt and color:

{{RootCmd|a command
|prompt=example ?
|color=blue}}

example ? a command

Up to five commands:

{{RootCmd|1. command
|2. command
|3. command
|4. command
|5. command
}}

root # 1. command
root # 2. command
root # 3. command
root # 4. command
root # 5. command