Linux Certif

Toute la documentation sur la certification Linux LPI

man

NAZWA

man - makra do formatowania stron man

SK£ADNIA

groff -Tascii -man plik ...

groff -Tps -man plik ...

man [sekcja] tytu³

OPIS

Ta strona podrêcznika opisuje pakiet makr groff tmac.an . Pakiet tych makr powinien byæ u¿ywany przez developerów kiedy pisz± lub przenosz± strony man dla Linuksa. Jest on w pe³ni kompatybilny z innymi wersjami tego pakietu, wiêc przenoszenie stron nie powinno byæ g³ównym problemem (wyj±tki w³±czaj± NET-2 BSD, które u¿ywa ca³kiem innego pakietu makr).

Zauwa¿, ¿e strony NET-2 BSD mog± byæ u¿yte z groffem przez proste podanie opcji -mdoc zamiast zwyk³ej -man . U¿ywanie opcji -mandoc jest jednak bardziej zalecane, jako ¿e wybierze ona automatycznie odpowiedni zestaw makr.

PREAMBU£A

Pierwsz± komend± na stronie man powinna byæ

.TH title section date source manual,

gdzie:

title

Tytu³ strony podrêcznika (np. MAN).

section

Numer sekcji, w której strona powinna siê znale¼æ (np. 7).

date

Data ostatniego poprawienia---pamiêtaj, by zmieniaæ j± za ka¿dym razem, kiedy dokonasz zmiany na stronie, poniewa¿ jest to najpopularniejsza droga kontrolowania wersji.

source

¬ród³o komendy.

Dla binariów u¿ywaj czego¶ w rodzaju: GNU, NET-2, SLS Distribution, MCC Distribution.

Dla wywo³añ systemowych, u¿ywaj wersji j±dra, której u¿ywasz: Linux 0.99.11.

Dla wywo³añ bibliotecznych, u¿yj ¼ród³a funkcji: GNU, BSD 4.3, Linux DLL 4.4.1.

manual

Tytu³ podrêcznika (np. Linux Programmer's Manual).

Sekcje podrêcznika man s± tradycyjnie definiowane nastêpuj±co:

1 Komendy

Te komendy mog± byæ wykonywane przez u¿ytkownika z pow³oki.

2 Wywo³ania systemowe

Te funkcje musz± byæ obs³ugiwane przez j±dro.

3 Wywo³ania biblioteczne

Wiêkszo¶æ funkcji libc takich jak sort(3))

4 Pliki specjalne

Pliki, które mo¿na znale¼æ w /dev)

5 Formaty plików i konwencje

Format dla pliku /etc/passwd i innych nadaj±cych siê do odczytu przez cz³owieka.

6 Gry

7 Pakiety makr i konwencje

Opis standardowego rozk³adu systemu plików, ta strona podrêcznika i wiele innych rzeczy.

8 Komendy zarz±dzania systemem.

Komendy takie, jak mount(8), które wywo³ywaæ mo¿e tylko root .

9 Wywo³ania j±dra

Jest to niestandardowa sekcja podrêcznika i jest w³±czona poniewa¿ ¼ród³a j±dra Linuksa s± swobodnie rozpowszechniane z licencj± GPL i wielu ludzi pracuje nad zmianami j±dra.

FONTY

Chocia¿ istnieje wiele konwencji dla stron man w ¶wiecie Unixowym, istnienie setek stron specyficznych Linuksowi definiuje nasze standardy:

Dla funkcji, argumenty zawsze s± podawane kursyw±, nawet w sekcji SK£ADNIA, gdzie reszta funkcji jest wydrukowana w pogrubieniu:

int myfunction(int argc, char **argv);

Nazwy plików s± tak¿e zawsze pisane kursyw± (np. /usr/include/stdio.h), poza tymi z sekcji SK£ADNIA, gdzie w³±czane pliki s± pogrubione (np. #include <stdio.h>).

Makra specjalne, które s± zwykle pisane du¿ymi literami, s± pogrubiane (np. MAXINT).

Podczas enumerowania listy kodów b³êdów, kody s± pogrubiane (taka lista zwykle u¿ywa makra .TP).

Wszelkie odwo³ania do innych stron man (lub temat bie¿±cej strony) s± pogrubione. Je¶li podany jest numer sekcji podrêcznika, podany jest bez spacji fontem roman, (np. man(7)).
Komendy do wyboru czcionki s± podane ni¿ej:

.B

Pogrubienie

.BI

Pogrubienie naprzemiennie z kursyw±

.BR

Pogrubienie naprzemiennie z fontem roman

.I

Kursywa

.IB

Kursywa naprzemiennie z pogrubieniem

.IR

Kursywa naprzemiennie z fontem roman

.RB

Font roman naprzemiennie z pogrubieniem

.RI

Font roman naprzemiennie z kursyw±

.SB

Ma³y font naprzemiennie z pogrubieniem

.SM

Ma³y font

Tradycyjnie, ka¿da komenda mo¿e mieæ do sze¶ciu argumentów, lecz wersja GNU wydaje siê znosiæ to ograniczenie. Argumenty s± oddzielane spacjami. Podwójne cudzys³owy mog± byæ u¿ywane do okre¶lania argumentów ze spacjami. Wszystkie argumenty zostan± wydrukowane obok siebie, bez wtr±conych spacji, tak ¿e komenda .BR mo¿e zostaæ u¿yta do podania s³owa pogrubionego, po którym nastêpuje znak interpunkcyjny w foncie roman.

SEKCJE

Sekcje zaczynaj± siê od .SH, po którym wystêpuje nazwa. Je¶li nazwa zawiera spacje i pojawia siê w tej samej linii co .SH, to umie¶æ j± miêdzy podwójnymi cudzys³owami. Tradycyjne nag³ówki to: NAZWA, SK£ADNIA, OPIS, OPCJE, PLIKI, ZOBACZ TAK¯E, DIAGNOSTYKA, B£ÊDY, i AUTOR. Jedynym wymaganym nag³ówkiem jest NAZWA, po którym powinna nast±piæ linijka z opisem programu:

.SH NAZWA
chess \- gra w szachy

Jest niesamowicie wa¿nym, aby u¿ywaæ tego formatu i ¿e wystêpuje backshlash przed kresk± po nazwie komendy. Ta sk³adnia (angielska, gdzie NAZWA to NAME) jest wykorzystywana przez program makewhatis(8) do tworzenia bazy krótkich opisów komend dla programu whatis(1) i apropos(1).

INNE MAKRA

Inne makra to miêdzy innymi:

.DT

Domy¶lne tabulacje

.HP

Pocz±tek wisz±cego wciêcia

.IP

Rozpocznij akapit wisz±cym tagiem. Jest to to samo co .TP, poza tym, ¿e tag podany jest w tej samej linii, nie w nastêpnej.

.LP

To samo co .PP

.PD

Ustaw odstêp miêdzyakapitowy na argument

.PP

Rozpocznij nowy akapit

.RE

Zakoñcz relatywne wciêcie (wcinany akapit)

.RS

Rozpocznij relatywne wciêcie (wcinany akapit)

.SS

Pod-nag³ówek (jak .SH, lecz u¿ywane do podsekcji)

.TP

Rozpocznij akapit z wisz±cym tagiem. Tag jest podawany w nastêpnej linii. Jest to podobne do .IP

PLIKI

/usr/local/lib/groff/tmac/tmac.an
/usr/man/whatis

ZOBACZ TAK¯E

groff(1), man(1), whatis(1), apropos(1), makewhatis(8)