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 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.

collapse-output (optional)

Collapses the output so that it is only displayed when the "Expand" link is clicked (must be set to true to enable collapsed output).

Usage

See the template's testcases:

CollapseParameter: unnamed
Wiki code	{{RootCmd|a command}}
Main version	root #a command
Sandbox version	#a command

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

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

CollapseParameters: output, collapse-output
Wiki code	{{RootCmd |ls -l /sys |collapse-output=true |output=<pre> total 0 drwxr-xr-x 2 root root 0 Jun 28 14:42 block drwxr-xr-x 30 root root 0 May 31 13:51 bus drwxr-xr-x 68 root root 0 May 31 13:51 class drwxr-xr-x 4 root root 0 May 31 13:51 dev drwxr-xr-x 23 root root 0 May 31 13:51 devices drwxr-xr-x 6 root root 0 May 31 13:51 firmware drwxr-xr-x 14 root root 0 May 31 13:51 fs drwxr-xr-x 11 root root 0 May 31 13:51 kernel drwxr-xr-x 281 root root 0 May 31 13:51 module drwxr-xr-x 2 root root 0 Jun 28 14:42 power </pre> }}
Main version	root #ls -l /sys Expand total 0 drwxr-xr-x 2 root root 0 Jun 28 14:42 block drwxr-xr-x 30 root root 0 May 31 13:51 bus drwxr-xr-x 68 root root 0 May 31 13:51 class drwxr-xr-x 4 root root 0 May 31 13:51 dev drwxr-xr-x 23 root root 0 May 31 13:51 devices drwxr-xr-x 6 root root 0 May 31 13:51 firmware drwxr-xr-x 14 root root 0 May 31 13:51 fs drwxr-xr-x 11 root root 0 May 31 13:51 kernel drwxr-xr-x 281 root root 0 May 31 13:51 module drwxr-xr-x 2 root root 0 Jun 28 14:42 power
Sandbox version	#ls -l /sys Expand total 0 drwxr-xr-x 2 root root 0 Jun 28 14:42 block drwxr-xr-x 30 root root 0 May 31 13:51 bus drwxr-xr-x 68 root root 0 May 31 13:51 class drwxr-xr-x 4 root root 0 May 31 13:51 dev drwxr-xr-x 23 root root 0 May 31 13:51 devices drwxr-xr-x 6 root root 0 May 31 13:51 firmware drwxr-xr-x 14 root root 0 May 31 13:51 fs drwxr-xr-x 11 root root 0 May 31 13:51 kernel drwxr-xr-x 281 root root 0 May 31 13:51 module drwxr-xr-x 2 root root 0 Jun 28 14:42 power

CollapseParameter: prompt, color
Wiki code	{{RootCmd |a command |prompt=example ? |color=lightblue }}
Main version	example ?a command
Sandbox version	example ?a command

CollapseParameter: 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

• {{GenericCmd}}
• {{Cmd}}
• {{Emerge}}