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