Template:EMan/doc
From Gentoo 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.
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.
Renders a command man page inline in a monospaced font with a link to the specified man page provided by dev.gentoo.org/~zmedico/. This is intended to mimic the functionality of the C (command) template while also providing a reference to man pages where desired.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Content | 1 | Man page name | String | required |
| Content | 2 | Man page section number | Number | required |
| raw | 3 | Link to man page on external website. Second positional param (section number) unused when 'raw' is specified but is still required (indicate correct section number, as this template may be migrated in the future to use it) | URL | optional |
Usage
See the template's testcases:
| Specify man page emerge(1) | |
|---|---|
| Wiki code | The {{EMan|emerge|1}} program
|
| Main version | The emerge(1) program |
| Sandbox version | The emerge(1) program |
| Specify man page make.conf(5) | |
|---|---|
| Wiki code | refer to the {{EMan|make.conf|5}} man page
|
| Main version | refer to the make.conf(5) man page |
| Sandbox version | refer to the make.conf(5) man page |
| No man page section | |
|---|---|
| Wiki code | Use {{EMan|ebuild}}
|
| Main version | Use {{Man template error}} Parameter section not defined. For correct usage see Man template's documentation on the section parameter. |
| Sandbox version | The {{Man template error}} Parameter section not defined. For correct usage see Man template's documentation on the section parameter. |
</noinclude>