diff options
Diffstat (limited to 'misc/po4a/README')
| -rw-r--r-- | misc/po4a/README | 55 |
1 files changed, 43 insertions, 12 deletions
diff --git a/misc/po4a/README b/misc/po4a/README index 2c45c97a50..460ea0c578 100644 --- a/misc/po4a/README +++ b/misc/po4a/README @@ -4,25 +4,39 @@ po4a (PO for anything) eases translations and their maintenance, allowing gettext's usage on unexpected areas like documentation. In po4a each documentation format is handled by a module, that -converts this format to/from PO. Formats included in po4a-0.47 are: -AsciiDoc, BibTex, Dia, Halibut, KernelHelp, LaTeX, Man, POD, SGML, TeX, -Texinfo, Text, WML, XHTML, XML, Yaml +converts this format to/from PO. Formats handled by po4a-0.63 -man pages are encoded in UTF-8. To read them in other languages than English, -do this for instance: -LANG=ru_RU.utf8 GROFF_ENCODING=utf8 man <man page> +. asciidoc: AsciiDoc format. +. dia: uncompressed Dia diagrams. +. docbook: DocBook XML. +. guide: Gentoo Linux's XML documentation format. +. ini: INI format. +. kernelhelp: Help messages of each kernel compilation option. +. latex: LaTeX format. +. man: Good old manual page format. +. pod: Perl Online Documentation format. +. sgml: either DebianDoc or DocBook DTD. +. texinfo: The info page format. +. tex: generic TeX documents (see also latex). +. text: simple text document. +. wml: WML documents. +. xhtml: XHTML documents. +. xml: generic XML documents (see also docbook). +. yaml: YAML documents. -WARNING: run po4a.SlackBuild as root (su -) not with only root privileges -(su), otherwise test #24 will fail. +man pages are encoded in UTF-8. To read them in other languages than +English, do this for instance: +LANG=ru_RU.utf8 GROFF_ENCODING=utf8 man <man page> -Dependencies tree is as follows (all dependencies listed are available at -http://slackbuilds.org). +Dependencies tree is as follows (all dependencies listed are available +at http://slackbuilds.org). -Po4a-0.47 +Po4a-0.63 | |-- perl-Module-Build |-- perl-YAML-Tiny. mandatory for the YAML module. -|-- perl-text-WrapI18N to format po4a's warnings and error messages. Optional. +|-- perl-text-WrapI18N to format po4a's warnings and error messages. +| | Optional. | |-- Text::CharWidth. Mandatory |-- perl-Unicode-LineBreak, includes module Unicode::GCString to compute text width, neeeded by AsciiDoc to determine two line titles in @@ -32,3 +46,20 @@ Po4a-0.47 |-- perl-Encode-HanExtra. Optional. |-- perl-Encode-JISX0213. Optional |-- perl-Encode-ISO2022. Mandatory + +In addition, perl-Test-Pod allows to run the test for the POFD format + +Note: by default the SlackBuild does not run ./Build test, because these +tests: +t/cfg-multi.t +t/cfg-single.t +t/cfg-split.t +fail if the script is run by root or even using fakeroot, which has been +acknowledged upstream. + +All tests have been successfully passed running '/Build test' by the +maintainer as regular user. If you want to check by yourself, un-comment +the lines 85 and 86 in the SlackBuild. You will then need to comment +them out to run the script again as root to actually build the package. + +WARNING: run this script with LANG set to an UTF-8 locale. |