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