2.5. As ferramentas DOC-BR

Trataremos aqui apenas das ferramentas criadas e utilizadas constantemente pelo DOC-BR. Tratam-se dos arquivos disponíveis sob o módulo tools/ no repositório CVS. Já vimos o que são e o que fazem esses arquivos, agora vamos aprender a usá-los.

2.5.1. A ferramenta fdp.pl

O fdp.pl como já mencionado, pega o arquivo SGML na saída padrão e retorna o mesmo conteúdo, porém tratado/modificado na saída. Portanto, como o resultado vai para saída padrão (stdout) ele deve ser redirecionado a um outro arquivo temporário. Use-o da seguinte forma:

% cp arquivo.sgml arquivo.sgml.bk
% /caminho/para/fdp.pl arquivo.sgml > arquivo.sgml.novo

Analise o conteúdo na tela (mensagens de alerta) e o novo arquivo gerado, arquivo.sgml.novo. Estando ok, renomei-o para o arquivo original:

% mv arquivo.sgml.novo arquivo.sgml

Não se esqueça de fazer backup do arquivo antes (comando cp(1)).

Acompanhe exemplo prático de uso dessa ferramenta:

Exemplo 2-6. Exemplo de uso do fdp.pl

% cp book.sgml book.sgml.bkp
% ~/CVS_ROOT/DOC-BR/tools/scripts/fdp.pl book.sgml > book.sgml.novo

[..]
ATENCAO: A linha 598 tem mais de 70 colunas tem 72 colunas
ATENCAO: A linha 599 tem mais de 70 colunas tem 73 colunas
ATENCAO: A linha 600 tem mais de 70 colunas tem 74 colunas
ATENCAO: A linha 603 tem mais de 70 colunas tem 81 colunas
ATENCAO: A linha 622 tem mais de 70 colunas tem 79 colunas

Total de 9 linha(s) alterada(s) no arquivo book.sgml
%
% mv book.sgml.novo book.sgml

2.5.2. Ferramenta sed(1) em conjunto com acentos.sed

acentos.sed é usado como arquivo de parâmetros para o sed(1) (usado com a opção -f). Seu uso é similar ao fdp.pl pois o sed(1) também receberá o arquivo original como entrada e gerará o resultado na saída padrão. Portanto para usá-lo faça como no exemplo:

Exemplo 2-7. Exemplo de uso do acentos.sed

% sed -f ~/CVS_ROOT/DOC-BR/tools/scripts/acentos.sed book.sgml > book.sgml.novo
% mv book.sgml.novo book.sgml

2.5.3. Configurando o vim(8) com as ferramentas FDP

XXX pendente. Preciso levantar essas informações com quem usa o vim(8).

2.5.4. Outras ferramentas no módulo tools/

Os outros arquivos, grep.sh, man.sh, unman.sh e space2tab.sh são rotinas para verificar e corrigir os ítens das regras do FDP, mas separados, para análises independentes. Normalmente são usados apenas por revisores mais minuciosos, já que as funções desempenhadas por estes são todas desempenhadas também pelo fdp.pl. Portanto dê preferência por usar o fdp.pl.

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>.