Warning, /sdk/pology/README.rst is written in an unsupported language. File is not indexed.

0001 Pology
0002 ======
0003 
0004 Pology is a collection of command-line tools and a Python library
0005 for in-depth processing of PO files, which are the predominant
0006 medium for translation of free software and associated documents.
0007 
0008 Pology is licensed under the GNU General Public License, version 3.
0009 
0010 Installing
0011 ----------
0012 
0013 Pology may be already packaged for your operating system distribution,
0014 in which case you can install it as usual through the package system.
0015 
0016 If you want to use Pology from the source, you can either install it
0017 or use it directly from the source directory.
0018 
0019 To build and install Pology into default installation prefix, execute::
0020 
0021     $ cd <pology-source>
0022     $ mkdir build && cd build
0023     $ cmake ..
0024     $ make && make install
0025 
0026 CMake, the build system, will notify you of any missing requirements
0027 and provide notes about the command line options that you can use
0028 to customize the build (e.g. installation prefix, etc).
0029 
0030 Note that if you install Pology outside of default installation prefix,
0031 you may need to make modify the environment as listed below.
0032 
0033 To use Pology directly from the source directory, you only need to
0034 set some environment variables::
0035 
0036   $ export PYTHONPATH=<pology-source>:$PYTHONPATH
0037   $ export PATH=<pology-source>/bin:$PATH
0038 
0039 To this you may also want to enable translations of command-line messages
0040 from Pology scripts, using::
0041 
0042   $ <pology-source>/po/pology/local.sh build [LANG]
0043 
0044 where you can supply the language code LANG when you want to build
0045 translations only for that one language.
0046 
0047 For more efficient use of Pology scripts in the command line, there are some
0048 shell completion definitions provided for the Bash shell. If you have installed
0049 Pology, you can activate them with::
0050 
0051   $ . <pology-install-prefix>/share/pology/completion/bash/pology
0052 
0053 or, if running from source directory::
0054 
0055   $ . <pology-source>/completion/bash/pology
0056 
0057 
0058 Documentation
0059 -------------
0060 
0061 Pology comes with user and API documentation.
0062 
0063 If you installed Pology from operating system packages, you will likely
0064 find the user manual at::
0065 
0066   /usr/share/doc/pology/user/en_US/index.html  (one page by chapter)
0067   /usr/share/doc/pology/user/en_US/index-mono.html  (everything on one page)
0068 
0069 and the API documentation at::
0070 
0071   /usr/share/doc/pology/api/en_US/index.html
0072 
0073 There may also be some documentation for language-specific support,
0074 e.g. for language LANG and in language LANG (this may sound a bit weird,
0075 but after all, Pology is a piece of software concerned with languages)::
0076 
0077     /usr/share/doc/pology/lang/LANG/LANG/index.html
0078     /usr/share/doc/pology/lang/LANG/LANG/index-mono.html
0079 
0080 If you built and installed Pology yourself, then look for similar paths
0081 in the installation directory that you set.
0082 
0083 If you opted to run Pology from sources, you can also build documentation
0084 within the source directory, by executing::
0085 
0086   $ <pology-source>/doc/user/local.sh build  (user manual)
0087   $ <pology-source>/doc/api/local.sh build  (API documentation)
0088   $ <pology-source>/lang/LANG/doc/local.sh build  (language-specific)
0089 
0090 These lines will produce the ``<pology-source>/doc-html`` directory,
0091 with similar subpaths as above (user/, api/, etc.)
0092 
0093 
0094 Source code
0095 -----------
0096 
0097 Source releases of Pology can be fetched from http://pology.nedohodnik.net/.
0098 
0099 The latest development code can be obtained from https://invent.kde.org/sdk/pology.
0100 
0101 
0102 Contact
0103 -------
0104 
0105 Any inquiries should be directed to the mailing list at:
0106 
0107   pology@lists.nedohodnik.net
0108 
0109 To subscribe to the mailing list or view archive, visit:
0110 
0111   http://lists.nedohodnik.net/listinfo.cgi/pology-nedohodnik.net
0112 
0113 You do not have to be subscribed to send messages, but expect
0114 some moderation holdup in that case.
0115 
0116 Currently there is no dedicated bug tracking system,
0117 so use the mailing list for bug reports and patches as well.
0118 
0119 
0120 Running the tests
0121 -----------------
0122 
0123 To run the automated tests, install pytest_ and use it::
0124 
0125     pytest tests/
0126 
0127 .. _pytest: https://docs.pytest.org/en/latest/
0128 
0129 
0130 Authors
0131 -------
0132 
0133 This is a non-exhaustive list of people who contributed various stuff::
0134 
0135     Yukiko Bando <ybando@k6.dion.ne.jp>
0136     Josep Ma. Ferrer <txemaq@gmail.com>
0137     Karl Ove Hufthammer <karl@huftis.org>
0138     Chusslove Illich (Часлав Илић) <caslav.ilic@gmx.net>
0139     Fumiaki Okushi <fumiaki@okushi.com>
0140     Cristian Oneț <onet.cristian@gmail.com>
0141     Alexander Potashev (Александр Поташев) <aspotashev@gmail.com>
0142     Goran Rakic (Горан Ракић) <grakic@devbase.net>
0143     Sébastien Renard <sebastien.renard@digitalfox.org>
0144     Nick Shaforostoff (Николай Шафоростов) <shaforostoff@kde.ru>
0145     Nicolas Ternisien <nicolas.ternisien@gmail.com>
0146     Marcelino Villarino Aguiar <mvillarino@gmail.com>
0147     Javier Viñal <fjvinal@gmail.com>
0148     Manfred Wiese <m.j.wiese@web.de>
0149 
0150 Current maintainer is Chusslove Illich <caslav.ilic@gmx.net>.
0151