Přeskočit na obsah

Šablona:Man/doc

Z Wikipedie, otevřené encyklopedie

Tato šablona slouží pro vkládání odkazů na manuálové stránky do článků o unixových systémech.

Použití

[editovat zdroj]

Příklady

[editovat zdroj]
Použití Výsledek
{{man|3|printf}} printf – manuálová stránka The Open Group System Interfaces Reference, Single UNIX Specification, Version 4 from The Open Group
{{man|3|printf|||inline}} printf
{{man|3|printf|FreeBSD}} printf(3) – manuálová stránka FreeBSD (knihovní funkce)
{{man|3|printf||formátovaný výstup}} printf: formatovaný výstup – manuálová stránka The Open Group System Interfaces Reference, Single UNIX Specification, Version 4 from The Open Group

Parametry

[editovat zdroj]
  1. Sekce manuálu
  2. Jméno manuálové stránky
  3. Zdroj (jméno podstránky ve jmenném prostoru Šablona:Man, například FreeBSD. Nechte prázdné pro implicitní systém.)
  4. Popis stránky
  5. Parametr stylu; inline způsobí vynechání popisu stránky.

Dostupné zdroje

[editovat zdroj]

Prosím rozšířte tuto tabulku při přidání zdroje!

Zdroj Použití Výsledek
implicitní[1] {{man|1|ls}} ls – manuálová stránka The Open Group Shell and Utilities Reference, Single UNIX Specification, Version 4 from The Open Group
CS {{man|1|ls|CS}} ls(1) – česká manuálová stránka Ubuntu Linuxu (uživatelské příkazy)
die.net {{man|1|ls|die.net}} ls(1) – manuálová stránka Linuxu (uživatelské příkazy)
Verze 6 Unix {{man|1|ls|v6}} [[[:Šablona:Man/v6]] ls(Šablona:Man/v6)] – Šablona:Man/v6
Verze 7 Unix {{man|1|ls|v7}} [[[:Šablona:Man/v7]] ls(Šablona:Man/v7)] – Šablona:Man/v7
Verze 8 Unix {{man|1|ls|v8}} [[[:Šablona:Man/v8]] ls(Šablona:Man/v8)] – Šablona:Man/v8
4.2BSD {{man|1|ls|4.2BSD}} [[[:Šablona:Man/4.2BSD]] ls(Šablona:Man/4.2BSD)] – Šablona:Man/4.2BSD
4.3BSD {{man|1|ls|4.3BSD}} [[[:Šablona:Man/4.3BSD]] ls(Šablona:Man/4.3BSD)] – Šablona:Man/4.3BSD
4.3BSD-Reno {{man|1|ls|4.3BSD-Reno}} [[[:Šablona:Man/4.3BSD-Reno]] ls(Šablona:Man/4.3BSD-Reno)] – Šablona:Man/4.3BSD-Reno
4.4BSD-Lite2 {{man|1|ls|4.4BSD-Lite2}} [[[:Šablona:Man/4.4BSD-Lite2]] ls(Šablona:Man/4.4BSD-Lite2)] – Šablona:Man/4.4BSD-Lite2
9front {{man|1|ls|9front}} [[[:Šablona:Man/9front]] ls(Šablona:Man/9front)] – Šablona:Man/9front
Darwin {{man|1|ls|Darwin}} [[[:Šablona:Man/Darwin]] ls(Šablona:Man/Darwin)] – Šablona:Man/Darwin
Debian {{man|1|ls|Debian}} ls(1) – manuálová stránka Debian Linuxu (uživatelské příkazy)
man.cx {{man|8|iptables|man.cx||inline}} [[[:Šablona:Man/man.cx]] iptables(Šablona:Man/man.cx)]
DragonFly BSD {{man|1|ls|DragonFly BSD}} [[[:Šablona:Man/DragonFly BSD]] ls(Šablona:Man/DragonFly BSD)] – Šablona:Man/DragonFly BSD
FreeBSD {{man|1|ls|FreeBSD}} ls(1) – manuálová stránka FreeBSD (obecné příkazy)
HP-UX {{man|1|ls|HP-UX}} [[[:Šablona:Man/HP-UX]] ls(Šablona:Man/HP-UX)] – Šablona:Man/HP-UX
Inferno {{man|1|ls|Inferno}} [[[:Šablona:Man/Inferno]] ls(Šablona:Man/Inferno)] – Šablona:Man/Inferno
IRIX {{man|1|ls|IRIX}} [[[:Šablona:Man/IRIX]] ls(Šablona:Man/IRIX)] – Šablona:Man/IRIX
Linux[2] {{man|7|epoll|Linux}} epoll(7) – manuálová stránka Linuxu (přehled, konvence a různé informace)
ManKier[2] {{man|1|ls|ManKier}} [[[:Šablona:Man/ManKier]] ls(Šablona:Man/ManKier)] – Šablona:Man/ManKier
MirOS BSD {{man|1|ls|MirOS BSD}} [[[:Šablona:Man/MirOS BSD]] ls(Šablona:Man/MirOS BSD)] – Šablona:Man/MirOS BSD
NetBSD {{man|1|ls|NetBSD}} ls(1) – manuálová stránka NetBSD (obecné příkazy)
OpenBSD {{man|1|ls|OpenBSD}} [[[:Šablona:Man/OpenBSD]] ls(Šablona:Man/OpenBSD)] – Šablona:Man/OpenBSD
OpenSolaris {{man|1|ls|OpenSolaris}} [[[:Šablona:Man/OpenSolaris]] ls(Šablona:Man/OpenSolaris)] – Šablona:Man/OpenSolaris
perldoc[3] {{man|1|perlrun|perldoc}} perlrun(1) – Perl Programming Documentation
Plan 9 {{man|1|ls|Plan 9}} [[[:Šablona:Man/Plan 9]] ls(Šablona:Man/Plan 9)] – Šablona:Man/Plan 9
Solaris {{man|1|ls|Solaris}} [[[:Šablona:Man/Solaris]] ls(Šablona:Man/Solaris)] – Šablona:Man/Solaris
SUS[4] {{man|cu|ls|SUS}} ls – manuálová stránka The Open Group Shell and Utilities Reference, Single UNIX Specification, Version 4 from The Open Group
SUS6[4] {{man|sh|putmsg|SUS6}} [[[:Šablona:Man/SUS6]] putmsg(Šablona:Man/SUS6)] – Šablona:Man/SUS6
  1. Přesměruje na implicitné stránky
  2. a b Poznámka: toto pokrývá všechny sekce včetně sekce 1 Uživatelského manuálu Linuxu a sekce 2, 3, 4, 5, 6, 7 a 8 Manuálu programátora Linuxu.
  3. Poznámka: toto je oficiální dokumentace jazyka Perl. Neobsahuje obecné manuálové stránky.
  4. a b Poznámka: SUS stránky používají nečíselný systém sekcí. Jednoduché mapování je na místě pro lidské pohodlí.

