texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

texinfo update (Thu Jul 28 19:22:01 EDT 2005)


From: Karl Berry
Subject: texinfo update (Thu Jul 28 19:22:01 EDT 2005)
Date: Thu, 28 Jul 2005 19:22:09 -0400

Index: INSTALL
===================================================================
RCS file: /cvsroot/texinfo/texinfo/INSTALL,v
retrieving revision 1.6
retrieving revision 1.7
diff -c -r1.6 -r1.7
*** INSTALL     3 Feb 2005 12:56:37 -0000       1.6
--- INSTALL     28 Jul 2005 22:58:47 -0000      1.7
***************
*** 1,236 ****
! Installation Instructions
! *************************
! 
! Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
! Software Foundation, Inc.
! 
! This file is free documentation; the Free Software Foundation gives
! unlimited permission to copy, distribute and modify it.
! 
! Basic Installation
! ==================
! 
! These are generic installation instructions.
! 
!    The `configure' shell script attempts to guess correct values for
! various system-dependent variables used during compilation.  It uses
! those values to create a `Makefile' in each directory of the package.
! It may also create one or more `.h' files containing system-dependent
! definitions.  Finally, it creates a shell script `config.status' that
! 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.)
! 
!    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
! diffs or instructions to the address given in the `README' so they can
! be considered for the next release.  If you are using the cache, and at
! some point `config.cache' contains results you don't want to keep, you
! may remove or edit it.
! 
!    The file `configure.ac' (or `configure.in') is used to create
! `configure' by a program called `autoconf'.  You only need
! `configure.ac' if you want to change it or regenerate `configure' using
! a newer version of `autoconf'.
! 
! The simplest way to compile this package is:
! 
!   1. `cd' to the directory containing the package's source code and type
!      `./configure' to configure the package for your system.  If you're
!      using `csh' on an old version of System V, you might need to type
!      `sh ./configure' instead to prevent `csh' from trying to execute
!      `configure' itself.
! 
!      Running `configure' takes awhile.  While running, it prints some
!      messages telling which features it is checking for.
! 
!   2. Type `make' to compile the package.
! 
!   3. Optionally, type `make check' to run any self-tests that come with
!      the package.
! 
!   4. Type `make install' to install the programs and any data files and
!      documentation.
! 
!   5. You can remove the program binaries and object files from the
!      source code directory by typing `make clean'.  To also remove the
!      files that `configure' created (so you can compile the package for
!      a different kind of computer), type `make distclean'.  There is
!      also a `make maintainer-clean' target, but that is intended mainly
!      for the package's developers.  If you use it, you may have to get
!      all sorts of other programs in order to regenerate files that came
!      with the distribution.
! 
! 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:
! 
!      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
! 
!    *Note Defining Variables::, for more details.
! 
! 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 must use a version of `make' that
! supports the `VPATH' variable, such as 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 `..'.
! 
!    If you have to use a `make' that does not support the `VPATH'
! variable, you have to compile the package for one architecture at a
! time in the source code directory.  After you have installed the
! package for one architecture, use `make distclean' before reconfiguring
! for another architecture.
! 
! Installation Names
! ==================
! 
! By default, `make install' will install the package's files in
! `/usr/local/bin', `/usr/local/man', etc.  You can specify an
! installation prefix other than `/usr/local' by giving `configure' the
! option `--prefix=PREFIX'.
! 
!    You can specify separate installation prefixes for
! architecture-specific files and architecture-independent files.  If you
! give `configure' the option `--exec-prefix=PREFIX', the package will
! use PREFIX as the prefix for installing programs and libraries.
! Documentation and other data files will 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.
! 
!    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
! option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
! 
! Optional Features
! =================
! 
! Some packages pay attention to `--enable-FEATURE' options to
! `configure', where FEATURE indicates an optional part of the package.
! They may also pay attention to `--with-PACKAGE' options, where PACKAGE
! is something like `gnu-as' or `x' (for the X Window System).  The
! `README' should mention any `--enable-' and `--with-' options that the
! package recognizes.
! 
!    For packages that use the X Window System, `configure' can usually
! find the X include and library files automatically, but if it doesn't,
! you can use the `configure' options `--x-includes=DIR' and
! `--x-libraries=DIR' to specify their locations.
! 
! 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 will run on.
! Usually, assuming the package is built to be run on the _same_
! architectures, `configure' can figure that out, but if it prints a
! message saying it cannot guess the machine type, give it the
! `--build=TYPE' option.  TYPE can either be a short name for the system
! type, such as `sun4', or a canonical name which has the form:
! 
!      CPU-COMPANY-SYSTEM
! 
! where SYSTEM can have one of these forms:
! 
!      OS KERNEL-OS
! 
!    See the file `config.sub' for the possible values of each field.  If
! `config.sub' isn't included in this package, then this package doesn't
! need to know the machine type.
! 
!    If you are _building_ compiler tools for cross-compiling, you should
! use the `--target=TYPE' option to select the type of system they will
! produce code for.
! 
!    If you want to _use_ a cross compiler, that generates code for a
! 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'.
! 
! 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 default
! values for variables like `CC', `cache_file', and `prefix'.
! `configure' looks for `PREFIX/share/config.site' if it exists, then
! `PREFIX/etc/config.site' if it exists.  Or, you can set the
! `CONFIG_SITE' environment variable to the location of the site script.
! A warning: not all `configure' scripts look for a site script.
! 
! Defining Variables
! ==================
! 
! Variables not defined in a site shell script can be set in the
! environment passed to `configure'.  However, some packages may run
! configure again during the build, and the customized values of these
! variables may be lost.  In order to avoid this problem, you should set
! them in the `configure' command line, using `VAR=value'.  For example:
! 
!      ./configure CC=/usr/local2/bin/gcc
! 
! causes the specified `gcc' to be used as the C compiler (unless it is
! overridden in the site shell script).  Here is a another example:
! 
!      /bin/bash ./configure CONFIG_SHELL=/bin/bash
! 
! Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
! configuration-related scripts to be executed by `/bin/bash'.
! 
! `configure' Invocation
! ======================
! 
! `configure' recognizes the following options to control how it operates.
! 
! `--help'
! `-h'
!      Print a summary of the options to `configure', and exit.
! 
! `--version'
! `-V'
!      Print the version of Autoconf used to generate the `configure'
!      script, and exit.
! 
! `--cache-file=FILE'
!      Enable the cache: use and save the results of the tests in FILE,
!      traditionally `config.cache'.  FILE defaults to `/dev/null' to
!      disable caching.
! 
! `--config-cache'
! `-C'
!      Alias for `--cache-file=config.cache'.
! 
! `--quiet'
! `--silent'
! `-q'
!      Do not print messages saying which checks are being made.  To
!      suppress all normal output, redirect it to `/dev/null' (any error
!      messages will still be shown).
! 
! `--srcdir=DIR'
!      Look for the package's source code in directory DIR.  Usually
!      `configure' can determine that directory automatically.
! 
! `configure' also accepts some other, not widely useful, options.  Run
! `configure --help' for more details.
  
--- 1,45 ----
! $Id: INSTALL,v 1.7 2005/07/28 22:58:47 karl Exp $
  
+      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.
+ 
+ For generic installation instructions on compiling and installing this
+ Automake-based distribution, please read the file `INSTALL.generic'.
+ 
+ Installation notes specific to Texinfo:
+ 
+ * texinfo.tex and the other *.tex files are not installed by `make
+   install'.  This is because there is no reliable way to know where to
+   install them.  Instead, you have to run an additional make command
+   after the normal make install:
+     make TEXMF=/your/texmf install-tex
+   texinfo.tex is installed in ${TEXMF}/tex/texinfo/texinfo.tex, etc.
+ 
+ * On the other hand, if you're maintaining a TeX distribution, you don't
+   want your users to see the installation warnings, because you already
+   have the files installed.  (And you're keeping them up to date, right?)
+   In this case, run configure --disable-install-warnings, or set
+   enable_install_warnings=no in the environment.
+ 
+ * On MacOSX, if configure fails with the error:
+       ac_cv_build='config.sub: invalid option -apple-darwin7.2.0
+ this is probably because your uname -p is returning "unknown".  Use
+ /usr/bin/uname instead.
+ 
+ * For instructions on compiling this distribution with DJGPP tools
+   for MS-DOS and MS-Windows, see the file djgpp/README.
+ 
+ * The Info tree uses a file `dir' as its root node; the `dir-example'
+   file in this distribution is included as a possible starting point.
+   Use it, modify it, or ignore it just as you like.
+ 
+ * You can create a file texinfo.cnf to be read by TeX when
+   processing Texinfo manuals.  For example, you might like to use
+   @afourpaper by default.  See the `Preparing for TeX' node in
+   texinfo.txi for more details.  You don't have to create the file if
+   you have nothing to put in it.
+ 
+ * If your info files are not in $prefix/info, you may wish to add a line
+ #define DEFAULT_INFOPATH "/mydir1:/mydir2:..."
+   to config.h after running configure.
P INSTALL


reply via email to

[Prev in Thread] Current Thread [Next in Thread]