Mirror of strace – the linux syscall tracer
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README-configure 13KB

  1. Installation Instructions
  2. *************************
  3. Copyright (C) 1994-1996, 1999-2002, 2004-2013 Free Software Foundation,
  4. Inc.
  5. Copying and distribution of this file, with or without modification,
  6. are permitted in any medium without royalty provided the copyright
  7. notice and this notice are preserved. This file is offered as-is,
  8. without warranty of any kind.
  9. Basic Installation
  10. ==================
  11. Briefly, the shell command './configure && make && make install' should
  12. configure, build, and install this package. The following more-detailed
  13. instructions are generic; see the 'README' file for instructions
  14. specific to this package. Some packages provide this 'README-configure'
  15. file but do not implement all of the features documented below. The
  16. lack of an optional feature in a given package is not necessarily a bug.
  17. More recommendations for GNU packages can be found in *note Makefile
  18. Conventions: (standards)Makefile Conventions.
  19. The 'configure' shell script attempts to guess correct values for
  20. various system-dependent variables used during compilation. It uses
  21. those values to create a 'Makefile' in each directory of the package.
  22. It may also create one or more '.h' files containing system-dependent
  23. definitions. Finally, it creates a shell script 'config.status' that
  24. you can run in the future to recreate the current configuration, and a
  25. file 'config.log' containing compiler output (useful mainly for
  26. debugging 'configure').
  27. It can also use an optional file (typically called 'config.cache' and
  28. enabled with '--cache-file=config.cache' or simply '-C') that saves the
  29. results of its tests to speed up reconfiguring. Caching is disabled by
  30. default to prevent problems with accidental use of stale cache files.
  31. If you need to do unusual things to compile the package, please try
  32. to figure out how 'configure' could check whether to do them, and mail
  33. diffs or instructions to the address given in the 'README' so they can
  34. be considered for the next release. If you are using the cache, and at
  35. some point 'config.cache' contains results you don't want to keep, you
  36. may remove or edit it.
  37. The file 'configure.ac' (or 'configure.in') is used to create
  38. 'configure' by a program called 'autoconf'. You need 'configure.ac' if
  39. you want to change it or regenerate 'configure' using a newer version of
  40. 'autoconf'.
  41. The simplest way to compile this package is:
  42. 1. 'cd' to the directory containing the package's source code and type
  43. './configure' to configure the package for your system.
  44. Running 'configure' might take a while. While running, it prints
  45. some messages telling which features it is checking for.
  46. 2. Type 'make' to compile the package.
  47. 3. Optionally, type 'make -k check' to run any self-tests that come with
  48. the package, generally using the just-built uninstalled binaries.
  49. 4. Type 'make install' to install the programs and any data files and
  50. documentation. When installing into a prefix owned by root, it is
  51. recommended that the package be configured and built as a regular
  52. user, and only the 'make install' phase executed with root
  53. privileges.
  54. 5. Optionally, type 'make installcheck' to repeat any self-tests, but
  55. this time using the binaries in their final installed location.
  56. This target does not install anything. Running this target as a
  57. regular user, particularly if the prior 'make install' required
  58. root privileges, verifies that the installation completed
  59. correctly.
  60. 6. You can remove the program binaries and object files from the
  61. source code directory by typing 'make clean'. To also remove the
  62. files that 'configure' created (so you can compile the package for
  63. a different kind of computer), type 'make distclean'. There is
  64. also a 'make maintainer-clean' target, but that is intended mainly
  65. for the package's developers. If you use it, you may have to get
  66. all sorts of other programs in order to regenerate files that came
  67. with the distribution.
  68. 7. Often, you can also type 'make uninstall' to remove the installed
  69. files again. In practice, not all packages have tested that
  70. uninstallation works correctly, even though it is required by the
  71. GNU Coding Standards.
  72. 8. Some packages, particularly those that use Automake, provide 'make
  73. distcheck', which can by used by developers to test that all other
  74. targets like 'make install' and 'make uninstall' work correctly.
  75. This target is generally not run by end users.
  76. Compilers and Options
  77. =====================
  78. Some systems require unusual options for compilation or linking that the
  79. 'configure' script does not know about. Run './configure --help' for
  80. details on some of the pertinent environment variables.
  81. You can give 'configure' initial values for configuration parameters
  82. by setting variables in the command line or in the environment. Here is
  83. an example:
  84. ./configure CC=c99 CFLAGS=-g LIBS=-lposix
  85. *Note Defining Variables::, for more details.
  86. Installation Names
  87. ==================
  88. By default, 'make install' installs the package's commands under
  89. '/usr/local/bin', include files under '/usr/local/include', etc. You
  90. can specify an installation prefix other than '/usr/local' by giving
  91. 'configure' the option '--prefix=PREFIX', where PREFIX must be an
  92. absolute file name.
  93. You can specify separate installation prefixes for
  94. architecture-specific files and architecture-independent files. If you
  95. pass the option '--exec-prefix=PREFIX' to 'configure', the package uses
  96. PREFIX as the prefix for installing programs and libraries.
  97. Documentation and other data files still use the regular prefix.
  98. In addition, if you use an unusual directory layout you can give
  99. options like '--bindir=DIR' to specify different values for particular
  100. kinds of files. Run 'configure --help' for a list of the directories
  101. you can set and what kinds of files go in them. In general, the default
  102. for these options is expressed in terms of '${prefix}', so that
  103. specifying just '--prefix' will affect all of the other directory
  104. specifications that were not explicitly provided.
  105. The most portable way to affect installation locations is to pass the
  106. correct locations to 'configure'; however, many packages provide one or
  107. both of the following shortcuts of passing variable assignments to the
  108. 'make install' command line to change installation locations without
  109. having to reconfigure or recompile.
  110. The first method involves providing an override variable for each
  111. affected directory. For example, 'make install
  112. prefix=/alternate/directory' will choose an alternate location for all
  113. directory configuration variables that were expressed in terms of
  114. '${prefix}'. Any directories that were specified during 'configure',
  115. but not in terms of '${prefix}', must each be overridden at install time
  116. for the entire installation to be relocated. The approach of makefile
  117. variable overrides for each directory variable is required by the GNU
  118. Coding Standards, and ideally causes no recompilation. However, some
  119. platforms have known limitations with the semantics of shared libraries
  120. that end up requiring recompilation when using this method, particularly
  121. noticeable in packages that use GNU Libtool.
  122. The second method involves providing the 'DESTDIR' variable. For
  123. example, 'make install DESTDIR=/alternate/directory' will prepend
  124. '/alternate/directory' before all installation names. The approach of
  125. 'DESTDIR' overrides is not required by the GNU Coding Standards, and
  126. does not work on platforms that have drive letters. On the other hand,
  127. it does better at avoiding recompilation issues, and works well even
  128. when some directory options were not specified in terms of '${prefix}'
  129. at 'configure' time.
  130. Optional Features
  131. =================
  132. If the package supports it, you can cause programs to be installed with
  133. an extra prefix or suffix on their names by giving 'configure' the
  134. option '--program-prefix=PREFIX' or '--program-suffix=SUFFIX'.
  135. Some packages pay attention to '--enable-FEATURE' options to
  136. 'configure', where FEATURE indicates an optional part of the package.
  137. They may also pay attention to '--with-PACKAGE' options, where PACKAGE
  138. is something like 'gnu-as' or 'x' (for the X Window System). The
  139. 'README' should mention any '--enable-' and '--with-' options that the
  140. package recognizes.
  141. For packages that use the X Window System, 'configure' can usually
  142. find the X include and library files automatically, but if it doesn't,
  143. you can use the 'configure' options '--x-includes=DIR' and
  144. '--x-libraries=DIR' to specify their locations.
  145. Some packages offer the ability to configure how verbose the
  146. execution of 'make' will be. For these packages, running './configure
  147. --enable-silent-rules' sets the default to minimal output, which can be
  148. overridden with 'make V=1'; while running './configure
  149. --disable-silent-rules' sets the default to verbose, which can be
  150. overridden with 'make V=0'.
  151. Specifying the System Type
  152. ==========================
  153. There may be some features 'configure' cannot figure out automatically,
  154. but needs to determine by the type of machine the package will run on.
  155. Usually, assuming the package is built to be run on the _same_
  156. architectures, 'configure' can figure that out, but if it prints a
  157. message saying it cannot guess the machine type, give it the
  158. '--build=TYPE' option. TYPE can either be a short name for the system
  159. type, such as 'sun4', or a canonical name which has the form:
  161. where SYSTEM can have one of these forms:
  162. OS
  163. KERNEL-OS
  164. See the file 'config.sub' for the possible values of each field. If
  165. 'config.sub' isn't included in this package, then this package doesn't
  166. need to know the machine type.
  167. If you are _building_ compiler tools for cross-compiling, you should
  168. use the option '--target=TYPE' to select the type of system they will
  169. 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'.
  174. Sharing Defaults
  175. ================
  176. If you want to set default values for 'configure' scripts to share, you
  177. can create a site shell script called 'config.site' that gives default
  178. values for variables like 'CC', 'cache_file', and 'prefix'. 'configure'
  179. looks for 'PREFIX/share/config.site' if it exists, then
  180. 'PREFIX/etc/config.site' if it exists. Or, you can set the
  181. 'CONFIG_SITE' environment variable to the location of the site script.
  182. A warning: not all 'configure' scripts look for a site script.
  183. Defining Variables
  184. ==================
  185. Variables not defined in a site shell script can be set in the
  186. environment passed to 'configure'. However, some packages may run
  187. configure again during the build, and the customized values of these
  188. variables may be lost. In order to avoid this problem, you should set
  189. them in the 'configure' command line, using 'VAR=value'. For example:
  190. ./configure CC=/usr/local2/bin/gcc
  191. causes the specified 'gcc' to be used as the C compiler (unless it is
  192. overridden in the site shell script).
  193. Unfortunately, this technique does not work for 'CONFIG_SHELL' due to an
  194. Autoconf limitation. Until the limitation is lifted, you can use this
  195. workaround:
  196. CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash
  197. 'configure' Invocation
  198. ======================
  199. 'configure' recognizes the following options to control how it operates.
  200. '--help'
  201. '-h'
  202. Print a summary of all of the options to 'configure', and exit.
  203. '--help=short'
  204. '--help=recursive'
  205. Print a summary of the options unique to this package's
  206. 'configure', and exit. The 'short' variant lists options used only
  207. in the top level, while the 'recursive' variant lists options also
  208. present in any nested packages.
  209. '--version'
  210. '-V'
  211. Print the version of Autoconf used to generate the 'configure'
  212. script, and exit.
  213. '--cache-file=FILE'
  214. Enable the cache: use and save the results of the tests in FILE,
  215. traditionally 'config.cache'. FILE defaults to '/dev/null' to
  216. disable caching.
  217. '--config-cache'
  218. '-C'
  219. Alias for '--cache-file=config.cache'.
  220. '--quiet'
  221. '--silent'
  222. '-q'
  223. Do not print messages saying which checks are being made. To
  224. suppress all normal output, redirect it to '/dev/null' (any error
  225. messages will still be shown).
  226. '--srcdir=DIR'
  227. Look for the package's source code in directory DIR. Usually
  228. 'configure' can determine that directory automatically.
  229. '--prefix=DIR'
  230. Use DIR as the installation prefix. *note Installation Names:: for
  231. more details, including other options available for fine-tuning the
  232. installation locations.
  233. '--no-create'
  234. '-n'
  235. Run the configure checks, but stop before creating any output
  236. files.
  237. 'configure' also accepts some other, not widely useful, options. Run
  238. 'configure --help' for more details.