]> granicus.if.org Git - recode/commitdiff
reST-ified contrib/README
authorFrançois Pinard <pinard@iro.umontreal.ca>
Fri, 22 Feb 2008 00:10:14 +0000 (19:10 -0500)
committerFrançois Pinard <pinard@iro.umontreal.ca>
Fri, 22 Feb 2008 00:10:14 +0000 (19:10 -0500)
ChangeLog
README
contrib/ChangeLog
contrib/README

index fbca58ce4ba6d44331a18ba5a49e52a92bcff573..e1150ed839d2273e56f507de59b5699c5b7b60d4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2008-02-21  François Pinard  <pinard@iro.umontreal.ca>
+
+       * README: Tell about contrib/README.
+
 2008-02-21  gettextize  <bug-gnu-gettext@gnu.org>
 
        * configure.ac (AM_GNU_GETTEXT_VERSION): Bump to 0.16.
diff --git a/README b/README
index a921c211bb2f60226d3d1b0141f77e0e0d002319..f2685512601af1c036f6b4857ebc2629796ebba8 100644 (file)
--- a/README
+++ b/README
@@ -43,10 +43,15 @@ 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.  Option ``-f`` is now fairly implemented, yet not fully.
+releases.
 
-In 1999, I gave a `presentation`__ of Recode in Japan.
+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
@@ -80,7 +85,7 @@ and development for Recode, do just as above, but this time, use::
 
     subscribe recode-forum
 
-Look into http://recode%(bpi)s/ for releases or pretests, and related
+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.
@@ -193,9 +198,9 @@ following table.  You may also choose to establish a link in your build
   Package name       Current      Minimum      Install after
   ================   ==========   ==========   =============
   :code:`autoconf`   2.61         2.12         :code:`m4`
-  :code:`automake`   1.10         1.4          :code:`Perl`
+  :code:`automake`   1.10         1.9          :code:`Perl`
   :code:`Flex`       2.5.33       2.5.4a
-  :code:`gettext`    0.16         0.14.3
+  :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
index 26a6eaae5090a2c710950d60f93e88a8df404ff3..b8108751f5912c4bb7f9c6f3af500b0dd55ccad0 100644 (file)
@@ -1,9 +1,13 @@
+2008-02-21  François Pinard  <pinard@iro.umontreal.ca>
+
+       * README: Converted to reST.
+
 2000-06-29  François Pinard  <pinard@iro.umontreal.ca>
 
        * recode.spec: New file, meant for RedHat.
        * Makefile.am: Distribute it.
        Reported by David Lebel.
-\f
+
 1998-11-28  François Pinard  <pinard@iro.umontreal.ca>
 
        * Makefile.amiga, Makefile.amiga-lib: Recoded /cl to Unix.
index 450fc8f37222d78f51408a2793cf695f5c64686a..0e40235e0ae7b7889bdec960935e367080cfe8e3 100644 (file)
-* README file for `recode/contrib/'.           -*- outline -*- (allout)
+.. role:: code(strong)
+.. role:: file(literal)
 
-.* Hi, people!
+=======================================
+README file for :file:`recode/contrib/`
+=======================================
 
-   The `contrib/' directory of the `recode' distribution contains a few
-   miscellaneous tools, ports, or such things, which have been collected
-   here and there, a bit randomly, for your possible entertainment or use.
+.. contents::
+.. sectnum::
 
