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