Difference between revisions of "Template:Man/doc"
Jump to navigation
Jump to search
imported>EdC~enwiki |
imported>EdC~enwiki (→Parameters: Sources) |
||
| Line 22: | Line 22: | ||
# Manual section | # Manual section | ||
# Manual page name | # Manual page name | ||
| − | # Source (the name of a [[Wikipedia:Subpages|subpage]] in the [[Template:Man]] [[namespace]] | + | # 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 | # Page description | ||
# Style parameter; currently <code>inline</code> omits the attribution. | # Style parameter; currently <code>inline</code> omits the attribution. | ||
| + | |||
| + | ===Available sources=== | ||
| + | Remove the "Man/" prefix when using as a parameter. Note: the ''doc'' and ''format'' entries are internal templates, not sources. | ||
| + | {{Special:prefixindex/Template:man/}} | ||
==Hacking== | ==Hacking== | ||
Revision as of 23:30, 8 January 2007
Template:Template doc page viewed directly To be used for inserting manual page links into articles on Unix topics.
Contents
Usage
Examples
In Out {{man|3|printf}}– System Interfaces Reference, The Single UNIX Specification, Issue 7 from The Open Group {{man|3|printf|||inline}}{{man|3|printf|FreeBSD}}– FreeBSD Library Functions Manual {{man|3|printf||formatted output conversion}}: formatted output conversion – System Interfaces Reference, The Single UNIX Specification, Issue 7 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
inlineomits the attribution.
Available sources
Remove the "Man/" prefix when using as a parameter. Note: the doc and format entries are internal templates, not sources.
- Man/4.2BSD
- Man/4.3BSD
- Man/4.3BSD-Reno
- Man/4.4BSD-Lite2
- Man/9front
- Man/BIND 9
- Man/Darwin
- Man/Debian
- Man/DragonFly BSD
- Man/Fedora
- Man/FreeBSD
- Man/HP-UX
- Man/IRIX
- Man/Inferno
- Man/Linux
- Man/ManKier
- Man/MirOS BSD
- Man/NetBSD
- Man/OpenBSD
- Man/OpenSolaris
- Man/Plan 9
- Man/SUS
- Man/SUS6
- Man/Schillix
- Man/Solaris
- Man/die.net
- Man/doc
- Man/format
- Man/man.cx
- Man/perldoc
- Man/v6
- Man/v7
Hacking
Writing sources
A source takes three parameters:
- Manual section
- Manual page name
- Output selector:
attribfor attribution,urlfor URL to page.
See Template:Man/die.net for an example.
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.