.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "PO4A-BUILD.CONF 5"
.TH PO4A-BUILD.CONF 5 "2018-06-07" "Ferramentas do Po4a" "Ferramentas do Po4a"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NOME"
.IX Header "NOME"
po4a\-build.conf \- arquivo de configuração para compilação de conteúdo
traduzido
.SH "Introdução"
.IX Header "Introdução"
\&\fIpo4a\-build.conf\fR descreve como \f(CW\*(C`po4a\-build\*(C'\fR deveria compilar a
documentação traduzida e não traduzida de um conjunto de documentos fontes
não traduzidos e arquivos \s-1PO\s0 correspondentes.
.PP
Todo suporte a formatos, em todo suporte a combinações, podem ser
manipulados em um único arquivo de configuração \fIpo4a\-build.conf\fR e uma
única chamada a \f(CW\*(C`po4a\-build\*(C'\fR. Porém, você também pode escolher separar os
diretórios de \fIpo/\fR e ter um arquivo de configuração para cada execução
(chamar \f(CW\*(C`po4a\-build \-f ARQUIVO\*(C'\fR para cada um).
.PP
Note que apesar de \fIpo4a\-build\fR permitir adição de suporte gettext para
tradução mensagens de saída de script, o próprio \fIpo4a\-build.conf\fR não
comporta tais traduções. \fIpo4a\-build.conf\fR somente se relaciona a conteúdo
estático de tradução, como páginas de manual.
.PP
Para suporte do \fIpo4a\-build\fR a mensagens de tradução em tempo de execução,
veja \fIpo4a\-runtime\fR\|(7).
.SH "Formatos suportados"
.IX Header "Formatos suportados"
Atualmente, \f(CW\*(C`po4a\-build\*(C'\fR tem suporte às seguintes combinações:
.IP "DocBook \s-1XML\s0 para seções 1 e 3" 4
.IX Item "DocBook XML para seções 1 e 3"
Tipicamente usado para páginas de manual, para shell scripts ou outros
interpretadores que não possuem seu próprio formato de documentação, como
\&\s-1POD.\s0 Um \s-1XML\s0 adequado pode ser gerado diretamente de uma página de manual
existente usando \f(CW\*(C`doclifter\*(C'\fR(1) e \f(CW\*(C`po4a\-build\*(C'\fR, o que vai, então, gerar um
arquivo \s-1POT\s0 sem qualquer carga de trabalho extra. O arquivo \s-1POT\s0 pode ser
oferecido para tradução e os arquivos \s-1PO\s0 adicionados ao diretório \fIpo/\fR
relevante. \f(CW\*(C`po4a\-build\*(C'\fR vai, então, preparar não somente as páginas de
manual não traduzidas do \s-1XML\s0 do \f(CW\*(C`doclifter\*(C'\fR, mas também usa \f(CW\*(C`po4a\*(C'\fR para
preparar um \s-1XML\s0 traduzido dos arquivos \s-1PO\s0 e, traduzido, das páginas de
manual do \s-1XML.\s0
.Sp
Páginas de manual são geradas usando suporte a docbook-xsl \- a folha de
estilo usada pode ser alterada usando a definição de \f(CW\*(C`XSLFILE\*(C'\fR no arquivo
de configuração do \f(CW\*(C`po4a\-build\*(C'\fR.
.IP "DocBook \s-1XML\s0 para \s-1HTML\s0" 4
.IX Item "DocBook XML para HTML"
A folha de estilo padrão para preparar o \s-1HTML\s0 final pode ser alterada usando
a definição de \f(CW\*(C`HTMLXSL\*(C'\fR no arquivo de configuração \f(CW\*(C`po4a\-build\*(C'\fR.
.IP "\s-1POD\s0 para seções 1, 3, 5 e 7" 4
.IX Item "POD para seções 1, 3, 5 e 7"
pod2man é usado para converter o conteúdo de \s-1POD\s0 para cada uma das seções
que se tem suporte.
.Sp
Use \f(CW\*(C`PODFILE\*(C'\fR para seção 1, \f(CW\*(C`PODMODULES\*(C'\fR para seção 3, \f(CW\*(C`POD5FILES\*(C'\fR para
seção 5 e \f(CW\*(C`POD7FILES\*(C'\fR para seção 7.
.Sp
Para conteúdo nas seções 5 ou 7 (as quais tendem a precisar de um nome de
arquivo que também é usado para o conteúdo da seção 1), se o nome de arquivo
incluir a 5 ou 7 como parte do nome do arquivo, isso (e qualquer extensão do
nome do arquivo) será automaticamente retirado.
.Sp
ex.: para preparar \fI/usr/share/man/man7/po4a.7.gz\fR:
.Sp
.Vb 2
\& # arquivos POD para seção 7
\& POD7FILES="doc/po4a.7.pod"
.Ve
.SH "Conteúdos de arquivo"
.IX Header "Conteúdos de arquivo"
Valores de configuração podem aparecer em qualquer ordem no arquivo de
configuração.
.PP
Qualquer conteúdo depois de uma \*(L"#\*(R" é ignorado.
.PP
Qualquer valor que iria sempre ser vazio pode ser removido do arquivo.
.PP
Alguns campos de configuração são necessários \- \fIpo4a\-build\fR poderia acabar
com nada para fazer, se os campos necessários estivessem vazios.
.IP "\s-1CONFIG\s0" 4
.IX Item "CONFIG"
Necessário.
.Sp
Nome e localização do arquivo de configuração (temporário) do \f(CW\*(C`po4a\*(C'\fR que
\&\f(CW\*(C`po4a\-build\*(C'\fR vai gerar e manter. Esse arquivo não precisa ficar no seu
sistema de controle de versão e pode ser com segurança removido durante a
compilação do pacote.
.Sp
.Vb 2
\& # nome e localização do arquivo de configuração
\& CONFIG="_build/po4a.config"
.Ve
.IP "\s-1PODIR\s0" 4
.IX Item "PODIR"
Necessário.
.Sp
Diretório contendo os arquivos \s-1PO\s0 para \s-1TODAS\s0 as traduções manipuladas por
este arquivo de configuração. Todas as strings serão mescladas em um arquivo
\&\s-1POT\s0 neste diretório e todos os arquivos \s-1PO\s0 mesclados com este arquivo
\&\s-1POT.\s0 Qualquer limite em \s-1KEEP\s0 (veja abaixo) será aplicado em todas as strings
de arquivo de entrada especificados neste arquivo e todos arquivos \s-1PO\s0 neste
diretório. O diretório não precisa ser chamado de \*(L"po\*(R". Por favor, repare,
porém, que algumas ferramentas de estatísticas esperam que ele seja chamado
de \*(L"po\*(R" e, portanto, é recomendado deixar este nome.
.Sp
.Vb 2
\& # diretório po para páginas de manual/documentações
\& PODIR="po/pod"
.Ve
.IP "\s-1POTFILE\s0" 4
.IX Item "POTFILE"
Necessário.
.Sp
Caminho para o arquivo \s-1POT\s0 (relativo à localização deste arquivo de
configuração) que vai ser gerado, mantido e atualizado por \f(CW\*(C`po4a\-build\*(C'\fR
para essas traduções.
.Sp
.Vb 2
\& # caminho para o arquivo POT
\& POTFILE="po/pod/po4a\-pod.pot"
.Ve
.IP "\s-1BASEDIR\s0" 4
.IX Item "BASEDIR"
Necessário.
.Sp
Diretório base para escrever o conteúdo traduzido.
.Sp
.Vb 2
\& # diretório base para arquivos gerados, ex.: doc
\& BASEDIR="_build"
.Ve
.IP "\s-1BINARIES\s0" 4
.IX Item "BINARIES"
Necessário.
.Sp
Mesmo se apenas um pacote for compilado, pelo menos um valor é necessário
aqui.
.Sp
A própria string é arbitrária, mas normalmente consiste no nome do pacote. O
conteúdo gerado vai, então, aparecer em subdiretórios de
\&\fI\s-1BASEDIR/BINARIES\s0\fR:
.Sp
.Vb 1
\& _build/po4a/man/man1/foo.1
.Ve
.Sp
Se o pacote compila mais do que um pacote binário (isto é, um pacote fonte e
múltiplos arquivos .deb ou .rpm), este campo pode ajudar a isolar o conteúdo
pretendido, tornando mais fácil automatizar o processo de compilação.
.Sp
Separe as strings com um espaço.
.Sp
.Vb 2
\& # pacotes binários que vão conter as páginas de manual geradas
\& BINARIES="po4a"
.Ve
.IP "\s-1KEEP\s0" 4
.IX Item "KEEP"
Valor a ser passado diretamente para \f(CW\*(C`po4a \-k\*(C'\fR para especificar o limite
para o conteúdo corretamente traduzido antes de uma tradução em particular é
omitido da compilação. Deixe vazio ou remova para usar o padrão (80%) ou
especifique zero para forçar a inclusão de todo o conteúdo, mesmo se
completamente não traduzido.
.Sp
Para controle total sobre este comportamento, considere com cuidado quais
arquivos estão atribuídos para qual arquivo de configuração
\&\fIpo4a\-build.conf\fR.
.Sp
Note que ter muitos arquivos em um \s-1POT\s0 pode ser mais conveniente para
tradutores, especificamente se os arquivos possuem strings em comum. Por
outro lado, arquivos \s-1POT\s0 com milhares de strings longas são assustadores
para tradutores, resultando em congelamentos de strings mais longos.
.Sp
.Vb 2
\& # limite mínimo de porcentagem de tradução para se manter
\& KEEP=
.Ve
.IP "\s-1XMLMAN1\s0" 4
.IX Item "XMLMAN1"
Arquivos DocBook \s-1XML\s0 para gera páginas de manual na seção 1. Separe nomes de
arquivos com espaços. Todos os arquivos precisam estar no diretório \s-1XMLDIR.\s0
.Sp
É uma prática comum juntar vários arquivos \s-1XML\s0 em um livro, para fornecer
uma tabela de conteúdos etc. Se o livro contém arquivos também especificados
em \s-1XMLMAN3,\s0 apenas especifique os arquivos \s-1XML\s0 para seção 1 aqui, e não o
livro propriamente dito. Se o livro contém apenas o conteúdo para esta
seção, especifique apenas o arquivo do livro.
.Sp
.Vb 2
\& # arquivos DocBook XML para seção 1
\& XMLMAN1="po4a\-build.xml po4aman\-display\-po.xml po4apod\-display\-po.xml"
.Ve
.IP "\s-1XMLMAN3\s0" 4
.IX Item "XMLMAN3"
Arquivos DocBook \s-1XML\s0 para gerar páginas de manual na seção 3. Separe nomes
de arquivos com espaços. Todos arquivos precisam estar no diretório \s-1XMLDIR.\s0
.Sp
É uma prática comum juntar vários arquivos \s-1XML\s0 em um livro, para fornecer
uma tabela de conteúdos etc. Se o livro contém arquivos também especificados
em \s-1XMLMAN1,\s0 apenas especifique os arquivos \s-1XML\s0 para seção 3 aqui, e não o
livro propriamente dito. Se o livro contém apenas o conteúdo para esta
seção, especifique apenas o arquivo do livro.
.Sp
.Vb 2
\& # Arquivos DocBook XML para seção 3
\& XMLMAN3=""
.Ve
.IP "\s-1XMLDIR\s0" 4
.IX Item "XMLDIR"
Localização de todos os arquivos DocBook \s-1XML.\s0 Atualmente, \f(CW\*(C`po4a\-build\*(C'\fR
espera ser capaz de localizar todos os arquivos listados em \s-1XMLMAN1\s0 e
\&\s-1XMLMAN3\s0 ao procurar por arquivos *.xml neste diretório.
.Sp
Deve ser especificado, se \s-1XMLMAN1\s0 ou \s-1XMLMAN3\s0 forem usados. Caminhos são
relativos à localização do arquivo de configuração.
.Sp
.Vb 2
\& # localização dos arquivos XML
\& XMLDIR="share/doc/"
.Ve
.IP "\s-1XMLPACKAGES\s0" 4
.IX Item "XMLPACKAGES"
Quais pacotes, fora da lista de \s-1BINARIES,\s0 usam o conteúdo fonte do \s-1XML.\s0
.Sp
Se quaisquer valores forem passados em \s-1XMLMAN1\s0 ou \s-1XMLMAN3,\s0 um valor deve ser
passado aqui também.
.Sp
.Vb 2
\& # pacotes binários usando DocBook XML & xsltproc
\& XMLPACKAGES="po4a"
.Ve
.IP "\s-1DOCBOOKDIR\s0" 4
.IX Item "DOCBOOKDIR"
Similar a \s-1XMLDIR,\s0 mas usado apenas para preparar os arquivos DocBook
traduzidos. Se seu pacote quer usar arquivos .sgml, por favor discuta como
eles deveriam ser compilados na lista de discussão po4a\-devel.
.Sp
.Vb 2
\& # padrão para localizar os arquivos .docbook
\& DOCBOOKDIR=""
.Ve
.IP "\s-1XSLFILE\s0" 4
.IX Item "XSLFILE"
Folha de estilo \s-1XSL\s0 usado para preparar o conteúdo traduzido e não traduzido
dos arquivos DocBook \s-1XML.\s0
.Sp
.Vb 2
\& # arquivo XSL a ser usado para DocBook XML
\& XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
.Ve
.IP "\s-1PODFILE\s0" 4
.IX Item "PODFILE"
Arquivos \s-1POD\s0 para gerar conteúdo de página de manual files na seção
1. Separe arquivos \s-1POD\s0 com espaços. Caminhos, se usados, precisam ser
relativos à localização do arquivo de configuração especificado.
.Sp
.Vb 2
\& # arquivos POD para seção 1
\& PODFILE="po4a po4a\-gettextize po4a\-normalize scripts/msguntypot"
.Ve
.IP "\s-1PODMODULES\s0" 4
.IX Item "PODMODULES"
Suporte especializado para módulos Perl contendo conteúdo \s-1POD\s0 \- o nome do
módulo vai ser reconstruído a partir do caminho (então, ele deveria ser um
layout Perl comum) e páginas de manual são colocadas automaticamente na
seção 3.
.Sp
.Vb 2
\& # arquivos POD para seção 3 \- nomes de módulo gerados novamente a partir do caminho
\& PODMODULES="lib/Locale/Po4a/*.pm"
.Ve
.IP "\s-1POD5FILES\s0" 4
.IX Item "POD5FILES"
Conteúdo \s-1POD\s0 arbitrário para usar ao gerar páginas de manual para seção
5. Caminhos, se usados, precisam ser relativos à localização do arquivo de
configuração especificado.
.Sp
Para conteúdo nas seções 5 ou 7 (as quais tendem a precisar de um nome de
arquivo que também é usado para o conteúdo da seção 1), se o nome de arquivo
incluir a 5 ou 7 como parte do nome do arquivo, isso (e qualquer extensão do
nome do arquivo) será automaticamente retirado.
.Sp
.Vb 2
\& # arquivos POD para seção 5
\& POD5FILES="doc/po4a\-build.conf.5.pod"
.Ve
.IP "\s-1POD7FILES\s0" 4
.IX Item "POD7FILES"
Conteúdo \s-1POD\s0 arbitrário para usar ao gerar páginas de manual para seção
7. Caminhos, se usados, precisam ser relativos à localização do arquivo de
configuração especificado.
.Sp
Para conteúdo nas seções 5 ou 7 (as quais tendem a precisar de um nome de
arquivo que também é usado para o conteúdo da seção 1), se o nome de arquivo
incluir a 5 ou 7 como parte do nome do arquivo, isso (e qualquer extensão do
nome do arquivo) será automaticamente retirado.
.Sp
.Vb 2
\& # arquivos POD para seção 7
\& POD7FILES="doc/po4a.7.pod"
.Ve
.IP "\s-1PODPACKAGES\s0" 4
.IX Item "PODPACKAGES"
Similar a \s-1XMLPACKAGES\s0 \- qualquer pacote esperando conteúdo ser compilado de
arquivos \s-1POD\s0 precisa incluir um valor em \s-1PODPACKAGES.\s0 Necessário se
quaisquer valores forem especificados para \s-1PODFILE, PODMODULES, POD5FILES\s0 ou
\&\s-1POD7FILES.\s0
.Sp
.Vb 2
\& # pacotes binários usando POD
\& PODPACKAGES="po4a"
.Ve
.IP "\s-1HTMLDIR\s0" 4
.IX Item "HTMLDIR"
Subdiretório de \s-1BASEDIR\s0 a ser usado para enviar a saída em \s-1HTML\s0 traduzido ou
não traduzido.
.Sp
.Vb 2
\& # saída HTML (subdiretório de BASEDIR)
\& HTMLDIR=""
.Ve
.IP "\s-1HTMLFILE\s0" 4
.IX Item "HTMLFILE"
Arquivo DocBook a ser convertido em \s-1HTML\s0 (pode ser o mesmo que um dos
arquivos em \s-1XMLMAN1\s0 ou \s-1XMLMAN3\s0). Seções não são relevantes para saída
\&\s-1HTML.\s0 Então, sinta-se à vontade para usar o arquivo único de livro de forma
que o \s-1HTML\s0 tenha tabela de conteúdos etc.
.Sp
.Vb 2
\& # HTML DocBook file
\& HTMLFILE=""
.Ve
.IP "\s-1HTMLXSL\s0" 4
.IX Item "HTMLXSL"
O padrão é usar uma folha de estilo \s-1XSL\s0 fragmentada. Atualmente não há
suporte a usar mais de uma folha de estilo por \s-1HTML.\s0
.Sp
.Vb 2
\& # arquivo XSL para usar para HTML
\& HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"
.Ve
.SH "AUTORES"
.IX Header "AUTORES"
.Vb 1
\& Neil Williams <linux@codehelp.co.uk>
.Ve