Template:Man/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:Man (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

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

Contents

[edit] Usage

[edit] Examples

In Out
{{man|3|printf}} printf(3) – Linux man page
{{man|3|printf|||inline}} printf(3)
{{man|3|printf|FreeBSD}} printf(3) – FreeBSD Library Functions Manual
{{man|3|printf||formatted output conversion}} printf(3): formatted output conversion – Linux man page

[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
default[2] {{man|1|man}} man(1) – Linux man page
Darwin {{man|1|man|Darwin}} man(1) – Darwin General Commands Manual
Debian {{man|1|man|Debian}} man(1) – Debian man page
FreeBSD {{man|1|man|FreeBSD}} man(1) – FreeBSD General Commands Manual
Linux {{man|1|man|Linux}} man(1) – Linux User's Manual
LinuxManPages {{man|1|man|LinuxManPages}} man(1) – Linux man page on linuxmanpages.com
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 Manual
SUS {{man|cu|man|SUS}} man – Commands & Utilities Reference, The Single UNIX® Specification, Issue 6 from The Open Group
Solaris {{man|1|man|Solaris}} man(1) – Solaris 10 Reference Manual Collection, Sun Microsystems Documentation
  1. ^ Current default
  2. ^ Redirects to the current default

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

[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
    • 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.

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