Provided by: po4a_0.41-1_all bug

NAZWA

       po4a-build.conf - plik konfiguracyjny do budowania przetlumaczonej
       dokumentacji

Wstp

       po4a-build.conf opisuje sposob "po4a-build" budowania tlumaczonej i
       nietlumaczonej dokumentacji ze zbioru nieprzetlumaczonych dokumentow
       rodlowych i odpowiadajcych im plikow PO.

       Wszystkie dostpne formaty i wszystkie dostpne kombinacje mona zawrze w
       pojedynczym pliku konfiguracyjnym po4a-build.conf i w pojedynczym
       wywolaniu programu "po4a-build". Jednake mona rownie rozdzieli katalogi
       po/ i uywa oddzielnego pliku konfiguracji dla kadego uruchomienia
       (naley wtedy za kadym razem wywola "po4a-build -f PLIK").

       Prosz zauway, e chocia po4a-build umoliwia obslug tlumacze komunikatow
       wyjciowych skryptow powloki, to po4a-build.conf nie wspiera tego.
       po4a-build.conf jest zwizany tylko z tlumaczeniami statycznej
       zawartoci, na przyklad stron podrcznika ekranowego.

       Prosz przeczyta po4a-runtime(7), aby dowiedzie si o wspieraniu przez
       po4a-build tlumacze komunikatow skryptow powloki.

Obs/lugiwane formaty

       Obecnie "po4a-build" obsluguje nastpujce kombinacje:

       DocBook XML dla sekcji 1 i 3
           Zazwyczaj uywany przez strony podrcznika skryptow powloki lub
           innych interpreterow, ktore nie maj wlasnego formatu dokumentacji
           typu POD. Odpowiedni XML mona wygenerowa bezporednio z istniejcej
           strony podrcznika za pomoc "doclifter", a "po4a-build" wygeneruje
           wtedy plik POT. Plik POT mona wtedy zaoferowa do przetlumaczenia, a
           pliki PO mona doda do odpowiedniego katalogu po/. "po4a-build"
           przygotuje wtedy nie tylko nieprzetlumaczon stron podrcznika uywajc
           "doclifter", ale take wywola "po4a" do przygotowania
           przetlumaczonych XML-i z plikow PO i wygenerowania z niego
           przetlumaczonych stron podrcznika.

           Strony podrcznika s generowane przy uyciu domylnych ustawie
           docbook-xsl. Uyty arkusz stylow mona zmieni  za pomoc ustawienia
           "XSLFILE" pliku konfiguracyjnego "po4a-build".

       DocBook XML dla HTML
           Arkusz stylow uywany do wygenerowania ostatecznego HTML-a mona
           zmieni  za pomoc ustawienia "HTMLXSL" pliku konfiguracyjnego
           "po4a-build"; mona te uy domylnego arkusza.

       POD dla sekcji 1, 3, 5 oraz 7
           pod2man jest uywany do konwersji zawartoci POD dla kadej z
           obslugiwanych sekcji.

           Prosimy uy "PODFILE" dla sekcji 1, "PODMODULES" dla sekcji 3,
           "POD5FILES" dla sekcji 5, "POD7FILES" dla sekcji 7.

           W przypadku zawartoci sekcji 5 lub 7 (ktore zazwyczaj wymagaj nazwy
           pliku uywanego rownie w przypadku zawartoci sekcji 1), jeli czci
           nazwy pliku jest 5 lub 7, to zostan one automatycznie usunite z
           nazwy pliku (lcznie z jakimkolwiek rozszerzeniem nazwy pliku).

           Na przyklad, aby przygotowa /usr/share/man/man7/po4a.7.gz:

            # pliki POD dla sekcji 7
            POD7FILES="doc/po4a.7.pod"

