INSTALL

   1 Prerequisites
   2 =============
   3
   4 When building with support for FTDI FT2232 based devices, you need at least
   5 one of the following libraries:
   6
   7 - libftdi (http://www.intra2net.com/opensource/ftdi/)
   8 - libftd2xx (http://www.ftdichip.com/Drivers/D2XX.htm)
   9
  10 Basic Installation
  11 ==================
  12
  13    OpenOCD is distributed without autotools generated files, i.e. without a
  14 configure script. Run ./bootstrap in the openocd directory to have all
  15 necessary files generated.
  16
  17    You have to explicitly enable desired JTAG interfaces during configure:
  18
  19 ./configure --enable-parport --enable-ftdi2232 --enable-ftd2xx \
  20             --enable-amtjtagaccel
  21
  22    Under Windows/Cygwin, only the ftd2xx driver is supported for FT2232 based
  23 devices. You have to specify the location of the FTDI driver package with the
  24 --with-ftd2xx=/full/path/name option.
  25
  26 Under Linux you can choose to build the parport driver with support for
  27 /dev/parportN instead of the default access with direct port I/O using
  28 --enable-parport_ppdev. This has the advantage of running OpenOCD without root
  29 privileges at the expense of a slight performance decrease.
  30
  31    These are generic installation instructions.
  32
  33    The `configure' shell script attempts to guess correct values for
  34 various system-dependent variables used during compilation.  It uses
  35 those values to create a `Makefile' in each directory of the package.
  36 It may also create one or more `.h' files containing system-dependent
  37 definitions.  Finally, it creates a shell script `config.status' that
  38 you can run in the future to recreate the current configuration, a file
  39 `config.cache' that saves the results of its tests to speed up
  40 reconfiguring, and a file `config.log' containing compiler output
  41 (useful mainly for debugging `configure').
  42
  43    If you need to do unusual things to compile the package, please try
  44 to figure out how `configure' could check whether to do them, and mail
  45 diffs or instructions to the address given in the `README' so they can
  46 be considered for the next release.  If at some point `config.cache'
  47 contains results you don't want to keep, you may remove or edit it.
  48
  49    The file `configure.in' is used to create `configure' by a program
  50 called `autoconf'.  You only need `configure.in' if you want to change
  51 it or regenerate `configure' using a newer version of `autoconf'.
  52
  53 The simplest way to compile this package is:
  54
  55   1. `cd' to the directory containing the package's source code and type
  56      `./configure' to configure the package for your system.  If you're
  57      using `csh' on an old version of System V, you might need to type
  58      `sh ./configure' instead to prevent `csh' from trying to execute
  59      `configure' itself.
  60
  61      Running `configure' takes a while.  While running, it prints some
  62      messages telling which features it is checking for.
  63
  64   2. Type `make' to compile the package.
  65
  66   3. Type `make install' to install the programs and any data files and
  67      documentation.
  68
  69   4. You can remove the program binaries and object files from the
  70      source code directory by typing `make clean'.
  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.  You can give `configure'
  77 initial values for variables by setting them in the environment.  Using
  78 a Bourne-compatible shell, you can do that on the command line like
  79 this:
  80      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  81
  82 Or on systems that have the `env' program, you can do it like this:
  83      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  84
  85 Compiling For Multiple Architectures
  86 ====================================
  87
  88    You can compile the package for more than one kind of computer at the
  89 same time, by placing the object files for each architecture in their
  90 own directory.  To do this, you must use a version of `make' that
  91 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  92 directory where you want the object files and executables to go and run
  93 the `configure' script.  `configure' automatically checks for the
  94 source code in the directory that `configure' is in and in `..'.
  95
  96    If you have to use a `make' that does not supports the `VPATH'
  97 variable, you have to compile the package for one architecture at a time
  98 in the source code directory.  After you have installed the package for
  99 one architecture, use `make distclean' before reconfiguring for another
 100 architecture.
 101
 102 Installation Names
 103 ==================
 104
 105    By default, `make install' will install the package's files in
 106 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 107 installation prefix other than `/usr/local' by giving `configure' the
 108 option `--prefix=PATH'.
 109
 110    You can specify separate installation prefixes for
 111 architecture-specific files and architecture-independent files.  If you
 112 give `configure' the option `--exec-prefix=PATH', the package will use
 113 PATH as the prefix for installing programs and libraries.
 114 Documentation and other data files will still use the regular prefix.
 115
 116    If the package supports it, you can cause programs to be installed
 117 with an extra prefix or suffix on their names by giving `configure' the
 118 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 119
 120 Optional Features
 121 =================
 122
 123    Some packages pay attention to `--enable-FEATURE' options to
 124 `configure', where FEATURE indicates an optional part of the package.
 125 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 126 is something like `gnu-as' or `x' (for the X Window System).  The
 127 `README' should mention any `--enable-' and `--with-' options that the
 128 package recognizes.
 129
 130    For packages that use the X Window System, `configure' can usually
 131 find the X include and library files automatically, but if it doesn't,
 132 you can use the `configure' options `--x-includes=DIR' and
 133 `--x-libraries=DIR' to specify their locations.
 134
 135 Specifying the System Type
 136 ==========================
 137
 138    There may be some features `configure' can not figure out
 139 automatically, but needs to determine by the type of host the package
 140 will run on.  Usually `configure' can figure that out, but if it prints
 141 a message saying it can not guess the host type, give it the
 142 `--host=TYPE' option.  TYPE can either be a short name for the system
 143 type, such as `sun4', or a canonical name with three fields:
 144      CPU-COMPANY-SYSTEM
 145
 146 See the file `config.sub' for the possible values of each field.  If
 147 `config.sub' isn't included in this package, then this package doesn't
 148 need to know the host type.
 149
 150    If you are building compiler tools for cross-compiling, you can also
 151 use the `--target=TYPE' option to select the type of system they will
 152 produce code for and the `--build=TYPE' option to select the type of
 153 system on which you are compiling the package.
 154
 155 Sharing Defaults
 156 ================
 157
 158    If you want to set default values for `configure' scripts to share,
 159 you can create a site shell script called `config.site' that gives
 160 default values for variables like `CC', `cache_file', and `prefix'.
 161 `configure' looks for `PREFIX/share/config.site' if it exists, then
 162 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 163 `CONFIG_SITE' environment variable to the location of the site script.
 164 A warning: not all `configure' scripts look for a site script.
 165
 166 Operation Controls
 167 ==================
 168
 169    `configure' recognizes the following options to control how it
 170 operates.
 171
 172 `--cache-file=FILE'
 173      Use and save the results of the tests in FILE instead of
 174      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 175      debugging `configure'.
 176
 177 `--help'
 178      Print a summary of the options to `configure', and exit.
 179
 180 `--quiet'
 181 `--silent'
 182 `-q'
 183      Do not print messages saying which checks are being made.
 184
 185 `--srcdir=DIR'
 186      Look for the package's source code in directory DIR.  Usually
 187      `configure' can determine that directory automatically.
 188
 189 `--version'
 190      Print the version of Autoconf used to generate the `configure'
 191      script, and exit.
 192
 193 `configure' also accepts some other, not widely useful, options.
 194