| 1 | EMDEBIAN-TOOLS README |
|---|
| 2 | ===================== |
|---|
| 3 | |
|---|
| 4 | SVN-BUILDPACKAGE |
|---|
| 5 | ---------------- |
|---|
| 6 | The generated manpages have been removed from SVN but are |
|---|
| 7 | needed for the package, ensure ./genmanpages is run before |
|---|
| 8 | trying to run svn-buildpackage -uc -us -rfakeroot |
|---|
| 9 | |
|---|
| 10 | TRANSLATORS |
|---|
| 11 | ----------- |
|---|
| 12 | emdebian-tools supports two kinds of translation - the debconf |
|---|
| 13 | templates and the manpages. Debconf PO files live in debian/po |
|---|
| 14 | and are already translated into many languages. Manpage translation |
|---|
| 15 | support is new and involves translating a lot of strings (over 1,600). |
|---|
| 16 | |
|---|
| 17 | To save needless SVN churn, the POT file for manpage translation is |
|---|
| 18 | NOT packaged in the emdebian-tools source package. However, it can |
|---|
| 19 | be generated, either from an SVN working copy or from the source |
|---|
| 20 | package using: |
|---|
| 21 | |
|---|
| 22 | $ ./doc/genmanpages |
|---|
| 23 | |
|---|
| 24 | This also generates the manpages themselves, including any that are |
|---|
| 25 | already translated. The command can be used repeatedly to update the |
|---|
| 26 | translated manpages as new strings / languages are added. |
|---|
| 27 | |
|---|
| 28 | To start a new translation of the manpages, run genmanpages, and |
|---|
| 29 | make a copy of po/emdebian-tools.pot using the locale name for your |
|---|
| 30 | translation, e.g. po/fr.po or po/pt_BR.po. Edit the PO file in your |
|---|
| 31 | preferred translation editor, setting the PO headers as appropriate. |
|---|
| 32 | |
|---|
| 33 | To update an existing translation, just run genmanpages which will |
|---|
| 34 | merge any new strings from po/emdebian-tools.pot into your PO file, |
|---|
| 35 | marking any modified strings as "fuzzy", adding new strings and |
|---|
| 36 | removing old ones. Edit your modified PO file to resolve the "fuzzy" |
|---|
| 37 | translations and provide translations for new strings. |
|---|
| 38 | |
|---|
| 39 | To clean up your working directory, use: |
|---|
| 40 | |
|---|
| 41 | $ fakeroot debian/rules clean |
|---|
| 42 | |
|---|
| 43 | Note that this is run automatically during the build and will remove |
|---|
| 44 | all the generated manpages prior to generating them afresh during the |
|---|
| 45 | build. *Do NOT attempt to edit the manpages themselves* |
|---|
| 46 | |
|---|
| 47 | Either commit your PO changes if you have access, or send your modified |
|---|
| 48 | PO file (not the POT file) to the debian-embedded mailing list or as an |
|---|
| 49 | i18n wishlist bug against emdebian-tools. (Once TDebs are supported in |
|---|
| 50 | Debian, new translations can be added directly without needing a bug |
|---|
| 51 | report or any action by the maintainer.) |
|---|
| 52 | |
|---|
| 53 | MANPAGE CONTENT |
|---|
| 54 | --------------- |
|---|
| 55 | |
|---|
| 56 | The manpage documentation for emdebian-tools is quite extensive and |
|---|
| 57 | alternative formats are available for easier reading: |
|---|
| 58 | |
|---|
| 59 | From Emdebian SVN, yelp can provide much nicer formatting (but only |
|---|
| 60 | for manpages derived from the XML, not those built from POD): |
|---|
| 61 | $ yelp ghelp:/$PWD/emdebian-tools.1.xml |
|---|
| 62 | |
|---|
| 63 | genmanpages creates HTML using docbook and POD formatting and the |
|---|
| 64 | files are regularly synced to the www: |
|---|
| 65 | http://linux.codehelp.co.uk/emdebian/man/ |
|---|
| 66 | |
|---|
