Template:Man
To be used for inserting manual page links into pages on Unix topics.
UsageEdit
ExamplesEdit
-
In Out {{man|3|printf}}
Linux Library Functions Manual –{{man|3|printf|||inline}}
{{man|3|printf|FreeBSD}}
FreeBSD Library Functions Manual –{{man|3|printf||formatted output conversion}}
Linux Library Functions Manual : formatted output conversion –
ParametersEdit
- 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 sourcesEdit
Please add to this table as you write new sources!
-
Source Example Result die.net[1] {{man|1|ls|die.net}} Linux User Commands Manual –default[2] {{man|1|ls}} Linux User Commands Manual –Darwin {{man|1|ls|Darwin}} Darwin and Mac OS X General Commands Manual –Debian {{man|1|ls|Debian}} Debian General Commands Manual –DragonFly {{man|1|ls|DragonFly BSD}} DragonFly General Commands Manual –FreeBSD {{man|1|ls|FreeBSD}} FreeBSD General Commands Manual –HP-UX {{man|1|ls|HP-UX}} HP-UX 11i User Commands Manual –IRIX {{man|1|ls|IRIX}} IRIX 6.5 User Commands Manual –Linux[3] {{man|7|epoll|Linux}} Linux Programmer's Manual – Overview, Conventions and Miscellanea –LinuxManPages {{man|1|ls|LinuxManPages}} Linux General Commands Manual on linuxmanpages.com –MirOS BSD {{man|1|ls|MirOS BSD}} MirOS BSD i386 General Commands Manual –NetBSD {{man|1|ls|NetBSD}} NetBSD General Commands Manual –OpenBSD {{man|1|ls|OpenBSD}} OpenBSD General Commands Manual –Plan 9 {{man|1|ls|Plan 9}} Plan 9 General Commands Manual –SUS {{man|cu|ls|SUS}} The Single UNIX® Specification, Issue 7 from The Open Group – Commands & Utilities Reference,Solaris {{man|1|ls|Solaris}} Solaris 10 User Commands Reference Manual –Inferno {{man|1|ls|Inferno}} Inferno General commands Manual –perldoc[4] {{man|1|perlrun|perldoc}} Perl Programming Documentation –
- ↑ Current default
- ↑ Redirects to the current default
- ↑ Note: this is the Linux programmer's manual. It contains manual pages primarily from sections 2, 3, 4, 5 and 7, and does not cover the usual GNU user utilities.
- ↑ Note: this is the official documentation included with Perl. It does not contain general manual pages.
Other sourcesEdit
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}}
Sun Studio Developer's Manual : source-level debugging tool –
The interface of Template:man/format is therefore externally visible and needs to be kept constant.
HackingEdit
Writing sourcesEdit
A source takes three parameters:
- Manual section
- Manual page name
- Output selector:
attrib
for attributionurl
for URL to pagedisplay_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.
InternalsEdit
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.