PO4A-BUILD(1)

NOME
po4a-build - Documentação traduzida de construção

SINOPSE

po4a-build [-f | --ficheiro FICHEIRO] [--pot-apenas]

po4a-build [-? | -h | --Ajuda | --versão]

DESCRIÇÃO

po4a-build tem a intenção de tornar muito fácil de exibir como pode ser documentação traduzida para produzir o conteúdo atual sem tradução.

Quando po4a prepara o conteúdo traduzido como POD ouDocBook XML, a documentação final pode então ser construída usandopo4a-build.Tanto o conteúdo sem tradução e traduzidoé construído como um único processo, atualizando os arquivos POT ao mesmo tempo.

Instruções de construção existentes são substituídas por uma única chamada para po4a-build e um ficheiro de configuração simples é usado para dizer po4a-build como formar cada elemento e que pacotes binários irá incluir o conteúdo traduzido e sem tradução.

Uma vez construído, o conteúdo estará no pacote de diretórios específicos sob o BASEDIR especificado no arquivo de configuração. Para um pacote binário foo, com traduções para o Alemão e Francês, isso resultaria em:

    BASEDIR/foo/man/man1/foo.1
    BASEDIR/foo/man/de/man1/foo.1
    BASEDIR/foo/man/fr/man1/foo.1

Isto torna mais fácil para incluir todo o conteúdo gerado no pacote binário com um único local de instalação:

    doc/foo/man/* ./usr/share/man/
    doc/foo/html/* ./usr/share/doc/foo/

Esta regra não precisa de ser atualizada quando novas traduções são adicionadas e adicionando um segundo pacote binário (bar) permite que o conteúdo para esse pacote seja mantido separado.

  Formatos Suportados

Atualmente, po4a-build suporta as seguintes combinações:

    1. DocBook XML para a parte 1.

    2. DocBook XML para a parte 3.

    3. DocBook XML para HTML.

    4. POD para a parte 1.

    5. POD para a parte 3.

    6. POD para a parte 5.

    7. POD para a parte 7.

Todos os formatos suportados, em todas as combinações suportadas, podem ser tratados em uma simples po4a build.conf-file configuração e em uma única chamada para po4a-build. Veja po4a-build.conf(5).

CONFIGURAÇÃO

po4a-build usa um arquivo de configuração padrão, po4a-build.conf que deve estar no diretório de nível mais alto do seu pacote VCS. (Use a -f opçãopara especificar um ficheiro diferente.) Ver po4a-build.conf(5).

Exemplo 1. exemplo de um ficheiro de configuração

Um exemplo de um ficheiro de configuração está disponível em:

    /usr/share/doc/po4a/examples/po4a-build.conf.example

  Apresentação de um ficheiro de configuração

O ficheiro de configuração é composto, em geral, por várias secções, suporte XML/XSL para apoio, POD e HTML.

Geralmente inclui o nome e a localização do ficheiro de configuração po4a (provavelmente o melhor é deixar isso como po4a.config), o diretório po contendo a documentação dos ficheiros PO (muitas vezes doc/po), o nome completo do ficheiro POT usado para criar as traduções, o BASEDIR para a saída gerada, se o pacote contém páginas do manual na secção 3 em vez de apenas a secção 1 e os nomes dos pacotes binários que devem conter a saída gerada.

O suporte XML/XSL inclui a especificação de que os pacotes binários usam suporte XSL na variável XMLPACKAGES, o ficheiro de nível superior DocBook para passar xsltproc e da localização dos ficheiros XML ou DocBook. O XSLFILE A pode ser substituído, se necessário.

O suporte POD inclui a especificação de que os pacotes binários usam o suporte POD na variável PODPACKAGES e o nome completo do ficheiro POD.

O suporte HTML especifica o subdiretório para criar abaixo do BASEDIR para o conteúdo HTML sem tradução e traduzido e o ficheiro DocBook para gerar o HTML.O ficheiro HTMLXSL pode ser substituído, se necessário.

COMANDOS

--pot-only
    As atualizações apenas do ficheiro(s) POT. --pot-only destinam-se a suportar pacotes, incluindo todos os ficheiros POT do pacote de origem. Pacotes usando Autotools podem facilmente adicionar ficheiro(s) POT via EXTRA_DIST mas os pacotes que usam apenas um Makefile ou certos ajudantes de construção VCS podem achar que é estranho adicionar o ficheiro POT (que é um ficheiro gerado), sem colocarem o ficheiro POT na VCS. Para evitar esse trabalho feio e desnecessário, po4a-build pode atualizar o ficheiro(s) POT no início da construção, para que dpkg-source os inclua na fonte tarball.

    Exemplo 2. exemplo de svn-buildpackage

    svn-buildpackage tem suporte explícito para esse tipo de adição, usando a useNativeDist propriedade SVN e tornar o destinonativo-dist.

        # Adiciona o ficheiro POT para a fonte tarball
        native-dist: Makefile
        	po4a-build --pot-only

        $ svn propset useNativeDist 1 debian

-h|--help
    imprimir a mensagem de uso e sair.

--versão
    print the script version and exit.

OPÇÕES

-f|--file FILE
    Substituir o po4a-build ficheiro de configuração padrão (po4a-build.conf) e fornecer o seu próprio.

AUTOR

po4a-build foi escrito por Neil Williams <codehelp@debian.org>.

Esta página do manual foi escrita por Neil Williams <codehelp@debian.org>