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

Contents of /psiconv/trunk/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log


Revision 49 - (show annotations)
Fri Jul 14 20:44:40 2000 UTC (19 years, 3 months ago) by frodo
File size: 8767 byte(s)
(Frodo) First stab at ImageMagick 5 support. Still problems with listing
        all filetypes, though.

1 PREFACE
2 =======
3
4 As of version 0.5, the psiconv package uses automake, autoconf and libtool.
5 This should make it possible to compile it on almost any architecture.
6 Of course, this all depends on whether I have isolated all possible
7 incompatibilities. If it does not compile for you, please send me a
8 bug report, with as much information as possible, or even patches if
9 you know what causes the problems.
10
11 If your platform has no 32-bit integers (as int, long or long long), you
12 can forget about compiling libpsiconv. Sorry.
13
14 There is no manpage yet for psiconv, but try `psiconv -h' for some help.
15
16 The included format data text files are translated by `make all' from
17 Psion Word to HTML. This process should succeed with no warnings or
18 errors. If the translation is ended without problems, psiconv is probably
19 working right.
20
21 If you want to use ImageMagick, please make sure that it is version 5.x.y.
22 Version 4 will no longer work.
23
24
25 Basic Installation
26 ==================
27
28 These are generic installation instructions.
29
30 The `configure' shell script attempts to guess correct values for
31 various system-dependent variables used during compilation. It uses
32 those values to create a `Makefile' in each directory of the package.
33 It may also create one or more `.h' files containing system-dependent
34 definitions. Finally, it creates a shell script `config.status' that
35 you can run in the future to recreate the current configuration, a file
36 `config.cache' that saves the results of its tests to speed up
37 reconfiguring, and a file `config.log' containing compiler output
38 (useful mainly for debugging `configure').
39
40 If you need to do unusual things to compile the package, please try
41 to figure out how `configure' could check whether to do them, and mail
42 diffs or instructions to the address given in the `README' so they can
43 be considered for the next release. If at some point `config.cache'
44 contains results you don't want to keep, you may remove or edit it.
45
46 The file `configure.in' is used to create `configure' by a program
47 called `autoconf'. You only need `configure.in' if you want to change
48 it or regenerate `configure' using a newer version of `autoconf'.
49
50 The simplest way to compile this package is:
51
52 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
54 using `csh' on an old version of System V, you might need to type
55 `sh ./configure' instead to prevent `csh' from trying to execute
56 `configure' itself.
57
58 Running `configure' takes awhile. While running, it prints some
59 messages telling which features it is checking for.
60
61 2. Type `make' to compile the package.
62
63 3. Optionally, type `make check' to run any self-tests that come with
64 the package.
65
66 4. Type `make install' to install the programs and any data files and
67 documentation.
68
69 5. You can remove the program binaries and object files from the
70 source code directory by typing `make clean'. To also remove the
71 files that `configure' created (so you can compile the package for
72 a different kind of computer), type `make distclean'. There is
73 also a `make maintainer-clean' target, but that is intended mainly
74 for the package's developers. If you use it, you may have to get
75 all sorts of other programs in order to regenerate files that came
76 with the distribution.
77
78 Compilers and Options
79 =====================
80
81 Some systems require unusual options for compilation or linking that
82 the `configure' script does not know about. You can give `configure'
83 initial values for variables by setting them in the environment. Using
84 a Bourne-compatible shell, you can do that on the command line like
85 this:
86 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
87
88 Or on systems that have the `env' program, you can do it like this:
89 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
90
91 Compiling For Multiple Architectures
92 ====================================
93
94 You can compile the package for more than one kind of computer at the
95 same time, by placing the object files for each architecture in their
96 own directory. To do this, you must use a version of `make' that
97 supports the `VPATH' variable, such as GNU `make'. `cd' to the
98 directory where you want the object files and executables to go and run
99 the `configure' script. `configure' automatically checks for the
100 source code in the directory that `configure' is in and in `..'.
101
102 If you have to use a `make' that does not supports the `VPATH'
103 variable, you have to compile the package for one architecture at a time
104 in the source code directory. After you have installed the package for
105 one architecture, use `make distclean' before reconfiguring for another
106 architecture.
107
108 Installation Names
109 ==================
110
111 By default, `make install' will install the package's files in
112 `/usr/local/bin', `/usr/local/man', etc. You can specify an
113 installation prefix other than `/usr/local' by giving `configure' the
114 option `--prefix=PATH'.
115
116 You can specify separate installation prefixes for
117 architecture-specific files and architecture-independent files. If you
118 give `configure' the option `--exec-prefix=PATH', the package will use
119 PATH as the prefix for installing programs and libraries.
120 Documentation and other data files will still use the regular prefix.
121
122 In addition, if you use an unusual directory layout you can give
123 options like `--bindir=PATH' to specify different values for particular
124 kinds of files. Run `configure --help' for a list of the directories
125 you can set and what kinds of files go in them.
126
127 If the package supports it, you can cause programs to be installed
128 with an extra prefix or suffix on their names by giving `configure' the
129 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
130
131 Optional Features
132 =================
133
134 Some packages pay attention to `--enable-FEATURE' options to
135 `configure', where FEATURE indicates an optional part of the package.
136 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
137 is something like `gnu-as' or `x' (for the X Window System). The
138 `README' should mention any `--enable-' and `--with-' options that the
139 package recognizes.
140
141 For packages that use the X Window System, `configure' can usually
142 find the X include and library files automatically, but if it doesn't,
143 you can use the `configure' options `--x-includes=DIR' and
144 `--x-libraries=DIR' to specify their locations.
145
146 Specifying the System Type
147 ==========================
148
149 There may be some features `configure' can not figure out
150 automatically, but needs to determine by the type of host the package
151 will run on. Usually `configure' can figure that out, but if it prints
152 a message saying it can not guess the host type, give it the
153 `--host=TYPE' option. TYPE can either be a short name for the system
154 type, such as `sun4', or a canonical name with three fields:
155 CPU-COMPANY-SYSTEM
156
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
159 need to know the host type.
160
161 If you are building compiler tools for cross-compiling, you can also
162 use the `--target=TYPE' option to select the type of system they will
163 produce code for and the `--build=TYPE' option to select the type of
164 system on which you are compiling the package.
165
166 Sharing Defaults
167 ================
168
169 If you want to set default values for `configure' scripts to share,
170 you can create a site shell script called `config.site' that gives
171 default values for variables like `CC', `cache_file', and `prefix'.
172 `configure' looks for `PREFIX/share/config.site' if it exists, then
173 `PREFIX/etc/config.site' if it exists. Or, you can set the
174 `CONFIG_SITE' environment variable to the location of the site script.
175 A warning: not all `configure' scripts look for a site script.
176
177 Operation Controls
178 ==================
179
180 `configure' recognizes the following options to control how it
181 operates.
182
183 `--cache-file=FILE'
184 Use and save the results of the tests in FILE instead of
185 `./config.cache'. Set FILE to `/dev/null' to disable caching, for
186 debugging `configure'.
187
188 `--help'
189 Print a summary of the options to `configure', and exit.
190
191 `--quiet'
192 `--silent'
193 `-q'
194 Do not print messages saying which checks are being made. To
195 suppress all normal output, redirect it to `/dev/null' (any error
196 messages will still be shown).
197
198 `--srcdir=DIR'
199 Look for the package's source code in directory DIR. Usually
200 `configure' can determine that directory automatically.
201
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.

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