Jump to content

Template:Manpage

From Wikitech

{{{name}}}({{{section}}})

Description

Link to an online manual page of the Debian manual pages repository.

A potential further improvement would be to specify a direct URL of the manpage located on a site other than Debian's as it's likely a manpage we need exists elsewhere.

Usage

{{manpage|name=example|section=1}}
{{manpage|name=example|section=5|lang=fr|chapter=Example}}
{{manpage|name=example|section=8|suite=Example}}

Examples

{{manpage|name=ls|section=1}}

ls(1)

{{manpage|name=ls|section=1|lang=fr}}

ls(1)

{{manpage|binarypackage=coreutils|name=ls|section=1}}

ls(1)

{{manpage|name=apt|section=8|chapter=DIAGNOSTICS}}

apt(8)#DIAGNOSTICS

Template Data

Quickly and easily link to a manpage from Debian's online mirror service

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
binarypackagebinarypackage

Debian package name associated with the manpage. Helpful for exact matching when multiple names exist.

Example
coreutils
Stringoptional
namename

Title of the manual page

Example
chmod
Stringrequired
sectionsection

Section of the manpage

Suggested values
1 2 3 4 5 6 7 8
Example
5
Numberrequired
suitesuite

Debian version of the manpage to use (stable, testing, unstable; Defaults to stable.)

Suggested values
stable testing unstable
Default
stable
Example
testing
Stringoptional
langlang

Manpage language to link

Suggested values
de en es fr ja zh_CN
Example
fr
Stringoptional
chapterchapter

Chapter to anchor at when visiting the webpage

Suggested values
DESCRIPTION BUGS
Example
DESCRIPTION
Stringoptional