You are browsing a read-only backup copy of Wikitech. The primary site can be found at wikitech.wikimedia.org

Template:Manpage

From Wikitech-static
Jump to navigation Jump to search

{{{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

<templatedata> { "params": { "binarypackage": { "description": "Debian package name associated with the manpage. Helpful for exact matching when multiple names exist.", "example": "coreutils", "type": "string", "required": false }, "name": { "description": "Title of the manual page", "example": "chmod", "type": "string", "required": true }, "section": { "description": "Section of the manpage", "example": "5", "type": "number", "required": true, "suggestedvalues": [ "1", "2", "3", "4", "5", "6", "7", "8" ] }, "lang": { "description": "Manpage language to link", "example": "fr", "type": "string", "required": false, "suggestedvalues": [ "de", "en", "es", "fr", "ja", "zh_CN" ] }, "chapter": { "label": "chapter", "description": "Chapter to anchor at when visiting the webpage", "example": "DESCRIPTION", "type": "string", "suggestedvalues": [ "DESCRIPTION", "BUGS" ] }, "suite": { "description": "Debian version of the manpage to use (stable, testing, unstable; Defaults to stable.)", "example": "testing", "type": "string", "suggestedvalues": [ "stable", "testing", "unstable" ], "default": "stable", "required": false } }, "format": "inline", "paramOrder": [ "binarypackage", "name", "section", "suite", "lang", "chapter" ], "description": "Quickly and easily link to a manpage from Debian's online mirror service" } </templatedata>