Template:Man/doc

From Gentoo Wiki
Jump to: navigation, 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.

Renders a command man page inline in a monospaced font with a link to the specified man page provided by man7.org. This is intended to mimic the functionality of Template:C while also providing a reference to man pages where desired.

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) Man Page
Anonymous parameter 2 Yes (n/a) Section

Usage

See the template's testcases:


Specify man page bash.1
Wiki code The {{Man|bash|1}} shell

Main version The bash shell
Sandbox version The bash shell
Specify man page ifconfig.8
Wiki code network configuration with the {{Man|ifconfig|8}} command

Main version network configuration with the ifconfig command
Sandbox version network configuration with the ifconfig command
Specify man page resizeterm.3x
Wiki code implemented by the {{Man|resizeterm|3x}} function

Main version implemented by the resizeterm function
Sandbox version implemented by the resizeterm function