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