]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
po-man: Add po-man/README.md
authorMario Blättermann <mario.blaettermann@gmail.com>
Mon, 29 Mar 2021 17:30:04 +0000 (19:30 +0200)
committerMario Blättermann <mario.blaettermann@gmail.com>
Mon, 29 Mar 2021 17:30:04 +0000 (19:30 +0200)
po-man/README.md [new file with mode: 0644]

diff --git a/po-man/README.md b/po-man/README.md
new file mode 100644 (file)
index 0000000..387331a
--- /dev/null
@@ -0,0 +1,23 @@
+# Working with man page translations
+
+## Add a new .po file
+
+To enable a new .po file, add their basename (in fact, the language code), to
+the first line of po4a.cfg:
+
+    [po4a_langs] de es fr pl uk
+
+It is not crucial to sort the entries alphabetically, but do it anyway for
+better readability.
+
+## Update the template and create translated files
+
+This is done in one step using the following simple command:
+
+    po4a po4a.cfg
+    
+If there's something wrong with a .po file, the comman will fail. In any case,
+have a look at the first line of po4a.cfg if all of the mentioned files are
+present.
+
+To the man page authors: Please don't forget to add your new man page to po4a.cfg!