Difference between revisions of "Template:RootCmd"
From Gentoo Wiki
Maffblaster (talk | contribs) (Add collapsed output functionality.) |
Maffblaster (talk | contribs) (Sync with sandbox. Make default RootCmd prettier.) |
||
| Line 2: | Line 2: | ||
|{{#if: {{{11|}}} | |{{#if: {{{11|}}} | ||
|{{Error|RootCmd|11}} | |{{Error|RootCmd|11}} | ||
| − | |{{GenericCmd|{{{1}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}|{{{5|}}}|{{{6|}}}|{{{7|}}}|{{{8|}}}|{{{9|}}}|{{{10|}}}|{{{11|}}}|prompt={{{prompt|root #}}}|color={{{color|#ef2929}}}|collapse-output={{{collapse-output|}}}|output={{{output|}}}}} | + | |{{GenericCmd|{{{1}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}|{{{5|}}}|{{{6|}}}|{{{7|}}}|{{{8|}}}|{{{9|}}}|{{{10|}}}|{{{11|}}}|prompt={{{prompt|root <span style{{=}}"color:royalblue;">#</span>}}}|color={{{color|#ef2929}}}|collapse-output={{{collapse-output|}}}|output={{{output|}}}}} |
}} | }} | ||
|{{Error|RootCmd|1}} | |{{Error|RootCmd|1}} | ||
Revision as of 08:50, 18 January 2022
[edit]
Documentation
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.
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 "|" for equal or pipe symbols, respectively.
- prompt (optional)
- Change the command prompt (default:
root #). - color (optional)
- Change the prompt color (default:
#ef2929red for text and#4169e1royalblue for the # symbol). - 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
trueto enable collapsed output).
Usage
See the template's testcases:
| Parameter: unnamed | |
|---|---|
| Wiki code | {{RootCmd|a command}}
|
| Main version | root #a command |
| Sandbox version | root #a command |
| Parameter: unnamed with the special characters "=" and "|" | |
|---|---|
| Wiki code | {{RootCmd|a command with {{=}} and {{!}}}}
|
| Main version | |
| Sandbox version | root #a command with = and | |
| Parameter: output | |
|---|---|
| Wiki code | {{RootCmd|a command|output=<pre>
Some output
</pre>}}
|
| Main version | root #a commandSome output |
| Sandbox version | root #a commandSome output |
| Parameters: 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
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 | root #ls -l /sys
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 |
| Parameter: prompt, color | |
|---|---|
| Wiki code | {{RootCmd
|a command
|prompt=example ?
|color=lightblue
}}
|
| 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 | 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
|
See also
- {{GenericCmd}} - The parent template of the {{RootCmd}}.
- {{Cmd}} - A child template of {{GenericCmd}}.
- {{Emerge}} - A child template of {{GenericCmd}}.
Note
The above documentation is transcluded from Template:RootCmd/doc. (edit | history)
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. (See the subpages of this template.)
The above documentation is transcluded from Template:RootCmd/doc. (edit | history)
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. (See the subpages of this template.)