summaryrefslogtreecommitdiffstats
path: root/misc/po4a/README
diff options
context:
space:
mode:
Diffstat (limited to 'misc/po4a/README')
-rw-r--r--misc/po4a/README51
1 files changed, 24 insertions, 27 deletions
diff --git a/misc/po4a/README b/misc/po4a/README
index 2c45c97a50..591c931290 100644
--- a/misc/po4a/README
+++ b/misc/po4a/README
@@ -1,34 +1,31 @@
-po4a - Versatile PO to/from other documentation formats converter
+po4a (convert PO to/from other documentation formats)
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
+In po4a each documentation format is handled by a module that converts
+this format to/from PO. Formats handled by po4a:
-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>
-
-WARNING: run po4a.SlackBuild as root (su -) not with only root privileges
-(su), otherwise test #24 will fail.
+- 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.
-Dependencies tree is as follows (all dependencies listed are available at
-http://slackbuilds.org).
+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>
-Po4a-0.47
-|
-|-- perl-Module-Build
-|-- perl-YAML-Tiny. mandatory for the YAML module.
-|-- 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
- encodings different from ASCII. Mandatory for TEXT module.
- |-- perl-MIME-Charset. Mandatory
- |-- perl-Encode-EUCJPASCII. Optional
- |-- perl-Encode-HanExtra. Optional.
- |-- perl-Encode-JISX0213. Optional
- |-- perl-Encode-ISO2022. Mandatory
+See README_SBo.txt for dependency info and build options.