Ubuntu Manpage: man - makra pro formátování manuálových stránek.

jméno
použití
popis
soubory
poznámky
chyby
další informace
překlad

JMÉNO

       man - makra pro formátování manuálových stránek.

POUŽITÍ

       groff -Tascii -man soubor ...
       groff -Tps -man soubor ...

       man [sekce] název

POPIS

Tato manuálová stránka popisuje makro balík groff an.tmac (často nazývaný jako makro balík man). Tento
balík maker by měli používat vývojáři při psaní nebo přenosu manuálových stránek pro Linux. Je celkem
kompatibilní s ostatními verzemi tohoto makro balíku, a proto by přenos manuálových stránek z jiných
systémů neměl být problémem (výjimkou je NET-2 BSD, který používá úplně jiný makro balík zvaný mdoc; viz
mdoc(7)).

NET-2 BSD manuálové stránky mohou být používány programem groff jednoduše, pokud použijeme volbu -mdoc
místo standardní volby -man. Doporučujeme ale používat volbu -mandoc, protože ta automaticky rozezná,
který makro balík má použít.

Konvence, které by měly být použity při psaní manuálových stránek v balíku man-pages, jsou uvedeny v
man-pages(7).

Titulní řádka
První příkaz manuálové stránky (po komentářích, tj. řádcích začínajících na .\") by měl být

.TH titulek sekce datum zdroj manuál

Více informací o parametrech, které mohou být předány příkazu TH, je uvedeno v man-pages(7).

Pozor, BSD manuálové stránky formátované mdoc začínají příkazem Dd, nikoliv příkazem TH.

Sekce
Sekce začínají příkazem .SH následovaným názvem dané sekce.

Jediná povinná sekce je JMÉNO, měla by být první a za ní by měl následovat jednořádkový popis programu:

.SH JMÉNO
item \- description

It is extremely important that this format is followed, and that there is a backslash before the single
dash which follows the item name. This syntax is used by the mandb(8) program to create a database of
short descriptions for the whatis(1) and apropos(1) commands. (See lexgrog(1) for further details on
the syntax of the NAME section.)

Seznam dalších sekcí, které se mohou v manuálové stránce vyskytnout, je uveden v man-pages(7).

Fonty
Příkazy pro nastavení řezu písma:

.B Tučné

.BI Tučné střídající se s kurzívou (zvláště užitečné pro specifikace funkcí)

.BR Tučné střídající se s normálním (zvláště užitečné pro odkazy na ostatní manuálové stránky)

.I Kurzíva

.IB Italika střídající se s tučným

.IR Italika střídající se s normálním

.RB Normální střídající se s tučným

.RI Normální střídající se s kurzívou

.SB Malé střídající se s tučným

.SM Malé (užitečné pro zkratky)

Traditionally, each command can have up to six arguments, but the GNU implementation removes this
limitation (you might still want to limit yourself to 6 arguments for portability's sake). Arguments are
delimited by spaces. Double quotes can be used to specify an argument which contains spaces. For the
macros that produce alternating type faces, the arguments will be printed next to each other without
intervening spaces, so that the .BR command can be used to specify a word in bold followed by a mark of
punctuation in Roman. If no arguments are given, the command is applied to the following line of text.

Další makra a řetězce
Níže jsou uvedena další související makra a předdefinované řetězce. Pokud není uvedeno jinak, všechna
makra způsobují zlom (konec aktuální rádky textu). Mnoho z těchto maker nastavuje nebo užívá "obecné
odsazení". Hodnota "obecné odsazení" je nastavena makrem s parametrem i níže; makro může i vypustit, v
tom případě bude užito aktuální obecné odsazení. Výsledkem je, že po sobě jdoucí odsazené odstavce mohou
používat stejné odsazení bez nutnosti jeho hodnotu opakovaně nastavovat. Obyčejný (neodsazený) odstavec
obnoví hodnotu obecného odsazení na výchozí hodnotu (0.5 palce) Jako výchozí jednotka odsazení je
použito en; jako jednotky používejte nejlépe en nebo em, protože se automaticky přizpůsobují změně
velikosti fontu. Další základní makra jsou:

Normální odstavce
.LP Stejné jako .PP (začni odstavec).

.P Stejné jako .PP (začni odstavec).

.PP Začni odstavec a obnov obecné odsazení.

Relativní hranice odsazení
.RS i Začátek relativní hranice odsazení: posune levý okraj i doprava (pokud je i vynecháno, použije
se hodnota obecného odsazení). Nové obecné odsazení je nastaveno na 0.5 palce. Výsledkem je, že
všechny následující odstavce budou odsazeny až do odpovídajícího .RE.

.RE Ukončí relativní hranici odsazení a obnoví předchozí hodnotu obecného odsazení.

Makra pro odsazené odstavce
.HP i Začne odstavec s visícím odsazením (první řádek začíná vlevo stejně jako normální odstavce,
ostatní řádky jsou odsazeny).

.IP x i Odsazený odstavec s volitelnou visící značkou. Pokud je značka x vynechána, je celý následující
odstavec odsazen o i. Pokud je značka x přítomna, je pověšena na levém okraji před následujícím
odsazeným odstavcem (je to stejné jako .TP, akorát je značka uvedena s příkazem, místo aby byla
na následující řádce). Pokud je značka příliš dlouhá, je text, který po ní následuje, posunut
dolů na další řádku (text nezmizí ani se nezkomolí). Pro seznamy s odrážkami se toto makro
používá se značkami \(bu (bullet) nebo \(em (em dash), pro číslované seznamy je pak značkou
číslo nebo písmeno následované tečkou; to zjednodušuje převod do jiných formátů.

.TP i Začne odstavec s visící značkou. Značka je uvedena na následující řádce, ale výsledek je stejný
jako u příkazu .IP.

Makra hypertextových odkazů
.UR url
Insert a hypertext link to the URI (URL) url, with all text up to the following .UE macro as the
link text.

.UE .RI [ trailer ]
Terminate the link text of the preceding .UR macro, with the optional trailer (if present, usually
a closing parenthesis and/or end-of-sentence punctuation) immediately following. For non-HTML
output devices (e.g., man -Tutf8), the link text is followed by the URL in angle brackets; if
there is no link text, the URL is printed as its own link text, surrounded by angle brackets.
(Angle brackets may not be available on all output devices.) For the HTML output device, the link
text is hyperlinked to the URL; if there is no link text, the URL is printed as its own link text.

These macros have been supported since GNU Troff 1.20 (2009-01-05) and Heirloom Doctools Troff since
160217 (2016-02-17).

Různá makra
.DT Obnoví původní hodnoty tabulátorů (0.5 palce); nepůsobí zlom.

.PD d Nastaví vertikální vzdálenost mezi odstavci na d (pokud je vynecháno, pak d=0.4v); nepůsobí
zlom.

.SS t Podkapitola t (jako .SH, ale užívá se pro podsekci uvnitř sekce).

Předdefinované řetězce
Balíček man obsahuje následující předdefinované řetězce:

\*R Symbol registrace: ®

\*S Změna výchozí velikosti fontu

\*(Tm Ochranná známka: ™

\*(lq Dvojité uvozovky směřující vlevo: “

\*(rq Dvojité uvozovky směřující vpravo: ”

Bezpečná sada
Ačkoliv technicky je man makro balíčkem programu troff, ve skutečnosti zpracovává manuálové stránky velké
množství dalších nástrojů, které neimplementují všechny možnosti programu troff. Proto je nejlepší
vyhýbat se některým exotičtějším možnostem, aby mohly tyto nástroje pracovat správně. Vyhněte se použití
různých preprocesorů troffu (pokud ale musíte, klidně použijte tbl(1), ale pro dvousloupcové tabulky
zkuste raději příkazy IP a TP). Vyhnětě se výpočtům; většina ostatních nástrojů je neumí zpracovat.
Používejte jednoduché příkazy, které se snadno převádějí do jiných formátů. Následující makra jsou obecně
považována za bezpečná (i když v mnoha případech budou překladači ignorována): \", ., ad, bp, br, ce, de,
ds, el, ie, if, fi, ft, hy, ig, in, na, ne, nf, nh, ps, so, sp, ti, tr.

Také můžete používat mnohé escape sekvence troffu (začínající na \). Pokud potřebujete uvést v textu
zpětné lomítko, použijte \e. Další sekvence, které je možné použít zahrnují (x je jakýkoliv znak a N je
jakákoliv číslice): \', \`, \-, \., \", \%, \*x, \*(xx, \(xx, \$N, \nx, \n(xx, \fx a \f(xx. Vyhněte se
escape sekvencím pro kreslení.

Nepoužívejte volitelný parametr pro bp (break page). Používejte pouze kladné hodnoty pro sp (vertical
space). Nedefinujte makro (de) se stejným jménem jako makro v tomto balíčku nebo v balíčku mdoc s jiným
významem; je pravděpodobné, že takové redefinování bude ignorováno. Každé kladné odszení (in) by mělo
mít odpovídající záporné odsazení (ačkoliv by měla být raději používána makra RS a RE). Testy (if,ie) by
měly mít jako podmínku jen 't' nebo 'n'. Měly by být použity pouze překlady (tr) které je možné
ignorovat. Změny fontů (ft a escape sekvence \f ) by měly mít pouze hodnoty 1, 2, 3, 4, R, I, B, P nebo
CW (příkaz ft nemusí mít žádný parametr).

Pokud využíváte pokročilejší možnosti, pečlivě vyzkoušejte výsledek s několika nástroji. Jestliže
zjistíte, že tato pokročilejší možnost je bezpečná, dejte vědět udržovateli tohoto dokumentu, aby ji mohl
přidat do seznamu.

SOUBORY

       /usr/share/groff/[*/]tmac/an.tmac
       /usr/man/whatis

POZNÁMKY

       By  all  means  include  full  URLs  (or  URIs)  in  the text itself; some tools such as man2html(1)  can
       automatically turn them into hypertext links. You can also use the UR and UE macros to identify links  to
       related information. If you include URLs, use the full URL (e.g., ⟨http://www.kernel.org⟩) to ensure that
       tools can automatically find the URLs.

       Nástroje zpracovávající tyto soubory by měly otevřít soubor a prozkoumat první znam, který není  prázdným
       místem.  Tečka  (.)  nebo jednoduchá uvozovka (')  na začátku řádku označují soubor troffu (jako man nebo
       mdoc). levá ostrá závorka (<) označuje soubor SGML/XML (jako HTML nebo Docbook). Cokoliv jiného je prostý
       ASCII text (např. "catman").

       Mnoho  manuálových  stránek  začíná  s  '\"  následovaným mezerou a řadou znaků, které určují, jak má být
       stránka zpracována. Pro zachování přenositelnosti doporučujeme vyhnout se všemu, s výjimkou tbl(1), který
       Linux  umí  detekovat  automaticky. Nicméně můžete tuto informaci uvést, takže méně schopné systémy mohou
       vaši manuálovou stránku zpracovat. Následují definice preprocesorů volaných těmito znaky:

       e  eqn(1)

       g  grap(1)

       p  pic(1)

       r  refer(1)

       t  tbl(1)

       v  vgrind(1)

CHYBY

       Většina maker popisuje formátování (např. druh fontu  a  rozteč)   namísto  značení  sémantického  obsahu
       (např.  tento  text  je  odkazem  na  jinou stránku), na rozdíl od formátů jako mdoc a DocBook (i HTML má
       sémantičtější  značení).  Proto  není  jednoduché  převést  formát  man  na  jiná  média,   udržet   jeho
       konzistentnost  a  automaticky  vkládat křížové odkazy. Pokud se budete držet výše uvedené bezpečné sady,
       měl by být v budoucnu automatický převod do jiného formátu jednodušší.

       Makro TX Sunu není implementováno.

DALŠÍ INFORMACE

       apropos(1),  groff(1),  lexgrog(1),  man(1),   man2html(1),   groff_mdoc(7),   whatis(1),   groff_man(7),
       groff_www(7), man-pages(7), mdoc(7)

PŘEKLAD

       Překlad této příručky do španělštiny vytvořili Pavel Heimlich <tropikhajma@gmail.com>

       Tento   překlad   je   bezplatná   dokumentace;   Přečtěte  si  GNU  General  Public  License  Version  3
       ⟨https://www.gnu.org/licenses/gpl-3.0.html⟩ nebo novější ohledně  podmínek  autorských  práv.  Neexistuje
       ŽÁDNÁ ODPOVĚDNOST.

       Pokud  narazíte  na  nějaké  chyby  v překladu této příručky, pošlete e-mail na adresu ⟨translation-team-
       cs@lists.sourceforge.net⟩.