release/src/router/pptpd/INSTALL

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