Template:Man/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 man.archlinux.org. 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 bash.1 | |
|---|---|
| Wiki code | The {{Man|bash|1}} shell
|
| Main version | The bash(1) shell |
| Sandbox version | The bash(1) shell |
| Specify man page ifconfig.8 | |
|---|---|
| Wiki code | network configuration with the {{Man|ifconfig|8}} command
|
| Main version | network configuration with the ifconfig(8) command |
| Sandbox version | network configuration with the ifconfig(8) command |
| Specify man page metalog.conf.5 | |
|---|---|
| Wiki code | refer to the {{Man|metalog.conf|5}} man page
|
| Main version | refer to the metalog.conf(5) man page |
| Sandbox version | refer to the metalog.conf(5) man page |
| Specify man page find.1p | |
|---|---|
| Wiki code | as noted in the {{Man|find|1p}} man page
|
| Main version | as noted in the find(1p) man page |
| Sandbox version | as noted in the find(1p) man page |
| Specify man page resizeterm.3x | |
|---|---|
| Wiki code | implemented by the {{Man|resizeterm|3x}} function
|
| Main version | implemented by the resizeterm(3x) function |
| Sandbox version | implemented by the resizeterm(3x) function |
| With raw param | |
|---|---|
| Wiki code | see {{Man|gpg-agent|1|raw=https://linux.die.net/man/1/gpg-agent}}
|
| Main version | see gpg-agent(1) |
| Sandbox version | see gpg-agent(1) |