Counter Strike : Global Offensive Source Code
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.

237 lines
9.3 KiB

  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.
  5. ======================================================================
  6. Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
  7. Foundation, Inc.
  8. This file is free documentation; the Free Software Foundation gives
  9. unlimited permission to copy, distribute and modify it.
  10. Basic Installation
  11. ==================
  12. These are generic installation instructions.
  13. The `configure' shell script attempts to guess correct values for
  14. various system-dependent variables used during compilation. It uses
  15. those values to create a `Makefile' in each directory of the package.
  16. It may also create one or more `.h' files containing system-dependent
  17. definitions. Finally, it creates a shell script `config.status' that
  18. you can run in the future to recreate the current configuration, and a
  19. file `config.log' containing compiler output (useful mainly for
  20. debugging `configure').
  21. It can also use an optional file (typically called `config.cache'
  22. and enabled with `--cache-file=config.cache' or simply `-C') that saves
  23. the results of its tests to speed up reconfiguring. (Caching is
  24. disabled by default to prevent problems with accidental use of stale
  25. cache files.)
  26. If you need to do unusual things to compile the package, please try
  27. to figure out how `configure' could check whether to do them, and mail
  28. diffs or instructions to the address given in the `README' so they can
  29. be considered for the next release. If you are using the cache, and at
  30. some point `config.cache' contains results you don't want to keep, you
  31. may remove or edit it.
  32. The file `configure.ac' (or `configure.in') is used to create
  33. `configure' by a program called `autoconf'. You only need
  34. `configure.ac' if you want to change it or regenerate `configure' using
  35. a newer version of `autoconf'.
  36. The simplest way to compile this package is:
  37. 1. `cd' to the directory containing the package's source code and type
  38. `./configure' to configure the package for your system. If you're
  39. using `csh' on an old version of System V, you might need to type
  40. `sh ./configure' instead to prevent `csh' from trying to execute
  41. `configure' itself.
  42. Running `configure' takes awhile. While running, it prints some
  43. messages telling which features it is checking for.
  44. 2. Type `make' to compile the package.
  45. 3. Optionally, type `make check' to run any self-tests that come with
  46. the package.
  47. 4. Type `make install' to install the programs and any data files and
  48. documentation.
  49. 5. You can remove the program binaries and object files from the
  50. source code directory by typing `make clean'. To also remove the
  51. files that `configure' created (so you can compile the package for
  52. a different kind of computer), type `make distclean'. There is
  53. also a `make maintainer-clean' target, but that is intended mainly
  54. for the package's developers. If you use it, you may have to get
  55. all sorts of other programs in order to regenerate files that came
  56. with the distribution.
  57. Compilers and Options
  58. =====================
  59. Some systems require unusual options for compilation or linking that
  60. the `configure' script does not know about. Run `./configure --help'
  61. for details on some of the pertinent environment variables.
  62. You can give `configure' initial values for configuration parameters
  63. by setting variables in the command line or in the environment. Here
  64. is an example:
  65. ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
  66. *Note Defining Variables::, for more details.
  67. Compiling For Multiple Architectures
  68. ====================================
  69. You can compile the package for more than one kind of computer at the
  70. same time, by placing the object files for each architecture in their
  71. own directory. To do this, you must use a version of `make' that
  72. supports the `VPATH' variable, such as GNU `make'. `cd' to the
  73. directory where you want the object files and executables to go and run
  74. the `configure' script. `configure' automatically checks for the
  75. source code in the directory that `configure' is in and in `..'.
  76. If you have to use a `make' that does not support the `VPATH'
  77. variable, you have to compile the package for one architecture at a
  78. time in the source code directory. After you have installed the
  79. package for one architecture, use `make distclean' before reconfiguring
  80. for another architecture.
  81. Installation Names
  82. ==================
  83. By default, `make install' will install the package's files in
  84. `/usr/local/bin', `/usr/local/man', etc. You can specify an
  85. installation prefix other than `/usr/local' by giving `configure' the
  86. option `--prefix=PATH'.
  87. You can specify separate installation prefixes for
  88. architecture-specific files and architecture-independent files. If you
  89. give `configure' the option `--exec-prefix=PATH', the package will use
  90. PATH as the prefix for installing programs and libraries.
  91. Documentation and other data files will still use the regular prefix.
  92. In addition, if you use an unusual directory layout you can give
  93. options like `--bindir=PATH' to specify different values for particular
  94. kinds of files. Run `configure --help' for a list of the directories
  95. you can set and what kinds of files go in them.
  96. If the package supports it, you can cause programs to be installed
  97. with an extra prefix or suffix on their names by giving `configure' the
  98. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  99. Optional Features
  100. =================
  101. Some packages pay attention to `--enable-FEATURE' options to
  102. `configure', where FEATURE indicates an optional part of the package.
  103. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  104. is something like `gnu-as' or `x' (for the X Window System). The
  105. `README' should mention any `--enable-' and `--with-' options that the
  106. package recognizes.
  107. For packages that use the X Window System, `configure' can usually
  108. find the X include and library files automatically, but if it doesn't,
  109. you can use the `configure' options `--x-includes=DIR' and
  110. `--x-libraries=DIR' to specify their locations.
  111. Specifying the System Type
  112. ==========================
  113. There may be some features `configure' cannot figure out
  114. automatically, but needs to determine by the type of machine the package
  115. will run on. Usually, assuming the package is built to be run on the
  116. _same_ architectures, `configure' can figure that out, but if it prints
  117. a message saying it cannot guess the machine type, give it the
  118. `--build=TYPE' option. TYPE can either be a short name for the system
  119. type, such as `sun4', or a canonical name which has the form:
  120. CPU-COMPANY-SYSTEM
  121. where SYSTEM can have one of these forms:
  122. OS KERNEL-OS
  123. See the file `config.sub' for the possible values of each field. If
  124. `config.sub' isn't included in this package, then this package doesn't
  125. need to know the machine type.
  126. If you are _building_ compiler tools for cross-compiling, you should
  127. use the `--target=TYPE' option to select the type of system they will
  128. produce code for.
  129. If you want to _use_ a cross compiler, that generates code for a
  130. platform different from the build platform, you should specify the
  131. "host" platform (i.e., that on which the generated programs will
  132. eventually be run) with `--host=TYPE'.
  133. Sharing Defaults
  134. ================
  135. If you want to set default values for `configure' scripts to share,
  136. you can create a site shell script called `config.site' that gives
  137. default values for variables like `CC', `cache_file', and `prefix'.
  138. `configure' looks for `PREFIX/share/config.site' if it exists, then
  139. `PREFIX/etc/config.site' if it exists. Or, you can set the
  140. `CONFIG_SITE' environment variable to the location of the site script.
  141. A warning: not all `configure' scripts look for a site script.
  142. Defining Variables
  143. ==================
  144. Variables not defined in a site shell script can be set in the
  145. environment passed to `configure'. However, some packages may run
  146. configure again during the build, and the customized values of these
  147. variables may be lost. In order to avoid this problem, you should set
  148. them in the `configure' command line, using `VAR=value'. For example:
  149. ./configure CC=/usr/local2/bin/gcc
  150. will cause the specified gcc to be used as the C compiler (unless it is
  151. overridden in the site shell script).
  152. `configure' Invocation
  153. ======================
  154. `configure' recognizes the following options to control how it
  155. operates.
  156. `--help'
  157. `-h'
  158. Print a summary of the options to `configure', and exit.
  159. `--version'
  160. `-V'
  161. Print the version of Autoconf used to generate the `configure'
  162. script, and exit.
  163. `--cache-file=FILE'
  164. Enable the cache: use and save the results of the tests in FILE,
  165. traditionally `config.cache'. FILE defaults to `/dev/null' to
  166. disable caching.
  167. `--config-cache'
  168. `-C'
  169. Alias for `--cache-file=config.cache'.
  170. `--quiet'
  171. `--silent'
  172. `-q'
  173. Do not print messages saying which checks are being made. To
  174. suppress all normal output, redirect it to `/dev/null' (any error
  175. messages will still be shown).
  176. `--srcdir=DIR'
  177. Look for the package's source code in directory DIR. Usually
  178. `configure' can determine that directory automatically.
  179. `configure' also accepts some other, not widely useful, options. Run
  180. `configure --help' for more details.