1
0
mirror of https://github.com/gryf/wmaker.git synced 2025-12-27 08:52:30 +01:00
Files
wmaker/doc/build/Translations.texi
Christophe CURIS bd49dbc2f5 doc: explain how to compile with language support
Now that the setup in configure.ac have been cleaned, moved the original
documentation from the 'INSTALL-WMAKER' file into the dedicated doc
'README.i18n' and updated it.

The information is completely removed from 'INSTALL-WMAKER' with an
invitation to see the new i18n doc in order to keep that file relatively
small and to avoid duplicating information, which is always harder to
maintain.

Signed-off-by: Christophe CURIS <christophe.curis@free.fr>
2015-01-20 21:29:24 +00:00

132 lines
4.6 KiB
Plaintext

\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename wmaker_i18n.info
@settitle Window Maker Internationalisation 1.0
@c %**end of header
@c This documentation is written in Texinfo format:
@c https://www.gnu.org/software/texinfo/manual/texinfo/
@c
@c The reference checker is the GNU texi2any tool, which can be invoked like this:
@c texi2any --plaintext --no-split --verbose Translations.texi
@c
@c If you modify this file, you may want to spell-check it with:
@c aspell --lang=en_GB --mode=texinfo check Translations.texi
@c
@c The length of lines in this file is set to 100 because it tends to keep sentences together
@c despite the embedded @commands{};
@c
@c It is generally considered good practice for Tex and Texinfo formats to keep sentences on
@c different lines, using the fact that in the end they will be merged in paragraph anyway, because
@c it makes the patchs clearer about where the changes actually are.
@finalout
@set version git#next
@c ---------------------------------------------------------------------------------- Title Page ---
@copying
@noindent
This manual is for @sc{Window Maker} window manager, version @value{version}.
@noindent Copyright @copyright{} 2015 The Window Maker Team.
@quotation
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program, see file COPYING for details.
@end quotation
@end copying
@titlepage
@title Window Maker Internationalisation
@subtitle A guide to enable support for language translations
@subtitle in @sc{Window Maker}.
@author Christophe CURIS
@page
@vskip 0pt plus 1filll
@insertcopying
@sp 1
Published by The Window Maker team on @today{}.
@end titlepage
@c ---------------------------------------------------------------------------- Table of Content ---
@node Top
@ifnottex
@top Window Maker Internationalisation
A guide to enable support for language translations
in @sc{Window Maker}.
@end ifnottex
@contents
@ifnottex
@sp 1
This manual is for Window Maker, version @value{version}.
@end ifnottex
@menu
* Enabling Languages support:: How to compile Window Maker with i18n support
@end menu
@c ------------------------------------------------------------------ Enabling Languages support ---
@node Enabling Languages support
@chapter Enabling Languages support
@sc{Window Maker} has the possibility to be translated in many languages, but by default none of
them will be installed, and the support for translation will not be compiled.
To enable the translation capabilities, you have to specify which language(s) you want to be
installed: this is done with the variable @env{LINGUAS} when running the @command{configure} script.
This variable should contain the space-separated list of languages you want to install.
You could for instance enable both French (@code{fr}) and Dutch (@code{nl}) with this:
@example
./configure LINGUAS="fr nl"
@end example
You can of course add any other option that you want to the @command{configure} command.
From the moment you specify the variable, the @command{configure} script will check that you have
the appropriate dependencies for this (basically the @code{gettext} function and the @code{libintl}
library); when you run @command{make} to compile the project, it will also compile the translation
(@code{mo} files) for the language(s) you asked (if available, of course), and during
@command{make install} it will install them in the usual directory.
@c --------------------------------------------------------------------- LINGUAS at system level ---
@section Setting @env{LINGUAS} at system level
As the variable @env{LINGUAS} is quite standard, you also have the possibility to set its value in
the @file{config.site} file for @sc{Autoconf}.
This file can be placed in one of these paths:
@itemize @bullet
@item @file{@emph{<prefix>}/share/config.site}
@item @file{@emph{<prefix>}/etc/config.site}
@end itemize
This way, the same language list will be used for all the programs that use @sc{Autoconf} that you
would compile.
Please note that if you also specify a value on the command line, it will have precedence over the
value in that file.
@c ------------------------------------------------------------------------------------- The End ---
@bye