/[public]/psiconv/trunk/INSTALL
ViewVC logotype

Diff of /psiconv/trunk/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 2 Revision 270
1PREFACE 1Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
2======= 2Foundation, Inc.
3 3
4As of version 0.5, the psiconv package uses automake, autoconf and libtool. 4 This file is free documentation; the Free Software Foundation gives
5This should make it possible to compile it on almost any architecture. 5unlimited permission to copy, distribute and modify it.
6Of course, this all depends on whether I have isolated all possible
7incompatibilities. If it does not compile for you, please send me a
8bug report, with as much information as possible, or even patches if
9you know what causes the problems.
10
11If your platform has no 32-bit integers (as int, long or long long), you
12can forget about compiling libpsiconv. Sorry.
13
14There is no manpage yet for psiconv, but try `psiconv -h' for some help.
15
16The included format data text files are translated by `make all' from
17Psion Word to HTML. This process should succeed with no warnings or
18errors. If the translation is ended without problems, psiconv is probably
19working right.
20
21 6
22Basic Installation 7Basic Installation
23================== 8==================
24 9
25 These are generic installation instructions. 10 These are generic installation instructions.
27 The `configure' shell script attempts to guess correct values for 12 The `configure' shell script attempts to guess correct values for
28various system-dependent variables used during compilation. It uses 13various system-dependent variables used during compilation. It uses
29those values to create a `Makefile' in each directory of the package. 14those values to create a `Makefile' in each directory of the package.
30It may also create one or more `.h' files containing system-dependent 15It may also create one or more `.h' files containing system-dependent
31definitions. Finally, it creates a shell script `config.status' that 16definitions. Finally, it creates a shell script `config.status' that
32you can run in the future to recreate the current configuration, a file 17you can run in the future to recreate the current configuration, and a
33`config.cache' that saves the results of its tests to speed up 18file `config.log' containing compiler output (useful mainly for
34reconfiguring, and a file `config.log' containing compiler output 19debugging `configure').
35(useful mainly for debugging `configure'). 20
21 It can also use an optional file (typically called `config.cache'
22and enabled with `--cache-file=config.cache' or simply `-C') that saves
23the results of its tests to speed up reconfiguring. (Caching is
24disabled by default to prevent problems with accidental use of stale
25cache files.)
36 26
37 If you need to do unusual things to compile the package, please try 27 If you need to do unusual things to compile the package, please try
38to figure out how `configure' could check whether to do them, and mail 28to figure out how `configure' could check whether to do them, and mail
39diffs or instructions to the address given in the `README' so they can 29diffs or instructions to the address given in the `README' so they can
40be considered for the next release. If at some point `config.cache' 30be considered for the next release. If you are using the cache, and at
41contains results you don't want to keep, you may remove or edit it. 31some point `config.cache' contains results you don't want to keep, you
32may remove or edit it.
42 33
43 The file `configure.in' is used to create `configure' by a program 34 The file `configure.ac' (or `configure.in') is used to create
44called `autoconf'. You only need `configure.in' if you want to change 35`configure' by a program called `autoconf'. You only need
45it or regenerate `configure' using a newer version of `autoconf'. 36`configure.ac' if you want to change it or regenerate `configure' using
37a newer version of `autoconf'.
46 38
47The simplest way to compile this package is: 39The simplest way to compile this package is:
48 40
49 1. `cd' to the directory containing the package's source code and type 41 1. `cd' to the directory containing the package's source code and type
50 `./configure' to configure the package for your system. If you're 42 `./configure' to configure the package for your system. If you're
74 66
75Compilers and Options 67Compilers and Options
76===================== 68=====================
77 69
78 Some systems require unusual options for compilation or linking that 70 Some systems require unusual options for compilation or linking that
79the `configure' script does not know about. You can give `configure' 71the `configure' script does not know about. Run `./configure --help'
80initial values for variables by setting them in the environment. Using 72for details on some of the pertinent environment variables.
81a Bourne-compatible shell, you can do that on the command line like
82this:
83 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
84 73
85Or on systems that have the `env' program, you can do it like this: 74 You can give `configure' initial values for configuration parameters
86 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure 75by setting variables in the command line or in the environment. Here
76is an example:
77
78 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
79
80 *Note Defining Variables::, for more details.
87 81
88Compiling For Multiple Architectures 82Compiling For Multiple Architectures
89==================================== 83====================================
90 84
91 You can compile the package for more than one kind of computer at the 85 You can compile the package for more than one kind of computer at the
94supports the `VPATH' variable, such as GNU `make'. `cd' to the 88supports the `VPATH' variable, such as GNU `make'. `cd' to the
95directory where you want the object files and executables to go and run 89directory where you want the object files and executables to go and run
96the `configure' script. `configure' automatically checks for the 90the `configure' script. `configure' automatically checks for the
97source code in the directory that `configure' is in and in `..'. 91source code in the directory that `configure' is in and in `..'.
98 92
99 If you have to use a `make' that does not supports the `VPATH' 93 If you have to use a `make' that does not support the `VPATH'
100variable, you have to compile the package for one architecture at a time 94variable, you have to compile the package for one architecture at a
101in the source code directory. After you have installed the package for 95time in the source code directory. After you have installed the
102one architecture, use `make distclean' before reconfiguring for another 96package for one architecture, use `make distclean' before reconfiguring
103architecture. 97for another architecture.
104 98
105Installation Names 99Installation Names
106================== 100==================
107 101
108 By default, `make install' will install the package's files in 102 By default, `make install' will install the package's files in
141`--x-libraries=DIR' to specify their locations. 135`--x-libraries=DIR' to specify their locations.
142 136
143Specifying the System Type 137Specifying the System Type
144========================== 138==========================
145 139
146 There may be some features `configure' can not figure out 140 There may be some features `configure' cannot figure out
147automatically, but needs to determine by the type of host the package 141automatically, but needs to determine by the type of machine the package
148will run on. Usually `configure' can figure that out, but if it prints 142will run on. Usually, assuming the package is built to be run on the
143_same_ architectures, `configure' can figure that out, but if it prints
149a message saying it can not guess the host type, give it the 144a message saying it cannot guess the machine type, give it the
150`--host=TYPE' option. TYPE can either be a short name for the system 145`--build=TYPE' option. TYPE can either be a short name for the system
151type, such as `sun4', or a canonical name with three fields: 146type, such as `sun4', or a canonical name which has the form:
147
152 CPU-COMPANY-SYSTEM 148 CPU-COMPANY-SYSTEM
153 149
150where SYSTEM can have one of these forms:
151
152 OS KERNEL-OS
153
154See the file `config.sub' for the possible values of each field. If 154 See the file `config.sub' for the possible values of each field. If
155`config.sub' isn't included in this package, then this package doesn't 155`config.sub' isn't included in this package, then this package doesn't
156need to know the host type. 156need to know the machine type.
157 157
158 If you are building compiler tools for cross-compiling, you can also 158 If you are _building_ compiler tools for cross-compiling, you should
159use the `--target=TYPE' option to select the type of system they will 159use the `--target=TYPE' option to select the type of system they will
160produce code for and the `--build=TYPE' option to select the type of 160produce code for.
161system on which you are compiling the package. 161
162 If you want to _use_ a cross compiler, that generates code for a
163platform different from the build platform, you should specify the
164"host" platform (i.e., that on which the generated programs will
165eventually be run) with `--host=TYPE'.
162 166
163Sharing Defaults 167Sharing Defaults
164================ 168================
165 169
166 If you want to set default values for `configure' scripts to share, 170 If you want to set default values for `configure' scripts to share,
169`configure' looks for `PREFIX/share/config.site' if it exists, then 173`configure' looks for `PREFIX/share/config.site' if it exists, then
170`PREFIX/etc/config.site' if it exists. Or, you can set the 174`PREFIX/etc/config.site' if it exists. Or, you can set the
171`CONFIG_SITE' environment variable to the location of the site script. 175`CONFIG_SITE' environment variable to the location of the site script.
172A warning: not all `configure' scripts look for a site script. 176A warning: not all `configure' scripts look for a site script.
173 177
174Operation Controls 178Defining Variables
175================== 179==================
180
181 Variables not defined in a site shell script can be set in the
182environment passed to `configure'. However, some packages may run
183configure again during the build, and the customized values of these
184variables may be lost. In order to avoid this problem, you should set
185them in the `configure' command line, using `VAR=value'. For example:
186
187 ./configure CC=/usr/local2/bin/gcc
188
189will cause the specified gcc to be used as the C compiler (unless it is
190overridden in the site shell script).
191
192`configure' Invocation
193======================
176 194
177 `configure' recognizes the following options to control how it 195 `configure' recognizes the following options to control how it
178operates. 196operates.
179 197
198`--help'
199`-h'
200 Print a summary of the options to `configure', and exit.
201
202`--version'
203`-V'
204 Print the version of Autoconf used to generate the `configure'
205 script, and exit.
206
180`--cache-file=FILE' 207`--cache-file=FILE'
181 Use and save the results of the tests in FILE instead of 208 Enable the cache: use and save the results of the tests in FILE,
182 `./config.cache'. Set FILE to `/dev/null' to disable caching, for 209 traditionally `config.cache'. FILE defaults to `/dev/null' to
183 debugging `configure'. 210 disable caching.
184 211
185`--help' 212`--config-cache'
186 Print a summary of the options to `configure', and exit. 213`-C'
214 Alias for `--cache-file=config.cache'.
187 215
188`--quiet' 216`--quiet'
189`--silent' 217`--silent'
190`-q' 218`-q'
191 Do not print messages saying which checks are being made. To 219 Do not print messages saying which checks are being made. To
194 222
195`--srcdir=DIR' 223`--srcdir=DIR'
196 Look for the package's source code in directory DIR. Usually 224 Look for the package's source code in directory DIR. Usually
197 `configure' can determine that directory automatically. 225 `configure' can determine that directory automatically.
198 226
199`--version'
200 Print the version of Autoconf used to generate the `configure'
201 script, and exit.
202
203`configure' also accepts some other, not widely useful, options. 227`configure' also accepts some other, not widely useful, options. Run
228`configure --help' for more details.
229

Legend:
Removed from v.2  
changed lines
  Added in v.270

frodo@frodo.looijaard.name
ViewVC Help
Powered by ViewVC 1.1.26