========================================================================
* AUTHORS
========================================================================
$Id: AUTHORS 5191 2013-02-23 00:11:18Z karl $
Texinfo authors.
Copyright 2003, 2005, 2006, 2007, 2008, 2010, 2011
Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
Adrian Aichner texi2html.
Olaf Bachmann texi2html.
Karl Berry all files.
Per Bothner makeinfo/xml.c, makeinfo/docbook.c updates.
Torsten Bronger texinfo.dtd.
Bob Chassell texinfo.tex, original texinfo.txi.
Lionel Cons original texi2html.
Akim Demaille texi2dvi, util/* tests.
Patrice Dumas texi2html, texi2html.texi, texinfo.txi, tp author.
Alper Ersoy makeinfo: enhancements in all files, especially
html-, xml-, and docbook-related.
Brian Fox all makeinfo/* and info/* files, info-stnd.texi.
Noah Friedman original texi2dvi.
Oleg Katsitadze doc/*
Dave Love original makeinfo/html.[ch].
Karl Heinz Marbaise original makeinfo language support, most files,
texi2html manual.
Philippe Martin original makeinfo xml/docbook output.
Sergey Poznyakoff all files.
Derek Price texi2html.
Paul Rubin original makeinfo/multi.c.
Andreas Schwab texinfo.tex, configure.ac, most makeinfo files.
Richard Stallman original texinfo.tex, install-info.c,
texindex.c, texinfo.txi.
Zack Weinberg texinfo.tex: @macro implementation.
Ralf Wildenhues util/gendocs.sh, makeinfo/tests/*,
makeinfo/html.c, makeinfo/cmds.c, makeinfo/footnote.c,
doc/texinfo.txi,
Makefile.am, configure.ac.
Eli Zaretskii all files.
See http://translationproject.org/team/index.html for the
translation teams for a given language LL. Additional info for
original texi2html translations:
fr: Patrice Dumas and Jean-Charles Malahieude
de: Reinhold Kainhofer
pt_BR,
pt: Jorge Barros de Abreu
ja: Found in Fedora. Don't know the author.
es: Francisco Vila
it: Federico Bruni
hu: Dénes Harmath
Images in the images directory come from the Singular project:
http://www.singular.uni-kl.de/
Many files included in the Texinfo distribution are copied from other
locations, no author information is given for those. See util/srclist*.
========================================================================
* Pod-Simple-Texinfo/README
========================================================================
Pod-Simple-Texinfo version 0.01
===============================
Pod::Simple based Pod formatter to render Texinfo.
INSTALLATION
To install this module type the following:
perl Makefile.PL
make
make test
make install
DEPENDENCIES
This module requires these other modules and libraries:
Pod::Simple::PullParser, Texinfo::Parser.
COPYRIGHT AND LICENCE
Copyright (C) 2011, 2012 Free Software Foundation, Inc.
This library 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 3 of the License,
or (at your option) any later version.
_url_escape is general_url_escape from Pod::Simple::HTML.
========================================================================
* README
========================================================================
$Id: README 5191 2013-02-23 00:11:18Z karl $
This is the README file for the GNU Texinfo distribution. Texinfo is
the preferred documentation format for GNU software.
Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
2002, 2003, 2004, 2009, 2010, 2011, 2012, 2013
Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
Home page: http://www.gnu.org/software/texinfo/
This page includes links to other Texinfo-related programs.
Primary distribution point: http://ftp.gnu.org/gnu/texinfo/
automatic mirror redirection: http://ftpmirror.gnu.org/texinfo/
mirror list: http://www.gnu.org/prep/ftp.html
Texinfo is a documentation system that uses a single source to produce
many forms of output:
- a PDF or DVI document (via the TeX typesetting system) with the normal
features of a book, including sectioning, cross references, indices, etc.
- an Info file with analogous features to make documentation browsing easy.
- a plain text (ASCII) file.
- an HTML output file suitable for use with a web browser.
- a Docbook file.
- a XML file transliterating the source with a Texinfo DTD.
See ./INSTALL* for installation instructions.
To get started with Texinfo, best is to read the Texinfo manual;
it is online at http://www.gnu.org/software/texinfo/manual/texinfo.
If you don't have Internet access, you can read the manual locally:
- first, build the distribution.
- then, for HTML, run: make -C doc html
and you can start reading at doc/texinfo.html/index.html.
- for PDF, if you have a working TeX, run: make -C doc pdf
- for Info, you can read about the Info reader itself with:
./info/ginfo doc/info
and then read the Texinfo manual:
./info/ginfo doc/texinfo
Texinfo mailing lists and archives:
- http://lists.gnu.org/mailman/listinfo/bug-texinfo
for bug reports, enhancement suggestions, technical discussion.
- http://lists.gnu.org/mailman/listinfo/help-texinfo
for authoring questions and general discussion.
There are no corresponding newsgroups.
Bug reports:
Please include enough information for the maintainers to reproduce the
problem. Generally speaking, that means:
- the contents of all input files necessary to reproduce the bug (crucial!).
- a statement of the problem and any samples of the erroneous output.
- the version number of Texinfo and the program(s) involved (use --version).
- hardware and operating system information (uname -a).
- unusual options you gave to configure, if any (see config.status).
- anything else that you think could be helpful.
Patches are most welcome; if possible, please make them with diff -c and
include ChangeLog entries.
See README-hacking for information on the Texinfo development
environment -- any interested parties are welcome. If you're a
programmer and wish to contribute, this should get you started. If
you're not a programmer, you can still make significant contributions by
writing test cases, checking the documentation against the
implementation, etc.
This distribution includes the following files, among others:
README This file.
README-hacking Texinfo developer information.
INSTALL Texinfo-specific installation notes.
NEWS Summary of new features by release.
Texinfo documentation files (in ./doc):
texinfo.txi Describes the Texinfo language and many
of the associated tools. It tells how to use
Texinfo to write documentation, how to use
Texinfo mode in GNU Emacs, TeX,
texi2any/makeinfo, and much else.
info.texi Describes how to read manuals in Info.
This document also comes as part of GNU Emacs.
info-stnd.texi How to use the standalone GNU Info reader that is
included in this distribution (./info).
Printing-related files:
doc/texinfo.tex This implements Texinfo in TeX, to typeset a
Texinfo file into a DVI or PDF file.
util/texindex.c This file contains the source for
the `texindex' program that generates
sorted indices used by TeX when
typesetting a file for printing.
util/texi2dvi This is a shell script for producing an
indexed DVI file using TeX and texindex.
util/texi2pdf Generate PDF (wrapper for texi2dvi).
Source directories:
djgpp/ Support for compiling under DJGPP.
gnulib/ Support files from Gnulib.
info/ Standalone Info reader.
install-info/ Maintain the Info dir file.
tp/ Texinfo Parser in Perl, includes texi2any/makeinfo.
Translation support:
po/ Strings of the programs.
po_document/ Strings in generated Texinfo documents.
Installation support:
Makefile.am Read by Automake to create a Makefile.in.
Makefile.in Read by configure to make a Makefile,
created by Automake.
configure.ac Read by Autoconf to create `configure'.
configure Configuration script for local conditions,
created by Autoconf.
build-aux/ Common files.
Finally, the contrib/ directory contains additional files from users
provided for your reading and/or hacking pleasure. They aren't part of
Texinfo proper or maintained by the Texinfo developers.
========================================================================
* README-hacking
========================================================================
$Id: README-hacking 5234 2013-03-12 22:56:31Z karl $
This file describes the development environment for Texinfo.
Copyright 2002, 2003, 2005, 2006, 2007, 2008, 2010, 2011, 2012, 2013
Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
The development sources for GNU Texinfo are available through anonymous
CVS at Savannah:
http://savannah.gnu.org/cvs/?group=texinfo
This distribution uses whatever versions of Automake, Autoconf, and
Gettext are listed in NEWS; usually the latest official releases. If you
are getting the sources from CVS (or change configure.ac), you'll need
to have these tools installed to (re)build. You'll also need help2man.
All of these programs are available from http://ftp.gnu.org/gnu.
After getting the CVS sources, and installing the tools above, you can run
./autogen.sh
and then, for example,
./configure -C CFLAGS='-g -Wdeclaration-after-statement'
and then
make
After the initial autogen && configure, simply running make should suffice.
The -C tells configure to cache test results, which usually speeds
things up a bit.
That particular -W is useful because a) intermixing declarations with
statements is an easy thing to do accidentally, b) gcc doesn't warn
about it by default, and c) other compilers that don't support it are
still widespread. If you're not using gcc, of course you shouldn't
specify that option.
Other -W options can be useful too, and patches are welcome to resolve
diagnostics; however, removing all possible warning messages, or
warnings with nonfree compilers, is explicitly not a goal.
If you want to delve into making a new backend for the Perl makeinfo,
the documentation in tp/Texinfo/Convert/Converter.pm is a good starting
point, as it describes the existing backends and other places to look.
Translations are handled through the Translation Project. When a new
.po is posted in
http://translationproject.org/latest/texinfo
http://translationproject.org/latest/texinfo_document
it should be installed.
This distribution also uses Gnulib (http://www.gnu.org/software/gnulib)
to share common files. Gnulib files used in Texinfo are checked in to
CVS. If you get automake/conf/etc. errors from ./autogen.sh, please try
doing a CVS checkout of gnulib (in a separate directory from the texinfo
checkout), and then run, say,
../gnulib/gnulib-tool --add-import
in your top-level Texinfo directory. (gnulib-tool is in the gnulib CVS tree.)
The currently-used gnulib modules and other gnulib information are
recorded in gnulib/m4/gnulib-cache.m4. Given a source checkout of
gnulib, you can update the files with gnulib-tool --add-import.
About running the Texinfo programs from a development source tree:
- Once the distribution is built, you can run the compiled programs
(info, texindex, install-info) out of the build tree without special
settings; they don't try to read any installed data files.
- The texi2dvi script and texinfo.tex can be run as-is, since they
are standalone and don't require compilation. For the same reasons,
they are officially updated between full Texinfo releases, at
http://ftpmirror.gnu.org/texinfo.
- Regarding texi2any (aka makeinfo), you can run tp/texi2any.pl
directly. This is the original source file for the program, so it's
convenient to be able to make changes and then run it.
To run it under a name that doesn't end in .pl, e.g., "makeinfo", you
can set the environment variable TEXINFO_DEV_SOURCE to 1, or symlink to
a trivial script:
#!/bin/sh
exec /YOUR/TEXINFO/DIR/tp/texi2any.pl "$@"
Steps for making a release (pretest or official):
- First checks:
ensure texinfo.tex, texi2dvi, and htmlxref.cnf are updated on ftp.gnu.org.
ensure TXI_XLATE in doc/Makefile.am matches actual file list.
- Official releases only:
version number in texi2dvi, texi2pdf, txirefcard.tex.
sync texi2html/test/ results with tp/.
ensure building standalone modules for CPAN still works.
make dvi and fix underfull/overfull boxes.
specially plead with bug-texinfo / beebe / compile farms to try.
try groff.texinfo from groff source repo.
- Changes to sources:
update version in configure.ac, ChangeLog; NEWS with date if official.
gnulib-tool --add-import
util/srclist-txi
pod2man Pod-Simple-Texinfo/pod2texi.pl >man/pod2texi.1 # until we fix deps
make
make po-check # update po/POTFILES.in as needed
make -C po update-po # but don't commit yet, dist updates po_document
make -C doc wwwdoc-build # and eventually -install, for official.
(export MALLOC_CHECK_=2; make distcheck) # repeat until clean
svn commit # when clean, then distcheck to be sure.
#create diff for official, see below
- To do the actual upload:
pkg=texinfo
ver=5.0.91
then do one of:
gnupload --to alpha.gnu.org:$pkg $pkg-$ver.tar.xz #pretest
gnupload --to ftp.gnu.org:$pkg $pkg-$ver.tar.{gz,xz} *.diff.gz #official
and the corresponding, to save in local archives:
mv -v $pkg-$ver.tar.xz* $misc/archive/$pkg/alpha/ #pretest
mv -v $pkg-$ver.tar.{gz,xz}* *.diff.gz $misc/archive/$pkg/ #official
For pretest release, send announcement to bug-texinfo.
- When official release is out there ...
... update DTD and web pages:
cd $HOME/gnu/www/texinfo/dtd # or wherever webpages checkout is
mkdir $ver; cvs add $ver
cp $tutil/texinfo.dtd $ver
cvs add $ver/texinfo.dtd
cvs com -m$ver $ver
update home page (texinfo.html) and commit as needed.
update manual, including:
pod2html Pod-Simple-Texinfo/pod2texi.pl >pod2texi.html
... tag source tree:
cvs tag -b texinfo_`echo $ver | tr . _`
... update texinfo at tug.org (contact root@tug.org); from last time:
prev=4.13
ver=5.0
cd ~ftp/tex
rm -rf texinfo-$prev*
cp ~/src/texinfo/texinfo-$ver.tar.{gz,xz} .
tar xzf texinfo-$ver.tar.gz
ln -s texinfo-$ver.tar.gz texinfo.tar.gz
!!:gs/gz/xz
relink texinfo $ver
... announcements:
news item at savannah.
send announcement to info-gnu, cc bug-texinfo.
... make diffs at official release:
prev=4.13
ver=5.0
cd $xarchive/../prod
tar xf texinfo-$ver.tar.gz
tar xf texinfo-$prev.tar.gz
diff -Nrc2 texinfo-$prev texinfo-$ver | xz >texinfo-$prev-$ver.diff.xz
gnupload --to ftp.gnu.org:texinfo !$
rm -rf texinfo-$ver texinfo-$prev
ro texinfo-*$ver*
========================================================================
* contrib/README
========================================================================
$Id: README 5191 2013-02-23 00:11:18Z karl $
texinfo/contrib/README
Copyright 2013 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
The items here are for your amusement and/or hacking pleasure.
See comments and/or --help strings in each for their purpose(s).
They are all free software, but not officially part of Texinfo, and the
Texinfo maintainers don't support them (and generally have no knowledge
about them, just passing them on).
The texifont/ subdirectory was an attempt at implementing a generalized
font system, but it remains incomplete. See the README there.
In contrast, the two txipsfonts-* files are attempts by Torsten Bronger
and Stephen Gildea, respectively, to use base PostScript fonts instead
of Computer Modern, in the simplest way. (I could not find the right
version of the original texinfo.tex on which Torsten's file was based.)
Adapting one of these to actually be installable would doubtless be much
simpler (which is not to say simple) than finalizing texifont/, though
of course much less featureful.
The perldoc-all subdirectory is about making Texinfo out of the standard
Perl *.pod files. The results are at
http://www.gnu.org/software/perl/manual.
========================================================================
* contrib/perldoc-all/README
========================================================================
$Id: README 5191 2013-02-23 00:11:18Z karl $
texinfo/contrib/perldoc-all/README
Copyright 2013 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
This stuff is about making Texinfo out of the standard Perl *.pod files.
The results are at http://www.gnu.org/software/perl/manual.
The idea is to download the perl distribution here, as in,
wget http://www.cpan.org/src/5.0/perl-5.16.2.tar.gz
and run (GNU) make. Aside from the result hopefully being useful in
itself, it also serves as a nontrivial example of using pod2texi.
========================================================================
* doc/README
========================================================================
$Id: README 5191 2013-02-23 00:11:18Z karl $
texinfo/doc/README
Copyright 2002, 2011 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
This directory contains documentation on the Texinfo system and the TeX
sources needed to process Texinfo sources. We recommend using the
texi2dvi included in this distribution to run a Texinfo manual through
TeX to produce a DVI file.
The .tex files are not installed automatically because TeX installations
vary so widely. Installing them in the wrong place would give a false
sense of security. So, you should simply cp *.tex to the appropriate
place. If your installation follows the TeX Directory Structure
standard (http://tug.org/tds/), this will be the directory
TEXMF/tex/texinfo/ for texinfo.tex, and TEXMF/tex/generic/epsf/ for
epsf.tex.
It is also possible to put these .tex files in a `local' place instead
of overwriting existing ones, but this is more complicated. See your TeX
documentation in general and the texmf.cnf file in particular for information.
If you add files to your TeX installations, not just replace existing
ones, you very likely have to update your ls-R file; do this by
running the mktexlsr command.
You can get the latest texinfo.tex from
ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex (and all GNU mirrors)
ftp://tug.org/tex/texinfo.tex (and all CTAN mirrors)
or from the gnulib project on Savannah (among other places).
If you have problems with the texinfo.tex in this distribution, please check
for a newer version.
========================================================================
* info/README
========================================================================
$Id: README 5191 2013-02-23 00:11:18Z karl $
texinfo/info/README
Copyright 2002, 2011 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
Info 2.0 is a complete rewrite of the original standalone Info that I
(Brian Fox) wrote in 1987, the first program I wrote for rms. That
program was something like my second Unix program ever, and my die-hard
machine language coding habits tended to show through. I found the
original Info hard to read and maintain, and thus decided to write this one.
The rewrite consists of about 12,000 lines of code written in about 12
days. I believe this version of Info to be in much better shape than the
original Info.
Info 2.0 is substantially different from its original standalone
predecessor. It appears almost identical to the GNU Emacs version, but has
the advantages of smaller size, ease of portability, and a built in library
which can be used in other programs (to get or display documentation from
Info files, for example).
A full listing of the commands available in Info can be gotten by typing
`?' while within an Info window. This produces a node in a window which
can be viewed just like any Info node.
--Brian Fox
========================================================================
* install-info/README
========================================================================
$Id: README 5191 2013-02-23 00:11:18Z karl $
texinfo/install-info/README
Copyright 2008, 2011, 2012 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
install-info updates the top-level dir file in the Info tree.
(It does not actually install .info files into the Info directory, oddly
enough.)
========================================================================
* tp/README
========================================================================
$Id: README 5222 2013-03-08 17:38:27Z karl $
texinfo/tp/README
Copyright 2011, 2012, 2013 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
Texinfo::Parser (hence the directory name tp) is a Perl module for
parsing Texinfo code into a tree representing the Texinfo code
structure.
These other modules and libraries are required (all have been standard
parts of Perl for years, at least since 5.7.3):
Carp, Config, Data::Dumper, Encode, File::Basename, File::Spec
Getopt::Long, Unicode::Normalize, Storable
It also uses the less widely-available modules:
Locale::Messages, Unicode::EastAsianWidth, Text::Unidecode
For these, internal versions are included, and are installed and used as
part of Texinfo (not disturbing the Perl installation at all).
To run the tests you also need:
Test::More, Data::Compare, Test::Deep
On Debian-based distros, Test::More is part of perl-modules and thus
installed with perl, the packages corresponding to the other modules
are named:
libdata-compare-perl libtest-deep-perl
This module is part of GNU Texinfo. A standalone Perl module may also be
produced from within the the Texinfo tree, using
./maintain/prepare_perl_module.sh
The resulting module, although standalone, should always be regenerated
from the sources in Texinfo, to avoid divergence of sources.
If you want to delve into making a new backend, the documentation in
tp/Texinfo/Convert/Converter.pm is a good starting point, as it
describes the existing backends and other places to look. To do a good
job, expect to spend a lot of time making it do the right thing with the
existing tests.
========================================================================
* tp/maintain/lib/Text-Unidecode/README
========================================================================
README for Text::Unidecode
Time-stamp: "2001-07-14 02:03:33 MDT"
Text::Unidecode
NAME
Text::Unidecode -- US-ASCII transliterations of Unicode text
SYNOPSIS
use utf8;
use Text::Unidecode;
print unidecode(
"\x{5317}\x{4EB0}\n"
# those are the Chinese characters for Beijing
);
# That prints: Bei Jing
DESCRIPTION
It often happens that you have non-Roman text data in Unicode, but
you can't display it -- usually because you're trying to show it
to a user via an application that doesn't support Unicode, or
because the fonts you need aren't accessible. You could represent
the Unicode characters as "???????" or "\15BA\15A0\1610...", but
that's nearly useless to the user who actually wants to read what
the text says.
What Text::Unidecode provides is a function, `unidecode(...)' that
takes Unicode data and tries to represent it in US-ASCII
characters (i.e., the universally displayable characters between
0x00 and 0x7F). The representation is almost always an attempt at
*transliteration* -- i.e., conveying, in Roman letters, the
pronunciation expressed by the text in some other writing
system. (See the example in the synopsis.)
See the POD for more information.
REQUIREMENTS
This module requires Perl 5.6.0 or higher. (Earlier Perls apparently
lack the "use utf8" pragma that Text::Unidecode needs.)
I have also observed that 5.6.0's Unicode support is shakey; strongly
consider upgrading to 5.6.1 at least.
INSTALLATION
You install Text::Unidecode, as you would install any perl module
library, by running these commands:
perl Makefile.PL
make
make test
make install
If you want to install a private copy of Text::Unidecode in your home
directory, then you should try to produce the initial Makefile with
something like this command:
perl Makefile.PL LIB=~/perl
See perldoc perlmodinstall for more information on installing modules.
DOCUMENTATION
POD-format documentation is included in Unidecode.pm. POD is readable
with the 'perldoc' utility. See ChangeLog for recent changes.
SUPPORT
Questions, bug reports, useful code bits, and suggestions for
Text::Unidecode should just be sent to me at sburke@cpan.org
AVAILABILITY
The latest version of Text::Unidecode is available from the
Comprehensive Perl Archive Network (CPAN). Visit
to find a CPAN site near you.
COPYRIGHT
Copyright 2001, Sean M. Burke , all rights reserved.
The programs and documentation in this dist are distributed in the
hope that they will be useful, but without any warranty; without even
the implied warranty of merchantability or fitness for a particular
purpose.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
========================================================================
* tp/maintain/lib/Unicode-EastAsianWidth/README
========================================================================
NAME
Unicode::EastAsianWidth - East Asian Width properties
VERSION
This document describes version 1.10 of Unicode::EastAsianWidth,
released October 14, 2007.
SYNOPSIS
use Unicode::EastAsianWidth;
$_ = chr(0x2588); # FULL BLOCK, an ambiguous-width character
/\p{InEastAsianAmbiguous}/; # true
/\p{InFullwidth}/; # false
{
local $Unicode::EastAsianWidth::EastAsian = 1;
/\p{InFullwidth}/; # true; only works on perl 5.8+
}
DESCRIPTION
This module provide user-defined Unicode properties that deal with East
Asian characters' width status, as specified in
.
It exports the following functions to the caller's scope, to be used by
Perl's Unicode matching system: "InEastAsianFullwidth",
"InEastAsianHalfwidth", "InEastAsianAmbiguous", "InEastAsianNarrow"
"InEastAsianWide", "InEastAsianNeutral".
In accord to TR11 cited above, two additional context-sensitive
properties are exported: "InFullwidth" (union of "Fullwidth" and "Wide")
and "InHalfwidth" (union of "Halfwidth", "Narrow" and "Neutral").
*Ambiguous* characters are treated by default as part of "InHalfwidth",
but you can modify this behaviour by assigning a true value to
$Unicode::EastAsianWidth::EastAsian.
CAVEATS
Setting $Unicode::EastAsianWidth::EastAsian at run-time only works on
Perl version 5.8 or above. Perl 5.6 users must use a BEGIN block to set
it before the "use" statement:
BEGIN { $Unicode::EastAsianWidth::EastAsian = 1 }
use Unicode::EastAsianWidth;
SEE ALSO
perlunicode,
AUTHORS
Audrey Tang
COPYRIGHT
Copyright 2002, 2003, 2007 by Audrey Tang .
This software is released under the MIT license cited below.
The "MIT" License
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
========================================================================
* tp/maintain/lib/libintl-perl/sample/README
========================================================================
This is a simple, respectively stupid Perl package that shows how the
complete internationalization process for a Perl package *could* be
done. It does not claim to be the smartest or the only possible
solution, but it provides at least a skeleton for real packages. If
libintl-perl should someday become an "established" Perl package, it
would probably be a lot better to seamlessly integrate the process
into ExtUtils::MakeMaker, but for now it's all we have.
The example focuses on the packaging process, i. e. on the things you
have to do to maintain an internationalized Perl package, so that
users of your package will benefit from translations you provide. It
therefore doesn't make use of any of the nitty-gritty details of
message translation like plural handling or the like.
Requirements
------------
The only requirement is a Perl aware version of GNU gettext. Perl
support was introduced only recently in GNU gettext, and you will have
to check whether your copy of GNU gettext already supports Perl.
Support for Perl was introduced in version 0.12.2 of GNU gettext. If
your version is older, you have to update GNU gettext.
First test
----------
The subdirectory "simplecal" contains a regular Perl package like the
ones you will find on the CPAN. You should first try to build and
use the package:
cd simplecal
perl Makefile.PL
make
If you see a warning that the prerequisite Locale::TextDomain is not
found, then you have to install libintl-perl first.
You should never "make install", the package is only a stupid example
and you will not really want to install it. You can simply try it out
from the installation directory itself:
perl -Ilib bin/simplecal.pl
It should print a crude calendar representation in English, or even in
your preferred language, depending on your system settings.
The Programming
---------------
Now we should dig into the sources. All relevant files are commented
and should give you a pretty good idea of what's going on. Change
your directory to the package directory "simplecal" and inspect the
source files.
The heart of the library is found in the file lib/SimpleCal.pm. This
Perl module defines functions that map numeric values to month names
or abbreviated week day names. You will find nothing unusual in this
module except for a line at the beginning of the file that reads:
use Locale::TextDomain qw (org.imperia.simplecal);
In case you are not familiar with the operator "qw", this is an
equivalent writing of
use Locale::TextDomain ('org.imperia.simplecal');
That line in the code does three things: It imports the module
Locale::TextDomain, *and* it states that the text domain (or
identifier) for this package is "org.imperia.simplecal", *and* it says
that the translations for this package can be found in the
subdirectory "LocaleDate" of any component of @INC (unless it can be
found in one of the system locations). See the POD in
Locale::TextDomain for more information.
You may also find out that some strings have a "__" or a "N__" in
front of them. The explanation to these funny things has two sides:
First, they mark the following strings as being translatable, so that the
parser "xgettext" included in GNU gettext can find them. Yet, at runtime
both "__" and "N__" are really function names, and they will look up
their argument in the translation database. There is more
documentation available on this. Guess where! Yepp, in the POD of
Locale::TextDomain.
The library is used by a Perl script "bin/simplecal.pl". Let's have a
look at that script now. The first remarkable line is the one that
calls POSIX::setlocale():
setlocale (LC_MESSAGES, '');
The POD of the POSIX module gives additional information on the
function setlocale(). In brief, that call initializes the locale
settings for the category "LC_MESSAGES" to the pre-selected user
settings (this is indicated by the empty second argument). The
constant LC_MESSAGES is exported by Locale::Messages, which is always
a safe choice. If your script is only intended to run with Perl 5.8
or better, you can also import LC_MESSAGES from the POSIX module.
The rest of the program only prints a calendar for the current month.
It retrieves the name of the month and the abbreviated weekday names
from our little SimpleCal.pm module which provides this information in
a localized form.
A Dutch Calendar
----------------
We want to see the calendar in Dutch now. All you have to do is to
set the environment variable LANGUAGE to the value "nl". If you don't
know how to do this, add the following line somewhere at the top of
"bin/simplecal.pl":
$ENV{LANGUAGE} = "nl";
Now run the script again:
perl -Ilib bin/simplecal.pl
It should print out the calendar in Dutch. Look at the *.po files in
the subdirectory "po" for a list of other translations I have
prepared. You can try them out in a similar manner.
Please see the file "README-NLS" in subdirectory "sample/simplecal"
for details on how to set the language via environment variables.
The Subdirectory "po"
---------------------
This directory contains the raw translations and a Makefile that will
compile and install them. If you enter this directory and type "make"
you will see a list of the available Makefile targets.
The first one is the target "pot", a so-called phony target, i. e. it
is not related to a file with the name of "pot". The command "make
pot" will remake the master catalog of the package and place the
result in the file "org.imperia.simplecal.pot"
("org.imperia.simplecal" is the text domain resp. identifier for our
package). Type the command "make pot" now to see how the master
catalog is actually generated. If the output says something like
"nothing to be done for `pot'", then delete the file
"org.imperia.simplecal.pot" and try again.
You should see now that the target file "org.imperia.simplecal.pot" is
generated by the program xgettext with a plethora of options:
xgettext --output=./org.imperia.simplecal.pox --from-code=utf-8 \
--add-comments=TRANSLATORS: --files-from=./POTFILES.in \
--copyright-holder="Imperia AG Huerth/Germany" \
--keyword --keyword='$__' --keyword=__ --keyword=__x \
--keyword=__n:1,2 --keyword=__nx:1,2 --keyword=__xn \
--keyword=N__ --language=perl && \
rm -f org.imperia.simplecal.pot && \
mv org.imperia.simplecal.pox org.imperia.simplecal.pot
Type "xgettext --help" for a detailled explanation of the command line
options. In brief this invocation causes xgettext to read a list of
files from the file "POTFILES.in", extract all messages from these
source files and place the result in the output file
"org.imperia.simplecal.pox". If the command succeeds, the old ".pot"
file is replaced by the new ".pox" file.
Yes, this is complicated, and that is why this skeleton Makefile is
provided here. You can copy it without any modification into your
package to use it.
The file POTFILES.in contains a list of source files to be scanned for
translatable strings. Have a look at it, and you will understand it.
The Makefile also includes a file called "PACKAGE". This file contains
all package-dependent information in a couple of Makefile variables:
- TEXTDOMAIN
This Makefile variable should contain the text domain/identifier
for your package. Please see the POD of Locale::TextDomain for advice
on a reasonable naming.
- LINGUAS
The language codes of all languages supported by your package. Each
entry corresponds to a po file in the po subdirectory.
- COPYRIGHT_HOLDER
Usually your name. Whatever you put here will be included as the
copyright holder in the header of the po files.
- MSGID_BUGS_ADDRESS
Usually your name and e-mail address. It will also be included in the
po header and translators will check this entry when they come across
a bug in a msgid, or when they have difficulties to translate a certain
message because of awkward coding on your side.
Okay, after "make pot" we have updated the master message catalog
TEXTDOMAIN.pot, in our case "org.imperia.simplecal.pot". Have a look
into the file now. It contains the original English messages that
xgettext has extracted from our source files and blank translations.
The po files (the files the names of which end with ".po") contain
previous translations provided by our package translators. Whenever
you change the Perl sources, the list of messages may change. This
results in a maybe new .pot file and requires an update of all po
files. Try that now and type "make update-po"
You will see confusing output from "make" but you may get the idea
that every single po file (every language that the package supports)
gets updated, and the new strings are inserted into the po
files. Since nothing really changed here (we did not change the source
files yet) you can now try to update the compiled po files which end in
".mo" with "make update-mo".
Again, you will see maybe cryptic output from "make" that signifies
that all compiled files are re-generated now by a program called
"msgfmt".
The last step requires that you copy the (possibly changed) mo files
into your package by "make install". This will copy the mo files into
the subdirectory "LocaleData" of your package so that libintl-perl is
able to find them at runtime.
You can perform all these steps at once by typing "make all" although
this is mostly useful for testing purposes. In reality the workflow
is different:
- You change your source files, messages may have been added, deleted
or modified. You will have to update the master message catalog by
typing "make pot".
- Since the translations may have gotten out-of-date, you will have to
merge your changes into all po files by "make update-po".
- Your translators will get copies of the po files, reflect your
changes in the po files and send them back to you.
- When you have received the updates, it is time to compile the po
files into a binary representation with "make update-mo".
- These binary mo files have to be installed under "LocaleData", and
you have to "make install". Note that "make install" installs the
mo files in your source package, not in the system location!
- Now that you have updated the translations for your package, you
will want to upload a new version to the CPAN.
Note that all these steps are *only* necessary for package
maintainers. As a user of the package, you will only see the
resulting mo files under "LocaleData". End users do *not* need any of
the gettext tools, and they do not have to perform any of the above
steps theirselves!
Changing the Sources
--------------------
You may wonder whether your translators have to re-translate
everything from scratch whenever you change your Perl sources. This
is, of course, not the case. Let's say, you want to add a welcome and
a good-bye message to the program output. Have a look into
"bin/simplecal.pl" and you will see that this is already prepared but
commented out (search for "Welcome to" and "Bye" if you can't find
it). Uncomment these lines and see what happens to the po files in
that case.
Before you proceed, you should have a look at the Dutch translation
file "nl.po". At the bottom you will find some lines that are
commented out with "#~" and that proove that I have already prepared
that case. The comment sign "#~" in po files signifies that a
particular translation is obsoleted, i. e. no longer needed because it
is no longer present in the source files.
Say, that you have really changed your mind, and you want to
re-introduce the welcome and good-bye messages to your program and you
uncomment the corresponding lines in "bin/simplecal.pl". You will
have to re-make the master catalog "org.imperia.simplecal.pot" by
"make pot", and then "make update-po" to update the po files. In
fact, "make update-po" is sufficient because it will also update the
pot file if it is out-of-date (i. e. if any of the source files have
changed in the meantime).
Type "make update-po" now, and look again at "po/nl.po". You will see
that the previously translated welcome and good-bye messages have been
re-activated from the obsoleted entries. In fact your translators
will have nothing to do, because their old translations are still
valid. Type "make install" and then re-run "perl -Ilib
bin/simplecal.pl", set the environment variable "LANG" to any of the
available languages, and things will still work perfectly.
Of course, it is a rare case that messages are discarded and later
re-activated in programming sources. It is more likely that you will
modify a message, or maybe add a message that is similar to former
ones. Let's say that you want to change the exclamation mark in the
good-bye message at the bottom of the script to a simple full stop.
Look for the line that reads
print __"Bye!\n";
and change it into
print __"Bye.\n";
Change into the directory "po", update the translation files with
"make update-po" and inspect the file "nl.po". At first glance, you
may not see any change. But then: The entry for the good-bye message
has an additional comment "#, fuzzy". The fuzzy mark signifies that
the msgerge program has found that a message is very similar to a
previous message (even obsoleted ones are taken into account), and
that it proposes an old translation here. The translator will
normally modify the translation accordingly (without having to re-type
everything), remove the fuzzy mark and send back the translation to
you.
In fact you could also install translations that have not been revised
by the translator and are still marked as fuzzy. This is not
recommended however! The algorithm used in msgmerge is quite smart
and seldom fails to detect minimal changes in the source message and
propose the old translation. However, it often proposes translations
from other valid or obsoleted entries that are only vaguely related to
the real meaning. You should understand the fuzzy merging mechanism
as a helpful feature to the translator only and never install fuzzy
translations unless you absolutely know what you are doing.
Pass Comments to Translators
----------------------------
The po files contain references for every message to the corresponding
source files as comments. But you still may feel a need for giving
hints to the translators. You may want to tell the translators, that
the good-bye message can be somewhat sloppy (or whatever you like).
This is simple to do. Have a look at the good-bye message in
"bin/simplecal.pl" and you will see that it is preceded by a comment
introduced with the string "TRANSLATORS:". If you start your Perl
comment like this, it will end up as a comment for translators in the
resulting po (resp. pot) file and may serve as a hint for translators.
In fact, the string "TRANSLATORS:" is arbitrarily chosen. If you
prefer another string, change it in the invocation of "xgettext" in
the skeleton Makefile provided here.
Informational Files
-------------------
You should put two additional files in your distribution. The first
one is "README-NLS". It should be a verbatim copy of the most recent
version found in the "simplecal" sample package. Please send
corrections or improvements to this file to the maintainer Guido
Flohr , and add package-specific notes to your
documentation instead. Users expect this file to have a standard
contents, and they will not check it for changes on a regular basis.
The file "TRANSLATIONS" should reflect the current translation status
of your package. It should list all currently availabe translations,
their completeness, and it should also inform your user which translations
are actively maintained, and which are not. You can find a sample
in the "simplecal" sample package.
Bringing It All Together
------------------------
The above sounds definitely more complicated than it is. In practice
you code as before but mark all your strings with "__" and friends
like described in the POD of Locale::TextDomain. Before a new release
you change into the directory "po" of your distribution and type "make
update-po" to update the available translations. Distribute the
modified po files to your translators, and once you have collected
them all, type "make install" to add them to your distribution.
That's all, all translations will be available in your package now.
Internationalizing Existing Packages
------------------------------------
Internationalizing an already existing package with libintl-perl is
less painful than you think. The following roadmap should do it with
minimal effort.
First create a subdirectory "po" in your sources, copy the "Makefile"
from this sample, and copy and edit the files "TEXTDOMAIN" and
"LINGUAS" (LINGUAS can set the Makefile variable "LINGUAS" to the
empty string and TEXTDOMAIN should set "TEXTDOMAIN" to a name as
advised in the POD of Locale::TextDomain).
Next you have to mark the translatable strings in your sources with
"__" and friends. You can do that by hand, but isn't that the kind of
job that you have bought a computer for? List your source files in
"po/POTFILES.in" and then try
xgettext -a --files-from=POTFILES.in -o all.pot
The option "-a" instructs xgettext to extract *all* strings from your
sources. This option may miss a few strings (consider a bug report in
that case), it will issue a lot of warnings about "illegal variable
interpolations" (see the POD of Locale::TextDomain for workarounds)
and will put a lot of strings extracted from your sources into the
file "all.pot".
Now, load the file "all.pot" into an editor of your choice. If your
choice is "GNU emacs" you will have maximum comfort: Select an entry,
type "s" and you can cycle through the source files that this
particular entry originates from. Other PO editors like KBabel or
PO-Edit provide similar functionality. But even with the "Notepad" on
MS-DOS you will be able to navigate to the corresponding source file.
Once you have found the origin in your sources, you have to decide
whether this is a false positive, and you simply ignore it. If it is
a translatable string you either simply mark it with "__" or you
"repair" it.
What does "repair" mean? Again, the POD of Locale::TextDomain... In
brief: Your Perl sources will be full of stuff like:
die "Cannot open file '$filename': $!\n";
This string is not suitable for translation, because it is not
constant. It may change depending on the value of the variable
$filename and the value of $!. You will have to change that into
something like:
die __x ("Cannot open file '{filename}': {err}\n",
filename => $filename, err => $err);
Once you are done with marking the strings, you can try to run your
scripts/modules and you will see a lot of complaints by Perl that it
doesn't know about "__" (in various incarnations). Remember that "__"
is really a function call and you have to import the function "__" and
its relatives into your namespace.
What you have to do is to invent an identifier for your package (see
Locale::TextDomain for hints) and then add the following line to all
of your source files that produced errors:
use Locale::TextDomain ('Name-Of-My-Package');
You will be happy if "Name-Of-My-Package" is the same as the Makefile
variable "TEXTDOMAIN" in the file "po/TEXTDOMAIN" that you have
created in the beginning.
For the common case of a pure library: Is that really all I have to
do? Yes! What about POSIX::setlocale(), don't I have to make a call
somewhere? No, not for a library! And what about calls to textdomain()
and bindtextdomain() that I know from C or other languages? No, this
is all hidden in "use TextDomain (PACKAGENAME)" for Perl.
To make it clear again: A library should NEVER change the locale
settings. The script that uses a library (or multiple libraries)
should do that, and this boils down to three lines of Perl:
use POSIX qw (setlocale);
use Locale::Messages (LC_MESSAGES);
setlocale (LC_MESSAGES, "");
That means: The *calling* Perl script, the one that uses possibly
internationalized libraries, should initialize the locale settings to
the user preferences. Libraries should honor that setting but should
never change it. If a script misses a call to setlocale(), your
internationalized library will happily continue to work flawlessly
with the original English messages, it is up to the client programmer
to reveal the i18n features in your code!
If you are new to internationalization (i + 18 characters + n = i18n),
you will probably only understand half of the above. Visit
http://ml.imperia.org/listinfo/libintl-perl/, subscribe to the mailing
list libintl-perl@imperia.net and ask there. And don't blame me, the
author, for any difficulties. libintl-perl is as complicated as i18n
itself, it even simplifies a lot of things. The complicated rest is
inevitable. ;-)
Good luck!
Guido
========================================================================
* tp/maintain/lib/libintl-perl/sample/simplecal/README-NLS
========================================================================
Notes on National Language Support (NLS)
****************************************
This package is internationalized with libintl-perl, a free
internationalization library for Perl, you will need to install a copy of
libintl-perl in order to use the package. You can get libintl-perl from the
Comprehensive Perl Archive Network CPAN at http://www.cpan.org/.
The following notes are meant to be a quick start guide for somewhat
experienced users and system administrators and many important details had to
be omitted for brevity. If you have any difficulties with the
internationalization features of this package, no matter if you are a
programmer, a translator, or an end user, feel free to ask at the mailing list
for libintl-perl. To do so, send an e-mail to the address
(please replace "AT" with a "@", and "DOT"
with a dot ".").
You can subscribe to this list at
http://ml.imperia.org/mailman/listinfo/libintl-perl
A searchable archive of earlier postings is located at
http://ml.imperia.org/libintl-perl/
You may already find an answer to your question there.
Feel free to include this document in your own Perl packages internationalized
with libintl-perl, no severe copyright restrictions apply. You should send
corrections or improvements to the author Guido Flohr , so that others can benefit from your changes.
The End User's View
===================
The installation routine for this package will automatically take care that
your system has a sufficient version of libintl-perl installed. This is
basically sufficient for proper operation, but - especially if
internationalized software is new to you - you should read on carefully in
order to fully benefit from the internationalization (I18N) features of this
package.
Perl Setup
----------
The I18N library libintl-perl will run with a wide range of Perl versions (at
least from Perl version 5.005_03 to Perl 5.8.0) but you will experience slight
difference in features and performance depending on the version of Perl you
use.
With Perl versions prior to 5.7.3 you can use the package for all European
scripts (including those with Greek or Cyrillic scripts), and also for many
scripts used outside Europe, like Arabic, Hebrew, Georgian, Vietnamese or
Thai, more general all scripts using 8 bit charsets. Other scripts are only
available if the translations in this package are provided in Unicode and they
can only be output in Unicode.
Beginning with Perl 5.7.3 the module Encode became part of the Perl core, and
it offers you a much wider range of possible scripts. If you plan to use some
of the lesser used scripts for Chinese, Japanese, and Korean, you should also
install the module Encode::HanExtra.
Setting Your Language
---------------------
Most modern systems are already prepared and configured for
internationalization, and the user interface of the software you have
installed will already be configured for your preferred language. Packages
internationalized with libintl-perl will honor these configuration settings
and will also operate in your preferred language if the necessary translations
are available.
The environment variable "LANGUAGE" has the highest precedence for
translations. The most common format for this environment variable is a
(lowercase) two-letter language code and an (uppercase) two-letter country
code separated by an underscore "_", for example:
LANGUAGE=fr_BE
export LANGUAGE
This will set your language preferences to French ("fr") for Belgium ("BE").
Other examples are French for France ("fr_FR"), German for Austria ("de_AT"),
and so on. You can also omit the country part ("FR", "DE", "IT", "RU", ...)
in which case a default setting for the country will be assumed.
If there are no translations available for your selected languages, the
original message (normally in English) will be displayed.
You can also define a chain of languages to be tried separated by a colon:
LANGUAGE=fr_BE:fr_FR:fr:it
Read this as: "I want translations in French for Belgium. If they are not
available try French for France, then any French translation, and finally
Italian". Please note that this chain notation is only allowed for the
environment variable "LANGUAGE", it is not valid for any of the following
variables.
If "LANGUAGE" is not set, the library checks the variable "LANG". It has the
same syntax as "LANGUAGE" but does not allow the preferences chain with the
colon syntax. After "LANG" the variable "LC_MESSAGES" (think "locale category
messages") is tried, and finally "LC_ALL".
Note for Microsoft Windows users: The locale preferences you have configured
for your system cannot yet be evaluated by libintl-perl. This may change for
future versions of libintl-perl but for the moment you have to make do with
the instructions given above. In order to set environment variables, you have
to right-click on the icon "My Computer" on your desktop, select "Properties"
in the context menu, and then click the tab labelled "Environment variables".
Setting the Output Charset
--------------------------
Even if you have managed to properly select your preferred language, you may
still have difficulties reading the program languages, because libintl-perl
was unable to determine the correct charset to use for messages. For example,
it may assume Unicode ("UTF-8") but you really need ISO-Latin-1 (also known as
"Latin-1" or "ISO-8859-1"). If this is the case, please set the environment
variable "OUTPUT_CHARSET" to the appropriate value, for example:
OUTPUT_CHARSET=iso-8859-1
export OUTPUT_CHARSET
Charset names are case-insensitive, i. e. "LATIN-1" is the equivalent to
"Latin-1" or even "lAtIn-1".
Note: The output charset "utf8" is NOT recognized. Please use the correct
abbreviation "utf-8" (with a hyphen) instead.
The Translator's View
=====================
If you want to contribute a new translation to this package, please contact
the author first. Somebody may have already started this translation, and
furthermore the package author will be able to give you detailled instructions
and help.
Translating a Perl package is not much work and it does not require any
technical skills. If you are able to use the software itself, you will also
be able to contribute a translation for your language. But why should you do
that? You are able to read and understand this text and you will also be able
to understand the English messages that the software spits out by default.
Computers are an integral part of today's society. Computers are used to
explore new sources of information, forbidding computers would be a modern
form of censorship. Computers may also improve social life, the internet
helps people to find contacts in their area and all over the world, even if
they would otherwise be deprived from that because of a handicap, lack of money
for traveling, or other reasons. In many societies, the ability to use and
handle a computer also has a strong impact on your perspectives in life, you
may not be able to find an adequate job because of your lack of computer
experience, or you may even lose your job because of that.
Everybody should benefit from computers, regardless of cultural
background. Computers are expansive goods, and their price is already a high
barrier to cross. If computers speak in a foreign language, the learning
curve gets steeper and the barrier gets even higher. You can help the people
that share your native language by contributing a translation. The author of
this package has already prepared everything, the rest is up to you!
The Programmer's View
=====================
You have downloaded this package because you want to use it in your own
project(s). The fact that the package is internationalized with libintl-perl
does not affect its usability in any way. But you should keep in mind that
textual messages produced by the package may change according to the locale
settings at run-time. This can lead to errors. For example, if you parse
error messages produced by the package, you will most probably fail to detect
what you are looking for, if these error messages are suddenly presented in
another language or another output charset.
It is probably needless to say that this is bad practice and an indicator for
a poorly written interface. Either you have missed the correct method for
determining the substance of the message in a locale-independent manner, or
the author of the package has mis-designed the package interface. In any
case, this is a technical problem that should be solved by technicians. You
should not put that burden on the shoulders of your users but rather solve the
problem in cooperation with the author of the module that causes it.
If this is absolutely impossible, as a temporary workaround you can completely
switch off the native language support of the package by setting the
environment variable "LANGUAGE" to the special value "C":
BEGIN {
$ENV{LANGUAGE} = $ENV{LANG} = "C";
}
The value "C" instructs libintl-perl to leave all messages untouched, and you
can use the package as if it was not internationalized at all.
If the project you are working on is not yet internationalized, you should
consider to prepare it for internationalization now. Doing so is only little
work for yourself, but results in a large benefit for the users of your
software. The package "libintl-perl" ships with exhaustive documentation for
programmers and a sample package that you can use as a skeleton for your own
project(s). Internationalizing Perl software with libintl-perl is easy, the
package that this file is a part of, prooves that.
Guido Flohr
========================================================================
* util/README
========================================================================
$Id: README 5191 2013-02-23 00:11:18Z karl $
texinfo/util/README
Copyright 2002, 2008, 2011, 2012, 2013 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
All the files here are maintained as part of the Texinfo distribution
(in contrast to the contrib/ directory).
These scripts actually get installed:
texindex texi2dvi texi2pdf pdftexi2dvi
(along with *.bat on Windows)
Also the XML stuff: texinfo.dtd texinfo.cat.
These are examples of wrapping makeinfo invocation to achieve their
various jobs:
detexinfo texi2html texi-elements-by-size
txicmdlist txicustomvars txixml2texi
The srclist.txt file specifies common source files to keep in sync; see
the srclist-update script in gnulib.
Finally, the gendocs script and templates (which are not installed) are
about creating all the usual output formats to be put on web pages.
For more, see the GNU Maintainers Information:
http://www.gnu.org/prep/maintain/html_node/Invoking-gendocs_002esh.html
========================================================================
* COPYING
========================================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
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 3 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. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
========================================================================
* tp/maintain/lib/libintl-perl/COPYING.LESSER
========================================================================
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations
below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
^L
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it
becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
^L
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control
compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
^L
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
^L
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
^L
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
^L
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply, and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License
may add an explicit geographical distribution limitation excluding those
countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
^L
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
^L
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms
of the ordinary General Public License).
To apply these terms, attach the following notices to the library.
It is safest to attach them to the start of each source file to most
effectively convey the exclusion of warranty; and each file should
have at least the "copyright" line and a pointer to where the full
notice is found.
Copyright (C)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper
mail.
You should also get your employer (if you work as a programmer) or
your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James
Random Hacker.
, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!