next up previous index
Következő: 5.1.15.8.3 /usr/share/misc : egyéb, Fel: 5.1.15.8 /usr/share : architektúra-független Előző: 5.1.15.8.1 /usr/share/dict : szó   Index

5.1.15.8.2 /usr/share/man : kézikönyvlapok

Ez a szakasz a /usr/share/man könyvtárban található kézikönyvlapok rendszeren belüli felépítési szerkezetét részletezi. A témával kapcsolatban a /var/cache/man könyvtárral foglalkozó részben is olvashatunk.

A kézikönyvlapok a <kézikönyvlap_könyvtár>/<elhelyezkedés>/kézikönyvlap<fejezet>/
<architektúra>
szerkezet szerint épülnek fel, amely szerekezetet az alábbiakban értelmezzük.

<kézikönyv_könyvtár>/<elhelyezkedés> -- kézikönyvlapok hierarchiája


A /usr/share/man könyvtár


A rendszer elsődleges <kézikönyv_könyvtára> a /usr/share/man könyvtár, amely a / és a /usr fájlrendszerek parancsainak és adatainak kezelési információit tartalmazza. Nyilvánvaló, hogy a / fájlrendszerben nincsenek kézikönyvlapok, mivel ezekre sem a bootolási idő alatt, sem a rendszerrel kapcsolatos vészhelyzetekben nincs szükség.

A <fejezet> a kezelési kézikönyv fejezetét írja le.

Intézkedéseket kell tenni annak érdekében, hogy a /usr/share/man struktúra támogassa az eltérő vagy többnyelvű kézikönyvlapokat. Ezeket az intézkedéseket a kézikönyvlapok tárolási nyilvántartásában és a lapok hivatkozási helyére vonatkozóan kell foganatosítani. Lényeges tényezők közé tartozik a kézikönyvlapok nyelve (beleértve a földrajzon alapuló eltéréseket is) és azok karakter kódkészlete.

A /usr/share/man könyvtárban található, eltérő nyelvű könyvtárak elnevezése a POSIX 1003.1 szabvány E mellékletén alapul, amely leírja a helyi azonosító karaktersorozatot (ez a legszélesebben elfogadott módszer a kulturális környezetek leírására). Az <elhelyezkedés> karaktersorozata a következőkből áll:

<nyelv>[<terület>][.<karakterkészlet>][,verzió]

A <nyelv> mezőt az ISO 639 alapján kellene megadni, amely egy kódrendszer a nyelvek neveinek ábrázolására. Ez két karakter hosszú lehet, és csak nagybetűkkel adható meg.

A <terület> mezőnek az ISO 3166 szabvány kétbetűs kódjának kellene lenni (ez - egy - az országok ábrázolásával kapcsolatos meghatározás), amennyiben ez lehetséges. Ez a legtöbbek számára jól ismert kétbetűs kód, amelyet az e-mail címek5.1 országkódjában is használnak. Ennek szintén kétbetűsnek kellene lennie, és csak nagybetűk használhatók.

A <karakterkészlet> mező ábrázolja a szabványos karakterkészletet. Ha a <karakterkészlet> mező csak számokkal van meghatározva, a szám jeleníti meg a karakterkészlet nemzetközi szabványának számértékét. Kívánatos, hogy ez az érték számokkal legyen ábrázolva; ha ez lehetséges (főként ISO szabványokkal), ne tartalmazzon további írásjeleket, és a betűket kisbetűkkel írjuk.

A jellemző <verzió> paraméterének meghatározása a <karakterkészlet> mező útán helyezkedik el, vesszővel határolva. Ez használatos az eltérő kultúrák közötti különbségtételre (például a szótár szerint rendszerezett, a rendszerorientáltabb gyűjteményi rendszerezéssel szemben). Ez a szabvány nem javasolja a <verzió> mező használatát, hacsak az nem szükséges.

Azok a rendszerek, amelyek egyedi nyelvet és kódkészletet használnak, elhagyhatják az <elhelyezkedés> almezőt és tárolhatják a <kézikönyv_könyvtár>-ban valamennyi kézikönyvlapot. Például egy rendszer, amelynek csak angol (English) nyelvű és ASCII kódolású kézikönyvlapjai vannak, tarthatja valamennyi kézikönyvlapját (a kézikönyv<fejezet> könyvtárakat) közvetlenül a /usr/share/man könyvtárban (valójában ez a hagyományos eset és elrendezés).