Zawarto pliku

       Kolejno wystpowania zmiennych konfiguracji w pliku jest dowolna.

       Jakakolwiek zawarto po znaku "#" jest ignorowana.

       Wartoci, ktore zawsze bd puste, mona usun z pliku.

       Niektore pola konfiguracji s wymagane - po4a-build moe nic nie zrobi,
       jeli pola te nie bd wypelnione.

       CONFIG
           Wymagany.

           Nazwa i lokalizacja (tymczasowego) pliku konfiguracyjnego "po4a",
           ktory "po4a-build" wygeneruje i ktorym bdzie zarzdzal. Pliku tego
           nie trzeba dodawa do systemu kontroli wersji i moe by czyszczony
           podczas budowania pakietu.

            # nazwa i lokalizacja pliku konfiguracji
            CONFIG="_build/po4a.config"

       PODIR
           Wymagany.

           Katalog zawierajcy pliki PO WSZYSTKICH tlumacze obslugiwany przez
           ten plik konfiguracyjny. Wszystkie komunikaty bd polczone do
           jednego pliku POT w tym katalogu, a wszystkie pliki PO polczone z
           tym plikiem POT. Kady prog KEEP (patrz niej) bdzie stosowany do
           wszystkich komunikatow ze wszystkich plikow wejciowych podanych w
           tym pliku i do wszystkich plikow PO w tym katalogu. Katalog nie
           musi si nazywa "po".

            # pkatalog po stron podrcznika/dokumentacji
            PODIR="po/pod"

       POTFILE
           Wymagany.

           cieka do pliku POT (wzgldna w stosunku do lokalizacji tego pliku
           konfiguracyjnego), ktory bdzie generowany, zarzdzany i
           aktualizowany przez "po4a-build".

            # cieka do pliku POT
            POTFILE="po/pod/po4a-pod.pot"

       BASEDIR
           Wymagany.

           Katalog bazowy do zapisywania przetlumaczonej zawartoci.

            # katalog bazowy dla wygenerowanych plikow, np. plikow doc
            BASEDIR="_build"

       BINARIES
           Wymagany.

           Nawet jeli budowany jest tylko jeden pakiet, wymagane jest podanie
           co najmniej jednej wartoci w tej zmiennej.

           Warto tego pola moe by przypadkowa, ale zazwyczaj zawiera nazw
           pakietu. Wygenerowane dokumenty pojawi si w podkatalogach
           BASEDIR/BINARIES:

            _build/po4a/man/man1/foo.1

           Jeli pakiet buduje wicej ni jeden pakiet binarny (tj. jeden pakiet
           rodlowy i wiele plikow *.deb lub *.rpm), to to pole moe pomoc w
           rozdzielaniu zawartoci kadego pakietu, ulatwiajc tym samym
           automatyzacj procesu budowania.

           Lacuchy znakow naley rozdziela spacjami.

            # pakiety binarne, ktore bd zawiera wygenerowane strony podrcznika
            BINARIES="po4a"

       KEEP
           Warto przekazywana bezporednio do "po4a -k" okrelajca procentowy
           prog tlumacze pozwalajcy zachowa tlumaczenie (w przypadku
           nieprzekroczenia progu wygenerowany przetlumaczony dokument jest
           usuwany). Prosz zostawi to pole puste lub usun go, aby uy wartoci
           domylnej (80%), albo ustawi warto na zero, aby wymusi wlczenie
           pelnej zawartoci, nawet kompletnie nieprzetlumaczonej.

           Aby mie pelny wplyw na to zachowanie. prosimy ostronie przypisywa
           pliki do zmiennych w pliku konfiguracyjnym po4a-build.conf.

           Prosz zauway, e umieszczenie wielu plikow w jednym pliku POT moe by
           wygodniejsze dla tlumaczy, zwlaszcza jeeli pliki te maj wspolne
           akapity. Z drugiej za strony pliki POT z tysicami komunikatow do
           przetlumaczenia zniechcaj tlumaczy i prowadz do dlugotrwalego
           okresu wstrzymania zmian oryginalnych komunikatow.

            # minimalny procentowy prog tlumacze pozwalajcy zapisa plik wynikowy
            KEEP=

       XMLMAN1
           Nazwy plikow DocBook XML do wygenerowania w sekcji 1. Nazwy plikow
           powinny by rozdzielone spacjami. Wszystkie pliki powinny si
           znajdowa w katalogu XMLDIR.

           Powszechn praktyk jest skladanie wielu plikow XML w jedn ksik w
           celu dostarczenia spisu treci itp. Jeli ksika zawiera pliki podane
           rownie w XMLMAN3, tutaj naley poda tylko pliki nalece do sekcji 1,
           a nie plik z nazw calej ksiki. Jeli ksika sklada si tylko z tej
           sekcji, naley poda plik z nazw calej ksiki.

            # pliki DocBook XML do sekcji 1
            XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"

       XMLMAN3
           Nazwy plikow DocBook XML do wygenerowania w sekcji 3. Nazwy plikow
           powinny by rozdzielone spacjami. Wszystkie pliki powinny si
           znajdowa w katalogu XMLDIR.

           Powszechn praktyk jest skladanie wielu plikow XML w jedn ksik w
           celu dostarczenia spisu treci itp. Jeli ksika zawiera pliki podane
           rownie w XMLMAN1, tutaj naley poda tylko pliki nalece do sekcji 3,
           a nie plik z nazw calej ksiki. Jeli ksika sklada si tylko z tej
           sekcji, naley poda plik z nazw calej ksiki.

            # pliki DocBook XML do sekcji 3
            XMLMAN3=""

       XMLDIR
           Lokalizacja wszystkich plikow DocBook XML. Obecnie  "po4a-build"
           oczekuje, e bdzie w stanie znale wszystkie pliki wymienione w
           XMLMAN1 i XMLMAN3, szukajc w tym katalogu plikow *.xml.

           Musi by podane, jeli uywa si XMLMAN1 lub XMLMAN3. cieki s wzgldne w
           stosunku do lokalizacji pliku konfiguracji.

            # lokalizacja plikow XML
            XMLDIR="share/doc/"

       XMLPACKAGES
           Ktore pakiety, z listy podanej w BINARIES, uywaj rodlowego XML-a.

           Jeli wypelniono XMLMAN1 lub XMLMAN3, naley wypelni rownie t zmienn.

            # pakiety binarne uywajce DocBook XML & xsltproc
            XMLPACKAGES="po4a"

       DOCBOOKDIR
           Podobne do XMLDIR, ale uywane tylko do utworzenie przetlumaczonych
           plikow DocBook. Jeli Twoj pakiet uywa plikow *.sgml, prosimy
           przedyskutowa sposob jego budowania na licie e-mailowej po4a-devel.

            # wzorzec wyszukiwania plikow .docbook
            DOCBOOKDIR=""

       XSLFILE
           Arkusz stylow XSL uywany do przygotowania przetlumaczonej i
           nieprzetlumaczonej zawartoci plikow DocBook XML.

            # plik XSL uywany w DocBook XML
            XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"

       PODFILE
           Pliki POD tworzce sekcj 1 stron podrcznika ekranowego. Nazwy plikow
           POD powinny by rozdzielone spacjami. cieki, jeli s uywane, powinny
           by wzgldne w stosunku do lokalizacji podanego pliku konfiguracji.

            # pliki POD dla sekcji 1
            PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"

       PODMODULES
           Specjalne wsparcie modulow Perla zawierajcych zawarto POD - nazwa
           modulu bdzie zbudowana ze cieki pliku (tak wic cieka powinna
           odzwierciedla typowy uklad cieek Perla), a strony podrcznika bd
           automatycznie umieszczone w sekcji 3.

            # pliki POD dla sekcji 3 - nazwy modulow utworzone ze cieki
            PODMODULES="lib/Locale/Po4a/*.pm"

       POD5FILES
           Dowolna zawarto POD tworzca strony podrcznika ekranowego w sekcji
           5. cieki, jeli s uywane, powinny by wzgldne w stosunku do
           lokalizacji podanego pliku konfiguracji.

           W przypadku zawartoci sekcji 5 lub 7 (ktore zazwyczaj wymagaj nazwy
           pliku uywanego rownie w przypadku zawartoci sekcji 1), jeli czci
           nazwy pliku jest 5 lub 7, to zostan one automatycznie usunite z
           nazwy pliku (lcznie z jakimkolwiek rozszerzeniem nazwy pliku).

            # pliki POD dla sekcji 5
            POD5FILES="doc/po4a-build.conf.5.pod"

       POD7FILES
           Dowolna zawarto POD tworzca strony podrcznika ekranowego w sekcji
           7. cieki, jeli s uywane, powinny by wzgldne w stosunku do
           lokalizacji podanego pliku konfiguracji.

           W przypadku zawartoci sekcji 5 lub 7 (ktore zazwyczaj wymagaj nazwy
           pliku uywanego rownie w przypadku zawartoci sekcji 1), jeli czci
           nazwy pliku jest 5 lub 7, to zostan one automatycznie usunite z
           nazwy pliku (lcznie z jakimkolwiek rozszerzeniem nazwy pliku).

            # pliki POD dla sekcji 7
            POD7FILES="doc/po4a.7.pod"

       PODPACKAGES
           Podobne do XMLPACKAGES - kady pakiet oczekujcy dokumentacji
           zbudowanej z plikow POD powinien by wymieniony w PODPACKAGES. Pole
           jest wymagane, jeli podano wartoci w PODFILE, PODMODULES, POD5FILES
           lub POD7FILES.

            # pakiety binarne uywajce POD
            PODPACKAGES="po4a"

       HTMLDIR
           Podkatalog katalogu BASEDIR, w ktorym bd umieszczone wynikowe pliki
           HTML, zarowno przetlumaczone, jak i nieprzetlumaczone.

            # wyjcie HTML (podkatalog BASEDIR)
            HTMLDIR=""

       HTMLFILE
           Plik DocBook jest konwertowany do HTML-a (moe by taki sam jak jeden
           z plikow w XMLMAN1 lub XMLMAN3). Sekcje nie maj znaczenia w
           przypadku wyjcia HTML, wic mona uy tutaj pojedynczego pliku ksiki,
           tak eby mial spis treci itp.

            # plik DocBook HTML
            HTMLFILE=""

       HTMLXSL
           Domylnie jest uywany jeden arkusz stylow XSL. Podanie wikszej
           liczby arkuszy stylow dla jednego przebiegu generowania HTML-a nie
           jest obecnie wspierane.

            # plik XSL uywany z HTML
            HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"

AUTORZY

        Neil Williams <linux@codehelp.co.uk>