模板:man

来自 Arch Linux 中文维基

链接到在线手册页,默认为 Arch 软件包的手册页

用法[编辑源代码]

{{man|主题编号|页名称|节}}
  • 主题编号 手册页所属章节(section)主题分类标识。
  • 页名称 手册页的具体名称。
  • 可选参数:手册页中的章节或网页内的锚点,也支持下面重写参数。
    • fragment 可选参数: URL 片段标识重写。
    • pkg 可选参数: 包名重写。
    • url 可选参数: URL 重写。
注意: 不要将 url= 参数指向 https://manpages.ubuntu.com/ 。该网站因返回 HTTP 代码 404 而臭名昭著,它使用 JavaScript 重定向到不同的页面。

示例[编辑源代码]

{{man|1|intro|NOTES}}

{{man|8|mount|FILESYSTEM-INDEPENDENT MOUNT OPTIONS}}

{{man|1|resolvectl|COMPATIBILITY WITH RESOLVCONF(8)}}

{{man|8|pacman|TRANSACTION OPTIONS (APPLY TO -S, -R AND -U)}}

{{man|5|systemd.network|[ROUTE] SECTION OPTIONS}}

{{man|5|aliases}} (默认包) vs. {{man|5|aliases|pkg=opensmtpd}} (opensmtpd)

{{man|1|mandoc|url=https://mandoc.bsd.lv/man/mandoc.1.html}}

{{man|8|wpa_supplicant|url=}}


上面的模板将显示如下:

intro(1) § NOTES

mount(8) § FILESYSTEM-INDEPENDENT MOUNT OPTIONS

resolvectl(1) § COMPATIBILITY WITH RESOLVCONF(8)

pacman(8) § TRANSACTION OPTIONS (APPLY TO -S, -R AND -U)

systemd.network(5) § [ROUTE] SECTION OPTIONS

aliases(5) (默认包) vs. aliases(5) (opensmtpd)

mandoc(1)

wpa_supplicant(8)

模板数据[编辑源代码]

下面是数据格式的进一步说明和解释。

模板参数[编辑模板数据]

参数描述类型状态
主题编号1

对应man手册体系中的不同主题,例如:「1」表示 用户命令,「8」表示 系统工具和守护进程。

数字必需
页名称2

对应的手册页(Manual Page)的名称,它是手册页中的唯一标识。例如:要指向「ls」命令的手册页,这里的「页名称」就是ls。

示例值
ls
字符串必需
3

对应手册页文档中的锚点(Fagment),即URL中「#」符号后面部分。主要用于精确定位内容,也可对部分参数进行重写。

示例值
url=https://man.archlinux.org/man/man-pages.7#Sections_within_a_manual_page
字符串可选