Template:Man: Difference between revisions

From Semi del Verbo
mNo edit summary
m (una versione importata: Template:Man)
Line 1: Line 1:
<includeonly><templatestyles src="Man/styles.css" />{{#ifexist:{{FULLPAGENAME}}/{{{1|man}}}
{{Man/format|1={{Man/{{#if:{{{3|}}}
| __NOEDITSECTION__ <div class="toccolours avviso-man"> [[Immagine:Template-info.svg|45px|Info]] {{Big|testo='''Istruzioni per l'uso'''}}<br/><small>Le [[Aiuto:Manuali dei template|'''istruzioni''']] che seguono sono contenute nella [[Aiuto:Sottopagina|sottopagina]] [[{{FULLPAGENAME}}/{{{1|man}}}]] ([{{fullurl:{{FULLPAGENAME}}/{{{1|man}}}|action=edit}} modifica]{{·}}[{{fullurl:{{FULLPAGENAME}}/{{{1|man}}}|action=history}} cronologia]) <br> Sandbox: [[{{FULLPAGENAME}}/Sandbox]] ([{{fullurl:{{FULLPAGENAME}}/Sandbox|action=edit}} modifica]{{·}}[{{fullurl:{{FULLPAGENAME}}/Sandbox|action=history}} cronologia]){{·}}Tutte le sottopagine: [[Speciale:PrefixIndex/{{FULLPAGENAME}}/|lista]]</small></div>
|{{{3}}}|default}}|{{{1}}}|{{{2}}}|display_section<noinclude>|shhh=1</noinclude>}}|2={{{2}}}|3={{Man/{{#if:{{{3|}}}
----
|{{{3}}}|default}}|{{{1}}}|{{{2}}}|url}}|4={{{4|}}}|5={{#ifeq:{{{5|}}}
{{/{{{1|man}}}}}
|inline||{{Man/{{#if:{{{3|}}}
| <div class="toccolours avviso-man"> {{Big|testo='''[{{fullurl:{{FULLPAGENAME}}/{{{1|man}}}|action=edit&preload=Template:Man/Preload}} Crea le istruzioni!]''' ([[Aiuto:Manuali dei template|aiuto]])}}</div>{{#ifeq:{{NAMESPACE}}|Utente||[[Categoria:Template senza istruzioni]]}}
|{{{3}}}|default}}|{{{1}}}|{{{2}}}|attrib}}}}}}<noinclude>
}}</includeonly><noinclude>
{{documentation}}
{{Protetta}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS TO THE /doc SUBPAGE, THANKS -->
{{template complesso}}
{{man}}
[[Categoria:Template descrizione template]]
</noinclude>
</noinclude>

Revision as of 17:03, 19 August 2020

{{{2}}} – Reference, The Single UNIX Specification, Issue 7 from The Open Group

Template documentation[view] [edit] [history] [purge]

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

Usage

Examples

In Out
{{man|3|printf}} printf – System Interfaces Reference, The Single UNIX Specification, Issue 7 from The Open Group
{{man|3|printf|||inline}} printf
{{man|3|printf|FreeBSD}} printf(3) – FreeBSD Library Functions Manual
{{man|3|printf||formatted output conversion}} printf: formatted output conversion – System Interfaces Reference, The Single UNIX Specification, Issue 7 from The Open Group

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.

Available sources

Please add to this table as you write new sources!

Source Example Result
default[1] {{man|1|ls}} ls – Commands & Utilities Reference, The Single UNIX Specification, Issue 7 from The Open Group
die.net {{man|1|ls|die.net}} ls(1) – Linux User Commands Manual
Version 6 Unix {{man|1|ls|v6}} ls(1) – Version 6 Unix Programmer's Manual
Version 7 Unix {{man|1|ls|v7}} ls(1) – Version 7 Unix Programmer's Manual
4.2BSD {{man|1|ls|4.2BSD}} ls(1) – 4.2BSD General Commands Manual
4.3BSD {{man|1|ls|4.3BSD}} ls(1) – 4.3BSD General Commands Manual
4.3BSD-Reno {{man|1|ls|4.3BSD-Reno}} ls(1) – BSD General Commands Manual
4.4BSD-Lite2 {{man|1|ls|4.4BSD-Lite2}} ls(1) – BSD General Commands Manual
9front {{man|1|ls|9front}} ls(1) – 9front manual page
Darwin {{man|1|ls|Darwin}} ls(1) – Darwin and macOS General Commands Manual
Debian {{man|1|ls|Debian}} ls(1) – Debian General Commands Manual
man.cx {{man|8|iptables|man.cx|inline}} iptables(8)
DragonFly BSD {{man|1|ls|DragonFly BSD}} ls(1) – DragonFly BSD General Commands Manual
FreeBSD {{man|1|ls|FreeBSD}} ls(1) – FreeBSD General Commands Manual
HP-UX {{man|1|ls|HP-UX}} ls(1) – HP-UX 11i User Commands Manual
Inferno {{man|1|ls|Inferno}} ls(1) – Inferno General commands Manual
IRIX {{man|1|ls|IRIX}} ls(1) – IRIX 6.5 User Commands Manual
BIND 9 {{man|1|named|BIND 9}} named – BIND 9
Linux[2] {{man|7|epoll|Linux}} epoll(7) – Linux Programmer's Manual – Overview, Conventions and Miscellanea
ManKier[2] {{man|1|ls|ManKier}} ls(1) – Linux General Commands Manual
MirOS BSD {{man|1|ls|MirOS BSD}} ls(1) – MirOS BSD i386 General Commands Manual
NetBSD {{man|1|ls|NetBSD}} ls(1) – NetBSD General Commands Manual
OpenBSD {{man|1|ls|OpenBSD}} ls(1) – OpenBSD General Commands Manual
OpenSolaris {{man|1|ls|OpenSolaris}} ls(1) – illumos and OpenSolaris User Commands Reference Manual from latest Sun based OpenSolaris
perldoc[3] {{man|1|perlrun|perldoc}} perlrun(1) – Perl Programming Documentation
Plan 9 {{man|1|ls|Plan 9}} ls(1) – Plan 9 Programmer's Manual, Volume 1
Solaris {{man|1|ls|Solaris}} ls(1) – Solaris 10 User Commands Reference Manual
SUS[4] {{man|cu|ls|SUS}} ls – Commands & Utilities Reference, The Single UNIX Specification, Issue 7 from The Open Group
SUS6[4] {{man|sh|putmsg|SUS6}} putmsg – System Interfaces Reference, The Single UNIX Specification, Issue 6 from The Open Group
  1. Redirects to the current default
  2. 2,0 2,1 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.
  3. Note: this is the official documentation included with Perl. It does not contain general manual pages.
  4. 4,0 4,1 Note: the SUS pages use a non-numerical chapter system. A simple mapping is in place for human comfort.

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.

Hacking

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.

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.