Template:Linux Command/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.

Parameters

Parameter name Required? Default value Description
wiki No (n/a) Wikipage Link, appended to: https://www.wikipedia.org/wiki/
man No (n/a) Man Page Link, appended to: http://man7.org/linux/man-pages/
Anonymous parameter 1 No (n/a) Internal Link to usage/documentation
Anonymous parameter 2 No (n/a) Internal Link to usage/documentation

Usage

See the template's testcases:

Single command in table
Wiki code {{Linux Command Table|1= {{Linux Command|ls|wiki=Ls|man=man1/ls.1.html|list directory contents}} }}

Main version
Command Documentation Description
ls list directory contents
Sandbox version Template:Linux Command Table/sandbox
Three commands in table, one with no man link, one with no wiki link, one with no description
Wiki code {{Linux Command Table|1= {{Linux Command|ls|wiki=Ls|man=man1/ls.1.html|list directory contents}} {{Linux Command|id|wiki=Id_(Unix)}} {{Linux Command|df|wiki=Df_(Unix)|man=man1/report file system disk space usage}} }}

Main version
Command Documentation Description
ls list directory contents
id (description missing)
df report file system disk space usage
Sandbox version Template:Linux Command Table/sandbox

See also