1.3. Início Rápido

Se você deseja ir começando, e se sente seguro de que pode ir pegando as coisas à medida que avança, siga estas instruções.

  1. Instale o meta-port textproc/docproj.

    # cd /usr/ports/textproc/docproj
    # make JADETEX=no install
  2. Obtenha uma cópia local da árvore de documentação do FreeBSD (doc) utilizando o svn.

    Se a velocidade da sua conexão ou se o espaço de armazenamento do seu disco local forem motivo de preocupação, o mínimo que você vai precisar será uma cópia de trabalho dos diretórios head/share, e head/idioma/share . Por exemplo:

    % mkdir -p head/share
    % mkdir -p head/en_US.ISO8859-1/share
    % svn checkout svn://svn.FreeBSD.org/doc/head/share head/share
    % svn checkout svn://svn.FreeBSD.org/doc/head/en_US.ISO8859-1/share head/en_US.ISO8859-1/share

    Se você tiver abundância de espaço em disco, você pode retirar uma cópia de trabalho completa (de todos os subdiretórios da árvore doc).

    % svn checkout svn://svn.FreeBSD.org/doc/head head
  3. Se você está preparando uma alteração de um artigo ou livro existente, retire uma versão de trabalho do arquivo do repositório. Se você está planejando contribuir com um novo livro ou artigo, então utilize um dos existentes como guia.

    Por exemplo, se você deseja contribuir com um novo artigo sobre como configurar uma VPN entre o FreeBSD e o Windows 2000, você pode fazer o seguinte:

    1. Retire uma cópia de trabalho do diretório articles.

      % svn checkout svn://svn.FreeBSD.org/doc/head/en_US.ISO8859-1/articles
    2. Copie um artigo existente para utilizar como template. Neste caso, você decidiu que o seu novo artigo iria para um diretório chamado vpn-w2k.

      % cd head/en_US.ISO8859-1/articles
      % svn export committers-guide vpn-w2k

    Se você deseja editar um documento existente, como por exemplo o FAQ, o qual está em head/en_US.ISO8859-1/books/faq, você deve retirar a cópia de trabalho do repositório da seguinte forma:

    % svn checkout svn://svn.FreeBSD.org/doc/head/en_US.ISO8859-1/books/faq
  4. Edite os arquivos .xml utilizando o editor da sua preferência.

  5. Teste a marcação SGML utilizando o alvo lint com o comando make. Isto irá listar rapidamente qualquer erro existente no documento sem realizar qualquer tipo de transformação no seu arquivo, o que consumiria tempo.

    % make lint

    Quando você estiver pronto para efetivamente compilar o documento, você pode especificar um único formato ou uma lista de formatos de destino, na variável FORMATS. Atualmente os formatos suportados são, html, html-split, txt, ps, pdf, e rtf. A lista mais atualizada dos formatos suportados está listada no início do arquivo head/share/mk/doc.docbook.mk. Certifique-se de utilizar aspas (") em volta da lista de formatos quando você estiver compilando mais de um formato num único comando.

    Por exemplo, para converter o documento apenas para html, você deve utilizar:

    % make FORMATS=html

    Mas quando você deseja converter o documento tanto para o formato html quanto para o formato txt, você pode utilizar duas execuções separadas do make(1), como a seguir:

    % make FORMATS=html
    % make FORMATS=txt

    ou, você pode fazer isso em um único comando:

    % make FORMATS="html txt"
  6. Envie suas alterações utilizando o send-pr(1).

Este, e outros documentos, podem ser obtidos em ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/

Para perguntas sobre FreeBSD, leia a documentação antes de contatar <questions@FreeBSD.org>.

Para perguntas sobre esta documentação, envie e-mail para <doc@FreeBSD.org>.