Если вы просто хотите начать что-то делать и чувствуете уверенность, что можете разобраться со всем самостоятельно, следуйте следующим указаниям.
установите мета-порт textproc/docproj.
# cd /usr/ports/textproc/docproj # make JADETEX=no install
Создайте локальную копию дерева doc FreeBSD. Для этого воспользуйтесь CVSup в режиме checkout либо создайте полную локальную копию хранилища CVS.
Если у ас имеется локальное хранилище 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>.
По вопросам, связанным с этой документацией, пишите <doc@FreeBSD.org>.
По вопросам, связанным с русским переводом документации, пишите в рассылку <frdp@FreeBSD.org.ua>.
Информация по подписке на эту рассылку находится на сайте проекта перевода.