Template:RootCmd/doc

From HPC Wiki
Jump to:navigation Jump to:search
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 or fixes, or to voice your opinion.

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

Parameters

Unnamed parameters (up to 10)
Add commands. Use {{=}} or {{!}} instead of the characters "=" or "|".
prompt (optional)
Change the command prompt (default: root #).
color (optional)
Change the prompt color (default: some red).
output (optional)
Add the command's output.

Usage

See the template's testcases:


Parameter: unnamed
Wiki code {{RootCmd|a command}}

Main version
root #a command
Sandbox version
#a command
Parameter: unnamed with the special characters "=" and "|"
Wiki code {{RootCmd|a command with {{=}} and {{!}}}}

Main version
root #a command with = and |
Sandbox version
#a command with = and |
Parameter: output
Wiki code {{RootCmd|a command|output=<pre> Some output </pre>}}

Main version
root #a command
Some output
Sandbox version
#a command
Some output
Parameter: prompt, color
Wiki code {{RootCmd |a command |prompt=example ? |color=blue }}

Main version
example ?a command
Sandbox version
example ?a command
Parameter: unnamed (10x)
Wiki code {{RootCmd |1. command |... |10. command }}

Main version
root #1. command
root #2. command
root #3. command
root #4. command
root #5. command
root #6. command
root #7. command
root #8. command
root #9. command
root #10. command
Sandbox version
#1. command
#2. command
#3. command
#4. command
#5. command
#6. command
#7. command
#8. command
#9. command
#10. command


See also