/contrib/ntp/INSTALL

https://bitbucket.org/freebsd/freebsd-head/ · #! · 178 lines · 138 code · 40 blank · 0 comment · 0 complexity · e3ae1a9a79a2dd5eb406f7cb7e523c27 MD5 · raw file

  1. Basic Installation
  2. ==================
  3. These are generic *nix installation instructions.
  4. For Windows/NT, please see ports/winnt and html/build/hints/winnt.html.
  5. The `configure' shell script attempts to guess correct values for
  6. various system-dependent variables used during compilation. It uses
  7. those values to create a `Makefile' in each directory of the package.
  8. It may also create one or more `.h' files containing system-dependent
  9. definitions. Finally, it creates a shell script `config.status' that
  10. you can run in the future to recreate the current configuration, a file
  11. `config.cache' that saves the results of its tests to speed up
  12. reconfiguring, and a file `config.log' containing compiler output
  13. (useful mainly for debugging `configure').
  14. If you need to do unusual things to compile the package, please try
  15. to figure out how `configure' could check whether to do them, and mail
  16. diffs or instructions to the address given in the `README' so they can
  17. be considered for the next release. If at some point `config.cache'
  18. contains results you don't want to keep, you may remove or edit it.
  19. The file `configure.in' is used to create `configure' by a program
  20. called `autoconf'. You only need `configure.in' if you want to change
  21. it or regenerate `configure' using a newer version of `autoconf'.
  22. The simplest way to compile this package is:
  23. 1. `cd' to the directory containing the package's source code and type
  24. `./configure' to configure the package for your system. If you're
  25. using `csh' on an old version of System V, you might need to type
  26. `sh ./configure' instead to prevent `csh' from trying to execute
  27. `configure' itself.
  28. Running `configure' takes a while. While running, it prints some
  29. messages telling which features it is checking for.
  30. 2. Type `make' to compile the package.
  31. 3. Optionally, type `make check' to run any self-tests that come with
  32. the package.
  33. 4. Type `make install' to install the programs and any data files and
  34. documentation.
  35. 5. You can remove the program binaries and object files from the
  36. source code directory by typing `make clean'. To also remove the
  37. files that `configure' created (so you can compile the package for
  38. a different kind of computer), type `make distclean'. There is
  39. also a `make maintainer-clean' target, but that is intended mainly
  40. for the package's developers. If you use it, you may have to get
  41. all sorts of other programs in order to regenerate files that came
  42. with the distribution.
  43. Compilers and Options
  44. =====================
  45. Some systems require unusual options for compilation or linking that
  46. the `configure' script does not know about. You can give `configure'
  47. initial values for variables by setting them in the environment. Using
  48. a Bourne-compatible shell, you can do that on the command line like
  49. this:
  50. CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  51. Or on systems that have the `env' program, you can do it like this:
  52. env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  53. Compiling For Multiple Architectures
  54. ====================================
  55. You can compile the package for more than one kind of computer at the
  56. same time, by placing the object files for each architecture in their
  57. own directory. To do this, you must use a version of `make' that
  58. supports the `VPATH' variable, such as GNU `make'. `cd' to the
  59. directory where you want the object files and executables to go and run
  60. the `configure' script. `configure' automatically checks for the
  61. source code in the directory that `configure' is in and in `..'.
  62. If you have to use a `make' that does not supports the `VPATH'
  63. variable, you have to compile the package for one architecture at a time
  64. in the source code directory. After you have installed the package for
  65. one architecture, use `make distclean' before reconfiguring for another
  66. architecture.
  67. Installation Names
  68. ==================
  69. By default, `make install' will install the package's files in
  70. `/usr/local/bin', `/usr/local/man', etc. You can specify an
  71. installation prefix other than `/usr/local' by giving `configure' the
  72. option `--prefix=PATH'.
  73. You can specify separate installation prefixes for
  74. architecture-specific files and architecture-independent files. If you
  75. give `configure' the option `--exec-prefix=PATH', the package will use
  76. PATH as the prefix for installing programs and libraries.
  77. Documentation and other data files will still use the regular prefix.
  78. If the package supports it, you can cause programs to be installed
  79. with an extra prefix or suffix on their names by giving `configure' the
  80. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  81. Optional Features
  82. =================
  83. Some packages pay attention to `--enable-FEATURE' options to
  84. `configure', where FEATURE indicates an optional part of the package.
  85. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  86. is something like `gnu-as' or `x' (for the X Window System). The
  87. `README' should mention any `--enable-' and `--with-' options that the
  88. package recognizes.
  89. For packages that use the X Window System, `configure' can usually
  90. find the X include and library files automatically, but if it doesn't,
  91. you can use the `configure' options `--x-includes=DIR' and
  92. `--x-libraries=DIR' to specify their locations.
  93. Specifying the System Type
  94. ==========================
  95. There may be some features `configure' can not figure out
  96. automatically, but needs to determine by the type of host the package
  97. will run on. Usually `configure' can figure that out, but if it prints
  98. a message saying it can not guess the host type, give it the
  99. `--host=TYPE' option. TYPE can either be a short name for the system
  100. type, such as `sun4', or a canonical name with three fields:
  101. CPU-COMPANY-SYSTEM
  102. See the file `config.sub' for the possible values of each field. If
  103. `config.sub' isn't included in this package, then this package doesn't
  104. need to know the host type.
  105. If you are building compiler tools for cross-compiling, you can also
  106. use the `--target=TYPE' option to select the type of system they will
  107. produce code for and the `--build=TYPE' option to select the type of
  108. system on which you are compiling the package.
  109. Sharing Defaults
  110. ================
  111. If you want to set default values for `configure' scripts to share,
  112. you can create a site shell script called `config.site' that gives
  113. default values for variables like `CC', `cache_file', and `prefix'.
  114. `configure' looks for `PREFIX/share/config.site' if it exists, then
  115. `PREFIX/etc/config.site' if it exists. Or, you can set the
  116. `CONFIG_SITE' environment variable to the location of the site script.
  117. A warning: not all `configure' scripts look for a site script.
  118. Operation Controls
  119. ==================
  120. `configure' recognizes the following options to control how it
  121. operates.
  122. `--cache-file=FILE'
  123. Use and save the results of the tests in FILE instead of
  124. `./config.cache'. Set FILE to `/dev/null' to disable caching, for
  125. debugging `configure'.
  126. `--help'
  127. Print a summary of the options to `configure', and exit.
  128. `--quiet'
  129. `--silent'
  130. `-q'
  131. Do not print messages saying which checks are being made.
  132. `--srcdir=DIR'
  133. Look for the package's source code in directory DIR. Usually
  134. `configure' can determine that directory automatically.
  135. `--version'
  136. Print the version of Autoconf used to generate the `configure'
  137. script, and exit.
  138. `configure' also accepts some other, not widely useful, options.