/[public]/psiconv/trunk/INSTALL

Diff of /psiconv/trunk/INSTALL

Parent Directory | Revision Log | View Patch Patch

Revision 2		Revision 346
1	PREFACE	1	Installation Instructions
2	=======	2	*************************
3		3
4	As of version 0.5, the psiconv package uses automake, autoconf and libtool.	4	Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation,
5	This should make it possible to compile it on almost any architecture.	5	Inc.
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		6
11	If your platform has no 32-bit integers (as int, long or long long), you	7	Copying and distribution of this file, with or without modification,
12	can forget about compiling libpsiconv. Sorry.	8	are permitted in any medium without royalty provided the copyright
13		9	notice and this notice are preserved. This file is offered as-is,
14	There is no manpage yet for psiconv, but try `psiconv -h' for some help.	10	without warranty of any kind.
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		11
22	Basic Installation	12	Basic Installation
23	==================	13	==================
24		14
25	These are generic installation instructions.	15	Briefly, the shell commands `./configure; make; make install' should
		16	configure, build, and install this package. The following
		17	more-detailed instructions are generic; see the `README' file for
		18	instructions specific to this package. Some packages provide this
		19	`INSTALL' file but do not implement all of the features documented
		20	below. The lack of an optional feature in a given package is not
		21	necessarily a bug. More recommendations for GNU packages can be found
		22	in *note Makefile Conventions: (standards)Makefile Conventions.
