'\" t
.\" Title: po4a-build
.\" Author: [see the "AUTOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1
.\" Date: 27/05/2018
.\" Manual: PO4A
.\" Source: PO4A
.\" Language: Spanish
.\"
.TH "PO4A\-BUILD" "1" "27/05/2018" "PO4A" "PO4A"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NOMBRE"
po4a-build \- Construye documentaci\('on traducida
.SH "SINOPSIS"
.HP \w'\fBpo4a\-build\fR\ 'u
\fBpo4a\-build\fR [\fB\-f\fR | \fB\-\-file\fR\fI
fichero\fR] [\fB\-\-pot\-only\fR]
.HP \w'\fBpo4a\-build\fR\ 'u
\fBpo4a\-build\fR [\fB\-?\fR | \fB\-h\fR | \fB\-\-help\fR | \fB\-\-version\fR]
.SH "DESCRIPCI\('ON"
.PP
La meta de
\fBpo4a\-build\fR
es facilitar la generaci\('on de documentaci\('on traducida tanto como lo es generar el contenido sin traducir\&.
.PP
Cuando
\fBpo4a\fR
prepara el contenido traducido bien como POD o DocBook XML, puede usar la orden
\fBpo4a\-build\fR
para generar la documentaci\('on final\&. El contenido traducido y sin traducir se generan en un s\('olo proceso, actualizando los ficheros POT a la vez\&.
.PP
Puede reemplazar las instrucciones de construcci\('on existentes con una sola invocaci\('on a
\fBpo4a\-build\fR
y un sencillo fichero de configuraci\('on usado para decir a
\fBpo4a\-build\fR
c\('omo construir cada elemento y qu\('e paquetes binarios incluir\('an el contenido traducido y sin traducir\&.
.PP
Una vez generado, el contenido estar\('a en los directorios espec\('ificos a cada paquete bajo el
\fBBASEDIR\fR
(directorio padre) definido en el fichero de configuraci\('on\&. Para un paquete binario \(Fofoo\(Fc, con traducciones al alem\('an y al franc\('es, el resultado ser\('ia el siguiente:
.sp
.if n \{\
.RS 4
.\}
.nf
BASEDIR/foo/man/man1/foo\&.1
BASEDIR/foo/man/de/man1/foo\&.1
BASEDIR/foo/man/fr/man1/foo\&.1
.fi
.if n \{\
.RE
.\}
.PP
Esto facilita incluir todo el contenido generado dentro de los paquetes binarios, con una sola ubicaci\('on de instalaci\('on\&.
.sp
.if n \{\
.RS 4
.\}
.nf
doc/foo/man/* \&./usr/share/man/
doc/foo/html/* \&./usr/share/doc/foo/
.fi
.if n \{\
.RE
.\}
.PP
Esta regla no se tendr\('a que actualizar al a\(~nadir traducciones nuevas, y permite a\(~nadir un segundo paquete binario (\(Fobar\(Fc) manteniendo el contenido de \('este separado\&.
.SS "Formatos compatibles"
.PP
A d\('ia de hoy,
\fBpo4a\-build\fR
es compatible con las siguientes combinaciones:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
DocBook XML para la secci\('on 1\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
DocBook XML para la secci\('on 3\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 3." 4.2
.\}
DocBook XML para HTML\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 4." 4.2
.\}
POD para la secci\('on 1\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 5.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 5." 4.2
.\}
POD para la secci\('on 3\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 6.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 6." 4.2
.\}
POD para la secci\('on 5\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 7.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 7." 4.2
.\}
POD para la secci\('on 7\&.
.RE
.PP
Puede gestionar todos los formatos compatibles y combinaciones posibles con un solo fichero de configuraci\('on,
po4a\-build\&.conf, y una sola invocaci\('on a
\fBpo4a\-build\fR\&. Consulte
\fBpo4a-build.conf\fR(5)\&.
.SH "CONFIGURACI\('ON"
.PP
Por omisi\('on,
\fBpo4a\-build\fR
usa un fichero de configuraci\('on,
po4a\-build\&.conf, el cual deber\('ia estar en el directorio superior del sistema de control de versiones de su paquete\&. (Use la opci\('on
\fB\-f\fR
para especificar un fichero diferente\&.) Consulte
\fBpo4a-build.conf\fR(5)\&.
.PP
\fBEjemplo 1. Ejemplo de fichero de configuraci\('on\fR
.PP
Dispone de un ejemplo de fichero de configuraci\('on en:
.sp
.if n \{\
.RS 4
.\}
.nf
/usr/share/doc/po4a/examples/po4a\-build\&.conf\&.example
.fi
.if n \{\
.RE
.\}
.SS "Dise\(~no del fichero de configuraci\('on"
.PP
El fichero de configuraci\('on consiste de varias secciones: general, compatibilidad con XML/XSL, POD y HTML\&.
.PP
General includes the name and location of the po4a config file (probably best to leave this as
po4a\&.config), the
po
directory containing the documentation PO files (often
doc/po), the full name of the POT file used to create the translations, the BASEDIR for the generated output, whether the package contains manpages in section 3 rather than just section 1 and the names of the binary packages which are to contain the generated output\&.
.PP
XML/XSL support includes specifying which of the binary packages use XSL support in the
\fBXMLPACKAGES\fR
variable, the top level DocBook file to pass to
\fBxsltproc\fR
and the location of the XML or DocBook files\&. The
\fBXSLFILE\fR
can be overridden, if necessary\&.
.PP
La compatibilidad con POD incluye especificar qu\('e paquetes binarios usan la compatibilidad con POD a trav\('es de la variable \(FoPODPACKAGES\(Fc y el nombre completo del fichero POD\&.
.PP
La compatibilidad con HTML especifica el subdirectorio a crear bajo \(FoBASEDIR\(Fc que contendr\('a el contenido HTML traducido y sin traducir, y el fichero DocBook usado para generar HTML\&. Puede anular el fichero \(FoHTMLXSL\(Fc si es necesario\&.
.SH "\('ORDENES"
.PP
\fB\-\-pot\-only\fR
.RS 4
Only updates the POT file(s)\&.
\fB\-\-pot\-only\fR
is intended to support packages including all POT files in the package source\&. Packages using Autotools can easily add the POT file via
\fBEXTRA_DIST\fR
but packages just using a Makefile or certain VCS build helpers can find it awkward to add the POT file (which is a generated file) without putting the POT file into the VCS\&. To avoid this ugly and unnecessary work,
\fBpo4a\-build\fR
can update the POT file(s) at the start of the build, so that
\fBdpkg\-source\fR
includes them into the source tarball\&.
.PP
\fBEjemplo 2. Ejemplo de svn\-buildpackage\fR
.PP
\fBsvn\-buildpackage\fR
tiene compatibilidad expl\('icita para esta clase de a\(~nadidos, usando la propiedad
\fBuseNativeDist\fR
de SVN y el \(Fotarget\(Fc de Make
\fBnative\-dist\fR\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# A\(~nade el fichero POT al archivo tar de fuentes
native\-dist: Makefile
po4a\-build \-\-pot\-only
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
$ svn propset useNativeDist 1 debian
.fi
.if n \{\
.RE
.\}
.RE
.PP
\fB\-h\fR|\fB\-\-help\fR
.RS 4
Muestra el mensaje de uso y cierra
.RE
.PP
\fB\-\-version\fR
.RS 4
print the script version and exit\&.
.RE
.SH "OPCIONES"
.PP
\fB\-f\fR|\fB\-\-file\fR\fI fichero\fR
.RS 4
Anula el fichero de configuraci\('on predefinido de
\fBpoa\-build\fR
(po4a\-build\&.conf) e introduce el suyo\&.
.RE
.SH "AUTOR"
.PP
\fBpo4a\-build\fR
fue creado por Neil Williams
\&.
.PP
Neil Williams escribi\('o esta p\('agina de manual\&.