From 05efa9eaa5690bb85220bcc6af38eb18714c90a9 Mon Sep 17 00:00:00 2001 From: Eric Blake Date: Tue, 4 Jan 2011 16:55:01 -0700 Subject: [PATCH] doc: regenerate INSTALL This partially reverts commit 0a29fc2d832c86d69e98b32bbdbc4e746ca2d16c. * doc/Makefile (INSTALL, INSTALL.ISO, INSTALL.UTF-8): Re-add @firstparagraphindent support, now that autoconf dropped it. (INSTALL_PRELUDE): Reinstate old macro. * doc/install.texi: Resync from autoconf. * doc/INSTALL: Reflect recent autoconf update. * doc/INSTALL.ISO: Likewise. * doc/INSTALL.UTF-8: Likewise. Reported by Karl Berry. Signed-off-by: Eric Blake --- ChangeLog | 12 ++++++ doc/INSTALL | 125 +++++++++++++++++++++++++++--------------------------- doc/INSTALL.ISO | 125 +++++++++++++++++++++++++++--------------------------- doc/INSTALL.UTF-8 | 125 +++++++++++++++++++++++++++--------------------------- doc/Makefile | 16 +++++-- doc/install.texi | 5 +-- 6 files changed, 216 insertions(+), 192 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6a6198b63..ea1d24916 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2011-01-04 Eric Blake + + doc: regenerate INSTALL + * doc/Makefile (INSTALL, INSTALL.ISO, INSTALL.UTF-8): Re-add + @firstparagraphindent support, now that autoconf dropped it. + (INSTALL_PRELUDE): Reinstate old macro. + * doc/install.texi: Resync from autoconf. + * doc/INSTALL: Reflect recent autoconf update. + * doc/INSTALL.ISO: Likewise. + * doc/INSTALL.UTF-8: Likewise. + Reported by Karl Berry. + 2011-01-04 Bruce Korb git-version-gen: avoid a sub-shell diff --git a/doc/INSTALL b/doc/INSTALL index 7761bccd3..95dac44e2 100644 --- a/doc/INSTALL +++ b/doc/INSTALL @@ -1,25 +1,25 @@ Installation Instructions ************************* - Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, -2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. +Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation, +Inc. Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without warranty of any kind. -0.1 Basic Installation -====================== +Basic Installation +================== Briefly, the shell commands `./configure; make; make install' should -configure, build, and install this package. The following more-detailed -instructions are generic; see the `README' file for instructions -specific to this package. Some packages provide this `INSTALL' file but -do not implement all of the features documented below. The lack of an -optional feature in a given package is not necessarily a bug. More -recommendations for GNU packages can be found in *note Makefile -Conventions: (standards)Makefile Conventions. +configure, build, and install this package. The following +more-detailed instructions are generic; see the `README' file for +instructions specific to this package. Some packages provide this +`INSTALL' file but do not implement all of the features documented +below. The lack of an optional feature in a given package is not +necessarily a bug. More recommendations for GNU packages can be found +in *note Makefile Conventions: (standards)Makefile Conventions. The `configure' shell script attempts to guess correct values for various system-dependent variables used during compilation. It uses @@ -30,10 +30,11 @@ you can run in the future to recreate the current configuration, and a file `config.log' containing compiler output (useful mainly for debugging `configure'). - It can also use an optional file (typically called `config.cache' and -enabled with `--cache-file=config.cache' or simply `-C') that saves the -results of its tests to speed up reconfiguring. Caching is disabled by -default to prevent problems with accidental use of stale cache files. + It can also use an optional file (typically called `config.cache' +and enabled with `--cache-file=config.cache' or simply `-C') that saves +the results of its tests to speed up reconfiguring. Caching is +disabled by default to prevent problems with accidental use of stale +cache files. If you need to do unusual things to compile the package, please try to figure out how `configure' could check whether to do them, and mail @@ -44,8 +45,8 @@ may remove or edit it. The file `configure.ac' (or `configure.in') is used to create `configure' by a program called `autoconf'. You need `configure.ac' if -you want to change it or regenerate `configure' using a newer version of -`autoconf'. +you want to change it or regenerate `configure' using a newer version +of `autoconf'. The simplest way to compile this package is: @@ -92,31 +93,31 @@ you want to change it or regenerate `configure' using a newer version of targets like `make install' and `make uninstall' work correctly. This target is generally not run by end users. -0.2 Compilers and Options -========================= +Compilers and Options +===================== Some systems require unusual options for compilation or linking that the `configure' script does not know about. Run `./configure --help' for details on some of the pertinent environment variables. You can give `configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here is -an example: +by setting variables in the command line or in the environment. Here +is an example: ./configure CC=c99 CFLAGS=-g LIBS=-lposix *Note Defining Variables::, for more details. -0.3 Compiling For Multiple Architectures -======================================== +Compiling For Multiple Architectures +==================================== You can compile the package for more than one kind of computer at the same time, by placing the object files for each architecture in their own directory. To do this, you can use GNU `make'. `cd' to the directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the source -code in the directory that `configure' is in and in `..'. This is known -as a "VPATH" build. +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. This +is known as a "VPATH" build. With a non-GNU `make', it is safer to compile the package for one architecture at a time in the source code directory. After you have @@ -137,8 +138,8 @@ this: may have to build one architecture at a time and combine the results using the `lipo' tool if you have problems. -0.4 Installation Names -====================== +Installation Names +================== By default, `make install' installs the package's commands under `/usr/local/bin', include files under `/usr/local/include', etc. You @@ -155,8 +156,8 @@ Documentation and other data files still use the regular prefix. In addition, if you use an unusual directory layout you can give options like `--bindir=DIR' to specify different values for particular kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. In general, the default -for these options is expressed in terms of `${prefix}', so that +you can set and what kinds of files go in them. In general, the +default for these options is expressed in terms of `${prefix}', so that specifying just `--prefix' will affect all of the other directory specifications that were not explicitly provided. @@ -171,13 +172,13 @@ affected directory. For example, `make install prefix=/alternate/directory' will choose an alternate location for all directory configuration variables that were expressed in terms of `${prefix}'. Any directories that were specified during `configure', -but not in terms of `${prefix}', must each be overridden at install time -for the entire installation to be relocated. The approach of makefile -variable overrides for each directory variable is required by the GNU -Coding Standards, and ideally causes no recompilation. However, some -platforms have known limitations with the semantics of shared libraries -that end up requiring recompilation when using this method, particularly -noticeable in packages that use GNU Libtool. +but not in terms of `${prefix}', must each be overridden at install +time for the entire installation to be relocated. The approach of +makefile variable overrides for each directory variable is required by +the GNU Coding Standards, and ideally causes no recompilation. +However, some platforms have known limitations with the semantics of +shared libraries that end up requiring recompilation when using this +method, particularly noticeable in packages that use GNU Libtool. The second method involves providing the `DESTDIR' variable. For example, `make install DESTDIR=/alternate/directory' will prepend @@ -188,8 +189,8 @@ it does better at avoiding recompilation issues, and works well even when some directory options were not specified in terms of `${prefix}' at `configure' time. -0.5 Optional Features -===================== +Optional Features +================= If the package supports it, you can cause programs to be installed with an extra prefix or suffix on their names by giving `configure' the @@ -214,11 +215,11 @@ overridden with `make V=1'; while running `./configure --disable-silent-rules' sets the default to verbose, which can be overridden with `make V=0'. -0.6 Particular systems -====================== +Particular systems +================== - On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC -is not installed, it is recommended to use the following options in + On HP-UX, the default C compiler is not ANSI C compatible. If GNU +CC is not installed, it is recommended to use the following options in order to use an ANSI C compiler: ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" @@ -226,9 +227,9 @@ order to use an ANSI C compiler: and if that doesn't work, install pre-built binaries of GCC for HP-UX. On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot -parse its `' header file. The option `-nodtk' can be used as a -workaround. If GNU CC is not installed, it is therefore recommended to -try +parse its `' header file. The option `-nodtk' can be used as +a workaround. If GNU CC is not installed, it is therefore recommended +to try ./configure CC="cc" @@ -246,8 +247,8 @@ not `/usr/local'. It is recommended to use the following options: ./configure --prefix=/boot/common -0.7 Specifying the System Type -============================== +Specifying the System Type +========================== There may be some features `configure' cannot figure out automatically, but needs to determine by the type of machine the package @@ -277,8 +278,8 @@ platform different from the build platform, you should specify the "host" platform (i.e., that on which the generated programs will eventually be run) with `--host=TYPE'. -0.8 Sharing Defaults -==================== +Sharing Defaults +================ If you want to set default values for `configure' scripts to share, you can create a site shell script called `config.site' that gives @@ -288,8 +289,8 @@ default values for variables like `CC', `cache_file', and `prefix'. `CONFIG_SITE' environment variable to the location of the site script. A warning: not all `configure' scripts look for a site script. -0.9 Defining Variables -====================== +Defining Variables +================== Variables not defined in a site shell script can be set in the environment passed to `configure'. However, some packages may run @@ -302,13 +303,13 @@ them in the `configure' command line, using `VAR=value'. For example: causes the specified `gcc' to be used as the C compiler (unless it is overridden in the site shell script). -Unfortunately, this technique does not work for `CONFIG_SHELL' due to an -Autoconf bug. Until the bug is fixed you can use this workaround: +Unfortunately, this technique does not work for `CONFIG_SHELL' due to +an Autoconf bug. Until the bug is fixed you can use this workaround: CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash -0.10 `configure' Invocation -=========================== +`configure' Invocation +====================== `configure' recognizes the following options to control how it operates. @@ -320,9 +321,9 @@ operates. `--help=short' `--help=recursive' Print a summary of the options unique to this package's - `configure', and exit. The `short' variant lists options used only - in the top level, while the `recursive' variant lists options also - present in any nested packages. + `configure', and exit. The `short' variant lists options used + only in the top level, while the `recursive' variant lists options + also present in any nested packages. `--version' `-V' @@ -350,9 +351,9 @@ operates. `configure' can determine that directory automatically. `--prefix=DIR' - Use DIR as the installation prefix. *note Installation Names:: for - more details, including other options available for fine-tuning the - installation locations. + Use DIR as the installation prefix. *note Installation Names:: + for more details, including other options available for fine-tuning + the installation locations. `--no-create' `-n' diff --git a/doc/INSTALL.ISO b/doc/INSTALL.ISO index 10306471f..d46f1fc29 100644 --- a/doc/INSTALL.ISO +++ b/doc/INSTALL.ISO @@ -1,25 +1,25 @@ Installation Instructions ************************* - Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, -2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. +Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation, +Inc. Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without warranty of any kind. -0.1 Basic Installation -====================== +Basic Installation +================== Briefly, the shell commands './configure; make; make install' should -configure, build, and install this package. The following more-detailed -instructions are generic; see the 'README' file for instructions -specific to this package. Some packages provide this 'INSTALL' file but -do not implement all of the features documented below. The lack of an -optional feature in a given package is not necessarily a bug. More -recommendations for GNU packages can be found in *note Makefile -Conventions: (standards)Makefile Conventions. +configure, build, and install this package. The following +more-detailed instructions are generic; see the 'README' file for +instructions specific to this package. Some packages provide this +'INSTALL' file but do not implement all of the features documented +below. The lack of an optional feature in a given package is not +necessarily a bug. More recommendations for GNU packages can be found +in *note Makefile Conventions: (standards)Makefile Conventions. The 'configure' shell script attempts to guess correct values for various system-dependent variables used during compilation. It uses @@ -30,10 +30,11 @@ you can run in the future to recreate the current configuration, and a file 'config.log' containing compiler output (useful mainly for debugging 'configure'). - It can also use an optional file (typically called 'config.cache' and -enabled with '--cache-file=config.cache' or simply '-C') that saves the -results of its tests to speed up reconfiguring. Caching is disabled by -default to prevent problems with accidental use of stale cache files. + It can also use an optional file (typically called 'config.cache' +and enabled with '--cache-file=config.cache' or simply '-C') that saves +the results of its tests to speed up reconfiguring. Caching is +disabled by default to prevent problems with accidental use of stale +cache files. If you need to do unusual things to compile the package, please try to figure out how 'configure' could check whether to do them, and mail @@ -44,8 +45,8 @@ may remove or edit it. The file 'configure.ac' (or 'configure.in') is used to create 'configure' by a program called 'autoconf'. You need 'configure.ac' if -you want to change it or regenerate 'configure' using a newer version of -'autoconf'. +you want to change it or regenerate 'configure' using a newer version +of 'autoconf'. The simplest way to compile this package is: @@ -92,31 +93,31 @@ you want to change it or regenerate 'configure' using a newer version of targets like 'make install' and 'make uninstall' work correctly. This target is generally not run by end users. -0.2 Compilers and Options -========================= +Compilers and Options +===================== Some systems require unusual options for compilation or linking that the 'configure' script does not know about. Run './configure --help' for details on some of the pertinent environment variables. You can give 'configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here is -an example: +by setting variables in the command line or in the environment. Here +is an example: ./configure CC=c99 CFLAGS=-g LIBS=-lposix *Note Defining Variables::, for more details. -0.3 Compiling For Multiple Architectures -======================================== +Compiling For Multiple Architectures +==================================== You can compile the package for more than one kind of computer at the same time, by placing the object files for each architecture in their own directory. To do this, you can use GNU 'make'. 'cd' to the directory where you want the object files and executables to go and run -the 'configure' script. 'configure' automatically checks for the source -code in the directory that 'configure' is in and in '..'. This is known -as a "VPATH" build. +the 'configure' script. 'configure' automatically checks for the +source code in the directory that 'configure' is in and in '..'. This +is known as a "VPATH" build. With a non-GNU 'make', it is safer to compile the package for one architecture at a time in the source code directory. After you have @@ -137,8 +138,8 @@ this: may have to build one architecture at a time and combine the results using the 'lipo' tool if you have problems. -0.4 Installation Names -====================== +Installation Names +================== By default, 'make install' installs the package's commands under '/usr/local/bin', include files under '/usr/local/include', etc. You @@ -155,8 +156,8 @@ Documentation and other data files still use the regular prefix. In addition, if you use an unusual directory layout you can give options like '--bindir=DIR' to specify different values for particular kinds of files. Run 'configure --help' for a list of the directories -you can set and what kinds of files go in them. In general, the default -for these options is expressed in terms of '${prefix}', so that +you can set and what kinds of files go in them. In general, the +default for these options is expressed in terms of '${prefix}', so that specifying just '--prefix' will affect all of the other directory specifications that were not explicitly provided. @@ -171,13 +172,13 @@ affected directory. For example, `make install prefix=/alternate/directory' will choose an alternate location for all directory configuration variables that were expressed in terms of '${prefix}'. Any directories that were specified during 'configure', -but not in terms of '${prefix}', must each be overridden at install time -for the entire installation to be relocated. The approach of makefile -variable overrides for each directory variable is required by the GNU -Coding Standards, and ideally causes no recompilation. However, some -platforms have known limitations with the semantics of shared libraries -that end up requiring recompilation when using this method, particularly -noticeable in packages that use GNU Libtool. +but not in terms of '${prefix}', must each be overridden at install +time for the entire installation to be relocated. The approach of +makefile variable overrides for each directory variable is required by +the GNU Coding Standards, and ideally causes no recompilation. +However, some platforms have known limitations with the semantics of +shared libraries that end up requiring recompilation when using this +method, particularly noticeable in packages that use GNU Libtool. The second method involves providing the 'DESTDIR' variable. For example, 'make install DESTDIR=/alternate/directory' will prepend @@ -188,8 +189,8 @@ it does better at avoiding recompilation issues, and works well even when some directory options were not specified in terms of '${prefix}' at 'configure' time. -0.5 Optional Features -===================== +Optional Features +================= If the package supports it, you can cause programs to be installed with an extra prefix or suffix on their names by giving 'configure' the @@ -214,11 +215,11 @@ overridden with 'make V=1'; while running `./configure --disable-silent-rules' sets the default to verbose, which can be overridden with 'make V=0'. -0.6 Particular systems -====================== +Particular systems +================== - On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC -is not installed, it is recommended to use the following options in + On HP-UX, the default C compiler is not ANSI C compatible. If GNU +CC is not installed, it is recommended to use the following options in order to use an ANSI C compiler: ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" @@ -226,9 +227,9 @@ order to use an ANSI C compiler: and if that doesn't work, install pre-built binaries of GCC for HP-UX. On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot -parse its '' header file. The option '-nodtk' can be used as a -workaround. If GNU CC is not installed, it is therefore recommended to -try +parse its '' header file. The option '-nodtk' can be used as +a workaround. If GNU CC is not installed, it is therefore recommended +to try ./configure CC="cc" @@ -246,8 +247,8 @@ not '/usr/local'. It is recommended to use the following options: ./configure --prefix=/boot/common -0.7 Specifying the System Type -============================== +Specifying the System Type +========================== There may be some features 'configure' cannot figure out automatically, but needs to determine by the type of machine the package @@ -277,8 +278,8 @@ platform different from the build platform, you should specify the "host" platform (i.e., that on which the generated programs will eventually be run) with '--host=TYPE'. -0.8 Sharing Defaults -==================== +Sharing Defaults +================ If you want to set default values for 'configure' scripts to share, you can create a site shell script called 'config.site' that gives @@ -288,8 +289,8 @@ default values for variables like 'CC', 'cache_file', and 'prefix'. 'CONFIG_SITE' environment variable to the location of the site script. A warning: not all 'configure' scripts look for a site script. -0.9 Defining Variables -====================== +Defining Variables +================== Variables not defined in a site shell script can be set in the environment passed to 'configure'. However, some packages may run @@ -302,13 +303,13 @@ them in the 'configure' command line, using 'VAR=value'. For example: causes the specified 'gcc' to be used as the C compiler (unless it is overridden in the site shell script). -Unfortunately, this technique does not work for 'CONFIG_SHELL' due to an -Autoconf bug. Until the bug is fixed you can use this workaround: +Unfortunately, this technique does not work for 'CONFIG_SHELL' due to +an Autoconf bug. Until the bug is fixed you can use this workaround: CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash -0.10 'configure' Invocation -=========================== +'configure' Invocation +====================== 'configure' recognizes the following options to control how it operates. @@ -320,9 +321,9 @@ operates. '--help=short' '--help=recursive' Print a summary of the options unique to this package's - 'configure', and exit. The 'short' variant lists options used only - in the top level, while the 'recursive' variant lists options also - present in any nested packages. + 'configure', and exit. The 'short' variant lists options used + only in the top level, while the 'recursive' variant lists options + also present in any nested packages. '--version' '-V' @@ -350,9 +351,9 @@ operates. 'configure' can determine that directory automatically. '--prefix=DIR' - Use DIR as the installation prefix. *note Installation Names:: for - more details, including other options available for fine-tuning the - installation locations. + Use DIR as the installation prefix. *note Installation Names:: + for more details, including other options available for fine-tuning + the installation locations. '--no-create' '-n' diff --git a/doc/INSTALL.UTF-8 b/doc/INSTALL.UTF-8 index 2f4c76d12..fcf2c9b73 100644 --- a/doc/INSTALL.UTF-8 +++ b/doc/INSTALL.UTF-8 @@ -1,25 +1,25 @@ Installation Instructions ************************* - Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, -2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. +Copyright (C) 1994-1996, 1999-2002, 2004-2011 Free Software Foundation, +Inc. Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without warranty of any kind. -0.1 Basic Installation -====================== +Basic Installation +================== Briefly, the shell commands ‘./configure; make; make install’ should -configure, build, and install this package. The following more-detailed -instructions are generic; see the ‘README’ file for instructions -specific to this package. Some packages provide this ‘INSTALL’ file but -do not implement all of the features documented below. The lack of an -optional feature in a given package is not necessarily a bug. More -recommendations for GNU packages can be found in *note Makefile -Conventions: (standards)Makefile Conventions. +configure, build, and install this package. The following +more-detailed instructions are generic; see the ‘README’ file for +instructions specific to this package. Some packages provide this +‘INSTALL’ file but do not implement all of the features documented +below. The lack of an optional feature in a given package is not +necessarily a bug. More recommendations for GNU packages can be found +in *note Makefile Conventions: (standards)Makefile Conventions. The ‘configure’ shell script attempts to guess correct values for various system-dependent variables used during compilation. It uses @@ -30,10 +30,11 @@ you can run in the future to recreate the current configuration, and a file ‘config.log’ containing compiler output (useful mainly for debugging ‘configure’). - It can also use an optional file (typically called ‘config.cache’ and -enabled with ‘--cache-file=config.cache’ or simply ‘-C’) that saves the -results of its tests to speed up reconfiguring. Caching is disabled by -default to prevent problems with accidental use of stale cache files. + It can also use an optional file (typically called ‘config.cache’ +and enabled with ‘--cache-file=config.cache’ or simply ‘-C’) that saves +the results of its tests to speed up reconfiguring. Caching is +disabled by default to prevent problems with accidental use of stale +cache files. If you need to do unusual things to compile the package, please try to figure out how ‘configure’ could check whether to do them, and mail @@ -44,8 +45,8 @@ may remove or edit it. The file ‘configure.ac’ (or ‘configure.in’) is used to create ‘configure’ by a program called ‘autoconf’. You need ‘configure.ac’ if -you want to change it or regenerate ‘configure’ using a newer version of -‘autoconf’. +you want to change it or regenerate ‘configure’ using a newer version +of ‘autoconf’. The simplest way to compile this package is: @@ -92,31 +93,31 @@ you want to change it or regenerate ‘configure’ using a newer version of targets like ‘make install’ and ‘make uninstall’ work correctly. This target is generally not run by end users. -0.2 Compilers and Options -========================= +Compilers and Options +===================== Some systems require unusual options for compilation or linking that the ‘configure’ script does not know about. Run ‘./configure --help’ for details on some of the pertinent environment variables. You can give ‘configure’ initial values for configuration parameters -by setting variables in the command line or in the environment. Here is -an example: +by setting variables in the command line or in the environment. Here +is an example: ./configure CC=c99 CFLAGS=-g LIBS=-lposix *Note Defining Variables::, for more details. -0.3 Compiling For Multiple Architectures -======================================== +Compiling For Multiple Architectures +==================================== You can compile the package for more than one kind of computer at the same time, by placing the object files for each architecture in their own directory. To do this, you can use GNU ‘make’. ‘cd’ to the directory where you want the object files and executables to go and run -the ‘configure’ script. ‘configure’ automatically checks for the source -code in the directory that ‘configure’ is in and in ‘..’. This is known -as a "VPATH" build. +the ‘configure’ script. ‘configure’ automatically checks for the +source code in the directory that ‘configure’ is in and in ‘..’. This +is known as a "VPATH" build. With a non-GNU ‘make’, it is safer to compile the package for one architecture at a time in the source code directory. After you have @@ -137,8 +138,8 @@ this: may have to build one architecture at a time and combine the results using the ‘lipo’ tool if you have problems. -0.4 Installation Names -====================== +Installation Names +================== By default, ‘make install’ installs the package's commands under ‘/usr/local/bin’, include files under ‘/usr/local/include’, etc. You @@ -155,8 +156,8 @@ Documentation and other data files still use the regular prefix. In addition, if you use an unusual directory layout you can give options like ‘--bindir=DIR’ to specify different values for particular kinds of files. Run ‘configure --help’ for a list of the directories -you can set and what kinds of files go in them. In general, the default -for these options is expressed in terms of ‘${prefix}’, so that +you can set and what kinds of files go in them. In general, the +default for these options is expressed in terms of ‘${prefix}’, so that specifying just ‘--prefix’ will affect all of the other directory specifications that were not explicitly provided. @@ -171,13 +172,13 @@ affected directory. For example, `make install prefix=/alternate/directory' will choose an alternate location for all directory configuration variables that were expressed in terms of ‘${prefix}’. Any directories that were specified during ‘configure’, -but not in terms of ‘${prefix}’, must each be overridden at install time -for the entire installation to be relocated. The approach of makefile -variable overrides for each directory variable is required by the GNU -Coding Standards, and ideally causes no recompilation. However, some -platforms have known limitations with the semantics of shared libraries -that end up requiring recompilation when using this method, particularly -noticeable in packages that use GNU Libtool. +but not in terms of ‘${prefix}’, must each be overridden at install +time for the entire installation to be relocated. The approach of +makefile variable overrides for each directory variable is required by +the GNU Coding Standards, and ideally causes no recompilation. +However, some platforms have known limitations with the semantics of +shared libraries that end up requiring recompilation when using this +method, particularly noticeable in packages that use GNU Libtool. The second method involves providing the ‘DESTDIR’ variable. For example, ‘make install DESTDIR=/alternate/directory’ will prepend @@ -188,8 +189,8 @@ it does better at avoiding recompilation issues, and works well even when some directory options were not specified in terms of ‘${prefix}’ at ‘configure’ time. -0.5 Optional Features -===================== +Optional Features +================= If the package supports it, you can cause programs to be installed with an extra prefix or suffix on their names by giving ‘configure’ the @@ -214,11 +215,11 @@ overridden with ‘make V=1’; while running `./configure --disable-silent-rules' sets the default to verbose, which can be overridden with ‘make V=0’. -0.6 Particular systems -====================== +Particular systems +================== - On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC -is not installed, it is recommended to use the following options in + On HP-UX, the default C compiler is not ANSI C compatible. If GNU +CC is not installed, it is recommended to use the following options in order to use an ANSI C compiler: ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" @@ -226,9 +227,9 @@ order to use an ANSI C compiler: and if that doesn't work, install pre-built binaries of GCC for HP-UX. On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot -parse its ‘’ header file. The option ‘-nodtk’ can be used as a -workaround. If GNU CC is not installed, it is therefore recommended to -try +parse its ‘’ header file. The option ‘-nodtk’ can be used as +a workaround. If GNU CC is not installed, it is therefore recommended +to try ./configure CC="cc" @@ -246,8 +247,8 @@ not ‘/usr/local’. It is recommended to use the following options: ./configure --prefix=/boot/common -0.7 Specifying the System Type -============================== +Specifying the System Type +========================== There may be some features ‘configure’ cannot figure out automatically, but needs to determine by the type of machine the package @@ -277,8 +278,8 @@ platform different from the build platform, you should specify the "host" platform (i.e., that on which the generated programs will eventually be run) with ‘--host=TYPE’. -0.8 Sharing Defaults -==================== +Sharing Defaults +================ If you want to set default values for ‘configure’ scripts to share, you can create a site shell script called ‘config.site’ that gives @@ -288,8 +289,8 @@ default values for variables like ‘CC’, ‘cache_file’, and ‘prefix’. ‘CONFIG_SITE’ environment variable to the location of the site script. A warning: not all ‘configure’ scripts look for a site script. -0.9 Defining Variables -====================== +Defining Variables +================== Variables not defined in a site shell script can be set in the environment passed to ‘configure’. However, some packages may run @@ -302,13 +303,13 @@ them in the ‘configure’ command line, using ‘VAR=value’. For example: causes the specified ‘gcc’ to be used as the C compiler (unless it is overridden in the site shell script). -Unfortunately, this technique does not work for ‘CONFIG_SHELL’ due to an -Autoconf bug. Until the bug is fixed you can use this workaround: +Unfortunately, this technique does not work for ‘CONFIG_SHELL’ due to +an Autoconf bug. Until the bug is fixed you can use this workaround: CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash -0.10 ‘configure’ Invocation -=========================== +‘configure’ Invocation +====================== ‘configure’ recognizes the following options to control how it operates. @@ -320,9 +321,9 @@ operates. ‘--help=short’ ‘--help=recursive’ Print a summary of the options unique to this package's - ‘configure’, and exit. The ‘short’ variant lists options used only - in the top level, while the ‘recursive’ variant lists options also - present in any nested packages. + ‘configure’, and exit. The ‘short’ variant lists options used + only in the top level, while the ‘recursive’ variant lists options + also present in any nested packages. ‘--version’ ‘-V’ @@ -350,9 +351,9 @@ operates. ‘configure’ can determine that directory automatically. ‘--prefix=DIR’ - Use DIR as the installation prefix. *note Installation Names:: for - more details, including other options available for fine-tuning the - installation locations. + Use DIR as the installation prefix. *note Installation Names:: + for more details, including other options available for fine-tuning + the installation locations. ‘--no-create’ ‘-n’ diff --git a/doc/Makefile b/doc/Makefile index 9a1ed6b2f..c40359bb0 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -28,17 +28,27 @@ html: $(doc).html dvi: $(doc).dvi pdf: $(doc).pdf +INSTALL_PRELUDE = echo '@firstparagraphindent insert' + # INSTALL file with old ASCII quotation marks (looks ugly on modern machines). INSTALL: install.texi - $(MAKEINFO) --plaintext --no-validate $< > $@ + $(INSTALL_PRELUDE) | cat - $< > tmp.texi + $(MAKEINFO) --plaintext --no-validate tmp.texi > $@ + rm -f tmp.texi # INSTALL file with ISO 646 or ISO 8859 quotation marks. INSTALL.ISO: install.texi - $(MAKEINFO) --plaintext --no-validate $< | sed -e "s/\`\([^']*\)'/'\1'/g" > $@ + $(INSTALL_PRELUDE) | cat - $< > tmpi.texi + $(MAKEINFO) --plaintext --no-validate tmpi.texi \ + | sed -e "s/\`\([^']*\)'/'\1'/g" > $@ + rm -f tmpi.texi # INSTALL file wit ISO 10646 (Unicode) quotation marks. INSTALL.UTF-8: install.texi - $(MAKEINFO) --plaintext --no-validate $< | sed -e "s/\`\([^']*\)'/‘\1’/g" > $@ + $(INSTALL_PRELUDE) | cat - $< > tmpu.texi + $(MAKEINFO) --plaintext --no-validate tmpu.texi \ + | sed -e "s/\`\([^']*\)'/‘\1’/g" > $@ + rm -f tmpu.texi GNULIB_TEXI_FILES = $(filter-out maintain.texi make-stds.texi standards.texi,$(wildcard *.texi)) $(wildcard posix-headers/*.texi) $(wildcard posix-functions/*.texi) $(wildcard glibc-headers/*.texi) $(wildcard glibc-functions/*.texi) diff --git a/doc/install.texi b/doc/install.texi index a220458cc..c43298b01 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -2,12 +2,11 @@ @c the INSTALL file. @ifclear autoconf -@firstparagraphindent insert @unnumbered Installation Instructions -Copyright @copyright{} 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, -2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. +Copyright @copyright{} 1994-1996, 1999-2002, 2004-2011 Free Software +Foundation, Inc. Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice -- 2.11.0