'\" t
.\" Title: po4a-build
.\" Author: [see the "АВТОР" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1
.\" Date: 06/07/2018
.\" Manual: PO4A
.\" Source: PO4A
.\" Language: Russian
.\"
.TH "po4a\-build" "1" "06/07/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 "НАЗВАНИЕ"
po4a-build \- собрать переведённую документацию
.SH "СИНТАКСИС"
.HP \w'\fBpo4a\-build\fR\ 'u
\fBpo4a\-build\fR [\fB\-f\fR | \fB\-\-file\fR\fI
FILE\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 "ОПИСАНИЕ"
.PP
\fBpo4a\-build\fR
предназначен для того, чтобы облегчить процесс создания переведённой документации и для создания непереведённого на данный момент содержимого\&.
.PP
как только
\fBpo4a\fR
приготовила переведённое содержимое в формате POD или DocBook XML, документация может быть собрана с помощью команды
\fBpo4a\-build\fR\&. Содержимое, которое перевели и не перевели, собирается одним процессом, в то же время обновляются POT файлы\&.
.PP
Существующие инструкции сборки выполняются при вызове команды
\fBpo4a\-build\fR, а файл настройки используется для того, чтобы указать
\fBpo4a\-build\fR
как собирать каждый элемент и в какой бинарный пакет нужно включать переведённое и непереведённое содержимое\&.
.PP
Как только завершится сборка, содержимое будет расположено в специфичной для пакета структуре каталогов с базовым каталогом
\fBBASEDIR\fR, что определено в файле настройки\&. Для бинарного пакета foo, с переводами на Немецкий и Французский, результаты будут располагаться в:
.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
Это позволяет облегчить включение всего создаваемого содержимого в бинарный пакет с единым местом установки:
.sp
.if n \{\
.RS 4
.\}
.nf
doc/foo/man/* \&./usr/share/man/
doc/foo/html/* \&./usr/share/doc/foo/
.fi
.if n \{\
.RE
.\}
.PP
Данное правило не требует обновления при добавлении новых переводов или вторичных бинарных пакетов (bar), предоставляя возможность хранить содержимое пакета отдельно\&.
.SS "Поддерживаемые форматы"
.PP
На данный момент
\fBpo4a\-build\fR
поддерживает следующие комбинации:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
DocBook XML для section 1\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
DocBook XML для section 3\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 3." 4.2
.\}
DocBook XML для HTML\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 4." 4.2
.\}
POD для section 1\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 5.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 5." 4.2
.\}
POD для section 3\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 6.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 6." 4.2
.\}
POD для section 5\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 7.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 7." 4.2
.\}
POD для section 7\&.
.RE
.PP
Настройки для всех поддерживаемых форматов и всех поддерживаемых комбинаций содержатся в одном файле
po4a\-build\&.conf, обработка производится вызовом команды
\fBpo4a\-build\fR\&. См\&.
\fBpo4a-build.conf\fR(5)\&.
.SH "НАСТРОЙКА"
.PP
\fBpo4a\-build\fR
обычно использует файл настройки
po4a\-build\&.conf, который должен находиться в корневом каталоге VCS вашего пакета\&. (Используйте параметр
\fB\-f\fR
для определения другого файла\&.) См\&.
\fBpo4a-build.conf\fR(5)\&.
.PP
\fBПример 1. пример файла настройки\fR
.PP
Пример файла настройки можно прочитать тут:
.sp
.if n \{\
.RS 4
.\}
.nf
/usr/share/doc/po4a/examples/po4a\-build\&.conf\&.example
.fi
.if n \{\
.RE
.\}
.SS "схема файла настройки"
.PP
Файл настройки состоит из нескольких секций (параграфов), основной части, настроек XML/XSL, POD и 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
POD поддерживает определение того, какой бинарный пакет использует POD, с помощью переменной PODPACKAGES и полного имени POD файла\&.
.PP
HTML поддержка позволяет определять подкаталоги, которые необходимо создавать в каталоге BASEDIR для непереведённых и переведённых HTML и DocBook файлов, необходимых при создании HTML\&. HTMLXSL файл может быть перезаписан при необходимости\&.
.SH "КОМАНДЫ"
.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
\fBПример 2. пример использования svn\-buildpackage\fR
.PP
\fBsvn\-buildpackage\fR
имеет явную поддержку такого рода дополнений, используя способность SVN
\fBuseNativeDist\fR
и цель сборщика (Make)
\fBnative\-dist\fR\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# добавить POT файл в архив исходных текстов
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
распечатать инструкцию по использованию и выйти\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
print the script version and exit\&.
.RE
.SH "ПАРАМЕТРЫ"
.PP
\fB\-f\fR|\fB\-\-file\fR\fI FILE\fR
.RS 4
Указать
\fBpo4a\-build\fR
не использовать файл настройки (po4a\-build\&.conf) по умолчанию и предоставить свой собственный\&.
.RE
.SH "АВТОР"
.PP
\fBpo4a\-build\fR
был написан Нейлом Уильямсом (Neil Williams)
\&.
.PP
Эта man\-страница была написана Нейлом Уильямсом (Neil Williams)