Pin Chrome's shortcut to the Win10 Start menu on install and OS upgrade.
[chromium-blink-merge.git] / third_party / protobuf / INSTALL.txt
blobce3b094905bb5c8cb94b65b8488ea847d0d3eadf
1 This file contains detailed but generic information on building and
2 installing the C++ part of this project.  For shorter instructions,
3 as well as instructions for compiling and installing the Java or
4 Python parts, see README.
6 ======================================================================
8 Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
9 Foundation, Inc.
11    This file is free documentation; the Free Software Foundation gives
12 unlimited permission to copy, distribute and modify it.
15 Basic Installation
16 ==================
18    These are generic installation instructions.
20    The `configure' shell script attempts to guess correct values for
21 various system-dependent variables used during compilation.  It uses
22 those values to create a `Makefile' in each directory of the package.
23 It may also create one or more `.h' files containing system-dependent
24 definitions.  Finally, it creates a shell script `config.status' that
25 you can run in the future to recreate the current configuration, and a
26 file `config.log' containing compiler output (useful mainly for
27 debugging `configure').
29    It can also use an optional file (typically called `config.cache'
30 and enabled with `--cache-file=config.cache' or simply `-C') that saves
31 the results of its tests to speed up reconfiguring.  (Caching is
32 disabled by default to prevent problems with accidental use of stale
33 cache files.)
35    If you need to do unusual things to compile the package, please try
36 to figure out how `configure' could check whether to do them, and mail
37 diffs or instructions to the address given in the `README' so they can
38 be considered for the next release.  If you are using the cache, and at
39 some point `config.cache' contains results you don't want to keep, you
40 may remove or edit it.
42    The file `configure.ac' (or `configure.in') is used to create
43 `configure' by a program called `autoconf'.  You only need
44 `configure.ac' if you want to change it or regenerate `configure' using
45 a newer version of `autoconf'.
47 The simplest way to compile this package is:
49   1. `cd' to the directory containing the package's source code and type
50      `./configure' to configure the package for your system.  If you're
51      using `csh' on an old version of System V, you might need to type
52      `sh ./configure' instead to prevent `csh' from trying to execute
53      `configure' itself.
55      Running `configure' takes awhile.  While running, it prints some
56      messages telling which features it is checking for.
58   2. Type `make' to compile the package.
60   3. Optionally, type `make check' to run any self-tests that come with
61      the package.
63   4. Type `make install' to install the programs and any data files and
64      documentation.
66   5. You can remove the program binaries and object files from the
67      source code directory by typing `make clean'.  To also remove the
68      files that `configure' created (so you can compile the package for
69      a different kind of computer), type `make distclean'.  There is
70      also a `make maintainer-clean' target, but that is intended mainly
71      for the package's developers.  If you use it, you may have to get
72      all sorts of other programs in order to regenerate files that came
73      with the distribution.
75 Compilers and Options
76 =====================
78    Some systems require unusual options for compilation or linking that
79 the `configure' script does not know about.  Run `./configure --help'
80 for details on some of the pertinent environment variables.
82    You can give `configure' initial values for configuration parameters
83 by setting variables in the command line or in the environment.  Here
84 is an example:
86      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
88    *Note Defining Variables::, for more details.
90 Compiling For Multiple Architectures
91 ====================================
93    You can compile the package for more than one kind of computer at the
94 same time, by placing the object files for each architecture in their
95 own directory.  To do this, you must use a version of `make' that
96 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
97 directory where you want the object files and executables to go and run
98 the `configure' script.  `configure' automatically checks for the
99 source code in the directory that `configure' is in and in `..'.
101    If you have to use a `make' that does not support the `VPATH'
102 variable, you have to compile the package for one architecture at a
103 time in the source code directory.  After you have installed the
104 package for one architecture, use `make distclean' before reconfiguring
105 for another architecture.
107 Installation Names
108 ==================
110    By default, `make install' will install the package's files in
111 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
112 installation prefix other than `/usr/local' by giving `configure' the
113 option `--prefix=PATH'.
115    You can specify separate installation prefixes for
116 architecture-specific files and architecture-independent files.  If you
117 give `configure' the option `--exec-prefix=PATH', the package will use
118 PATH as the prefix for installing programs and libraries.
119 Documentation and other data files will still use the regular prefix.
121    In addition, if you use an unusual directory layout you can give
122 options like `--bindir=PATH' to specify different values for particular
123 kinds of files.  Run `configure --help' for a list of the directories
124 you can set and what kinds of files go in them.
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'.
130 Optional Features
131 =================
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.
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.
145 Specifying the System Type
146 ==========================
148    There may be some features `configure' cannot figure out
149 automatically, but needs to determine by the type of machine the package
150 will run on.  Usually, assuming the package is built to be run on the
151 _same_ architectures, `configure' can figure that out, but if it prints
152 a message saying it cannot guess the machine type, give it the
153 `--build=TYPE' option.  TYPE can either be a short name for the system
154 type, such as `sun4', or a canonical name which has the form:
156      CPU-COMPANY-SYSTEM
158 where SYSTEM can have one of these forms:
160      OS KERNEL-OS
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.
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.
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'.
175 Sharing Defaults
176 ================
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.
186 Defining Variables
187 ==================
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:
195      ./configure CC=/usr/local2/bin/gcc
197 will cause the specified gcc to be used as the C compiler (unless it is
198 overridden in the site shell script).
200 `configure' Invocation
201 ======================
203    `configure' recognizes the following options to control how it
204 operates.
206 `--help'
207 `-h'
208      Print a summary of the options to `configure', and exit.
210 `--version'
211 `-V'
212      Print the version of Autoconf used to generate the `configure'
213      script, and exit.
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.
220 `--config-cache'
221 `-C'
222      Alias for `--cache-file=config.cache'.
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).
231 `--srcdir=DIR'
232      Look for the package's source code in directory DIR.  Usually
233      `configure' can determine that directory automatically.
235 `configure' also accepts some other, not widely useful, options.  Run
236 `configure --help' for more details.