26		23
27	The `configure' shell script attempts to guess correct values for	24	The `configure' shell script attempts to guess correct values for
28	various system-dependent variables used during compilation. It uses	25	various system-dependent variables used during compilation. It uses
29	those values to create a `Makefile' in each directory of the package.	26	those values to create a `Makefile' in each directory of the package.
30	It may also create one or more `.h' files containing system-dependent	27	It may also create one or more `.h' files containing system-dependent
31	definitions. Finally, it creates a shell script `config.status' that	28	definitions. Finally, it creates a shell script `config.status' that
32	you can run in the future to recreate the current configuration, a file	29	you 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	30	file `config.log' containing compiler output (useful mainly for
34	reconfiguring, and a file `config.log' containing compiler output	31	debugging `configure').
35	(useful mainly for debugging `configure').	32
		33	It can also use an optional file (typically called `config.cache'
		34	and enabled with `--cache-file=config.cache' or simply `-C') that saves
		35	the results of its tests to speed up reconfiguring. Caching is
		36	disabled by default to prevent problems with accidental use of stale
		37	cache files.
36		38
37	If you need to do unusual things to compile the package, please try	39	If you need to do unusual things to compile the package, please try
38	to figure out how `configure' could check whether to do them, and mail	40	to figure out how `configure' could check whether to do them, and mail
39	diffs or instructions to the address given in the `README' so they can	41	diffs or instructions to the address given in the `README' so they can
40	be considered for the next release. If at some point `config.cache'	42	be considered for the next release. If you are using the cache, and at
41	contains results you don't want to keep, you may remove or edit it.	43	some point `config.cache' contains results you don't want to keep, you
		44	may remove or edit it.
42		45
43	The file `configure.in' is used to create `configure' by a program	46	The file `configure.ac' (or `configure.in') is used to create
44	called `autoconf'. You only need `configure.in' if you want to change	47	`configure' by a program called `autoconf'. You need `configure.ac' if
45	it or regenerate `configure' using a newer version of `autoconf'.	48	you want to change it or regenerate `configure' using a newer version
		49	of `autoconf'.
46		50
47	The simplest way to compile this package is:	51	The simplest way to compile this package is:
48		52
49	1. `cd' to the directory containing the package's source code and type	53	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	54	`./configure' to configure the package for your system.
51	using `csh' on an old version of System V, you might need to type
52	`sh ./configure' instead to prevent `csh' from trying to execute
53	`configure' itself.
54		55
55	Running `configure' takes awhile. While running, it prints some	56	Running `configure' might take a while. While running, it prints
56	messages telling which features it is checking for.	57	some messages telling which features it is checking for.
57		58
58	2. Type `make' to compile the package.	59	2. Type `make' to compile the package.
59		60
60	3. Optionally, type `make check' to run any self-tests that come with	61	3. Optionally, type `make check' to run any self-tests that come with
61	the package.	62	the package, generally using the just-built uninstalled binaries.
62		63
63	4. Type `make install' to install the programs and any data files and	64	4. Type `make install' to install the programs and any data files and
64	documentation.	65	documentation. When installing into a prefix owned by root, it is
		66	recommended that the package be configured and built as a regular
		67	user, and only the `make install' phase executed with root
		68	privileges.
65		69
		70	5. Optionally, type `make installcheck' to repeat any self-tests, but
		71	this time using the binaries in their final installed location.
		72	This target does not install anything. Running this target as a
		73	regular user, particularly if the prior `make install' required
		74	root privileges, verifies that the installation completed
		75	correctly.
		76
66	5. You can remove the program binaries and object files from the	77	6. You can remove the program binaries and object files from the
67	source code directory by typing `make clean'. To also remove the	78	source code directory by typing `make clean'. To also remove the
68	files that `configure' created (so you can compile the package for	79	files that `configure' created (so you can compile the package for
69	a different kind of computer), type `make distclean'. There is	80	a different kind of computer), type `make distclean'. There is
70	also a `make maintainer-clean' target, but that is intended mainly	81	also a `make maintainer-clean' target, but that is intended mainly
71	for the package's developers. If you use it, you may have to get	82	for the package's developers. If you use it, you may have to get
72	all sorts of other programs in order to regenerate files that came	83	all sorts of other programs in order to regenerate files that came
73	with the distribution.	84	with the distribution.
74		85
		86	7. Often, you can also type `make uninstall' to remove the installed
		87	files again. In practice, not all packages have tested that
		88	uninstallation works correctly, even though it is required by the
		89	GNU Coding Standards.
		90
		91	8. Some packages, particularly those that use Automake, provide `make
		92	distcheck', which can by used by developers to test that all other
		93	targets like `make install' and `make uninstall' work correctly.
		94	This target is generally not run by end users.
		95
75	Compilers and Options	96	Compilers and Options
76	=====================	97	=====================
77		98
78	Some systems require unusual options for compilation or linking that	99	Some systems require unusual options for compilation or linking that
79	the `configure' script does not know about. You can give `configure'	100	the `configure' script does not know about. Run `./configure --help'
80	initial values for variables by setting them in the environment. Using	101	for details on some of the pertinent environment variables.
81	a Bourne-compatible shell, you can do that on the command line like
82	this:
83	CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
84		102
85	Or on systems that have the `env' program, you can do it like this:	103	You can give `configure' initial values for configuration parameters
86	env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure	104	by setting variables in the command line or in the environment. Here
		105	is an example:
		106
		107	./configure CC=c99 CFLAGS=-g LIBS=-lposix
		108
		109	*Note Defining Variables::, for more details.
87		110
88	Compiling For Multiple Architectures	111	Compiling For Multiple Architectures
89	====================================	112	====================================
90		113
91	You can compile the package for more than one kind of computer at the	114	You can compile the package for more than one kind of computer at the
92	same time, by placing the object files for each architecture in their	115	same time, by placing the object files for each architecture in their
93	own directory. To do this, you must use a version of `make' that	116	own directory. To do this, you can use GNU `make'. `cd' to the
94	supports the `VPATH' variable, such as GNU `make'. `cd' to the
95	directory where you want the object files and executables to go and run	117	directory where you want the object files and executables to go and run
96	the `configure' script. `configure' automatically checks for the	118	the `configure' script. `configure' automatically checks for the
97	source code in the directory that `configure' is in and in `..'.	119	source code in the directory that `configure' is in and in `..'. This
		120	is known as a "VPATH" build.
98		121
99	If you have to use a `make' that does not supports the `VPATH'	122	With a non-GNU `make', it is safer to compile the package for one
100	variable, you have to compile the package for one architecture at a time	123	architecture at a time in the source code directory. After you have
101	in the source code directory. After you have installed the package for	124	installed the package for one architecture, use `make distclean' before
102	one architecture, use `make distclean' before reconfiguring for another	125	reconfiguring for another architecture.
103	architecture.	126
		127	On MacOS X 10.5 and later systems, you can create libraries and
		128	executables that work on multiple system types--known as "fat" or
		129	"universal" binaries--by specifying multiple `-arch' options to the
		130	compiler but only a single `-arch' option to the preprocessor. Like
		131	this:
		132
		133	./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
		134	CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
		135	CPP="gcc -E" CXXCPP="g++ -E"
		136
		137	This is not guaranteed to produce working output in all cases, you
		138	may have to build one architecture at a time and combine the results
		139	using the `lipo' tool if you have problems.
104		140
105	Installation Names	141	Installation Names
106	==================	142	==================
107		143
108	By default, `make install' will install the package's files in	144	By default, `make install' installs the package's commands under
109	`/usr/local/bin', `/usr/local/man', etc. You can specify an	145	`/usr/local/bin', include files under `/usr/local/include', etc. You
110	installation prefix other than `/usr/local' by giving `configure' the	146	can specify an installation prefix other than `/usr/local' by giving
111	option `--prefix=PATH'.	147	`configure' the option `--prefix=PREFIX', where PREFIX must be an
		148	absolute file name.
112		149
113	You can specify separate installation prefixes for	150	You can specify separate installation prefixes for
114	architecture-specific files and architecture-independent files. If you	151	architecture-specific files and architecture-independent files. If you
115	give `configure' the option `--exec-prefix=PATH', the package will use	152	pass the option `--exec-prefix=PREFIX' to `configure', the package uses
116	PATH as the prefix for installing programs and libraries.	153	PREFIX as the prefix for installing programs and libraries.
117	Documentation and other data files will still use the regular prefix.	154	Documentation and other data files still use the regular prefix.
118		155
119	In addition, if you use an unusual directory layout you can give	156	In addition, if you use an unusual directory layout you can give
120	options like `--bindir=PATH' to specify different values for particular	157	options like `--bindir=DIR' to specify different values for particular
121	kinds of files. Run `configure --help' for a list of the directories	158	kinds of files. Run `configure --help' for a list of the directories
122	you can set and what kinds of files go in them.	159	you can set and what kinds of files go in them. In general, the
		160	default for these options is expressed in terms of `${prefix}', so that
		161	specifying just `--prefix' will affect all of the other directory
		162	specifications that were not explicitly provided.
		163
		164	The most portable way to affect installation locations is to pass the
		165	correct locations to `configure'; however, many packages provide one or
		166	both of the following shortcuts of passing variable assignments to the
		167	`make install' command line to change installation locations without
		168	having to reconfigure or recompile.
		169
		170	The first method involves providing an override variable for each
		171	affected directory. For example, `make install
		172	prefix=/alternate/directory' will choose an alternate location for all
		173	directory configuration variables that were expressed in terms of
		174	`${prefix}'. Any directories that were specified during `configure',
		175	but not in terms of `${prefix}', must each be overridden at install
		176	time for the entire installation to be relocated. The approach of
		177	makefile variable overrides for each directory variable is required by
		178	the GNU Coding Standards, and ideally causes no recompilation.
		179	However, some platforms have known limitations with the semantics of
		180	shared libraries that end up requiring recompilation when using this
		181	method, particularly noticeable in packages that use GNU Libtool.
		182
		183	The second method involves providing the `DESTDIR' variable. For
		184	example, `make install DESTDIR=/alternate/directory' will prepend
		185	`/alternate/directory' before all installation names. The approach of
		186	`DESTDIR' overrides is not required by the GNU Coding Standards, and
		187	does not work on platforms that have drive letters. On the other hand,
		188	it does better at avoiding recompilation issues, and works well even
		189	when some directory options were not specified in terms of `${prefix}'
		190	at `configure' time.
		191
		192	Optional Features
		193	=================
123		194
124	If the package supports it, you can cause programs to be installed	195	If the package supports it, you can cause programs to be installed
125	with an extra prefix or suffix on their names by giving `configure' the	196	with an extra prefix or suffix on their names by giving `configure' the
126	option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.	197	option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
127
128	Optional Features
129	=================
130		198
131	Some packages pay attention to `--enable-FEATURE' options to	199	Some packages pay attention to `--enable-FEATURE' options to
132	`configure', where FEATURE indicates an optional part of the package.	200	`configure', where FEATURE indicates an optional part of the package.
133	They may also pay attention to `--with-PACKAGE' options, where PACKAGE	201	They may also pay attention to `--with-PACKAGE' options, where PACKAGE
134	is something like `gnu-as' or `x' (for the X Window System). The	202	is something like `gnu-as' or `x' (for the X Window System). The
…		…
138	For packages that use the X Window System, `configure' can usually	206	For packages that use the X Window System, `configure' can usually
139	find the X include and library files automatically, but if it doesn't,	207	find the X include and library files automatically, but if it doesn't,
140	you can use the `configure' options `--x-includes=DIR' and	208	you can use the `configure' options `--x-includes=DIR' and
141	`--x-libraries=DIR' to specify their locations.	209	`--x-libraries=DIR' to specify their locations.
142		210
		211	Some packages offer the ability to configure how verbose the
		212	execution of `make' will be. For these packages, running `./configure
		213	--enable-silent-rules' sets the default to minimal output, which can be
		214	overridden with `make V=1'; while running `./configure
		215	--disable-silent-rules' sets the default to verbose, which can be
		216	overridden with `make V=0'.
		217
		218	Particular systems
		219	==================
		220
		221	On HP-UX, the default C compiler is not ANSI C compatible. If GNU
		222	CC is not installed, it is recommended to use the following options in
		223	order to use an ANSI C compiler:
		224
		225	./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
		226
		227	and if that doesn't work, install pre-built binaries of GCC for HP-UX.
		228
		229	HP-UX `make' updates targets which have the same time stamps as
		230	their prerequisites, which makes it generally unusable when shipped
		231	generated files such as `configure' are involved. Use GNU `make'
		232	instead.
		233
		234	On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
		235	parse its `<wchar.h>' header file. The option `-nodtk' can be used as
		236	a workaround. If GNU CC is not installed, it is therefore recommended
		237	to try
		238
		239	./configure CC="cc"
		240
		241	and if that doesn't work, try
		242
		243	./configure CC="cc -nodtk"
		244
		245	On Solaris, don't put `/usr/ucb' early in your `PATH'. This
		246	directory contains several dysfunctional programs; working variants of
		247	these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
		248	in your `PATH', put it _after_ `/usr/bin'.
		249
		250	On Haiku, software installed for all users goes in `/boot/common',
		251	not `/usr/local'. It is recommended to use the following options:
		252
		253	./configure --prefix=/boot/common
		254
143	Specifying the System Type	255	Specifying the System Type
144	==========================	256	==========================
145		257
146	There may be some features `configure' can not figure out	258	There may be some features `configure' cannot figure out
147	automatically, but needs to determine by the type of host the package	259	automatically, but needs to determine by the type of machine the package
148	will run on. Usually `configure' can figure that out, but if it prints	260	will run on. Usually, assuming the package is built to be run on the
		261	_same_ architectures, `configure' can figure that out, but if it prints
149	a message saying it can not guess the host type, give it the	262	a 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	263	`--build=TYPE' option. TYPE can either be a short name for the system
151	type, such as `sun4', or a canonical name with three fields:	264	type, such as `sun4', or a canonical name which has the form:
		265
152	CPU-COMPANY-SYSTEM	266	CPU-COMPANY-SYSTEM
153		267
		268	where SYSTEM can have one of these forms:
		269
		270	OS
		271	KERNEL-OS
		272
154	See the file `config.sub' for the possible values of each field. If	273	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	274	`config.sub' isn't included in this package, then this package doesn't
156	need to know the host type.	275	need to know the machine type.
157		276
158	If you are building compiler tools for cross-compiling, you can also	277	If you are _building_ compiler tools for cross-compiling, you should
159	use the `--target=TYPE' option to select the type of system they will	278	use the option `--target=TYPE' to select the type of system they will
160	produce code for and the `--build=TYPE' option to select the type of	279	produce code for.
161	system on which you are compiling the package.	280
		281	If you want to _use_ a cross compiler, that generates code for a
		282	platform different from the build platform, you should specify the
		283	"host" platform (i.e., that on which the generated programs will
		284	eventually be run) with `--host=TYPE'.
162		285
163	Sharing Defaults	286	Sharing Defaults
164	================	287	================
165		288
166	If you want to set default values for `configure' scripts to share,	289	If you want to set default values for `configure' scripts to share,
…		…
169	`configure' looks for `PREFIX/share/config.site' if it exists, then	292	`configure' looks for `PREFIX/share/config.site' if it exists, then
170	`PREFIX/etc/config.site' if it exists. Or, you can set the	293	`PREFIX/etc/config.site' if it exists. Or, you can set the
171	`CONFIG_SITE' environment variable to the location of the site script.	294	`CONFIG_SITE' environment variable to the location of the site script.
172	A warning: not all `configure' scripts look for a site script.	295	A warning: not all `configure' scripts look for a site script.
173		296
174	Operation Controls	297	Defining Variables
175	==================	298	==================
		299
		300	Variables not defined in a site shell script can be set in the
		301	environment passed to `configure'. However, some packages may run
		302	configure again during the build, and the customized values of these
		303	variables may be lost. In order to avoid this problem, you should set
		304	them in the `configure' command line, using `VAR=value'. For example:
		305
		306	./configure CC=/usr/local2/bin/gcc
		307
		308	causes the specified `gcc' to be used as the C compiler (unless it is
		309	overridden in the site shell script).
		310
		311	Unfortunately, this technique does not work for `CONFIG_SHELL' due to
		312	an Autoconf bug. Until the bug is fixed you can use this workaround:
		313
		314	CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
		315
		316	`configure' Invocation
		317	======================
176		318
177	`configure' recognizes the following options to control how it	319	`configure' recognizes the following options to control how it
178	operates.	320	operates.
179		321
		322	`--help'
		323	`-h'
		324	Print a summary of all of the options to `configure', and exit.
		325
		326	`--help=short'
		327	`--help=recursive'
		328	Print a summary of the options unique to this package's
		329	`configure', and exit. The `short' variant lists options used
		330	only in the top level, while the `recursive' variant lists options
		331	also present in any nested packages.
		332
		333	`--version'
		334	`-V'
		335	Print the version of Autoconf used to generate the `configure'
		336	script, and exit.
		337
180	`--cache-file=FILE'	338	`--cache-file=FILE'
181	Use and save the results of the tests in FILE instead of	339	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	340	traditionally `config.cache'. FILE defaults to `/dev/null' to
183	debugging `configure'.	341	disable caching.
184		342
185	`--help'	343	`--config-cache'
186	Print a summary of the options to `configure', and exit.	344	`-C'
		345	Alias for `--cache-file=config.cache'.
187		346
188	`--quiet'	347	`--quiet'
189	`--silent'	348	`--silent'
190	`-q'	349	`-q'
191	Do not print messages saying which checks are being made. To	350	Do not print messages saying which checks are being made. To
…		…
194		353
195	`--srcdir=DIR'	354	`--srcdir=DIR'
196	Look for the package's source code in directory DIR. Usually	355	Look for the package's source code in directory DIR. Usually
197	`configure' can determine that directory automatically.	356	`configure' can determine that directory automatically.
198		357
199	`--version'	358	`--prefix=DIR'
200	Print the version of Autoconf used to generate the `configure'	359	Use DIR as the installation prefix. *note Installation Names::
201	script, and exit.	360	for more details, including other options available for fine-tuning
		361	the installation locations.
202		362
		363	`--no-create'
		364	`-n'
		365	Run the configure checks, but stop before creating any output
		366	files.
		367
203	`configure' also accepts some other, not widely useful, options.	368	`configure' also accepts some other, not widely useful, options. Run
		369	`configure --help' for more details.
		370

 Legend:



Removed from v.2
 


changed lines


 
Added in v.346
 Legend:



Removed from v.2
 


changed lines


 
Added in v.346
-Removed from v.2
+Added in v.346

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