|
1
by wbaumann
first import |
1 |
2008-07-12
|
2 |
----------
|
|
3 |
||
4 |
#Copyright (C) 2006, 2007, 2008 Werner Baumann |
|
5 |
||
6 |
#Copying and distribution of this file, with or without modification, are |
|
7 |
#permitted in any medium without royalty. |
|
8 |
||
9 |
||
10 |
davfs2 uses the GNU gettext utilities to support localized messages. |
|
11 |
Information about GNU gettext may be found at |
|
12 |
http://www.gnu.org/software/gettext/manual/ |
|
13 |
||
14 |
For the man pages (and probably other documentation in future), it makes use |
|
15 |
of the po4a tools in order to keep translations of documentation maintainable. |
|
16 |
po4a (http://po4a.alioth.debian.org/) applies the gettext tools to arbitrary |
|
17 |
documentation. |
|
18 |
||
19 |
||
20 |
Messages
|
|
21 |
--------
|
|
22 |
All messages that need translation are in the file po/davfs2.pot. The |
|
23 |
translated messages will be in po/ll.po, where ll is the two-letter country |
|
24 |
code. |
|
25 |
If you start a translation into a language not yet supported, you may just |
|
26 |
take a copy of po/davfs2.pot for your ll.po file. |
|
27 |
||
28 |
||
29 |
Man Pages
|
|
30 |
---------
|
|
31 |
The .pot files of the man pages are in the man/ subdirectory together with |
|
32 |
a configuration file for po4a to automatically build all the translated man |
|
33 |
pages from the .po files. |
|
34 |
There is a subdirectory for each language, named after the country code, that |
|
35 |
holds the .po files and the addendum files. As usual the initial .po file can |
|
36 |
be a copy of the .pot file. |
|
37 |
||
38 |
||
39 |
Replacement Text in Man Pages
|
|
40 |
-----------------------------
|
|
41 |
davfs2 uses all uppercase strings enclosed in @-characters for strings that may |
|
42 |
change with every version or at compile time (like @PACKAGE_STRING@ or |
|
43 |
@SYS_CACHE_DIR@). They will be replaced at compile time by the correct value. |
|
44 |
Please use them in your translation unaltered. To allow correct integration |
|
45 |
into the translated text, here are the most probable values: |
|
46 |
||
47 |
@PACKAGE@ davfs2 |
|
48 |
@PACKAGE_STRING@ davfs2 1.2.0 |
|
49 |
@PROGRAM_NAME@ mount.davfs |
|
50 |
@CONFIGFILE@ davfs2.conf |
|
51 |
@SECRETSFILE@ secrets |
|
52 |
@CERTS_DIR@ certs |
|
53 |
@CLICERTS_DIR@ certs/private |
|
54 |
@SYS_CONF_DIR@ /usr/local/etc/davfs2 or |
|
55 |
/etc/davfs2 |
|
56 |
@SYS_RUN@ /var/run/mount.davfs |
|
57 |
@SYS_CACHE_DIR@ /var/cache/davfs2 |
|
58 |
@USER@ davfs2 |
|
59 |
@GROUP@ davfs2 |
|
60 |
||
61 |
||
62 |
Additional Text
|
|
63 |
---------------
|
|
64 |
At least you want to add a paragraph about the translators into the localized |
|
65 |
man page. But maybe you feel the need for some more additions that are |
|
66 |
not present in the English man page. |
|
67 |
Unfortunately, these additions cannot be inserted directly into the .po file, |
|
68 |
as the document structure must not differ from the original. So these |
|
69 |
additions have to go into separate files, called addendum. |
|
70 |
You can use the template man/template.translator to add a paragraph about |
|
71 |
the translators. If you need more than this, you have to create additional |
|
72 |
addendum files. Please see the po4a documentation for the syntax of the |
|
73 |
PO4A-HEADER to mark the position where to add the text. |
|
74 |
Please use the same character encoding as in the .po file. |
|
75 |
||
76 |
||
77 |
Character Encoding
|
|
78 |
------------------
|
|
79 |
** This issue seems to be fixed today and man pages are allowed to be |
|
80 |
utf-8. But I am not really sure. ** |
|
81 |
At the moment, the "man" tool, or at least one of its helper programs, do not |
|
82 |
seem capable of handling UTF-8 encoding. Luckily, gettext can convert the |
|
83 |
encoding when the translated man page is created. So you may use UTF-8 in the |
|
84 |
.po file or any other encoding. But please tell me which character encoding |
|
85 |
should be used when the man page is built. |