Azok az országok, amelyekhez létezik elfogadott szabványos karakterkészlet, természetesen elhagyhatják a <karakterkészlet> mezőt, bár ennek megtartása erősen javallott, különösen azon országok esetében, amelyekben több eltérő szabvány is konkurál.

Néhány példa:

Nyelv Terület Karakterkészlet Könyvár
angol -- ASCII /usr/share/man/en
angol Egyesült Királyság ASCII /usr/share/man/en_GB
angol Egyesült Államok ASCII /usr/share/man/en_US
francia Kanada ISO-8859-1 /usr/share/man/fr_CA
francia Franciaország ISO-8859-1 /usr/share/man/fr_FR
német Németország ISO 646 /usr/share/man/de_DE.646
német Németország ISO 6937 /usr/share/man/de_DE.6937
német Németország ISO 8859-1 /usr/share/man/de_DE.88591
német Svájc ISO 646 /usr/share/man/de_CH.646
japán Japán JIS /usr/share/man/ja_JP.jis
japán Japán SJIS /usr/share/man/ja_JP.sjis
japán Japán UJIS (vagy EUC-J) /usr/share/man/ja_JP.ujis

Hasonló elrendezés szükséges az architektúra-független kézikönyvlapok számára is (ilyenek például az eszközmeghajtó programok dokumentációi vagy az alacsony szintű rendszeradminisztrációs parancsok). Ezeket az <arch> könyvtárban kellene elhelyezni, a megfelelő kézikönyv<fejezet> könyvtárban (például a ctrlaltdel(8) i386 architektúrájú kézikönyvlap a /usr/share/man/<terület>/man8/i386/ könyvtárba tehető ctrlaltdel.8 néven).

A /usr/local könyvtár parancsainak és adatainak kézikönyvlapjai a /usr/local/man könyvtárban tárolhatók. Az X11R6 kézikönyvlapjai a /usr/X11R6/man könyvtár alatt tárolhatók. Az ebben a könyvtárban található kézikönyvlapok hierarchiájának, a /usr/share/man könyvtárral megegyező stuktúrájúnak kellene lennie. Az üres alkönyvtárak elhagyhatók a kézikönyvlapok hierarchiájából. (Például, ha a /usr/local/man könyvtár 4. fejezetében (Eszközmeghajtók) nem található egyetlen kézikönyvlap sem, akkor a /usr/local/man/man4 könyvtár elhagyható.)

A cat lapok fejezetei (cat<fejezet>) tartalmazzák azon megformázott kézikönyvlap bejegyzéseket, amelyek megtalálhatók a <kézikönyv_könyvtár>/<elhelyezkedés> alkönyvtárakban is, de ezeknek nem szükséges a terjesztése, szemben az nroff forrás kézikönyvlapokkal.

A kézikönyvlapok 1-től 8-ig számozott fejezetei tradicionálisan definiáltak. Általában egy adott nevű kézikönyvlap fájl a .<fejezet>-számot, a tartalmára világosan utaló neve után viseli.

Néhány nagyobb alkalmazás-specifikus kézikönyvlap csoportnak lehet még további rag, szótoldalék hozzáfűzés a csomag kézikönyvlapjainak nevében. Például az MH levélkezelő rendszer valamennyi kézikönyvlapjának nevéhez hozzá kellene fűzni az mh ragot. Valamennyi X Window Rendszerrel kapcsolatos kézikönyvlap nevéhez hozzá kellene fűzni egy x-et.

A gyakorlatban a különféle nyelvű kézikönyvlapok a /usr/share/man megfelelő alkönyvtáraiban vannak, amely alkalmazható más kézikönyvlap hierarchiákra - például a /usr/local/man vagy a /usr/X11R6/man könyvtárak esetében - is (a szabvány e része alkalmazott a későbbiekben az opcionálisan használható /var/cache/man struktúra esetében is).

Következzen valamennyi fejezet rövid leirása:


next up previous index
Következő: 5.1.15.8.3 /usr/share/misc : egyéb, Fel: 5.1.15.8 /usr/share : architektúra-független Előző: 5.1.15.8.1 /usr/share/dict : szó   Index

1999-09-17