Template:Man/doc

Template:Template doc page viewed directly To be used for inserting manual page links into articles on Unix topics.

Usage

Examples

In	Out
`{{man\|3\|printf}}`	`printf` – System Interfaces Reference, The Single UNIX Specification, Version 4 from The Open Group
`{{man\|3\|printf\|\|\|inline}}`	`printf`
`{{man\|3\|printf\|FreeBSD}}`	`printf(3)` – FreeBSD Library Functions Manual
`{{man\|3\|printf\|\|formatted output conversion}}`	`printf`: formatted output conversion – System Interfaces Reference, The Single UNIX Specification, Version 4 from The Open Group

Parameters

Manual section
Manual page name
Source (the name of a subpage in the Template:Man namespace e.g. FreeBSD. Leave blank for the current default.)
Page description
Style parameter; currently inline omits the attribution.

Available sources

Please add to this table as you write new sources!

Source	Example	Result
die.net^[1]	`{{man\|1\|man\|die.net}}`	`man(1)` – Linux User Commands Manual
default^[2]	`{{man\|1\|man}}`	`man` – Shell and Utilities Reference, The Single UNIX Specification, Version 4 from The Open Group
Darwin	`{{man\|1\|man\|Darwin}}`	`man(1)` – Darwin and macOS General Commands Manual
Debian	`{{man\|1\|man\|Debian}}`	`man(1)` – Debian General Commands Manual
FreeBSD	`{{man\|1\|man\|FreeBSD}}`	`man(1)` – FreeBSD General Commands Manual
Linux	`{{man\|1\|man\|Linux}}`	`man(1)` – Linux User Manual – User Commands
LinuxManPages	`{{man\|1\|man\|LinuxManPages}}`	`[[[:Template:Man/LinuxManPages]] man(Template:Man/LinuxManPages)]` – Template:Man/LinuxManPages
MirOS BSD	`{{man\|1\|man\|MirOS BSD}}`	`man(1)` – MirOS BSD i386 General Commands Manual
NetBSD	`{{man\|1\|man\|NetBSD}}`	`man(1)` – NetBSD General Commands Manual
OpenBSD	`{{man\|1\|man\|OpenBSD}}`	`man(1)` – OpenBSD General Commands Manual
Plan 9	`{{man\|1\|man\|Plan 9}}`	`man(1)` – Plan 9 Programmer's Manual, Volume 1
SUS	`{{man\|cu\|man\|SUS}}`	`man` – Shell and Utilities Reference, The Single UNIX Specification, Version 4 from The Open Group
Solaris	`{{man\|1\|man\|Solaris}}`	`man(1)` – Solaris 11.4 User Commands Reference Manual

^ Current default
^ Redirects to the current default

Other sources

Occasionally you will come across manual pages for which writing a source is overkill. In this case you can use Template:man/format directly with a URL for formatting:

In	Out
`{{man/format\|1\|dbx\|http://.../dbx.1.html\|source-level debugging tool\|[[Sun Studio]] Developer's Manual}}`	`dbx(1)`: source-level debugging tool – Sun Studio Developer's Manual

The interface of Template:man/format is therefore externally visible and needs to be kept constant.

Hacking

Writing sources

A source takes three parameters:

Manual section
Manual page name
Output selector:
- attrib for attribution
- url for URL to page
- display_section for section to display in parentheses.

See Template:Man/die.net for an example; see Template:Man/FreeBSD for a demonstration of varying the attribution by manual section.

Internals

Template:man handles choosing the default source and calling it for URL and attribution; the default source is Template:man/default, which is a template redirect currently to Template:man/die.net. Template:man/format actually formats the link and descriptions into a nice-looking link+auxilia in Unix style.

[1] Current default

[2] Redirects to the current default

[1]

[2]