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

Annotation of /psiconv/trunk/INSTALL

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2 - (hide annotations)
Sun Oct 3 21:10:47 1999 UTC (20 years, 3 months ago) by frodo
File size: 8660 byte(s)
Imported sources

1 frodo 2 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    
22     Basic Installation
23     ==================
24    
25     These are generic installation instructions.
26    
27     The `configure' shell script attempts to guess correct values for
28     various system-dependent variables used during compilation. It uses
29     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
31     definitions. Finally, it creates a shell script `config.status' that
32     you can run in the future to recreate the current configuration, a file
33     `config.cache' that saves the results of its tests to speed up
34     reconfiguring, and a file `config.log' containing compiler output
35     (useful mainly for debugging `configure').
36    
37     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
39     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'
41     contains results you don't want to keep, you may remove or edit it.
42    
43     The file `configure.in' is used to create `configure' by a program
44     called `autoconf'. You only need `configure.in' if you want to change
45     it or regenerate `configure' using a newer version of `autoconf'.
46    
47     The simplest way to compile this package is:
48    
49     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
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     Running `configure' takes awhile. While running, it prints some
56     messages telling which features it is checking for.
57    
58     2. Type `make' to compile the package.
59    
60     3. Optionally, type `make check' to run any self-tests that come with
61     the package.
62    
63     4. Type `make install' to install the programs and any data files and
64     documentation.
65    
66     5. You can remove the program binaries and object files from the
67     source code directory by typing `make clean'. To also remove the
68     files that `configure' created (so you can compile the package for
69     a different kind of computer), type `make distclean'. There is
70     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
72     all sorts of other programs in order to regenerate files that came
73     with the distribution.
74    
75     Compilers and Options
76     =====================
77    
78     Some systems require unusual options for compilation or linking that
79     the `configure' script does not know about. You can give `configure'
80     initial values for variables by setting them in the environment. Using
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    
85     Or on systems that have the `env' program, you can do it like this:
86     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
87    
88     Compiling For Multiple Architectures
89     ====================================
90    
91     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
93     own directory. To do this, you must use a version of `make' that
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
96     the `configure' script. `configure' automatically checks for the
97     source code in the directory that `configure' is in and in `..'.
98    
99     If you have to use a `make' that does not supports the `VPATH'
100     variable, you have to compile the package for one architecture at a time
101     in the source code directory. After you have installed the package for
102     one architecture, use `make distclean' before reconfiguring for another
103     architecture.
104    
105     Installation Names
106     ==================
107    
108     By default, `make install' will install the package's files in
109     `/usr/local/bin', `/usr/local/man', etc. You can specify an
110     installation prefix other than `/usr/local' by giving `configure' the
111     option `--prefix=PATH'.
112    
113     You can specify separate installation prefixes for
114     architecture-specific files and architecture-independent files. If you
115     give `configure' the option `--exec-prefix=PATH', the package will use
116     PATH as the prefix for installing programs and libraries.
117     Documentation and other data files will still use the regular prefix.
118    
119     In addition, if you use an unusual directory layout you can give
120     options like `--bindir=PATH' to specify different values for particular
121     kinds of files. Run `configure --help' for a list of the directories
122     you can set and what kinds of files go in them.
123    
124     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
126     option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
127    
128     Optional Features
129     =================
130    
131     Some packages pay attention to `--enable-FEATURE' options to
132     `configure', where FEATURE indicates an optional part of the package.
133     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
135     `README' should mention any `--enable-' and `--with-' options that the
136     package recognizes.
137    
138     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,
140     you can use the `configure' options `--x-includes=DIR' and
141     `--x-libraries=DIR' to specify their locations.
142    
143     Specifying the System Type
144     ==========================
145    
146     There may be some features `configure' can not figure out
147     automatically, but needs to determine by the type of host the package
148     will run on. Usually `configure' can figure that out, but if it prints
149     a message saying it can not guess the host type, give it the
150     `--host=TYPE' option. TYPE can either be a short name for the system
151     type, such as `sun4', or a canonical name with three fields:
152     CPU-COMPANY-SYSTEM
153    
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
156     need to know the host type.
157    
158     If you are building compiler tools for cross-compiling, you can also
159     use the `--target=TYPE' option to select the type of system they will
160     produce code for and the `--build=TYPE' option to select the type of
161     system on which you are compiling the package.
162    
163     Sharing Defaults
164     ================
165    
166     If you want to set default values for `configure' scripts to share,
167     you can create a site shell script called `config.site' that gives
168     default values for variables like `CC', `cache_file', and `prefix'.
169     `configure' looks for `PREFIX/share/config.site' if it exists, then
170     `PREFIX/etc/config.site' if it exists. Or, you can set the
171     `CONFIG_SITE' environment variable to the location of the site script.
172     A warning: not all `configure' scripts look for a site script.
173    
174     Operation Controls
175     ==================
176    
177     `configure' recognizes the following options to control how it
178     operates.
179    
180     `--cache-file=FILE'
181     Use and save the results of the tests in FILE instead of
182     `./config.cache'. Set FILE to `/dev/null' to disable caching, for
183     debugging `configure'.
184    
185     `--help'
186     Print a summary of the options to `configure', and exit.
187    
188     `--quiet'
189     `--silent'
190     `-q'
191     Do not print messages saying which checks are being made. To
192     suppress all normal output, redirect it to `/dev/null' (any error
193     messages will still be shown).
194    
195     `--srcdir=DIR'
196     Look for the package's source code in directory DIR. Usually
197     `configure' can determine that directory automatically.
198    
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.

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