FreeBSD kézikönyv
Előző | Fejezet 24. A FreeBSD frissítése és frissen tartása | Következő

# 24.4. A dokumentáció frissítése

Az alaprendszer és a Portgyűjtemény mellett a dokumentáció is a FreeBSD operációs rendszer szerves részét képezi. Noha a FreeBSD dokumentációjának legfrissebb változata folyamatosan elérhető a FreeBSD honlapjáról, egyes felhasználók ezt csak lassan vagy nem képesek folyamatosan elérni. Szerencsére egy helyi másolat megfelelő karbantartásával az egyes kiadásokhoz tartozó dokumentáció is frissíthető.

## 24.4.1. A dokumentáció frissítése CVSup használatával

A FreeBSD telepített dokumentációjának forrásai az alaprendszeréhez hasonlóan (lásd 24.7 Szakasz) a CVSup segítségével frissíthetőek. Ebben a szakaszban megismerhetjük:

- hogyan telepítsük a dokumentáció előállításához szükséges eszközöket, amelyekkel a forrásokból újra tudjuk generálni a FreeBSD dokumentációját;

- hogyan töltsük le a dokumentáció forrását CVSup segítségével a `/usr/doc` könyvtárba;

- a dokumentáció előállításához alkalmazott rendszer milyen beállításokkal rendelkezik, vagyis hogyan korlátozzuk a generálást bizonyos nyelvekre vagy formátumokra.

## 24.4.2. A CVSup és a dokumentációs eszközök telepítése

Viszonylag sokféle eszközre lesz szükségünk, ha a FreeBSD dokumentációját a forrásokból akarjuk előállítani. Ezek az segédprogramok nem részei a FreeBSD alaprendszerének, mivel alapvetően nagyon sok helyet foglalnak el, és leginkább olyan FreeBSD felhasználók számára fontosak, akik folyamatosan a dokumentációval dolgoznak vagy gyakran frissítik azt forrásból.

A feladathoz szükséges összes eszköz elérhető a Portgyűjteményből. Ebben a FreeBSD Dokumentációs Projekt összeállított egy `textproc/docproj` nevű portot, amellyel az említett programok telepítését és frissítését igyekezték megkönnyíteni.

> Megjegyzés: Ha nem tartunk igényt a dokumentáció PostScript® vagy PDF változatára, akkor ehelyett inkább érdemes megfontolnunk a `textproc/docproj-nojadetex` port telepítését. Ebben a változatban a teTeX betűszedő rendszer kivételével az összes segédprogram megtalálható. Mivel a teTeX önmagában nagyon sok segédeszköz telepítését jelenti, ezért amennyiben a PDF változat ténylegesen nem szükséges, érdemes eltekinteni a telepítésétől.

A CVSup telepítésével kapcsolatban pedig részletesebb információkat a CVSup használatával foglalkozó szakaszban olvashatunk.

## 24.4.3. A dokumentáció forrásának frissítése

A `/usr/share/examples/cvsup/doc-supfile` konfigurációs állomány segítségével a CVSup képes letölteni a dokumentáció forrásállományainak legfrissebb példányait. Itt a frissítést alapértelmezés szerint egy nem létező géptől fogjuk kérni (mivel ezt kötelező kitölteni), azonban a cvsup(1) programnak egy parancssori paraméter segítségével megadhatjuk melyik CVSup szerverről töltse le a forrásokat:

    # cvsup -h cvsup.FreeBSD.org -g -L 2 /usr/share/examples/cvsup/doc-supfile

Ne felejtsük el a `cvsup.FreeBSD.org` helyére beírni a hozzánk földrajzilag legközelebb elhelyezkedő CVSup szervert. Ezek teljes listáját a A.6.7 Szakasz tartalmazza.

Egy ideig eltarthat, amíg először letöltjük a forrásokat. Várjuk meg türelmesen, amíg befejeződik a művelet.

Később a forrásokat ugyanezzel a paranccsal tudjuk frissíteni. A CVSup ugyanis mindig csak a legutóbbi futtatása óta történt változásokat tölti le, ezért később már ez a lépés jelentősen felgyorsulhat.

