code.delx.au - gnu-emacs-elpa/blob - packages/realgud/INSTALL

   1 Installation Instructions
   2 *************************
   3
   4 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
   5 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
   6
   7    Copying and distribution of this file, with or without modification,
   8 are permitted in any medium without royalty provided the copyright
   9 notice and this notice are preserved.  This file is offered as-is,
  10 without warranty of any kind.
  11
  12 Basic Installation
  13 ==================
  14
  15    Briefly, the shell commands `./configure && make' should configure,
  16 and build this package.  If that succeeds `make install' will install
  17 the package. However on some systems you may need root privileges, you
  18 may have to use `sudo make install' or perhaps `su root' beforehand.
  19
  20
  21    See http://wiki.github.com/rocky/emacs-dbgr/how-to-install for more
  22 detail as to how to install this package.
  23
  24 Generic Information
  25 ===================
  26
  27    The `configure' shell script attempts to guess correct values for
  28 various system-dependent variables used during compilation.  It uses
  29 those values to create a `Makefile' in each directory of the package.
  30 It also creates a shell script `config.status' that you can run in
  31 the future to recreate the current configuration, and a file
  32 `config.log' containing compiler output (useful mainly for debugging
  33 `configure').
  34
  35    The configure script can also use an optional file (typically
  36 called `config.cache' and enabled with `--cache-file=config.cache' or
  37 simply `-C') that saves the results of its tests to speed up
  38 reconfiguring.  Caching is disabled by default to prevent problems
  39 with accidental use of stale cache files.
  40
  41    If you need to do unusual things to compile the package, please try
  42 to figure out how `configure' could check whether to do them, and mail
  43 diffs or instructions to the address given in the `README' so they can
  44 be considered for the next release.  If you are using the cache, and at
  45 some point `config.cache' contains results you don't want to keep, you
  46 may remove or edit it.
  47
  48    The file `configure.ac' is used to create `configure' by a program
  49 called `autoconf'.  You need `configure.ac' if you want to change it
  50 or regenerate `configure' using a newer version of `autoconf'.
  51
  52    The simplest way to compile this package is:
  53
  54   1. `cd' to the directory containing the package's source code and type
  55      `./configure' to configure the package for your system.
  56
  57      Running `configure' might take a while.  While running, it prints
  58      some messages telling which features it is checking for.
  59
  60   2. Type `make' to compile the package.
  61
  62   3. Optionally, type `make check' to run any self-tests that come with
  63      the package, generally using the just-built uninstalled binaries.
  64
  65   4. Type `make install' to install the programs and any data files and
  66      documentation.  When installing into a prefix owned by root, it is
  67      recommended that the package be configured and built as a regular
  68      user, and only the `make install' phase executed with root
  69      privileges.
  70
  71   5. You can remove the compiled Emacs Lisp files and other derived
  72      files from the source code directory by typing `make clean'.  To
  73      also remove the files that `configure' created (so you can
  74      compile the package for a different kind of computer), type `make
  75      distclean'.  There is also a `make maintainer-clean' target, but
  76      that is intended mainly for the package's developers.  If you use
  77      it, you may have to get all sorts of other programs in order to
  78      regenerate files that came with the distribution.
  79
  80   6. You can also type `make uninstall' to remove the installed files
  81      again.
  82
  83   7. We don't provide `make distcheck' right now, but perhaps someday
  84      we will. This is by used by developers to test that all other
  85      targets like `make install' and `make uninstall' work correctly.
  86      This target is generally not run by end users.
  87
  88 Options
  89 =====================
  90
  91    Run `./configure --help' for details on the pertinent
  92 environment variables.
  93
  94    You can give `configure' initial values for configuration parameters
  95 by setting variables in the command line or in the environment.  Here
  96 is an example:
  97
  98      ./configure CC=c99 EMACS=/usr/bin/emacs23-x
  99
 100    *Note Defining Variables::, for more details.
 101
 102 Installation Names
 103 ==================
 104
 105    By default, `make install' installs the package's emacs files under
 106 `/usr/local/share/emacs/site-lisp', You can specify an installation
 107 prefix other than `/usr/local/emacs/site-lisp' by giving `configure'
 108 the option `--with-site-lisp=PREFIX', where PREFIX must be an absolute
 109 file name.
 110
 111    The most portable way to affect installation locations is to pass the
 112 correct locations to `configure'; however, many packages provide one or
 113 both of the following shortcuts of passing variable assignments to the
 114 `make install' command line to change installation locations without
 115 having to reconfigure or recompile.
 116
 117    The first method involves providing an override variable for each
 118 affected directory.  For example, `make install
 119 prefix=/alternate/directory' will choose an alternate location for all
 120 directory configuration variables that were expressed in terms of
 121 `${prefix}'.  Any directories that were specified during `configure',
 122 but not in terms of `${prefix}', must each be overridden at install
 123 time for the entire installation to be relocated.  The approach of
 124 makefile variable overrides for each directory variable is required by
 125 the GNU Coding Standards, and ideally causes no recompilation.
 126 However, some platforms have known limitations with the semantics of
 127 shared libraries that end up requiring recompilation when using this
 128 method, particularly noticeable in packages that use GNU Libtool.
 129
 130    The second method involves providing the `DESTDIR' variable.  For
 131 example, `make install DESTDIR=/alternate/directory' will prepend
 132 `/alternate/directory' before all installation names.  The approach of
 133 `DESTDIR' overrides is not required by the GNU Coding Standards, and
 134 does not work on platforms that have drive letters.  On the other hand,
 135 it does better at avoiding recompilation issues, and works well even
 136 when some directory options were not specified in terms of `${prefix}'
 137 at `configure' time.
 138
 139 Optional Features
 140 =================
 141
 142    If the package supports it, you can cause programs to be installed
 143 with an extra prefix or suffix on their names by giving `configure' the
 144 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 145
 146    Some packages pay attention to `--enable-FEATURE' options to
 147 `configure', where FEATURE indicates an optional part of the package.
 148 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 149 is something like `gnu-as' or `x' (for the X Window System).  The
 150 `README' should mention any `--enable-' and `--with-' options that the
 151 package recognizes.
 152
 153    For packages that use the X Window System, `configure' can usually
 154 find the X include and library files automatically, but if it doesn't,
 155 you can use the `configure' options `--x-includes=DIR' and
 156 `--x-libraries=DIR' to specify their locations.
 157
 158    Some packages offer the ability to configure how verbose the
 159 execution of `make' will be.  For these packages, running `./configure
 160 --enable-silent-rules' sets the default to minimal output, which can be
 161 overridden with `make V=1'; while running `./configure
 162 --disable-silent-rules' sets the default to verbose, which can be
 163 overridden with `make V=0'.
 164
 165
 166 Sharing Defaults
 167 ================
 168
 169    If you want to set default values for `configure' scripts to share,
 170 you can create a site shell script called `config.site' that gives
 171 default values for variables like `CC', `cache_file', and `prefix'.
 172 `configure' looks for `PREFIX/share/config.site' if it exists, then
 173 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 174 `CONFIG_SITE' environment variable to the location of the site script.
 175 A warning: not all `configure' scripts look for a site script.
 176
 177 Defining Variables
 178 ==================
 179
 180    Variables not defined in a site shell script can be set in the
 181 environment passed to `configure'.  However, some packages may run
 182 configure again during the build, and the customized values of these
 183 variables may be lost.  In order to avoid this problem, you should set
 184 them in the `configure' command line, using `VAR=value'.  For example:
 185
 186      ./configure EMACS=/usr/bin/emacs23-x
 187
 188 causes the specified `/usr/bin/emacs23-x' to be used as the Emacs program
 189 to use.
 190
 191 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
 192 an Autoconf bug.  Until the bug is fixed you can use this workaround:
 193
 194      CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
 195
 196 `configure' Invocation
 197 ======================
 198
 199    `configure' recognizes the following options to control how it
 200 operates.
 201
 202 `--help'
 203 `-h'
 204      Print a summary of all of the options to `configure', and exit.
 205
 206 `--help=short'
 207 `--help=recursive'
 208      Print a summary of the options unique to this package's
 209      `configure', and exit.  The `short' variant lists options used
 210      only in the top level, while the `recursive' variant lists options
 211      also present in any nested packages.
 212
 213 `--version'
 214 `-V'
 215      Print the version of Autoconf used to generate the `configure'
 216      script, and exit.
 217
 218 `--cache-file=FILE'
 219      Enable the cache: use and save the results of the tests in FILE,
 220      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 221      disable caching.
 222
 223 `--config-cache'
 224 `-C'
 225      Alias for `--cache-file=config.cache'.
 226
 227 `--quiet'
 228 `--silent'
 229 `-q'
 230      Do not print messages saying which checks are being made.  To
 231      suppress all normal output, redirect it to `/dev/null' (any error
 232      messages will still be shown).
 233
 234 `--srcdir=DIR'
 235      Look for the package's source code in directory DIR.  Usually
 236      `configure' can determine that directory automatically.
 237
 238 `--prefix=DIR'
 239      Use DIR as the installation prefix.  *note Installation Names::
 240      for more details, including other options available for fine-tuning
 241      the installation locations.
 242
 243 `--no-create'
 244 `-n'
 245      Run the configure checks, but stop before creating any output
 246      files.
 247
 248 `configure' also accepts some other, not widely useful, options.  Run
 249 `configure --help' for more details.
 250