Cosmetics.
[libiconv.git] / djgpp / README
blobcdb909127357e1961e20051f412da01c6c715465
1 This is a port of GNU Libiconv 1.6 to MSDOS/DJGPP.
3 1.:     DJGPP specific changes.
4         =======================
5         There are no DJGPP specific changes. This package should
6         configure and compile out-of-the-box.
7         Please read the documentation to become familiar with this
8         product.
11 2.:     Installing the binary package.
12         ==============================
14 2.1.:   Copy the binary distribution into the top DJGPP installation
15         directory and unzip the binary distribution running *ONE* of
16         the following commands:
17           unzip32 licv16b.zip      or
18           djtarx licv16b.zip       or
19           pkunzip -d licv16b.zip
23 3.:     Building the binaries from sources.
24         ===================================
26 3.1.:   To build the binaries you will need the following binary packages:
27           djdev203.zip, bsh204b.zip, gcc2952b.zip,
28           bnu210b.zip, mak3791b.zip, fil316b.zip,
29           shl112b.zip, txt20b.zip, txi40b.zip,
30           grep24b.zip and sed302b.zip
33         All this packages can be found in the v2gnu directory of any
34         Simtel.NET mirror.
35         You will need bsh204b.zip and *NOT* a prior version or the build will fail.
36         The same applies to djdev203.zip. You *MUST* use the updated versions of
37         fil316b.zip (date: 2000-05-30) and shl112b.zip (date: 2000-08-11). This
38         updated versions have been recompiled with djdev203.zip and know about
39         the "/dev/env" functionality introduced with djdev203.zip. All the other
40         packages are the ones I have used to build the binaries from this sources.
41         Previuos and/or later versions of this packages may do the job as well but
42         I have not tested this.
44 3.2.:   Create a temporary directory and copy the source package: licv16s.zip
45         into the temporary directory. If you download the source distribution
46         from one of the DJGPP archives, just unzip it preserving the directory
47         structure, runnig ONE of the following commands:
48           unzip32 licv16s.zip      or
49           djtarx licv16s.zip       or
50           pkunzip -d licv16s.zip
52         Source distributions downloaded from one of the GNU FTP sites need
53         some more work to unpack.  First, you MUST use the `djtar' program to
54         unzip the package.  That's because some file names in the official
55         distributions need to be changed to avoid problems on the various
56         platforms supported by DJGPP.  `djtar' can rename files on the fly
57         given a file with name mappings.  The distribution includes a file
58         `djgpp/fnchange.lst' with the necessary mappings.  So you need first
59         to retrieve that file, and then invoke `djtar' to unpack the
60         distribution.  Here's how:
62           djtar -x -p -o libiconv-1.6/djgpp/fnchange.lst libiconv-1.6.tar.gz > lst
63           djtar -x -n lst libiconv-1.6.tar.gz
65         (The name of the distribution archive and the top-level directory will
66         be different for versions other than 1.6.)
68 3.3.:   The package is preconfigured for djdev203. To build the products you
69         should run the following command:
70           make
72         After the compilation has finished, you can check the products
73         running the command:
74           make check
76         To install the products run the command:
77           make install
79         This will install the products (iconv.exe iconv.h libcharset.h libconv.a
80         libcharset.a iconv.1 iconv.3 iconv_open.3 iconv_close.3) into your DJGPP
81         installation tree. As usual, prefix is defined as "/dev/env/DJDIR".
82         If you prefer to install into same other directory run the command:
83           make install prefix=z:/some/other/dir
85         Of course, you should replace "z:/some/other/dir" by an appropriate path
86         that will meet your requeriments.
88 3.4.:   If you need/want to reconfigure the package you will have to run the
89         following commands:
90           make distclean
91           djgpp\config
93         Please note that you *MUST* use the "distclean" option or the config.cache
94         file will *NOT* be deleted. In this case you are *NOT* reconfiguring
95         because the configuration informations is read from the cache file instead
96         of being newly computed.
97         To build the programs in a directory other than where the sources are,
98         you must add the parameter that specifies the source directory,
99         e.g:
100           x:\src\gnu\libiconv.16\djgpp\config x:/src/gnu/libiconv.16
102         Lets assume you want to build the binaries in a directory placed on a 
103         different drive (z:\build in this case) from where the sources are,
104         then you will run the following commands:
105           z:
106           md \build
107           cd \build
108           x:\src\gnu\libiconv.16\djgpp\config x:/src/gnu/libiconv.16
110         You *MUST* use forward slashes to specify the source directory.
111         After having configured the package run the folowing commands to create
112         the binaries and docs and install them:
113           make
114           make check
115           make install
117         Send suggestions and bug reports concerning the DJGPP port to
118         comp.os.msdos.djgpp or djgpp@delorie.com. Libiconv specific bugs
119         must be reported to Bruno Haible <haible@clisp.cons.org>.
122           Guerrero, Juan Manuel <st001906@hrz1.hrz.tu-darmstadt.de>