A források letöltése után a dokumentációt például az ekkor keletkezett `/usr/doc` könyvtárban található `Makefile` használatával állíthatjuk elő. Tehát miután az `/etc/make.conf` állományban beállítottuk a `SUP_UPDATE`, `SUPHOST` és `DOCSUPFILE` változókat, le tudjuk futtatni a következő parancsot:

    # cd /usr/doc
    # make update

Az előbb említett make(1) változók jellemző értékei:

    SUP_UPDATE= yes
    SUPHOST?= cvsup.freebsd.org
    DOCSUPFILE?= /usr/share/examples/cvsup/doc-supfile

> Megjegyzés: Mivel a `SUPHOST` és a `DOCSUPFILE` változók értékét a `?=` szimbólummal állítottuk be, lehetőségünk van a parancssorból ezeknek más értékeket adni. Az `/etc/make.conf` állományba általában így érdemes felvenni a változókat, így nem kell minden alkalommal módosítani, amikor valamilyen új beállítást akarunk kipróbálni.

## 24.4.4. A dokumentáció különböző beállításai

A FreeBSD dokumentációjához tartozó, frissítést és előállítást végző rendszernek van néhány olyan beállítása, amelyekkel kérhetjük kizárólag csak a dokumentáció egyes részeinek frissítését vagy bizonyos kimeneti formátumok használatát. Ezek vagy globálisan az `/etc/make.conf` állományban, vagy pedig a parancssorból, a make(1) program paramétereként adhatóak meg.

Ízelítőül néhány közülük:

`DOC_LANG`

  Az előállítandó és telepítendő nyelvű dokumentáció felsorolása, tehát például csak az angol dokumentáció esetén ez `en_US.ISO8859-1`.

`FORMATS`

  Az előállítandó dokumentáció kimeneti formátumainak felsorolása. Itt pillanatnyilag értékként a `html`, `html-split`, `txt`, `ps`, `pdf` és `rtf` jelenhet meg.

`SUPHOST`

  A frissítéshez használt CVSup szerver hálózati neve.

`DOCDIR`

  Az elkészült dokumentáció telepítésének helye. Ez alapértelmezés szerint a `/usr/share/doc`.

A folyamathoz kapcsolódóan további rendszerszintű make(1) változókról a make.conf(5) man oldalon olvashatunk.

A FreeBSD dokumentációjának előállításáért felelős rendszerben használható make(1) további változók bemutatásával kapcsolatban pedig olvassuk el az A FreeBSD Dokumentációs Projekt irányelvei kezdőknek című könyvet.

## 24.4.5. A FreeBSD dokumentációjának telepítése forrásból

Miután sikerült letöltenünk a `/usr/doc` könyvtárba a dokumentáció legfrissebb forrásait, készen állunk a rendszerünkön telepített példány frissítésére.

A `DOCLANG` értékeként megadott nyelven készült dokumentációkat a következő paranccsal tudjuk frissíteni:

    # cd /usr/doc
    # make install clean

Ha a `make.conf` állományban korábban már megadtuk a `DOCSUPFILE`, `SUPHOST` és `SUP_UPDATE` változók értékeit, akkor a telepítés fázisa könnyedén össze is vonatható a források frissítésével:

    # cd /usr/doc
    # make update install clean

Ha pedig csak bizonyos nyelvekhez tartozó dokumentációt szeretnénk frissíteni, akkor a make(1) akár a `/usr/doc` könyvtáron belül az egyes nyelvekhez tartozó alkönyvtárakon belül is meghívható, például:

    # cd /usr/doc/en_US.ISO8859-1
    # make update install clean

A dokumentáció formátumát a `FORMATS` változó felhasználásával tudjuk meghatározni:

    # cd /usr/doc
    # make FORMATS='html html-split' install clean

Előző | Tartalom | Következő
A Portgyűjtemény frissítése a Portsnap használatával | Fel | A fejlesztői ág követése

Ha kérdése van a FreeBSD-vel kapcsolatban, a következő címre írhat (angolul): <freebsd-questions@FreeBSD.org>.
Ha ezzel a dokumentummal kapcsolatban van kérdése, kérjük erre a címre írjon: <gabor@FreeBSD.org>.