.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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-02" "Herramientas de po4a" "Herramientas de 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 "NOMBRE"
.IX Header "NOMBRE"
po4a\-build.conf \- Fichero de configuración para construir contenido
traducido
.SH "Introducción"
.IX Header "Introducción"
\&\fIpo4a\-build.conf\fR describe cómo \f(CW\*(C`po4a\-build\*(C'\fR debe construir la
documentación original y traducida a partir de un conjunto de documentos
originales y sus correspondientes ficheros \s-1PO.\s0
.PP
Puede gestionar todos los formatos compatibles en todas la combinaciones
aceptadas con un solo fichero de configuración \fIpo4a\-build.conf\fR y una sola
invocación a \f(CW\*(C`po4a\-build\*(C'\fR. Por otro lado, también puede escoger separar los
directorios \fIpo/\fR y usar un fichero de configuración cada vez (invoque
\&\f(CW\*(C`po4a\-build \-f fichero\*(C'\fR para cada uno de ellos).
.PP
Tenga en cuenta que a pesar de que \fIpo4a\-build\fR posibilita añadir la
compatibilidad gettext con la traducción de los mensajes de salida de
scripts, \fIpo4a\-build.conf\fR no tiene constancia de tales
traducciones. \fIpo4a\-build.conf\fR sólo se remite a traducir contenido
estático como páginas de manual.
.PP
Consulte \fIpo4a\-runtime (7)\fR para ver la compatibilidad de
\&\fI\fIpo4a\-runtime\fI\|(7)\fR con mensajes en tiempo de ejecución.
.SH "Formatos compatibles"
.IX Header "Formatos compatibles"
A día de hoy, \f(CW\*(C`po4a\-build\*(C'\fR es compatible con las siguientes combinaciones:
.IP "DocBook \s-1XML\s0 en las secciones 1 y 3." 4
.IX Item "DocBook XML en las secciones 1 y 3."
Generalmente usado por las páginas de manual, scripts de consola u otros
intérpretes que no tienen un formato de documentación como \s-1POD.\s0 Puede
generar \s-1XML\s0 a partir de una página de manual existente con \f(CW\*(C`doclifter\*(C'\fR(1),
tras lo cual \f(CW\*(C`po4a\-build\*(C'\fR generará un fichero \s-1POT\s0 sin más carga en el
proceso. El fichero \s-1POT\s0 puede así ofrecerse para su traducción, y añadirá
los ficheros \s-1PO\s0 al directorio \fIpo/\fR apropiado. Llegado a este punto,
\&\f(CW\*(C`po4a\-build\*(C'\fR no solo preparará la página de manual original a partir del
fichero \s-1XML\s0 y \f(CW\*(C`doclifter\*(C'\fR, sino que también usará \f(CW\*(C`po4a\*(C'\fR para preparar el
\&\s-1XML\s0 traducido a partir de los ficheros \s-1PO,\s0 generando por último las páginas
de manual construidas a partir del \s-1XML.\s0
.Sp
Las páginas de manual se generan con la compatibilidad predefinida en
docbook-xsl. Puede invalidar la hoja de estilo usando el elemento de
configuración \f(CW\*(C`XSLFILE\*(C'\fR en el fichero de configuración de \f(CW\*(C`po4a\-build\*(C'\fR.
.IP "DocBook \s-1XML\s0 para \s-1HTML\s0" 4
.IX Item "DocBook XML para HTML"
Puede usar la hoja de estilo predefinida usada para preparar el \s-1HTML\s0 final
(o lo puede invalidar con el elemento de configuración <\s-1HTMLXSL\s0> en el
fichero de configuración \f(CW\*(C`po4a\-build\*(C'\fR).
.IP "\s-1POD\s0 para las secciones 1, 3, 5 y 7" 4
.IX Item "POD para las secciones 1, 3, 5 y 7"
pod2man se usa para la conversión de contenido \s-1POD\s0 para cada una de las
secciones compatibles.
.Sp
Use \f(CW\*(C`PODFILE\*(C'\fR para la sección 1, \f(CW\*(C`PODMODULES\*(C'\fR para la sección 3,
\&\f(CW\*(C`POD5FILES\*(C'\fR para la sección 5 y \f(CW\*(C`POD7FILES\*(C'\fR para la sección 7.
.Sp
Si un nombre de fichero incluye el 5 o el 7, con contenido para las
secciones 5 o 7 (que generalmente necesita un nombre de fichero usado
también para el contenido en la sección 1), perderá el número en su nombre
(y cualquier extensión de nombre de fichero).
.Sp
Por ejemplo, para preparar \fI/usr/share/man/man7/po4a.7.gz\fR:
.Sp
.Vb 2
\& # Ficheros POD para la sección 7
\& POD7FILES="doc/po4a.7.pod"
.Ve
.SH "Contenido del fichero"
.IX Header "Contenido del fichero"
Los valores de configuración pueden tener cualquier orden dentro del fichero
de configuración.
.PP
El contenido presente después de «#» se ignorará.
.PP
Puede descartar del fichero cualquier valor que siempre vaya a dejar vacío.
.PP
Se precisan algunos campos de configuración, ya que \fIpo4a\-build\fR podría
acabar sin nada que hacer debido a campos vacíos.
.IP "CONFIGURACIÓN" 4
.IX Item "CONFIGURACIÓN"
Obligatorio.
.Sp
Nombre y ubicación del fichero de configuración (temporal) de \f(CW\*(C`po4a\*(C'\fR que
\&\f(CW\*(C`po4a\-build\*(C'\fR generará y mantendrá. Este fichero no necesita estar en su
sistema de control de versiones y puede eliminarlo sin problema durante la
construcción del paquete.
.Sp
.Vb 2
\& # Nombre y ubicación del fichero de configuración
\& CONFIG="_build/po4a.config"
.Ve
.IP "\s-1PODIR\s0" 4
.IX Item "PODIR"
Obligatorio.
.Sp
El directorio que contiene todos los ficheros \s-1PO\s0 para \s-1TODAS\s0 las traducciones
incluidas en este fichero de configuración. Todas los cadenas se fusionarán
en un fichero \s-1POT\s0 dentro de este directorio, y todos los ficheros \s-1PO\s0 se
fusionarán («merge») con ese fichero \s-1POT.\s0 Cualquier umbral de \s-1KEEP \s0(véase
más adelante), se aplicará a todas las cadenas de todos los ficheros de
entrada especificados en este fichero y a todos los ficheros \s-1PO\s0 contenidos
en este directorio. El directorio no precisa llamarse «/po». Tenga en
cuenta, por otra parte, que algunas herramientas estadísticas suponen que el
nombre es «po», y por ello se recomienda preservar este nombre.
.Sp
.Vb 2
\& # Directorio po para páginas de manual/documentación
\& PODIR="po/pod"
.Ve
.IP "\s-1POTFILE \s0(fichero \s-1POT\s0)" 4
.IX Item "POTFILE (fichero POT)"
Obligatorio.
.Sp
La ruta al fichero \s-1POT \s0(relativa a la ubicación de este fichero de
configuración) que se generará, mantendrá y actualizará para estas
traducciones mediante \f(CW\*(C`po4a\-build\*(C'\fR.
.Sp
.Vb 2
\& # Ruta al fichero POT
\& POTFILE="po/pod/po4a\-pod.pot"
.Ve
.IP "\s-1BASEDIR\s0" 4
.IX Item "BASEDIR"
Obligatorio.
.Sp
El directorio base en el que escribir el contenido traducido.
.Sp
.Vb 2
\& # Directorio base para los ficheros generados, p. ej., doc
\& BASEDIR="_build"
.Ve
.IP "\s-1BINARIES \s0(Binarios)" 4
.IX Item "BINARIES (Binarios)"
Obligatorio.
.Sp
Debe introducir un valor aunque se construya un sólo paquete.
.Sp
La cadena en si misma es arbitraria, pero consiste generalmente de un nombre
de paquete. El contenido generado aparecerá en los subdirectorios de
\&\fI\s-1BASEDIR/BINARIES\s0\fR:
.Sp
.Vb 1
\& _build/po4a/man/man1/foo.1
.Ve
.Sp
Si el paquete se construye con más de un paquete binario (por ejemplo, un
paquete de fuentes y varios ficheros «.deb» o «.rpm»), puede emplear este
campo para aislar el contenido para cada paquete, facilitando así
automatizar el proceso de construcción.
.Sp
Separe las cadenas con un espacio.
.Sp
.Vb 2
\& # Los paquetes binarios que contendrán las páginas de manual generadas
\& BINARIES="po4a"
.Ve
.IP "\s-1KEEP\s0" 4
.IX Item "KEEP"
Este es un valor que puede introducir directamente a \f(CW\*(C`po4a \-k\*(C'\fR para
especificar el umbral porcentual de traducción necesaria en un fichero \s-1PO\s0
para su construcción, antes de omitir una traducción en particular del
proceso de construcción por no superarlo. De estar vacío o no presente,
usará el valor predefinido (80%), o especifique cero para forzar la
inclusión de todo el contenido, aunque no exista nada traducido.
.Sp
Para tener un control completo sobre este comportamiento, considere
cuidadosamente qué ficheros se asignan a cada fichero de configuración
\&\fIpo4a\-build.conf\fR.
.Sp
Tenga en cuenta que tener varios ficheros en un solo fichero \s-1POT\s0 puede ser
conveniente para traductores, especialmente si hay cadenas compartidas. Por
otra parte, los ficheros \s-1POT\s0 con miles de largas cadenas atemorizan a los
traductores, conduciendo a un largo proceso de estabilización de cadenas.
.Sp
.Vb 2
\& # El umbral mínimo de porcentaje traducido para generar la documentación
\& KEEP=
.Ve
.IP "\s-1XMLMAN1\s0" 4
.IX Item "XMLMAN1"
Los ficheros DocBook \s-1XML\s0 para generar páginas de manual en la Sección
1. Separe los nombres de fichero con espacios. Todos los ficheros deben
estar en el directorio \s-1XMLDIR.\s0
.Sp
Unir varios ficheros \s-1XML\s0 en un solo libro es una práctica bastante extendida
para así poder ofrecer una tabla de contenidos etc. Si el libro contiene
ficheros también especificados en \s-1XMLMAN3,\s0 especifique sólo los ficheros \s-1XML\s0
para la sección 1, no el libro completo. Si el libro sólo contiene contenido
destinado a esta sección, especifique únicamente el fichero de libro («book
file»).
.Sp
.Vb 2
\& # Los ficheros DocBook XML para la sección 1
\& XMLMAN1="po4a\-build.xml po4aman\-display\-po.xml po4apod\-display\-po.xml"
.Ve
.IP "\s-1XMLMAN3\s0" 4
.IX Item "XMLMAN3"
Los ficheros DocBook \s-1XML\s0 para generar páginas de manual en la sección
3. Separe los nombres de fichero con espacios. Todos los ficheros deben
estar en el directorio \s-1XMLDIR.\s0
.Sp
Unir varios ficheros \s-1XML\s0 en un solo libro es una práctica bastante
extendida, para así poder ofrecer una tabla de contenidos etc. Si el libro
contiene ficheros también especificados en \s-1XMLMAN1,\s0 especifique sólo los
ficheros \s-1XML\s0 para la sección 3, no el libro completo. Si el libro sólo
contiene contenido destinado a esta sección, especifique sólo el fichero de
libro.
.Sp
.Vb 2
\& # Los ficheros DocBook XML para la sección 3
\& XMLMAN3=""
.Ve
.IP "\s-1XMLDIR\s0" 4
.IX Item "XMLDIR"
Esta es la ubicación de todos los ficheros DocBook \s-1XML. A\s0 día de hoy,
\&\f(CW\*(C`po4a\-build\*(C'\fR espera ser capaz de encontrar todos los ficheros listados en
\&\s-1XMLMAN1\s0 y \s-1XMLMAN3\s0 buscando en este directorio los ficheros «*.xml».
.Sp
Debe especificar si usa \s-1XMLMAN1\s0 o \s-1XMLMAN3.\s0 Las rutas son relativas a la
ubicación del fichero de configuración.
.Sp
.Vb 2
\& # La ubicación de los ficheros XML
\& XMLDIR="share/doc/"
.Ve
.IP "\s-1XMLPACKAGES\s0" 4
.IX Item "XMLPACKAGES"
Los paquetes listados en «BINARIES» que emplean contenido \s-1XML\s0 en las
fuentes.
.Sp
Si da un valor a \s-1XMLMAN1\s0 o \s-1XMLMAN3,\s0 debe también especificar un valor en
este campo.
.Sp
.Vb 2
\& # Los paquetes binarios que usan DocBook XML y xsltproc
\& XMLPACKAGES="po4a"
.Ve
.IP "\s-1DOCBOOKDIR\s0" 4
.IX Item "DOCBOOKDIR"
Es similar a \s-1XMLDIR,\s0 pero sólo se usa para preparar los ficheros DocBook
traducidos. Si su paquete quiere usar ficheros «.sgml», comente en la lista
de correo po4a\-devel cómo estos se deberían construir.
.Sp
.Vb 2
\& # El patrón donde encontrar los ficheros «.docbook»
\& DOCBOOKDIR=""
.Ve
.IP "\s-1XSLFILE\s0" 4
.IX Item "XSLFILE"
La hoja de estilo \s-1XSL\s0 usada para preparar el contenido traducido y original
a partir de los ficheros DocBook \s-1XML.\s0
.Sp
.Vb 2
\& # El fichero XSL a usar con Docbook XSL
\& XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
.Ve
.IP "\s-1PODFILE\s0" 4
.IX Item "PODFILE"
Esto especifica el o los fichero(s) \s-1POD\s0 de los que generar contenido de
página de manual para la sección 1. Separe los ficheros \s-1POD\s0 con espacios. De
usar rutas, deben ser relativas a la ubicación del fichero de configuración
especificado.
.Sp
.Vb 2
\& # Los ficheros POD para la sección 1
\& PODFILE="po4a po4a\-gettextize po4a\-normalize scripts/msguntypot"
.Ve
.IP "\s-1PODMODULES\s0" 4
.IX Item "PODMODULES"
La compatibilidad específica para los módulos Perl que contienen el
contenido \s-1POD.\s0 El nombre del módulo se reconstruirá a partir de la ruta (el
típico diseño Perl) y las páginas de manual se instalarán automáticamente en
la sección 3.
.Sp
.Vb 3
\& # Los ficheros POD para la sección 3 \- Los nombres de módulo se generan
\& con la ruta.
\& PODMODULES="lib/Locale/Po4a/*.pm"
.Ve
.IP "\s-1POD5FILES\s0" 4
.IX Item "POD5FILES"
El contenido \s-1POD\s0 arbitrario a usar para generar páginas de manual en la
sección 5. Si usa rutas, deben ser relativas a la ubicación del fichero de
configuración especificado.
.Sp
Si un nombre de fichero incluye el 5 o el 7, con contenido para las
secciones 5 o 7 (que generalmente necesita un nombre de fichero usado
también para el contenido en la sección 1), perderá el número en su nombre
(y cualquier extensión de nombre de fichero).
.Sp
.Vb 2
\& # Los ficheros POD para la sección 5
\& POD5FILES="doc/po4a\-build.conf.5.pod"
.Ve
.IP "\s-1POD7FILES\s0" 4
.IX Item "POD7FILES"
El contenido \s-1POD\s0 arbitrario para generar páginas de manual para la sección
7. Si usa rutas, deben ser relativas a la ubicación del fichero de
configuración especificado.
.Sp
Si un nombre de fichero incluye el 5 o el 7, con contenido para las
secciones 5 o 7 (que generalmente necesita un nombre de fichero usado
también para el contenido en la sección 1), perderá el número en su nombre
(y cualquier extensión de nombre de fichero).
.Sp
.Vb 2
\& # Ficheros POD para la sección 7
\& POD7FILES="doc/po4a.7.pod"
.Ve
.IP "\s-1PODPACKAGES\s0" 4
.IX Item "PODPACKAGES"
Es parecido a \s-1XMLPACKAGES:\s0 Debe incluir un valor a \s-1PODPACKAGES\s0 para cada
paquete que espere contenido construido a partir de ficheros \s-1POD.\s0 Es
obligatorio de haber especificado cualquier valor en \s-1PODFILE,
PODMODULES,POD5FILES\s0 o \s-1POD7FILES.\s0
.Sp
.Vb 2
\& # Los paquetes binarios que usan POD
\& PODPACKAGES="po4a"
.Ve
.IP "\s-1HTMLDIR\s0" 4
.IX Item "HTMLDIR"
Un subdirectorio de \s-1BASEDIR\s0 que se usará para depositar la salida \s-1HTML\s0
traducida u original.
.Sp
.Vb 2
\& # Salida HTML (subdirectorio de BASEDIR)
\& HTMLDIR=""
.Ve
.IP "\s-1HTMLFILE\s0" 4
.IX Item "HTMLFILE"
El fichero DocBook a convertir a \s-1HTML \s0(puede ser igual a uno de los ficheros
en \s-1XMLFILE\s0). Las secciones carecen de importancia para la salida de \s-1HTML,\s0
así que puede usar un solo fichero de libro ya que \s-1HTML\s0 tiene una tabla de
contenidos, etc.
.Sp
.Vb 2
\& # HTML DocBook file
\& HTMLFILE=""
.Ve
.IP "\s-1HTMLXSL\s0" 4
.IX Item "HTMLXSL"
Por omisión se usa una hoja de estilo \s-1XSL\s0 «chunked». No puede usar más de
una hoja de estilo por \s-1HTML\s0 en cada ejecución.
.Sp
.Vb 2
\& # El fichero XSL a 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
.SH "TRADUCCION"
.IX Header "TRADUCCION"
.Vb 2
\& Jordi Vilalta <jvprat@gmail.com>
\& Omar Campagne <ocampagne@gmail.com>
.Ve