-   Beware that nothing here is supported by the `recode' maintainer, you
-   might have to contact the authors directly to get support.  There is no
-   guarantee that any file in this directory will still exist in subsequent
-   releases.  Finally, there is no guarantee either that I will accept
-   to include contributions, unless I find them very good or very small.
-   But I'm quite willing to give URL pointers to other tools, right here!
+Hi, people!
+===========
 
-.* Included files
+The :file:`contrib/` directory of the Recode distribution contains a few
+miscellaneous tools, ports, or such things, which have been collected
+here and there, a bit randomly, for your possible entertainment or use.
 
-   To the best of my knowledge, all included files are free, and already
-   available widely by other means.  I did not collect any kind legalistic
-   papers proving that the contained material is indeed free.  In case of
-   a dispute, or at the mere request of the author, I'll quickly remove
-   any dubious material.  So, do not consider the files here as being as
-   *safe* as the things you usually get from the Free Software Foundation.
+Beware that nothing here is supported by the Recode maintainer, you
+might have to contact the authors directly to get support.  There is no
+guarantee that any file in this directory will still exist in subsequent
+releases.  Finally, there is no guarantee either that I will accept to
+include contributions, unless I find them very good or very small.  But
+I'm quite willing to give URL pointers to other tools, right here!
 
-   Please drop me a note about what you found to be useful, in here,
-   to help me at deciding what should be kept and what should go away.
+Included files
+==============
 
-. + utf8.el
+To the best of my knowledge, all included files are free, and already
+available widely by other means.  I did not collect any kind legalistic
+papers proving that the contained material is indeed free.  In case of a
+dispute, or at the mere request of the author, I'll quickly remove any
+dubious material.  So, do not consider the files here as being as *safe*
+as the things you usually get from the Free Software Foundation.
 
-    This tool helps Emacs users at inserting UTF-8 encoded ISO-10646 or
-    Unicode characters in an Emacs buffer.  Submitted by Gary Houston
-    <ghouston@actrix.gen.nz> to `gnu.emacs.sources', 1994-10.
+Please drop me a note about what you found to be useful, in here, to
+help me at deciding what should be kept and what should go away.
 
-. + recode.el
++ :file:`utf8.el`
 
-    This is a miscellaneous collection of tools, documented in French,
-    for using `recode' from Emacs, when Latin-1 is in use.  Submitted by
-    François Pinard <pinard@iro.umontreal.ca>, 1994-12.
+  This tool helps Emacs users at inserting UTF-8 encoded ISO-10646 or
+  Unicode characters in an Emacs buffer.  Submitted by Gary Houston
+  <ghouston@actrix.gen.nz> to :code:`gnu.emacs.sources`, 1994-10.
 
-. + djgpp-README
-. + djgpp-diffs
++ :file:`recode.el`
 
-    These files represent a port of version 3.4.1 of `recode' to DJGPP,
-    submitted by Wojciech Galazka <wgalazka@chem.uw.edu.pl>, 1997-11.
+  This is a miscellaneous collection of tools, documented in French,
+  for using Recode from Emacs, when Latin-1 is in use.  Submitted by
+  François Pinard <pinard@iro.umontreal.ca>, 1994-12.
 
-. + Makefile.amiga
-. + Makefile.amiga-lib
++ :file:`djgpp-README`
++ :file:`djgpp-diffs`
 
-    These makefiles allow building `recode' 3.4k on Amiga.
-    Submitted by Stefan Haubenthal, 1998-11.
+  These files represent a port of version 3.4.1 of Recode to DJGPP,
+  submitted by Wojciech Galazka <wgalazka@chem.uw.edu.pl>, 1997-11.
 
-. + recode.spec
++ :file:`Makefile.amiga`
++ :file:`Makefile.amiga-lib`
 
-    RPM spec file to prepare `recode' on RedHat.
-    Submitted by David Lebel, 2000-06.
+  These makefiles allow building Recode 3.4k on Amiga.  Submitted by
+  Stefan Haubenthal, 1998-11.
 
-.* External pointers
++ :file:`recode.spec`
 
-. + Documentation
+  RPM spec file to prepare Recode on RedHat.  Submitted by David Lebel,
+  2000-06.
 
-.  - IETF references
+External pointers
+=================
 
-.   : Character Mnemonics & Character Sets
-      ftp://nic.ddn.mil/rfc/rfc1345.txt
-      Keld Simonsen <keld@dkuug.dk>, 1992-06.
+Documentation
+-------------
 
-.   : UTF-7 - A Mail-Safe Transformation Format of Unicode
-      ftp://nic.ddn.mil/rfc/rfc1642.txt
-      David Goldsmith <david_goldsmith@taligent.com> and Mark Davis
-      <ark_davis@taligent.com>, 1994-07.
++ IETF references
 
-.   : UTF-8, a transformation format of Unicode and ISO 10646
-      ftp://nic.ddn.mil/rfc/rfc2044.txt
-      François Yergeau <yergeau@alis.com>, 1997-10.
+  + Character Mnemonics & Character Sets
 
-.  - Various references
+    + ftp://nic.ddn.mil/rfc/rfc1345.txt
 
-.   : Unicode charset mappings
-      ftp://ftp.unicode.org:/Public/MAPPINGS/
+    Keld Simonsen <keld@dkuug.dk>, 1992-06.
 
