patch-INSTALL 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. --- cryptsetup-1.1.0.orig/INSTALL 2009-07-06 18:53:08.000000000 +0200
  2. +++ cryptsetup-1.1.0/INSTALL 2010-02-14 18:24:56.000000000 +0100
  3. @@ -1,13 +1,25 @@
  4. -Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
  5. -Foundation, Inc.
  6. +Installation Instructions
  7. +*************************
  8. - This file is free documentation; the Free Software Foundation gives
  9. -unlimited permission to copy, distribute and modify it.
  10. +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
  11. +2006, 2007, 2008, 2009 Free Software Foundation, Inc.
  12. +
  13. + Copying and distribution of this file, with or without modification,
  14. +are permitted in any medium without royalty provided the copyright
  15. +notice and this notice are preserved. This file is offered as-is,
  16. +without warranty of any kind.
  17. Basic Installation
  18. ==================
  19. - These are generic installation instructions.
  20. + Briefly, the shell commands `./configure; make; make install' should
  21. +configure, build, and install this package. The following
  22. +more-detailed instructions are generic; see the `README' file for
  23. +instructions specific to this package. Some packages provide this
  24. +`INSTALL' file but do not implement all of the features documented
  25. +below. The lack of an optional feature in a given package is not
  26. +necessarily a bug. More recommendations for GNU packages can be found
  27. +in *note Makefile Conventions: (standards)Makefile Conventions.
  28. The `configure' shell script attempts to guess correct values for
  29. various system-dependent variables used during compilation. It uses
  30. @@ -20,9 +32,9 @@ debugging `configure').
  31. It can also use an optional file (typically called `config.cache'
  32. and enabled with `--cache-file=config.cache' or simply `-C') that saves
  33. -the results of its tests to speed up reconfiguring. (Caching is
  34. +the results of its tests to speed up reconfiguring. Caching is
  35. disabled by default to prevent problems with accidental use of stale
  36. -cache files.)
  37. +cache files.
  38. If you need to do unusual things to compile the package, please try
  39. to figure out how `configure' could check whether to do them, and mail
  40. @@ -32,30 +44,37 @@ some point `config.cache' contains resul
  41. 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'.
  46. +`configure' by a program called `autoconf'. You need `configure.ac' if
  47. +you want to change it or regenerate `configure' using a newer version
  48. +of `autoconf'.
  49. -The simplest way to compile this package is:
  50. + The simplest way to compile this package is:
  51. 1. `cd' to the directory containing the package's source code and type
  52. - `./configure' to configure the package for your system. If you're
  53. - using `csh' on an old version of System V, you might need to type
  54. - `sh ./configure' instead to prevent `csh' from trying to execute
  55. - `configure' itself.
  56. + `./configure' to configure the package for your system.
  57. - Running `configure' takes awhile. While running, it prints some
  58. - messages telling which features it is checking for.
  59. + Running `configure' might take a while. While running, it prints
  60. + some messages telling which features it is checking for.
  61. 2. Type `make' to compile the package.
  62. 3. Optionally, type `make check' to run any self-tests that come with
  63. - the package.
  64. + the package, generally using the just-built uninstalled binaries.
  65. 4. Type `make install' to install the programs and any data files and
  66. - documentation.
  67. + documentation. When installing into a prefix owned by root, it is
  68. + recommended that the package be configured and built as a regular
  69. + user, and only the `make install' phase executed with root
  70. + privileges.
  71. - 5. You can remove the program binaries and object files from the
  72. + 5. Optionally, type `make installcheck' to repeat any self-tests, but
  73. + this time using the binaries in their final installed location.
  74. + This target does not install anything. Running this target as a
  75. + regular user, particularly if the prior `make install' required
  76. + root privileges, verifies that the installation completed
  77. + correctly.
  78. +
  79. + 6. You can remove the program binaries and object files from the
  80. source code directory by typing `make clean'. To also remove the
  81. files that `configure' created (so you can compile the package for
  82. a different kind of computer), type `make distclean'. There is
  83. @@ -64,6 +83,16 @@ The simplest way to compile this package
  84. all sorts of other programs in order to regenerate files that came
  85. with the distribution.
  86. + 7. Often, you can also type `make uninstall' to remove the installed
  87. + files again. In practice, not all packages have tested that
  88. + uninstallation works correctly, even though it is required by the
  89. + GNU Coding Standards.
  90. +
  91. + 8. Some packages, particularly those that use Automake, provide `make
  92. + distcheck', which can by used by developers to test that all other
  93. + targets like `make install' and `make uninstall' work correctly.
  94. + This target is generally not run by end users.
  95. +
  96. Compilers and Options
  97. =====================
  98. @@ -75,7 +104,7 @@ for details on some of the pertinent env
  99. by setting variables in the command line or in the environment. Here
  100. is an example:
  101. - ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
  102. + ./configure CC=c99 CFLAGS=-g LIBS=-lposix
  103. *Note Defining Variables::, for more details.
  104. @@ -84,44 +113,89 @@ Compiling For Multiple Architectures
  105. You can compile the package for more than one kind of computer at the
  106. same time, by placing the object files for each architecture in their
  107. -own directory. To do this, you must use a version of `make' that
  108. -supports the `VPATH' variable, such as GNU `make'. `cd' to the
  109. +own directory. To do this, you can use GNU `make'. `cd' to the
  110. directory where you want the object files and executables to go and run
  111. the `configure' script. `configure' automatically checks for the
  112. -source code in the directory that `configure' is in and in `..'.
  113. +source code in the directory that `configure' is in and in `..'. This
  114. +is known as a "VPATH" build.
  115. - If you have to use a `make' that does not support the `VPATH'
  116. -variable, you have to compile the package for one architecture at a
  117. -time in the source code directory. After you have installed the
  118. -package for one architecture, use `make distclean' before reconfiguring
  119. -for another architecture.
  120. + With a non-GNU `make', it is safer to compile the package for one
  121. +architecture at a time in the source code directory. After you have
  122. +installed the package for one architecture, use `make distclean' before
  123. +reconfiguring for another architecture.
  124. +
  125. + On MacOS X 10.5 and later systems, you can create libraries and
  126. +executables that work on multiple system types--known as "fat" or
  127. +"universal" binaries--by specifying multiple `-arch' options to the
  128. +compiler but only a single `-arch' option to the preprocessor. Like
  129. +this:
  130. +
  131. + ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
  132. + CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
  133. + CPP="gcc -E" CXXCPP="g++ -E"
  134. +
  135. + This is not guaranteed to produce working output in all cases, you
  136. +may have to build one architecture at a time and combine the results
  137. +using the `lipo' tool if you have problems.
  138. Installation Names
  139. ==================
  140. - By default, `make install' will install the package's files in
  141. -`/usr/local/bin', `/usr/local/man', etc. You can specify an
  142. -installation prefix other than `/usr/local' by giving `configure' the
  143. -option `--prefix=PATH'.
  144. + By default, `make install' installs the package's commands under
  145. +`/usr/local/bin', include files under `/usr/local/include', etc. You
  146. +can specify an installation prefix other than `/usr/local' by giving
  147. +`configure' the option `--prefix=PREFIX', where PREFIX must be an
  148. +absolute file name.
  149. You can specify separate installation prefixes for
  150. architecture-specific files and architecture-independent files. If you
  151. -give `configure' the option `--exec-prefix=PATH', the package will use
  152. -PATH as the prefix for installing programs and libraries.
  153. -Documentation and other data files will still use the regular prefix.
  154. +pass the option `--exec-prefix=PREFIX' to `configure', the package uses
  155. +PREFIX as the prefix for installing programs and libraries.
  156. +Documentation and other data files still use the regular prefix.
  157. In addition, if you use an unusual directory layout you can give
  158. -options like `--bindir=PATH' to specify different values for particular
  159. +options like `--bindir=DIR' to specify different values for particular
  160. kinds of files. Run `configure --help' for a list of the directories
  161. -you can set and what kinds of files go in them.
  162. +you can set and what kinds of files go in them. In general, the
  163. +default for these options is expressed in terms of `${prefix}', so that
  164. +specifying just `--prefix' will affect all of the other directory
  165. +specifications that were not explicitly provided.
  166. - If the package supports it, you can cause programs to be installed
  167. -with an extra prefix or suffix on their names by giving `configure' the
  168. -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  169. + The most portable way to affect installation locations is to pass the
  170. +correct locations to `configure'; however, many packages provide one or
  171. +both of the following shortcuts of passing variable assignments to the
  172. +`make install' command line to change installation locations without
  173. +having to reconfigure or recompile.
  174. +
  175. + The first method involves providing an override variable for each
  176. +affected directory. For example, `make install
  177. +prefix=/alternate/directory' will choose an alternate location for all
  178. +directory configuration variables that were expressed in terms of
  179. +`${prefix}'. Any directories that were specified during `configure',
  180. +but not in terms of `${prefix}', must each be overridden at install
  181. +time for the entire installation to be relocated. The approach of
  182. +makefile variable overrides for each directory variable is required by
  183. +the GNU Coding Standards, and ideally causes no recompilation.
  184. +However, some platforms have known limitations with the semantics of
  185. +shared libraries that end up requiring recompilation when using this
  186. +method, particularly noticeable in packages that use GNU Libtool.
  187. +
  188. + The second method involves providing the `DESTDIR' variable. For
  189. +example, `make install DESTDIR=/alternate/directory' will prepend
  190. +`/alternate/directory' before all installation names. The approach of
  191. +`DESTDIR' overrides is not required by the GNU Coding Standards, and
  192. +does not work on platforms that have drive letters. On the other hand,
  193. +it does better at avoiding recompilation issues, and works well even
  194. +when some directory options were not specified in terms of `${prefix}'
  195. +at `configure' time.
  196. Optional Features
  197. =================
  198. + If the package supports it, you can cause programs to be installed
  199. +with an extra prefix or suffix on their names by giving `configure' the
  200. +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  201. +
  202. Some packages pay attention to `--enable-FEATURE' options to
  203. `configure', where FEATURE indicates an optional part of the package.
  204. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  205. @@ -134,6 +208,45 @@ find the X include and library files aut
  206. you can use the `configure' options `--x-includes=DIR' and
  207. `--x-libraries=DIR' to specify their locations.
  208. + Some packages offer the ability to configure how verbose the
  209. +execution of `make' will be. For these packages, running `./configure
  210. +--enable-silent-rules' sets the default to minimal output, which can be
  211. +overridden with `make V=1'; while running `./configure
  212. +--disable-silent-rules' sets the default to verbose, which can be
  213. +overridden with `make V=0'.
  214. +
  215. +Particular systems
  216. +==================
  217. +
  218. + On HP-UX, the default C compiler is not ANSI C compatible. If GNU
  219. +CC is not installed, it is recommended to use the following options in
  220. +order to use an ANSI C compiler:
  221. +
  222. + ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
  223. +
  224. +and if that doesn't work, install pre-built binaries of GCC for HP-UX.
  225. +
  226. + On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
  227. +parse its `<wchar.h>' header file. The option `-nodtk' can be used as
  228. +a workaround. If GNU CC is not installed, it is therefore recommended
  229. +to try
  230. +
  231. + ./configure CC="cc"
  232. +
  233. +and if that doesn't work, try
  234. +
  235. + ./configure CC="cc -nodtk"
  236. +
  237. + On Solaris, don't put `/usr/ucb' early in your `PATH'. This
  238. +directory contains several dysfunctional programs; working variants of
  239. +these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
  240. +in your `PATH', put it _after_ `/usr/bin'.
  241. +
  242. + On Haiku, software installed for all users goes in `/boot/common',
  243. +not `/usr/local'. It is recommended to use the following options:
  244. +
  245. + ./configure --prefix=/boot/common
  246. +
  247. Specifying the System Type
  248. ==========================
  249. @@ -149,14 +262,15 @@ type, such as `sun4', or a canonical nam
  250. where SYSTEM can have one of these forms:
  251. - OS KERNEL-OS
  252. + OS
  253. + KERNEL-OS
  254. See the file `config.sub' for the possible values of each field. If
  255. `config.sub' isn't included in this package, then this package doesn't
  256. need to know the machine type.
  257. If you are _building_ compiler tools for cross-compiling, you should
  258. -use the `--target=TYPE' option to select the type of system they will
  259. +use the option `--target=TYPE' to select the type of system they will
  260. produce code for.
  261. If you want to _use_ a cross compiler, that generates code for a
  262. @@ -186,9 +300,14 @@ them in the `configure' command line, us
  263. ./configure CC=/usr/local2/bin/gcc
  264. -will cause the specified gcc to be used as the C compiler (unless it is
  265. +causes the specified `gcc' to be used as the C compiler (unless it is
  266. overridden in the site shell script).
  267. +Unfortunately, this technique does not work for `CONFIG_SHELL' due to
  268. +an Autoconf bug. Until the bug is fixed you can use this workaround:
  269. +
  270. + CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
  271. +
  272. `configure' Invocation
  273. ======================
  274. @@ -197,7 +316,14 @@ operates.
  275. `--help'
  276. `-h'
  277. - Print a summary of the options to `configure', and exit.
  278. + Print a summary of all of the options to `configure', and exit.
  279. +
  280. +`--help=short'
  281. +`--help=recursive'
  282. + Print a summary of the options unique to this package's
  283. + `configure', and exit. The `short' variant lists options used
  284. + only in the top level, while the `recursive' variant lists options
  285. + also present in any nested packages.
  286. `--version'
  287. `-V'
  288. @@ -224,6 +350,16 @@ operates.
  289. Look for the package's source code in directory DIR. Usually
  290. `configure' can determine that directory automatically.
  291. +`--prefix=DIR'
  292. + Use DIR as the installation prefix. *note Installation Names::
  293. + for more details, including other options available for fine-tuning
  294. + the installation locations.
  295. +
  296. +`--no-create'
  297. +`-n'
  298. + Run the configure checks, but stop before creating any output
  299. + files.
  300. +
  301. `configure' also accepts some other, not widely useful, options. Run
  302. `configure --help' for more details.