35. fejezet - Súgó és dokumentáció

Tartalomjegyzék

35.1. Dokumentációkönyvtár
35.2. Kézikönyvoldalak (man)
35.3. Információs oldalak
35.4. openSUSE Wiki

Kivonat

Az openSUSE számos információs és dokumentációs forrást kínál, amelyek közül a legtöbb megtalálható a telepített rendszeren.

Dokumentáció az /usr/share/doc könyvtárban

Ez a hagyományos súgókönyvtár számos, különféle dokumentációs fájlt tartalmaz, valamint a rendszer kiadási megjegyzéseit. A telepített csomagokról a packages alkönyvtárban található információ. További, részletes információ: 35.1. - Dokumentációkönyvtár.

Kézikönyvoldalak (man) és info oldalak a parancsértelmező parancsairól

Amikor a parancsértelmezőt használja, nincs szükség arra, hogy minden parancs minden paraméterét fejből tudja. A parancsértelmező hagyományosan kínál beépített segítséget a kézikönyvoldalak és az info oldalak formájában. További részletek a 35.2. - Kézikönyvoldalak (man) és 35.3. - Információs oldalak részekben olvashatók.

Asztali rendszerek súgóközpontjai

A KDE és a GNOME súgóközpontjai (a KDE help center, illetve a Help) központi, jól kereshető elérést kínálnak a rendszer legfontosabb dokumentációs erőforrásaihoz. Ide tartoznak a telepített alkalmazások online súgói, a kézikönyvoldalak, az info oldalak, valamint a termék mellé kapott Novell/SUSE kézikönyvek.

Egyes alkalmazások saját súgócsomagjai

Amennyiben új szoftvert telepít a YaST segítségével, a legtöbb esetben a szoftverdokumentáció is automatikusan telepítésre kerül, és rendszerint megjelenik az asztal segítségnyújtó rendszerében. Néhány más alkalmazás ellenben (például a GIMP) más típusú online súgócsomagokat tartalmaz, amelyet a YaST alkalmazástól függetlenül kell telepíteni és nem részei a súgócentrumnak.

35.1. Dokumentációkönyvtár

Hagyományosan a könyvtár, amelyben a telepített Linux-rendszeren a dokumentáció megtalálható, az /usr/share/doc. Ez a könyvtár általában a rendszeren telepített csomagokkal kapcsolatos információt, valamint kiadási megjegyzéseket, kézikönyveket és sok más egyebet tartalmaz.

[Note]A tartalom függ a telepített csomagoktól

A Linux-világban számos kézikönyv és más dokumentáció, a programokhoz hasonlóan csomagok formájában érhető el. Az, hogy mennyi és milyen információ található az /usr/share/docs könyvtárban, a telepített (dokumentációs) csomagoktól is függ. Ha az itt említett alkönyvtárak hiányoznának, akkor ellenőrizze, hogy a megfelelő csomagok telepítésre kerültek-e a rendszeren, és ha nem, akkor telepítse őket a YaST segítségével.

35.1.1. Novell/SUSE kézikönyvek

A könyvek HTML- és PDF-változatban is hozzáférhetők, különféle nyelveken. A manual alkönyvtárban a termékhez kapcsolódó Novell/SUSE kézikönyvek többsége elérhető HTML formátumban. A termékhez kapcsolódó dokumentációról a kézikönyvek előszavából kaphat áttekintést.

Ha egynél több nyelvet telepített, akkor az /usr/share/doc/manual könyvtárban lehet, hogy a kézikönyvek is több nyelven szerepelnek. A Novell/SUSE kézikönyvek HTML-változatai szintén megtalálhatók mindkét asztali környezet súgóközpontjaiban. Azzal kapcsolatban, hogy hol találja a könyvek PDF- és HTML-változatait a telepítőkészleten, tekintse meg az openSUSE Kiadási megjegyzéseit. Ezek a telepített rendszeren az /usr/share/doc/release-notes/ fájlban, vagy online a http://www.novell.com/documentation/ címen, a termékhez tartozó weboldalon találhatók.

35.1.2. Feladatleírások (HOWTO)

Ha a howto csomag telepítve van a rendszeren, akkor az /usr/share/doc alatt található egy howto alkönyvtár is, ahol további dokumentumok találhatók a Linux-szoftverek telepítésének és üzemeltetésének számos feladatáról.

35.1.3. Csomagdokumentáció