-      The Unicode consortium makes available plenty of charset mappings
-      for converting "legacy" charsets to Unicode.
+  + UTF-7 - A Mail-Safe Transformation Format of Unicode
 
-.  - Normalisation et internationalisation: Inventaire et prospectives des
+    + ftp://nic.ddn.mil/rfc/rfc1642.txt
+
+    David Goldsmith <david_goldsmith@taligent.com> and Mark Davis
+    <ark_davis@taligent.com>, 1994-07.
+
+  +  UTF-8, a transformation format of Unicode and ISO 10646
+
+     + ftp://nic.ddn.mil/rfc/rfc2044.txt
+
+     François Yergeau <yergeau@alis.com>, 1997-10.
+
++ Various references
+
+  + Unicode charset mappings
+
+    + ftp://ftp.unicode.org:/Public/MAPPINGS/
+
+    The Unicode consortium makes available plenty of charset mappings
+    for converting "legacy" charsets to Unicode.
+
+  +  Normalisation et internationalisation: Inventaire et prospectives des
      normes clefs pour le traitement informatique du français.  (392p.)
 
      This is a report, written in French, discussing charset issues and many
      other topics as well.  Laurent Bourbeau <bourbeau@progiciels-bpi.ca>
      and François Pinard <pinard@iro.umontreal.ca>, 1995-10.
-     ftp://ftp.iro.umontreal.ca/pub/contrib/pinard/accents/oqil-tome1.ps.gz
-     http://www.ceveil.qc.ca/Normes
 
-. + Programs
+     + ftp://ftp.iro.umontreal.ca/pub/contrib/pinard/accents/oqil-tome1.ps.gz
+     + http://www.ceveil.qc.ca/Normes
+
+Programs
+--------
+
++ :code:`libiconv`
+
+  This comprehensive charset converter library revolves around Unicode,
+  and support Asian encodings among many others.  Even Recode uses it!
+
+  + ftp://ftp.ilog.fr/pub/Users/haible/gnu/libiconv-1.3.tar.gz
+
+  Bruno Haible <haible@ilog.fr>
+
++ :code:`tcs`
+
+  Here is the main recoding tool from the Plan9 project.
+
+  + ftp://research.att.com/dist/tcs.shar.Z
+
++ :code:`yuedit`
+
+  This GUI editor handles many encodings, among which UTF-8.  It also
+  installs uniconv, a recoding program, and uniprint, a printing tool.
+
+  + ftp://sunsite.unc.edu/pub/Linux/apps/editors/X/yudit-1.2.tar.gz
+
+  Gaspar Sinai <gsinai@iname.com>, 1999-01.
+
++ :code:`ucs-fonts`
+
+   These 6x13 fonts, covering Unicode characters besides the Asian sets,
+   merely replace the Linux fixed 6x13 font.  Works nicely with yudit.
+
+   + http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz
+
+   Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk>, 1998-11.
+
++ :code:`MtRecode`
+
+  This charset converter is oriented towards SGML text manipulation.  It
+  may be freely downloaded for non-commercial, non-military use from:
+
+  + http://www.lpl.univ-aix.fr/projects/multext/MtRecode/
 
-.  - libiconv
+  Pointer given by Jean Véronis <veronis@univ-aix.fr>, 1996-06.
 
