wmbattery/INSTALL

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