summaryrefslogtreecommitdiffstats
path: root/misc/po4a/README
diff options
context:
space:
mode:
Diffstat (limited to 'misc/po4a/README')
-rw-r--r--misc/po4a/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/misc/po4a/README b/misc/po4a/README
new file mode 100644
index 0000000000..e560c89996
--- /dev/null
+++ b/misc/po4a/README
@@ -0,0 +1,36 @@
+po4a - Versatile PO to/from other documentation formats converter
+
+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.45 are:
+BibTex, Dia, Halibut, KernelHelp, LaTeX, Man, POD, SGML, TeX,
+Texinfo, Text, WML, XHTML, XML.
+
+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.
+
+Dependencies tree is as follows (all dependencies listed are available at
+http://slackbuilds.org).
+
+Po4a-0.45
+|
+|-- locale-gettext (included in Slackware 14.1), allows translation of
+| po4a's own messages. Optional
+|-- perl-term-ReadKey to retrieve the terminal's line width. Only used if
+| perl-text-WrapI18N is available. 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
+ 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