View source for Template:Man/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
To be used for inserting [[manual page]] links into articles on [[Unix]] topics.

==Usage==
===Examples===
:{|class="wikitable"
|-
!In !! Out
|-
|<code><nowiki>{{man|3|printf}}</nowiki></code> || {{man|3|printf}}
|-
|<code><nowiki>{{man|3|printf|||inline}}</nowiki></code> || {{man|3|printf|||inline}}
|-
|<code><nowiki>{{man|3|printf|FreeBSD}}</nowiki></code> || {{man|3|printf|FreeBSD}}
|-
|<code><nowiki>{{man|3|printf||formatted output conversion}}</nowiki></code> || {{man|3|printf||formatted output conversion}}
|-
|}

===Parameters===
# Manual section
# Manual page name
# Source (the name of a [[Wikipedia:Subpages|subpage]] in the [[Template:Man]] [[namespace]] e.g. [[Template:Man/FreeBSD|FreeBSD]]. Leave blank for the current [[Template:Man/default|default]].)
# Page description
# Style parameter; currently <code>inline</code> omits the attribution.

===Available sources===
Please add to this table as you write new sources!
:{|class="wikitable"
!Source!!Example!!Result
|-
|''[[/default|default]]''<ref>Redirects to the current default</ref>||{{tlx|man|1|ls}}||{{man|1|ls}}
|-
|[[/die.net|die.net]]||{{tlx|man|1|ls|die.net}}||{{man|1|ls|die.net}}
|-
|[[/v6|Version 6 Unix]]||{{tlx|man|1|ls|v6}}||{{man|1|ls|v6}}
|-
|[[/v7|Version 7 Unix]]||{{tlx|man|1|ls|v7}}||{{man|1|ls|v7}}
|-
|[[/4.2BSD|4.2BSD]]||{{tlx|man|1|ls|4.2BSD}}||{{man|1|ls|4.2BSD}}
|-
|[[/4.3BSD|4.3BSD]]||{{tlx|man|1|ls|4.3BSD}}||{{man|1|ls|4.3BSD}}
|-
|[[/4.3BSD-Reno|4.3BSD-Reno]]||{{tlx|man|1|ls|4.3BSD-Reno}}||{{man|1|ls|4.3BSD-Reno}}
|-
|[[/4.4BSD-Lite2|4.4BSD-Lite2]]||{{tlx|man|1|ls|4.4BSD-Lite2}}||{{man|1|ls|4.4BSD-Lite2}}
|-
|[[/9front|9front]]||{{tlx|man|1|ls|9front}}||{{man|1|ls|9front}}
|-
|[[/Darwin|Darwin]]||{{tlx|man|1|ls|Darwin}}||{{man|1|ls|Darwin}}
|-
|[[/Debian|Debian]]||{{tlx|man|1|ls|Debian}}||{{man|1|ls|Debian}}
|-
|[[/man.cx|man.cx]]||{{tlx|man|8|iptables|man.cx||inline}}||{{man|8|iptables|man.cx||inline}}
|-
|[[/DragonFly BSD|DragonFly BSD]]||{{tlx|man|1|ls|DragonFly BSD}}||{{man|1|ls|DragonFly BSD}}
|-
|[[/FreeBSD|FreeBSD]]||{{tlx|man|1|ls|FreeBSD}}||{{man|1|ls|FreeBSD}}
|-
|[[/HP-UX|HP-UX]]||{{tlx|man|1|ls|HP-UX}}||{{man|1|ls|HP-UX}}
|-
|[[/Inferno|Inferno]]||{{tlx|man|1|ls|Inferno}}||{{man|1|ls|Inferno}}
|-
|[[/IRIX|IRIX]]||{{tlx|man|1|ls|IRIX}}||{{man|1|ls|IRIX}}
|-
|[[/BIND_9|BIND 9]]||{{tlx|man|1|named|BIND 9}}||{{man|1|named|BIND 9}}
|-
|[[/Linux|Linux]]<ref name=linuxall>Note: this covers all sections, including section 1 of the Linux user's manual and sections 2, 3, 4, 5, 6, 7, and 8 of the Linux programmer's manual.</ref>||{{tlx|man|7|epoll|Linux}}||{{man|7|epoll|Linux}}
|-
|[[/ManKier|ManKier]]<ref name=linuxall/>||{{tlx|man|1|ls|ManKier}}||{{man|1|ls|ManKier}}
|-
|[[/MirOS BSD|MirOS BSD]]||{{tlx|man|1|ls|MirOS BSD}}||{{man|1|ls|MirOS BSD}}
|-
|[[/NetBSD|NetBSD]]||{{tlx|man|1|ls|NetBSD}}||{{man|1|ls|NetBSD}}
|-
|[[/OpenBSD|OpenBSD]]||{{tlx|man|1|ls|OpenBSD}}||{{man|1|ls|OpenBSD}}
|-
|[[/OpenSolaris|OpenSolaris]]||{{tlx|man|1|ls|OpenSolaris}}||{{man|1|ls|OpenSolaris}}
|-
|[[/perldoc|perldoc]]<ref>Note: this is the official documentation included with [[Perl]]. It does not contain general manual pages.</ref>||{{tlx|man|1|perlrun|perldoc}}||{{man|1|perlrun|perldoc}}
|-
|[[/Plan 9|Plan 9]]||{{tlx|man|1|ls|Plan 9}}||{{man|1|ls|Plan 9}}
|-
|[[/Solaris|Solaris]]||{{tlx|man|1|ls|Solaris}}||{{man|1|ls|Solaris}}
|-
|[[/SUS|SUS]]<ref name=sus>Note: the SUS pages use a non-numerical chapter system. A simple mapping is in place for human comfort.</ref>||{{tlx|man|cu|ls|SUS}}||{{man|cu|ls|SUS}}
|-
|[[/SUS6|SUS6]]<ref name=sus/>||{{tlx|man|sh|putmsg|SUS6}}||{{man|sh|putmsg|SUS6}}
|}

<references/>

===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:
:{|class="wikitable"
|-
!In !! Out
|-
|<code><nowiki>{{man/format|1|dbx|http://.../dbx.1.html|source-level debugging tool|[[Sun Studio]] Developer's Manual}}</nowiki></code> || {{man/format|1|dbx|http://developers.sun.com/sunstudio/documentation/ss11/mr/man1/dbx.1.html|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:
#*<code>attrib</code> for attribution
#*<code>url</code> for URL to page
#*<code>display_section</code> 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.

<includeonly>{{Sandbox other||
[[Category:External link templates|{{PAGENAME}}]]
[[Category:Software templates|{{PAGENAME}}]]
}}</includeonly>