Ако просто искате да започвате и се чувствате уверени, че ще разберете нещата докато четете, следвайте тези инструкции.
Инсталирайте textproc/docproj meta-port.
# cd /usr/ports/textproc/docproj # make JADETEX=no install
Изтеглете локално копие на FreeBSD doc дървото. Използвайте CVSup или checkout метод, или вземете пълно копие на CVS хранилището.
Ако имате локално копие на хранилището, като минимум трябва да изтеглите doc/share, и doc/en_US.ISO8859-1/share директории.
% cvs checkout doc/share % cvs checkout doc/en_US.ISO8859-1/share
Ако имате достатъчно дисково пространство можете да изтеглите всичко.
% cvs checkout doc
Ако смятате да променяте съществуваща книга или статия, изтеглете я от хранилището. Ако смятате да създавате нова книга или статия, използвайте съществуваща като пример.
Например, ако смятате да създадете нова статия за инсталиране на VPN (виртуална частна мрежа) между FreeBSD и Windows 2000 можете да направите следното.
Изтеглете articles директория.
% cvs checkout doc/en_US.ISO8859-1/articles
Копирайте съществуваща статия като шаблон. В този случай ще решим, че новата статия се намира в директория vpn-w2k .
% cd doc/en_US.ISO8859-1/articles % cp -r committers-guide vpn-w2k
Ако искате да редактирате съществуващ документ, като FAQ, който се намира в doc/en_US.ISO8859-1/books/faq трябва да го изтеглите от хранилището.
% cvs checkout doc/en_US.ISO8859-1/books/faq
Редактирайте .sgml файловете с помощта на редактор по избор.
Проверете маркирането като използвате lint цел. Така бързо ще откриете грешки в документа, без да извършвате отнемащото време трансформиране.
% make lint
Когато сте готови да изградите (компилирате) документа можете да зададете само един изходен формат или списък формати като използвате FORMATS променлива. В момента се поддържат само html, html-split, txt, ps, pdf, и rtf. По-нов списък с формати е показан в началото на doc/share/mk/doc.docbook.mk файл. Използвайте кавички около списъка с формати когато изграждате повече от един формат с една команда.
Например, за да конвертирате документа само към html , трябва да използвате:
% make FORMATS=html
Но, ако искате да получите едновременно html и txt формати, можете да използвате или две различни команди make(1) така:
% make FORMATS=html % make FORMATS=txt
или само една команда :
% make FORMATS="html txt"
Изпратете промените които сте направили с помощта на send-pr(1).
Този и други документи можете да намерите в ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.
За въпроси отностно FreeBSD, прочетете
документацията
преди да попитате в <questions@FreeBSD.org>.
За въпроси отностно този документ, e-mail <doc@FreeBSD.org>.