xapian-applications/omega/INSTALL

   1 Omega Installation
   2 ==================
   3
   4 Originally based on automake's generic "Installation Instructions" which are:
   5
   6 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
   7 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
   8
   9    Copying and distribution of this file, with or without modification,
  10 are permitted in any medium without royalty provided the copyright
  11 notice and this notice are preserved.  This file is offered as-is,
  12 without warranty of any kind.
  13
  14 Prerequisites
  15 =============
  16
  17 You need the following libraries installed before building Omega.  If you
  18 install these from packages, make sure you install any corresponding -dev or
  19 -devel packages as well:
  20
  21   * zlib <https://www.zlib.net/>
  22   * PCRE2 <https://www.pcre.org/>
  23   * libmagic (which comes with the file program
  24     <https://www.darwinsys.com/file/>) - on RPM-based package systems, the
  25     package with the header in is often named file-devel
  26
  27 Quick Installation Guide
  28 ========================
  29
  30 The simplest way to compile this package is:
  31
  32   1. 'cd' to the directory containing the package's source code and type
  33      './configure' to configure the package for your system.
  34
  35      You need to make sure that xapian-config from xapian-core is on your path,
  36      or else pass its full path to omega's configure script:
  37
  38        ./configure XAPIAN_CONFIG=/path/to/xapian-config
  39
  40      Running 'configure' might take a while.  While running, it prints
  41      some 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 the self-tests that come with
  46      the package, using the just-built uninstalled binaries.
  47
  48   4. Type 'make install' to install the programs and any data files and
  49      documentation.  When installing into a prefix owned by root, it is
  50      recommended that the package be configured and built as a regular
  51      user, and only the 'make install' phase executed with root
  52      privileges.
  53
  54   5. You can remove the program binaries and object files from the
  55      source code directory by typing 'make clean'.  To also remove the
  56      files that 'configure' created (so you can compile the package for
  57      a different kind of computer), type 'make distclean'.  There is
  58      also a 'make maintainer-clean' target, but that is intended mainly
  59      for the package's developers.  If you use it, you may have to get
  60      all sorts of other programs in order to regenerate files that came
  61      with the distribution.
  62
  63   6. You can also type 'make uninstall' to remove the installed files
  64      again.
  65
  66 Compilers and Options
  67 =====================
  68
  69    Some systems may require unusual options for compilation or linking that
  70 the 'configure' script does not know about.  Run './configure --help'
  71 for details on some of the pertinent environment variables.
  72
  73    You can give 'configure' initial values for configuration parameters
  74 by setting variables in the command line or in the environment.  Here
  75 is an example:
  76
  77      ./configure CXX=g++-4.9 CFLAGS=-O2 LIBS=-lposix
  78
  79    If your system requires special flags, do let us know.  Where possible
  80 we'd prefer configure to determine such flags by itself, but if we can't
  81 then at least we can document the special flags to help other users of
  82 systems like yours.
  83
  84 Compiling For Multiple Architectures
  85 ====================================
  86
  87 When using GCC on platforms which support multiple architectures, the simplest
  88 way to select a non-default architecture is to pass a CXX setting to configure
  89 which includes the appropriate -m option - e.g. to build for x86 on x86-64
  90 you would configure with:
  91
  92 ./configure CXX='g++ -m32'
  93
  94 On macOS 10.5 and later systems, you can create libraries and
  95 executables that work on multiple system types--known as "fat" or
  96 "universal" binaries--by specifying multiple '-arch' options to the
  97 compiler but only a single '-arch' option to the preprocessor.  Like
  98 this:
  99
 100      ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 101                  CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 102                  CPP="gcc -E" CXXCPP="g++ -E"
 103
 104 Building in a separate directory
 105 ================================
 106
 107 If you wish to perform your build in a separate directory from the source,
 108 create and change to the build directory, and run the configure script (in
 109 the source directory) from the build directory, like so:
 110
 111   mkdir BUILD
 112   cd BUILD
 113   ../configure
 114
 115 Installation Names
 116 ==================
 117
 118    By default, 'make install' installs the package's commands under
 119 '/usr/local/bin', include files under '/usr/local/include', etc.  You
 120 can specify an installation prefix other than '/usr/local' by giving
 121 'configure' the option '--prefix=PREFIX', where PREFIX must be an
 122 absolute file name.
 123
 124    You can specify separate installation prefixes for
 125 architecture-specific files and architecture-independent files.  If you
 126 pass the option '--exec-prefix=PREFIX' to 'configure', the package uses
 127 PREFIX as the prefix for installing programs and libraries.
 128 Documentation and other data files still use the regular prefix.
 129
 130    In addition, if you use an unusual directory layout you can give
 131 options like '--bindir=DIR' to specify different values for particular
 132 kinds of files.  Run 'configure --help' for a list of the directories
 133 you can set and what kinds of files go in them.
 134
 135 Specifying the System Type
 136 ==========================
 137
 138    There may be some features 'configure' cannot figure out
 139 automatically, but needs to determine by the type of machine the package
 140 will run on.  Usually, assuming the package is built to be run on the
 141 _same_ architectures, 'configure' can figure that out, but if it prints
 142 a message saying it cannot guess the machine type, give it the
 143 '--build=TYPE' option.  TYPE can either be a short name for the system
 144 type, such as 'sun4', or a canonical name which has the form:
 145
 146      CPU-COMPANY-SYSTEM
 147
 148 where SYSTEM can have one of these forms:
 149
 150      OS
 151      KERNEL-OS
 152
 153    See the file 'config.sub' for the possible values of each field.  If
 154 'config.sub' isn't included in this package, then this package doesn't
 155 need to know the machine type.
 156
 157    If you want to _use_ a cross compiler, that generates code for a
 158 platform different from the build platform, you should specify the
 159 "host" platform (i.e., that on which the generated programs will
 160 eventually be run) with '--host=TYPE'.
 161
 162 Sharing Defaults
 163 ================
 164
 165    If you want to set default values for 'configure' scripts to share,
 166 you can create a site shell script called 'config.site' that gives
 167 default values for variables like 'CXX', 'cache_file', and 'prefix'.
 168 'configure' looks for 'PREFIX/share/config.site' if it exists, then
 169 'PREFIX/etc/config.site' if it exists.  Or, you can set the
 170 'CONFIG_SITE' environment variable to the location of the site script.
 171 A warning: not all 'configure' scripts look for a site script.
 172
 173 Defining Variables
 174 ==================
 175
 176    Variables not defined in a site shell script can be set in the
 177 environment passed to 'configure'.  However, some packages may run
 178 configure again during the build, and the customized values of these
 179 variables may be lost.  In order to avoid this problem, you should set
 180 them in the 'configure' command line, using 'VAR=value'.  For example:
 181
 182      ./configure CXX=/usr/local2/bin/g++
 183
 184 causes the specified 'g++' to be used as the C++ compiler (unless it is
 185 overridden in the site shell script).
 186
 187 'configure' Invocation
 188 ======================
 189
 190 'configure' recognizes the following standard options to control how it
 191 operates:
 192
 193 '--help'
 194 '-h'
 195      Print a summary of all of the options to 'configure', and exit.
 196
 197 '--version'
 198 '-V'
 199      Print the version of Autoconf used to generate the 'configure'
 200      script, and exit.
 201
 202 '--cache-file=FILE'
 203      Enable the cache: use and save the results of the tests in FILE,
 204      traditionally 'config.cache'.  FILE defaults to '/dev/null' to
 205      disable caching.
 206
 207 '--config-cache'
 208 '-C'
 209      Alias for '--cache-file=config.cache'.
 210
 211 '--quiet'
 212 '--silent'
 213 '-q'
 214      Do not print messages saying which checks are being made.  To
 215      suppress all normal output, redirect it to '/dev/null' (any error
 216      messages will still be shown).
 217
 218 '--srcdir=DIR'
 219      Look for the package's source code in directory DIR.  Usually
 220      'configure' can determine that directory automatically.
 221
 222 'configure' also accepts some other, not widely useful, options.  Run
 223 'configure --help' for more details.