-     This comprehensive charset converter library revolves around Unicode,
-     and support Asian encodings among many others.  Even `recode' uses it!
-     ftp://ftp.ilog.fr/pub/Users/haible/gnu/libiconv-1.3.tar.gz
-     Bruno Haible <haible@ilog.fr>
++ :code:`sp`
 
-.  - tcs
+  This quite nice SGML structure analyser contains internal C++ modules
+  for handling many charsets.
 
-     Here is the main recoding tool from the Plan9 project.
-     ftp://research.att.com/dist/tcs.shar.Z
+  + ftp://ftp.jclark.com/pub/sp/sp-1.3.tar.gz
 
-.  - yuedit
+  James Clark <jjc@jclark.com>
 
-     This GUI editor handles many encodings, among which UTF-8.  It also
-     installs uniconv, a recoding program, and uniprint, a printing tool.
-     ftp://sunsite.unc.edu/pub/Linux/apps/editors/X/yudit-1.2.tar.gz
-     Gaspar Sinai <gsinai@iname.com>, 1999-01.
++ :code:`b2c`
 
-.  - ucs-fonts
+  This program is able to generate interpreted
+  character dumps, but properly embedded within complete C header files.
 
-     These 6x13 fonts, covering Unicode characters besides the Asian sets,
-     merely replace the Linux fixed 6x13 font.  Works nicely with yudit.
-     http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz
-     Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk>, 1998-11.
+  + http://research.de.uu.net:8080/~gnu/b2c/b2c-2.1.tar.gz
 
-.  - MtRecode
+  Jörg Heitkötter <Joerg.Heitkoetter@de.uu.net>, 1997-11.
 
-     This charset converter is oriented towards SGML text manipulation.  It
-     may be freely downloaded for non-commercial, non-military use from:
-     http://www.lpl.univ-aix.fr/projects/multext/MtRecode/
-     Pointer given by Jean Véronis <veronis@univ-aix.fr>, 1996-06.
++ :code:`PyRecode`
 
-.  - sp
+  This wrapper provides Free Recode functionality to Python programs.
 
-     This quite nice SGML structure analyser contains internal C++ modules
-     for handling many charsets.
-     ftp://ftp.jclark.com/pub/sp/sp-1.3.tar.gz
-     James Clark <jjc@jclark.com>
+  + http://www.suxers.de/PyRecode.tgz
 
-.  - b2c
+  Andreas Jung <ajung@server.python.net>
 
-     This program is able to generate interpreted
-     character dumps, but properly embedded within complete C header files.
-     http://research.de.uu.net:8080/~gnu/b2c/b2c-2.1.tar.gz
-     Jörg Heitkötter <Joerg.Heitkoetter@de.uu.net>, 1997-11.
+  Also see:
 
-.  - PyRecode
+  + http://www.vex.net/parnassus/apyllo.py?find=recode
+  + http://www.suxers.de/python/pyrecode.htm
 
-     This wrapper provides Free `recode' functionnality to Python programs.
-     http://www.suxers.de/PyRecode.tgz
-     Andreas Jung <ajung@server.python.net>
+Non-Unix ports or alikes
+========================
 
-     Also see:
-     http://www.vex.net/parnassus/apyllo.py?find=recode
-     http://www.suxers.de/python/pyrecode.htm
+Please mailto:recode-bugs@iro.umontreal.ca if you are aware of various
+ports to non-Unix systems not listed here, or for corrections.  Please
+provide the goal system, a complete and stable URL, the maintainer name
+and address, the Recode version used as a base, and your comments.
 
-.* Non-Unix ports or alikes
++ IBM/PC (MSDOS)
 
-   Please mailto:recode-bugs@iro.umontreal.ca if you are aware of various
-   ports to non-Unix systems not listed here, or for corrections.  Please
-   provide the goal system, a complete and stable URL, the maintainer name
-   and address, the recode version used as a base, and your comments.
+  + + ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/rcode34b.zip
+    + ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/rcode34s.zip
+    + ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/rcode34d.zip
 
-. + IBM/PC (MSDOS)
+    (for binaries, sources and docs respectively) maintained by Wojciech
+    Galazka <wgalazka@chem.uw.edu.pl> Based on Recode 3.4.1.
 
-.  - ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/rcode34b.zip
-     ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/rcode34s.zip
-     ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/rcode34d.zip
-     (for binaries, sources and docs respectively)
-     maintained by Wojciech Galazka <wgalazka@chem.uw.edu.pl>
-     Based on recode 3.4.1.
+  + + http://www.simtel.net/simtel.net/
+    + http://www.leo.org/pub/comp/platforms/pc/gnuish (Germany)
+    + ftp://ftp.simtel.net/simtelnet/gnu
+    + ftp://ftp.leo.org/pub/comp/platforms/pc/gnuish
 
-.  - http://www.simtel.net/simtel.net/
-     http://www.leo.org/pub/comp/platforms/pc/gnuish (Germany)
-     ftp://ftp.simtel.net/simtelnet/gnu
-     ftp://ftp.leo.org/pub/comp/platforms/pc/gnuish
-     maintained by Darrel Hankerson <hankedr@mail.auburn.edu>
-     You get many GNU tools, not only `recode'.  The GNUish project is
-     described in `gnuish_t.htm'.
+    maintained by Darrel Hankerson <hankedr@mail.auburn.edu> You get
+    many GNU tools, not only Recode.  The GNUish project is described in
+    :file:`gnuish_t.htm`.