قالب:Man/شرح
 | هذه صفحة توثيق قالب:Man الفرعية، لشرح القالب وتصنيفه، وهي لا تدخل في استخدامه. |
To be used for inserting manual page links into articles on Unix topics.
Usage
عدلExamples
عدلIn Out {{man|3|printf}}– System Interfaces المرجع، مُوَاصَفَة يونكس الموحدة، الإصدارة 4 من المجموعة المفتوحة (بالإنجليزية: The Single UNIX Specification, Version 4 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 المرجع، مُوَاصَفَة يونكس الموحدة، الإصدارة 4 من المجموعة المفتوحة (بالإنجليزية: The Single UNIX Specification, Version 4 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
عدلPlease add to this table as you write new sources!
Source Example Result default[1] {{man|1|ls}}– Shell and Utilities المرجع، مُوَاصَفَة يونكس الموحدة، الإصدارة 4 من المجموعة المفتوحة (بالإنجليزية: The Single UNIX Specification, Version 4 from The Open Group) die.net {{man|1|ls|die.net}}– قالب:Man/die.net Version 6 Unix {{man|1|ls|v6}}– قالب:Man/v6 Version 7 Unix {{man|1|ls|v7}}– قالب:Man/v7 Version 8 Unix {{man|1|ls|v8}}– قالب:Man/v8 4.2BSD {{man|1|ls|4.2BSD}}– قالب:Man/4.2BSD 4.3BSD {{man|1|ls|4.3BSD}}– قالب:Man/4.3BSD 4.3BSD-Reno {{man|1|ls|4.3BSD-Reno}}– قالب:Man/4.3BSD-Reno 4.4BSD-Lite2 {{man|1|ls|4.4BSD-Lite2}}– قالب:Man/4.4BSD-Lite2 9front {{man|1|ls|9front}}– قالب:Man/9front Darwin {{man|1|ls|Darwin}}– قالب:Man/Darwin Debian {{man|1|ls|Debian}}– قالب:Man/Debian man.cx {{man|8|iptables|man.cx|inline}}DragonFly BSD {{man|1|ls|DragonFly BSD}}– DragonFly BSD General Commands Manual FreeBSD {{man|1|ls|FreeBSD}}– FreeBSD General Commands Manual HP-UX {{man|1|ls|HP-UX}}– قالب:Man/HP-UX Inferno {{man|1|ls|Inferno}}– قالب:Man/Inferno IRIX {{man|1|ls|IRIX}}– قالب:Man/IRIX Linux[2] {{man|7|epoll|Linux}}– Linux Programmer's Manual – Overview, Conventions and Miscellanea ManKier[2] {{man|1|ls|ManKier}}– Linux General Commands Manual MirOS BSD {{man|1|ls|MirOS BSD}}– قالب:Man/MirOS BSD NetBSD {{man|1|ls|NetBSD}}– NetBSD General Commands Manual OpenBSD {{man|1|ls|OpenBSD}}– OpenBSD General Commands Manual OpenSolaris {{man|1|ls|OpenSolaris}}– قالب:Man/OpenSolaris perldoc[3] {{man|1|perlrun|perldoc}}– قالب:Man/perldoc Plan 9 {{man|1|ls|Plan 9}}– قالب:Man/Plan 9 Solaris {{man|1|ls|Solaris}}– قالب:Man/Solaris SUS[4] {{man|cu|ls|SUS}}– Shell and Utilities المرجع، مُوَاصَفَة يونكس الموحدة، الإصدارة 4 من المجموعة المفتوحة (بالإنجليزية: The Single UNIX Specification, Version 4 from The Open Group) SUS6[4] {{man|sh|putmsg|SUS6}}– قالب:Man/SUS6
- ^ Redirects to the current default
- ^ ا ب 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.
- ^ Note: this is the official documentation included with Perl. It does not contain general manual pages.
- ^ ا ب Note: the SUS pages use a non-numerical chapter system. A simple mapping is in place for human comfort.
General recommendations
عدلFor most articles, it is preferable to cite SUS (if present) for standard, the FreeBSD page for history, and the Linux page for a relatively widespread form. Add other OS pages as needed.
There are several sources for Linux manual pages. Just use "Linux" which points to manned.org, which has up-to-date manpages collected from several Linux distributions (as well as FreeBSD); it will, by default, "try to get the latest and most-close-to-upstream version of a man page", which "will fetch the man page from any of the available systems".[1] Do not go for die.net unless it's the only place where a page can be found, as the formatting is horrible and the pages are old.
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}}
: 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:
attribfor attributionurlfor URL to pagedisplay_sectionfor 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/SUS. Template:man/format actually formats the link and descriptions into a nice-looking link+auxilia in Unix style.