Obecná doporučení

[editovat zdroj]

Pro většinu článků je nejvhodnější citovat SUS (je-li přítomný) pro standardní Unix, FreeBSD stránky pro historii, a Linuxové stránky pro nejrozšířenější unixový systém. Pokud je potřeba, přidejte stránky jiných systémů.

Existuje několik webů s manuálovými stránkami Linuxu. Použijte pouze „Linux“, který ukazuje na manned.org, kde jsou aktuální manuálové stránky shromažděné z několika distribucí Linuxu (a FreeBSD); implicitně „se pokusí získat nejnovější a nejbližší verzi manuálové stránky“, kterou „načte z některého z dostupných systémů“.[1] die.net používejte pouze, pokud to je jediné místo, kde daná manuálpová stránka je, protože formátování stránek na tomto webu je hrozné a stránky jsou staré.

Jiné zdroje

[editovat zdroj]

Občas narazíte na manuálové stránky, pro které je psaní zdrojového kódu přehnané. V takovém případě můžete pro formátování použít přímo Šablona:Man/format s URL:

Použití Výsledek
{{man/format|1|dbx|http://.../dbx.1.html|ladící nástroj na zdrojové úrovni|[[Sun Studio]] Developer's Manuál}}
dbx(1): ladící nástroj na zdrojové úrovni – Sun Studio Developer's Manual

Rozhraní Šablona:Man/format je proto externě viditelné a nesmí se měnit.

Hackování

[editovat zdroj]

Zapisování zdroje

[editovat zdroj]

Zdroj má tři parametry:

  1. Sekce manuálu
  2. Jméno manuálové stránky
  3. Výstupní selektor:
    • attrib pro popis stránky
    • url pro URL stránky
    • display_section pro číslo sekce, které se vypíše v závorkách.

Příklad použití je na Šablona:Man/die.net; na Šablona:Man/FreeBSD je ukázka změny popisu stránky podle sekce manuálu.

Internály

[editovat zdroj]

Šablona:Man se stará o výběr implicitního zdroje a dosazení URL a popisu stránky; implicitním zdrojem je Šablona:Man/default, které je aktuálně přesměrovaná na Šablona:Man/SUS. Šablona:Man/format formátuje odkaz a popis do pěkně vypadajícího odkazu+auxilia v unixovém stylu.

Reference

[editovat zdroj]

V tomto článku byl použit překlad textu z článku Template:Man/doc na anglické Wikipedii.

  1. About - Manned.org [online]. Dostupné online.