- added new test results
[openocd.git] / 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 On Windows, you need either Cygwin or MinGW, but compilation for MinGW is also
11 possible using a Cygwin host.
12
13 Basic Installation
14 ==================
15
16    OpenOCD is distributed without autotools generated files, i.e. without a 
17 configure script. Run ./bootstrap in the openocd directory to have all
18 necessary files generated.
19
20    You have to explicitly enable desired JTAG interfaces during configure:
21
22 ./configure --enable-parport --enable-ft2232-libftdi (OR  --enable-ft2232-ftd2xx) \
23             --enable-amtjtagaccel
24
25    Under Windows/Cygwin, only the ftd2xx driver is supported for FT2232 based
26 devices. You have to specify the location of the FTDI driver package with the
27 --with-ftd2xx=/full/path/name option.
28
29 Under Linux you can choose to build the parport driver with support for
30 /dev/parportN instead of the default access with direct port I/O using
31 --enable-parport_ppdev. This has the advantage of running OpenOCD without root
32 privileges at the expense of a slight performance decrease. This is also
33 available on FreeBSD using PPI, but the naming of the devices is different.
34
35 Generic installation instructions
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 a while.  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. Type `make install' to install the programs and any data files and
74      documentation.
75
76   4. You can remove the program binaries and object files from the
77      source code directory by typing `make clean'.  
78
79 Compilers and Options
80 =====================
81
82    Some systems require unusual options for compilation or linking that
83 the `configure' script does not know about.  You can give `configure'
84 initial values for variables by setting them in the environment.  Using
85 a Bourne-compatible shell, you can do that on the command line like
86 this:
87      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
88
89 Or on systems that have the `env' program, you can do it like this:
90      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
91
92 Compiling For Multiple Architectures
93 ====================================
94
95    You can compile the package for more than one kind of computer at the
96 same time, by placing the object files for each architecture in their
97 own directory.  To do this, you must use a version of `make' that
98 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
99 directory where you want the object files and executables to go and run
100 the `configure' script.  `configure' automatically checks for the
101 source code in the directory that `configure' is in and in `..'.
102
103    If you have to use a `make' that does not supports the `VPATH'
104 variable, you have to compile the package for one architecture at a time
105 in the source code directory.  After you have installed the package for
106 one architecture, use `make distclean' before reconfiguring for another
107 architecture.
108
109 Installation Names
110 ==================
111
112    By default, `make install' will install the package's files in
113 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
114 installation prefix other than `/usr/local' by giving `configure' the
115 option `--prefix=PATH'.
116
117    You can specify separate installation prefixes for
118 architecture-specific files and architecture-independent files.  If you
119 give `configure' the option `--exec-prefix=PATH', the package will use
120 PATH as the prefix for installing programs and libraries.
121 Documentation and other data files will still use the regular prefix.
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 Specifying the System Type
143 ==========================
144
145    There may be some features `configure' can not figure out
146 automatically, but needs to determine by the type of host the package
147 will run on.  Usually `configure' can figure that out, but if it prints
148 a message saying it can not guess the host type, give it the
149 `--host=TYPE' option.  TYPE can either be a short name for the system
150 type, such as `sun4', or a canonical name with three fields:
151      CPU-COMPANY-SYSTEM
152
153 See the file `config.sub' for the possible values of each field.  If
154 `config.sub' isn't included in this package, then this package doesn't
155 need to know the host type.
156
157    If you are building compiler tools for cross-compiling, you can also
158 use the `--target=TYPE' option to select the type of system they will
159 produce code for and the `--build=TYPE' option to select the type of
160 system on which you are compiling the package.
161
162 Sharing Defaults
163 ================
164
165    If you want to set default values for `configure' scripts to share,
166 you can create a site shell script called `config.site' that gives
167 default values for variables like `CC', `cache_file', and `prefix'.
168 `configure' looks for `PREFIX/share/config.site' if it exists, then
169 `PREFIX/etc/config.site' if it exists.  Or, you can set the
170 `CONFIG_SITE' environment variable to the location of the site script.
171 A warning: not all `configure' scripts look for a site script.
172
173 Operation Controls
174 ==================
175
176    `configure' recognizes the following options to control how it
177 operates.
178
179 `--cache-file=FILE'
180      Use and save the results of the tests in FILE instead of
181      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
182      debugging `configure'.
183
184 `--help'
185      Print a summary of the options to `configure', and exit.
186
187 `--quiet'
188 `--silent'
189 `-q'
190      Do not print messages saying which checks are being made.
191
192 `--srcdir=DIR'
193      Look for the package's source code in directory DIR.  Usually
194      `configure' can determine that directory automatically.
195
196 `--version'
197      Print the version of Autoconf used to generate the `configure'
198      script, and exit.
199
200 `configure' also accepts some other, not widely useful, options.
201