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

Diff of /psiconv/trunk/INSTALL

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

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

Legend:
Removed from v.49  
changed lines
  Added in v.254

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