Ha most csak a legalapvetőbb ismeretekre van szükségünk, és a részletekkel csupán később akarunk majd foglalkozni, akkor az alábbi utasítások alapján javasolt elindulni:
Telepítsük a textproc/docproj metaportot:
#
cd /usr/ports/textproc/docproj
#
make JADETEX=no install
Készítsünk egy helyi másolatot a
FreeBSD forrásának doc
könyvtáráról. Erre megfelel a
CVSup checkout
módja vagy a repository teljes tartalmának
letöltése.
Egy használható helyi másolathoz
legalább a doc/share
és
doc/en_US.ISO8859-1/share
könyvtárakat kell kikérnünk:
%
cvs checkout doc/share
%
cvs checkout doc/en_US.ISO8859-1/share
Ha viszont sok tárhellyel rendelkezük, akkor akár mindent kikérhetünk:
%
cvs checkout doc
Amikor egy korábban felrakott könyvhöz vagy cikkhez készítünk módosításokat, előtte kérjük ki a repositoryból. Ha egy új könyvet vagy cikket szeretnék beküldeni, akkor építkezzünk a meglevőekből.
Tegyük fel például, hogy írtunk egy cikket a FreeBSD és Windows® 2000 rendszerek közti VPN-hálózatok létrehozásáról:
Kérjük ki az articles
könyvtár tartalmát.
%
cvs checkout doc/en_US.ISO8859-1/articles
Másoljunk le valamelyik cikket és
használjuk fel sablonként. Most úgy
döntöttük, hogy az új cikket a
vpn-w2k
könyvtárba
helyezzük el:
%
cd doc/en_US.ISO8859-1/articles
%
cp -R committers-guide vpn-w2k
Ha viszont egy már létező dokumentumot
akarunk szerkeszteni, például a GYIK-ot, akkor
kérjük ki azt a könyvtárat, amelyikben
található. Ez ebben az esetben a
doc/en_US.ISO8859-1/books/faq
:
%
cvs checkout doc/en_US.ISO8859-1/books/faq
A könyvtárban található
.xml
állományokat
írjuk át a kedvenc
szövegszerkesztőnkkel.
A forrásban használt jelölőket a
lint
cél
segítségével ellenőrizhetjük.
Ilyenkor anélkül tudjuk megtalálni a
dokumentum forrásában rejtőző
hibákat, hogy ténylegesen el kellene
végeznünk azok időigényes
átalakítását:
%
make lint
Amikor viszont valóban le akarjuk
generáltatni a dokumentumot, a FORMATS
változóban tudjuk felsorolt a kért
formátumokat. Itt jelen pillanatban a
html
, html-split
,
txt
, ps
,
pdf
és rtf
értékeket szerepeltethetjük. A
támogatott formátumok legfrissebb
listáját mellesleg a
doc/share/doc.docbook.mk
állományban találhatjuk meg. Ha
egyszerre több formátumot kértünk,
akkor ne felejtsük el idézőjelek
közé tenni a felsorolást.
Például így lehet egy dokumentumot
csak html
formátumra
alakítani:
%
make FORMATS=html
Ha viszont egyszerre szeretnénk a
dokumentumból html
és
txt
formátumot létrehozatni,
akkor megtehetjük azt két külön
make(1) paranccsal:
%
make FORMATS=html
%
make FORMATS=txt
Vagy egyetlen paranccsal:
%
make FORMATS="html txt"
Küldjük be a módosításainkat a send-pr(1) használatával.
Ha kérdése van a FreeBSD-vel kapcsolatban, a
következő címre írhat (angolul):
<questions@FreeBSD.org>.
Ha ezzel a dokumentummal kapcsolatban van kérdése, kérjük erre a címre írjon:
<gabor@FreeBSD.org>.