INSTALL

   1 Quick installation
   2 ==================
   3
   4    In most cases it should be sufficient to do:
   5
   6         ./configure
   7         make
   8         make install
   9
  10    The above will compile and install the NTFS library and utility
  11 programs into /usr/local/lib and /usr/local/bin respectively. The man
  12 pages will be installed by default in /usr/local/man.
  13
  14 Basic Installation
  15 ==================
  16
  17    The `configure' shell script attempts to guess correct values for
  18 various system-dependent variables used during compilation.  It uses
  19 those values to create a `Makefile' in each directory of the package.
  20 It may also create one or more `.h' files containing system-dependent
  21 definitions.  Finally, it creates a shell script `config.status' that
  22 you can run in the future to recreate the current configuration, and a
  23 file `config.log' containing compiler output (useful mainly for
  24 debugging `configure').
  25
  26    It can also use an optional file (typically called `config.cache'
  27 and enabled with `--cache-file=config.cache' or simply `-C') that saves
  28 the results of its tests to speed up reconfiguring.  (Caching is
  29 disabled by default to prevent problems with accidental use of stale
  30 cache files.)
  31
  32    If you need to do unusual things to compile the package, please try
  33 to figure out how `configure' could check whether to do them, and mail
  34 diffs or instructions to the address given in the `README' so they can
  35 be considered for the next release.  If you are using the cache, and at
  36 some point `config.cache' contains results you don't want to keep, you
  37 may remove or edit it.
  38
  39    The file `configure.ac' (or `configure.in') is used to create
  40 `configure' by a program called `autoconf'.  You only need
  41 `configure.ac' if you want to change it or regenerate `configure' using
  42 a newer version of `autoconf'.
  43
  44 The simplest way to compile this package is:
  45
  46   1. `cd' to the directory containing the package's source code and type
  47      `./configure' to configure the package for your system.  If you're
  48      using `csh' on an old version of System V, you might need to type
  49      `sh ./configure' instead to prevent `csh' from trying to execute
  50      `configure' itself.
  51
  52      Running `configure' takes awhile.  While running, it prints some
  53      messages telling which features it is checking for.
  54
  55   2. Type `make' to compile the package.
  56
  57   3. Optionally, type `make check' to run any self-tests that come with
  58      the package.
  59
  60   4. Type `make install' to install the programs and any data files and
  61      documentation.
  62
  63   5. You can remove the program binaries and object files from the
  64      source code directory by typing `make clean'.  To also remove the
  65      files that `configure' created (so you can compile the package for
  66      a different kind of computer), type `make distclean'.  There is
  67      also a `make maintainer-clean' target, but that is intended mainly
  68      for the package's developers.  If you use it, you may have to get
  69      all sorts of other programs in order to regenerate files that came
  70      with the distribution.
  71
  72 Compilers and Options
  73 =====================
  74
  75    Some systems require unusual options for compilation or linking that
  76 the `configure' script does not know about.  Run `./configure --help'
  77 for details on some of the pertinent environment variables.
  78
  79    You can give `configure' initial values for configuration parameters
  80 by setting variables in the command line or in the environment.  Here
  81 is an example:
  82
  83         ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
  84
  85    *Note Defining Variables::, for more details.
  86
  87 Compiling For Multiple Architectures
  88 ====================================
  89
  90    You can compile the package for more than one kind of computer at the
  91 same time, by placing the object files for each architecture in their
  92 own directory.  To do this, you must use a version of `make' that
  93 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  94 directory where you want the object files and executables to go and run
  95 the `configure' script.  `configure' automatically checks for the
  96 source code in the directory that `configure' is in and in `..'.
  97
  98    If you have to use a `make' that does not support the `VPATH'
  99 variable, you have to compile the package for one architecture at a
 100 time in the source code directory.  After you have installed the
 101 package for one architecture, use `make distclean' before reconfiguring
 102 for another architecture.
 103
 104 Installation Names
 105 ==================
 106
 107    By default, `make install' will install the package's files in
 108 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 109 installation prefix other than `/usr/local' by giving `configure' the
 110 option `--prefix=PATH'.
 111
 112    You can specify separate installation prefixes for
 113 architecture-specific files and architecture-independent files.  If you
 114 give `configure' the option `--exec-prefix=PATH', the package will use
 115 PATH as the prefix for installing programs and libraries.
 116 Documentation and other data files will still use the regular prefix.
 117
 118    In addition, if you use an unusual directory layout you can give
 119 options like `--bindir=PATH' to specify different values for particular
 120 kinds of files.  Run `configure --help' for a list of the directories
 121 you can set and what kinds of files go in them.
 122
 123    If the package supports it, you can cause programs to be installed
 124 with an extra prefix or suffix on their names by giving `configure' the
 125 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 126
 127 Optional Features
 128 =================
 129
 130    Some packages pay attention to `--enable-FEATURE' options to
 131 `configure', where FEATURE indicates an optional part of the package.
 132 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 133 is something like `gnu-as' or `x' (for the X Window System).  The
 134 `README' should mention any `--enable-' and `--with-' options that the
 135 package recognizes.
 136
 137    For packages that use the X Window System, `configure' can usually
 138 find the X include and library files automatically, but if it doesn't,
 139 you can use the `configure' options `--x-includes=DIR' and
 140 `--x-libraries=DIR' to specify their locations.
 141
 142    The `--enable-debug' option to `configure' will enable additional debugging
 143 checks in the code as well as debugging information output which will be
 144 emitted to stdout.
 145
 146 Specifying the System Type
 147 ==========================
 148
 149    There may be some features `configure' cannot figure out
 150 automatically, but needs to determine by the type of machine the package
 151 will run on.  Usually, assuming the package is built to be run on the
 152 _same_ atchitectures, `configure' can figure that out, but if it prints
 153 a message saying it cannot guess the machine type, give it the
 154 `--build=TYPE' option.  TYPE can either be a short name for the system
 155 type, such as `sun4', or a canonical name which has the form:
 156      CPU-COMPANY-SYSTEM
 157
 158 where SYSTEM can have one of these forms:
 159
 160         OS KERNEL-OS
 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 machine type.
 165
 166    If you are _building_ compiler tools for cross-compiling, you should
 167 use the `--target=TYPE' option to select the type of system they will
 168 produce code for.
 169
 170    If you want to _use_ a cross compiler, that generates code for a
 171 platform different from the build platform, you should specify the
 172 "host" platform (i.e., that on which the generated programs will
 173 eventually be run) with `--host=TYPE'.
 174
 175 Sharing Defaults
 176 ================
 177
 178    If you want to set default values for `configure' scripts to share,
 179 you can create a site shell script called `config.site' that gives
 180 default values for variables like `CC', `cache_file', and `prefix'.
 181 `configure' looks for `PREFIX/share/config.site' if it exists, then
 182 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 183 `CONFIG_SITE' environment variable to the location of the site script.
 184 A warning: not all `configure' scripts look for a site script.
 185
 186 Defining Variables
 187 ==================
 188
 189    Variables not defined in a site shell script can be set in the
 190 environment passed to `configure'.  However, some packages may run
 191 configure again during the build, and the customized values of these
 192 variables may be lost.  In order to avoid this problem, you should set
 193 them in the `configure' command line, using `VAR=value'.  For example:
 194
 195      ./configure CC=/usr/local2/bin/gcc
 196
 197 will cause the specified gcc to be used as the C compiler (unless it is
 198 overridden in the site shell script).
 199
 200 `configure' Invocation
 201 ======================
 202
 203    `configure' recognizes the following options to control how it
 204 operates.
 205
 206 `--help'
 207 `-h'
 208      Print a summary of the options to `configure', and exit.
 209
 210 `--version'
 211 `-V'
 212      Print the version of Autoconf used to generate the `configure'
 213      script, and exit.
 214
 215 `--cache-file=FILE'
 216      Enable the cache: use and save the results of the tests in FILE,
 217      traditionally `./config.cache'.  FILE defaults to `/dev/null' to
 218      disable caching.
 219
 220 `--config-cache'
 221 `-C'
 222      Alias for `--cache-file=config.cache'.
 223
 224 `--quiet'
 225 `--silent'
 226 `-q'
 227      Do not print messages saying which checks are being made.  To
 228      suppress all normal output, redirect it to `/dev/null' (any error
 229      messages will still be shown).
 230
 231 `--srcdir=DIR'
 232      Look for the package's source code in directory DIR.  Usually
 233      `configure' can determine that directory automatically.
 234
 235 `configure' also accepts some other, not widely useful, options.  Run
 236 `configure --help' for more details.
 237