A packages könyvtárban találhatók azok a dokumentumok, amelyek a rendszeren telepített szoftvercsomagok részei. Minden csomaghoz létrejön egy /usr/share/doc/packages/csomagnév alkönyvtár. Ebben gyakran találhatók a csomaggal kapcsolatos README fájlok, néha példák, konfigurációs fájlok vagy kiegészítő parancsfájlok. Az alábbi listában az /usr/share/doc/packages könyvtárban jellemzően előforduló fájlok láthatók. A bejegyzések egyike sem kötelező, és sok csomag csak néhányat tartalmaz közülük.

AUTHORS

A fő fejlesztők listája.

BUGS

Ismert hibák vagy hibás működés. Tartalmazhat egy hivatkozást egy Bugzilla weboldalra, ahol kereshet az összes hiba között.

CHANGES , ChangeLog

Az egyes verziók közötti változások összefoglalása. Általában fejlesztők számára érdekes, mert nagyon részletes.

COPYING , LICENSE

Licencadatok.

FAQ

Levelezőlistákról vagy hírcsoportokból összegyűjtött kérdések és válaszok.

INSTALL

A csomag telepítésének leírása. Mivel amikorra ezt a fájlt olvassa, a csomag már telepítve van, ennek a fájlnak a tartalma nyugodtan figyelmen kívül hagyható.

README, README.*

Általános információ a szoftverről, például hogy mire szolgál és hogyan kell használni.

TODO

Olyan funkciók, amelyek egyelőre még nincsenek megvalósítva, de a jövőben várhatóan meg lesznek.

MANIFEST

A fájlok jegyzéke, rövid összefoglalóval.

NEWS

Az adott verzió újdonságainak leírása.

35.2. Kézikönyvoldalak (man)

A kézikönyvoldalak (man) a Linux-rendszer nélkülözhetetlen részei. Elmagyarázzák a parancsok használatát, valamint információt adnak az összes rendelkezésre álló beállításról és paraméterről. A kézikönyvoldalak megjelenítéséhez írja be a man utasítást, majd a parancs nevét, tehát például man ls.

A kézikönyvoldalak közvetlenül a parancsértelmezőben jelennek meg. A bennük való fel- és lefelé mozgáshoz használja a Page ↑ és Page ↓ billentyűket. A dokumentum elejére, vagy végére a Home és End billentyűkkel lehet ugrani. A megtekintési módból a Q megnyomásával léphet ki. A man parancsról magáról is kérhető információ: írja be, hogy man man. A kézikönyvoldalak kategóriákba vannak sorolva, ahogy az a következő helyen látható: 35.1. táblázat - Man oldalak – Kategóriák és leírások (részlet a man program man oldalából).

35.1. táblázat - Man oldalak – Kategóriák és leírások

Szám

Leírás

1

Végrehajtandó programok vagy parancsok

2

Rendszerhívások (a kernel által nyújtott szolgáltatások)

3

Programkönyvtár-hívások (a programkönyvtárakon belüli funkciók)

4

Speciális fájlok (általában a /dev alatt találhatók)

5

Fájlformátumok és konvenciók (/etc/fstab)

6

Játékok

7

Vegyes (makrócsomagok és konvenciók), például man(7), groff(7)

8

Rendszeradminisztrációs parancsok (általában csak a root számára;)

9

Kernelrutinok (nem szabványos)


Minden kézikönyvoldal több részből áll, ezek címkéje NAME, SYNOPSIS, DESCRIPTION, SEE ALSO, LICENSING és AUTHOR. A parancs fajtájától függően további kiegészítő részek is lehetnek.

35.3. Információs oldalak

Az információs oldalak is fontos információforrásnak számítanak a rendszeren belül. Általában részletesebb információt adnak, mint a kézikönyvoldalak. Egy adott parancs info oldalának megjelenítéséhez írja be az info utasítást, majd a parancs nevét, tehát például info ls. Az info oldalakat és annak egyes részeit, az úgynevezett csomópontokat (node) közvetlenül a parancsértelmezőben tekintheti meg egy megjelenítő programmal. A Szóköz billentyűvel léphet előre és a <— billentyűvel visszafelé. Egy adott csomóponton belül tallózhat a Page ↑ és Page ↓ billentyűkkel is, de csak a Szóköz és <— viszi át az előző ill. következő csomópontra. A megjelenítőből a Q megnyomásával léphet ki. Nem minden kézikönyvoldalhoz tartozik info oldal és fordítva.

35.4. openSUSE Wiki

Az openSUSE rendszerrel kapcsolatos különböző aspektusú, részletes információ található a Wikiben: http://en.opensuse.org. Bármely wikioldalt módosíthatja, vagy újakat hozhat létre. Ehhez regisztrációra, majd belépésre van szükség. A módosításhoz kattintson a Szerkesztés hivatkozásra.