+++ /dev/null
-.. role:: code(strong)
-.. role:: file(literal)
-
-===================================
-README file for Free :code:`recode`
-===================================
-
-.. raw:: html
-
- <!--: Faire
- import socket
- if socket.gethostname() == 'phenix':
- bpi = ':8080'
- else:
- bpi = '.progiciels-bpi.ca'
- :-->
- <!-- Traiter! -->
-
-..
-
-.. contents::
-.. sectnum::
-
-Introduction
-============
-
-What is Recode?
----------------
-
-Here is version 3.6 for the Free :code:`recode` program and library.
-Hereafter, Recode means the whole package, :code:`recode` means the
-executable program. Glance through this :file:`README` file before
-starting configuration. Make sure you read files :file:`ABOUT-NLS` and
-:file:`INSTALL` if you are not familiar with them already.
-
-The Recode library converts files between character sets and usages.
-It recognises or produces more than 300 different character sets
-and transliterates files between almost any pair. When exact
-transliteration are not possible, it gets rid of offending characters
-or falls back on approximations. The :code:`recode` program is a handy
-front-end to the library.
-
-The Recode program and library have been written by François Pinard,
-yet it significantly reuses works from Keld Simonsen and Bruno Haible.
-It is an evolving package, and specifications might change in future
-releases.
-
-Little notes:
-
-+ Option ``-f`` is now fairly implemented, yet not fully.
-+ there is a `contrib/`__ directory in the distribution.
-+ In 1999, I gave a `presentation`__ of Recode in Japan.
-
-__ contrib.html
-__ m17n99.html
-
-Reports and collaboration
--------------------------
-
-Send bug reports to mailto:recode-bugs@iro.umontreal.ca' . A bug
-report is an adequate description of the problem: your input, what you
-expected, what you got, and why this is wrong. Diffs are welcome, but
-they only describe a solution, from which the problem might be uneasy
-to infer. If needed, submit actual data files with your report. Small
-data files are preferred. Big files may sometimes be necessary, but do
-not send them on the mailing list; rather take special arrangement with
-the maintainer.
-
-Your feedback will help us to make a better and more portable
-package. Consider documentation errors as bugs, and report them
-as such. If you develop anything pertaining to Recode or have
-suggestions, let us know and share your findings by writing at
-mailto:recode-forum@iro.umontreal.ca . You may also choose to directly
-write at mailto:pinard@iro.umontreal.ca, yet be warned that such
-correspondence is often visible for a while through the Recode Web site.
-
-If you feel like receiving releases and pretest announcements for the
-Recode package, send a message to mailto:majordomo@iro.umontreal.ca
-having, in its body, a line saying::
-
- subscribe recode-announce
-
-If you rather want to participate actively in discussions, pretesting
-and development for Recode, do just as above, but this time, use::
-
- subscribe recode-forum
-
-Visit http://recode%(bpi)s/ for releases or pretests, and related
-files. In particular, button ``Browse`` gives access to a weekly mirror
-of the current unpackaged work files, while button ``Folders`` gives
-access to saved or pending correspondence.
-
-Please *do not* widely redistribute releases having a letter after the
-version numbers, as these are meant for pretesting only, and might not
-be stable enough for other usages.
-
-Development plan
-----------------
-
-My plan has long been to end the 3.x series of this package, rather
-aiming 4.0 as a major internal rewrite. As there is still a long
-way before 4.0 gets ready, and *especially* because some of my good
-collaborators insisted that I do so, there will be a Recode 3.7. That
-release is meant to provide a selection of user-contributed patches.
-
-For prototyping what Recode will become and experimenting new concepts
-more easily, I created a subsidiary and standalone project named
-Recodec, meant to receive the best part of my development efforts in
-this particular area. Once I'll be happy with the prototype, the plan
-is to rewrite it from Python to C, somehow. Visit the Web pages for
-this `Recodec project`__ for more information and details. For now at
-least, new features go to Recodec only.
-
-__ http://recodec.progiciels-bpi.ca
-
-Notes for version 3.7-beta1
----------------------------
-
-The beta 1 pre-test release for the incoming Recode 3.7 has been made
-available for those needing it right away. While it solves some serious
-bugs and portability problems, others are meant to be addressed only in
-later pre-tests. In particular, none of charset or surface issues, user
-requests, and various suggestions appear in this pre-test, and will not
-either in later pretests, until all real show-stoppers are solved first.
-So this is in no way a candidate for a Recode 3.7 release.
-
-The test suite is worth more comments:
-
-+ The suite is very partial, and may not be thought as a validation
- suite. Before it could be used to ascertain confidence, it would need,
- much more tests than it has already.
-
-+ Testing is notably more speedy than it used to be. For example, the
- previous :code:`bigauto` test, which was not run by default because it
- ran for too long, is now executed within the standard test suite, once
- in non-strict mode, and a second time in strict mode.
-
-+ It does not use Autotest anymore, but rather a home grown test driver
- much inspired from the Codespeak project. The link between the test and
- the Recode library is established through a Pyrex interface, so you need
- to have :code:`python` and :code:`python-devel` installed first.
-
-+ Beware that the Pyrex interface to the Recode library is only meant
- for testing. for now at least. While you may play with it, it would not
- be wise relying on it, as the specifications might change at any time.
-
-Installation
-============
-
-Getting your own copy
----------------------
-
-The canonical distribution point for this version is:
-
- http://recode%(bpi)s/archives/recode.tar.gz
-
-GNU mirrors usually hold a copy of non-pretest releases, the canonical
-distribution point for the last such release is:
-
- ftp://ftp.gnu.org/pub/gnu/recode/recode-3.6.tar.gz
-
-Some older distributions, and maybe beta pre-releases for testers,
-*might* be available in this directory:
-
- http://recode%(bpi)s/archives/
-
-There is a reachable copy of my own sandbox repository for Recode. I
-experiment with it, and branches may be reset at any time. The server
-might not even be up (then just tell me!). To get your own copy, try
-these commands::
-
- git clone git://recode%(bpi)s/recode
- cd recode
- sh after-git.sh
-
-(or ``python after-git.py`` if you miss either :code:`sh` or GNU
-:code:`touch`).
-
-Once you have an unpacked distribution, see files:
-
- =================== =======================================================
- File name Description
- =================== =======================================================
- :file:`ABOUT-NLS` how to customise this program to your language
- :file:`COPYING` copying conditions for the program
- :file:`COPYING.LIB` copying conditions for the library
- :file:`INSTALL` compilation and installation instructions
- :file:`NEWS` major changes in the current release
- :file:`THANKS` partial list of contributors
- =================== =======================================================
-
-Configure options
------------------
-
-Besides those configure options documented in files :file:`INSTALL`
-and :file:`ABOUT-NLS`, a few extra options may be accepted after
-``./configure``:
-
-+ Options ``--disable-shared`` or ``--disable-static``
-
- to inhibit the building of shared libraries or static libraries; the
- default is to always build static libraries, and to attempt building
- shared libraries if there is some known recipe for this.
-
-+ Option ``--with-gnu-ld``
-
- to force the assomption that the C compiler uses GNU ld.
-
-+ Option ``--with-dmalloc``
-
- to trigger a debugging feature for looking at memory management
- problems, it pre-requires Gray Watson's package, which is available as
- ftp://ftp.letters.com/src/dmalloc/dmalloc.tar.gz .
-
-Maintenance tools
------------------
-
-For simple modifications to Recode, you should not need special tools
-beyond those usual for installing GNU packages. However, if you modify
-any :file:`.l` source file, Python and Flex are both needed for remaking
-:file:`merged.c`.
-
-For more comprehensive modifications, you might need more tools. If not
-done already, make sure you have a copy of the packages listed in the
-following table. You may also choose to establish a link in your build
-:file:`doc/` directory, as explained within :file:`doc/Makemore`.
-
- ================ ========== ========== =============
- Package name Current Minimum Install after
- ================ ========== ========== =============
- :code:`autoconf` 2.61 2.12 :code:`m4`
- :code:`automake` 1.10 1.9 :code:`Perl`
- :code:`Flex` 2.5.33 2.5.4a
- :code:`gettext` 0.16 0.16
- :code:`Help2man` 1.36 1.020 :code:`Perl`
- :code:`libtool` 1.5.24 1.3.4
- :code:`m4` 1.4.10 1.4n
- :code:`Make` 3.81
- :code:`Perl` 5.8.8 5.005.03
- :code:`Python` 2.5.1 2.2
- :code:`tar` 1.17 1.12
- :code:`wget` 1.10.2
- ================ ========== ========== =============
-
-The *current* version numbers just happen to be those used for
-development, it is often likely that older versions would work just as
-well. The *minimum* version numbers were once acceptable, they might
-not be anymore, this has not been verified; any updating information is
-welcome!
-
-Installation hints
-------------------
-
-Here are a few hints which might help installing Recode on some systems.
-Many may be applied by temporary presetting environment variables while
-calling ``./configure``. File :file:`INSTALL` explains this.
-
-+ Compilation time
-
- Some C compilers, like Apollo's, have a hard time compiling
- :file:`merged.c`. If this is your case, avoid compiler
- optimisation. From within the Bourne shell, you may use::
-
- CFLAGS= ./configure
-
- But if you want to give a real hard time to your C optimiser on
- :file:`merged.c`, to get code that runs only a bit faster, merely
- try::
-
- CPPFLAGS=-DINLINE_HARDER ./configure
-
-+ Smallish systems
-
- For 80286 based systems (do some still exist?!), it has been
- reported that some compilers generate wrong code while optimising
- for *small* models. So, from within the Bourne shell, do::
-
- CFLAGS=-Ml LDFLAGS=-Ml ./configure
-
- to force large memory model. For 80286 Xenix compiler, the last time
- it was tried a while ago, one ought to use::
-
- CFLAGS='-Ml -F2000' LDFLAGS=-Ml ./configure
-
- Other systems have poor :code:`pipe`/:code:`popen` support or trash
- heavily when processes fork. In this case, just before doing
- ``make``, edit :file:`config.h` and ensure :code:`HAVE_PIPE` is
- *not* defined.
projects / recode / blobdiff