Template:Man/doc

From Wikipedia, the free encyclopedia

This is the template documentation page for Template:Man. This page is not necessarily intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs.

---

To be used for inserting manual page links into articles on Unix topics.

Contents 1 Usage 1.1 Examples 1.2 Parameters 1.3 Available sources 2 Hacking 2.1 Writing sources 2.2 Internals

[edit] Usage

[edit] Examples

In	Out
{{man|3|printf}}	printf(3) – Linux man page on die.net
{{man|3|printf|||inline}}	printf(3)
{{man|3|printf|FreeBSD}}	printf(3) – FreeBSD Manual
{{man|3|printf||formatted output conversion}}	printf(3): formatted output conversion – Linux man page on die.net

[edit] Parameters

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

[edit] 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 man page on die.net
default[2]	{{man|1|man}}	man(1) – Linux man page on die.net
FreeBSD	{{man|1|man|FreeBSD}}	man(1) – FreeBSD Manual
Linux	{{man|1|man|Linux}}	man(1) – Linux man page on usr-share-man.org
OpenBSD	{{man|1|man|OpenBSD}}	man(1) – OpenBSD Manual

1. ^ Current default
2. ^ Redirects to the current default

[edit] Hacking

[edit] Writing sources

A source takes three parameters:

1. Manual section
2. Manual page name
3. Output selector: attrib for attribution, url for URL to page.

See Template:Man/die.net for an example.

[edit] 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.