INSTALL

   1 To build RPM you will need several other packages:
   2 --------------------------------------------------
   3
   4 The zlib library for compression support. You might also need/want
   5 the unzip executable for java jar dependency analysis. All available from
   6     http://www.gzip.org/zlib/
   7
   8 The libmagic (aka file) library for file type detection (used by rpmbuild).
   9 The source for the file utility + library is available from
  10     ftp://ftp.astron.com/pub/file/
  11
  12 The NSS >= 3.12 library for encryption, and NSPR library which NSS uses.
  13 Both NSPR and NSS libraries and headers need to be installed during RPM
  14 compilation. As NSPR and NSS typically install their headers outside
  15 the regular include search path, you need to tell configure about this,
  16 eg something like:
  17     ./configure <......> CPPFLAGS="-I/usr/include/nspr -I/usr/include/nss"
  18
  19 The NSPR and NSS libraries are available from
  20     http://www.mozilla.org/projects/security/pki/nss/
  21     http://www.mozilla.org/projects/nspr/
  22
  23 The Berkeley DB >= 4.3.x (4.5.x or newer recommended) is required for the
  24 default database backend. BDB can be downloaded from
  25 http://www.oracle.com/technology/software/products/berkeley-db/index.html
  26
  27 RPM supports two different ways to include it, both methods have their
  28 distinct advantages and disadvantages:
  29
  30 1) Building and using an internal copy of BDB
  31
  32    This is the "safe" way: upgrades to system BDB can not affect your
  33    rpmdb integrity and you have full control over how BDB is configured.
  34    On the other hand, any updates (security or bugfix) to BDB will require
  35    rebuilding RPM.
  36
  37    To use this method, download a recent version of BDB from the URL above,
  38    expand the tarball into rpm source directory root and create "db" symlink
  39    to it, eg:
  40    $ wget http://download.oracle.com/berkeley-db/db-4.5.20.tar.gz
  41    $ tar xzf db-4.5.20.tar.gz
  42    $ ln -s db-4.5.20 db
  43    $ ./configure [other options...]
  44
  45 2) Linking to external (system) BDB
  46
  47    If you can control when and how system BDB is upgraded, this option
  48    saves space, removes the need to rebuild RPM in case of security etc
  49    updates to BDB and also makes build rpm itself much faster. On the other
  50    hand, major BDB upgrades can be disruptive, especially if
  51    the on-disk format changes somehow.
  52
  53    To use this method, simply pass in --with-external-db to ./configure
  54    script. If the system BDB is installed outside compiler + linker default
  55    paths, you can use CPPFLAGS and LDFLAGS to tell configure where to look,
  56    for example:
  57
  58    $ ./configure --with-external-db CPPFLAGS=-I/usr/include/db45
  59
  60 Minimal instructions for building BDB are
  61     cd build_unix
  62     ../dist/configure --with-posixmutexes
  63     make
  64     make install
  65
  66 For embedded Lua scripting support (recommended and enabled by default),
  67 you'll need Lua >= 5.1 library + development environment installed.
  68 Note that only the library is needed at runtime, RPM never calls external
  69 Lua interpreter for anything. Lua is available from
  70     http://www.lua.org
  71
  72 If SELinux support is desired, it can be enabled with --with-selinux option
  73 to configure and libselinux development environment installed. SELinux
  74 is available from
  75     http://www.nsa.gov/selinux/
  76
  77 It may be desired to install bzip2, gzip, and xz/lzma so that RPM can use these
  78 formats.  Gzip is necessary to build packages that contain compressed
  79 tar balls, these are quite common on the Internet.
  80 These are availible from
  81     http://www.gzip.org
  82     http://www.bzip.org
  83     http://tukaani.org/xz/
  84
  85 If you want to build the Python bindings to RPM library, it can be enabled
  86 with --enable-python option to configure. You'll need to have Python (>= 2.3)
  87 runtime and C API development environment installed, this is available from
  88     http://www.python.org/
  89
  90 To enable POSIX.1e draft 15 file capabilities support, configure with
  91 --with-cap. You'll also need recent libcap, available from:
  92     http://ftp.kernel.org/pub/linux/libs/security/linux-privs/libcap2/
  93
  94 To enable POSIX 1003.1e draft 17 ACL verification support, configure with
  95 --with-acl. You'll also need the ACL library, available from:
  96     ftp://oss.sgi.com/projects/xfs/cmd_tars/
  97
  98 For best results you should compile with GCC and GNU Make.  Users have
  99 reported difficulty with other build tools (any patches to lift these
 100 dependencies are welcome). Both GCC and GNU Make available from
 101     http://www.gnu.org/
 102
 103 If National Language Support (NLS) is desired you will need gnu
 104 gettext (currently this is required to build rpm but we hope to
 105 lift this requirement soon), available from
 106     http://www.gnu.org/
 107
 108 If you are going to hack the sources (or compile from source repository)
 109 you will need most of the GNU development tools including:
 110 autoconf, automake, gettext, libtool, makeinfo, perl, GNU m4, GNU tar
 111 available from
 112     http://www.gnu.org/
 113
 114 RPM distribution tarballs come with doxygen generated HTML documentation
 115 for the public RPM API, but if you want to generate documentation for
 116 the entire source including internal API's, use --enable-hackingdocs
 117 configure option. Doxygen is needed for this, it's available at
 118     http://www.stack.nl/~dimitri/doxygen/
 119
 120 If you plan on using cryptographic signatures you will need a version
 121 of GPG, available from
 122     http://www.gnupg.org/
 123
 124 To compile RPM:
 125 --------------
 126
 127 RPM uses a small shell script to run: libtool, autoconf,
 128 automake. This step should not be necessary if you are running a
 129 released version of rpm, however if you have gotten the rpm sources
 130 directly from the source code repository, you need to generate
 131 intermediate files by running the autogen.sh script.
 132
 133 The autogen.sh script checks that the required tools are installed.
 134 The autogen.sh script also runs configure for you and passes the command line
 135 arguments to configure.  To run it without configure type:
 136
 137     ./autogen.sh --noconfigure
 138
 139 If your libraries are not in a standard place you will need to change
 140 configures environment.  These options can be passed directly to
 141 configure or to autogen.sh which will pass them through to configure.
 142
 143 Here is an example:
 144     LIBS='-L/opt/libz/ -L/opt/BerkeleyDB/lib/' \
 145     CPPFLAGS='-I/opt/libz/ -I/opt/BerkeleyDB/include' \
 146     ./configure
 147
 148 If you have build tools stored in non standard places you should check
 149 the resulting Makefile to be sure that the tools you wish to use have
 150 been correctly identified.  The configure script will modify your path
 151 before looking for the build tools and it may find versions of these
 152 tools that you do not want.  It uses the following search path
 153
 154     MYPATH="/bin:/usr/bin:/usr/local/bin:$PATH:/opt/gnu/bin"
 155
 156 now build the system with:
 157
 158     make
 159
 160 and then install with:
 161
 162     make install
 163
 164 Rpm comes with an automated self-test suite. The test-suite relies heavily
 165 on fakechroot (https://github.com/fakechroot/) and cannot be executed
 166 without it. Provided that fakechroot was found during configure,
 167 it can be executed after a succesful build with:
 168
 169     make check
 170
 171 Finally, if you wish to prepare an rpm source tar ball, you should do
 172
 173     make dist
 174
 175 To package RPM:
 176 --------------
 177
 178 After RPM has been installed you can run rpm to build an rpm package.
 179 Edit the rpm.spec file to mirror any special steps you needed to
 180 follow to make rpm compile and change the specfile to match your
 181 taste.  You will need to put the rpm source tar file into the
 182 SOURCES directory and we suggest putting the specfile in the
 183 SPECS directory, then run rpmbuild -ba rpm.spec.  You will end up
 184 with two rpms which can be found in RPMS and SRPMS.
 185
 186 If you are going to install rpm on machines with OS package managers
 187 other then rpm, you may choose to install the base rpm package via a
 188 cpio instead of a tar file.  Instead of running "make tar" during the
 189 build process, as discribed above, use the base rpm packages to create
 190 a cpio.  After the rpms have been created run rpm2cpio on the base rpm
 191 package, this will give you a cpio package which can then use to
 192 install rpm on a new system.
 193
 194     rpm2cpio rpm-4.0-1.solaris2.6-sparc.rpm > rpm-4.0-1.solaris2.6-sparc.cpio
 195
 196
 197 Non Linux Configuration Issues:
 198 ------------------------------
 199
 200
 201 OS dependencies:
 202 ----------------
 203
 204 Under RPM based Linux distributions all libraries (in fact all files
 205 distributed with the OS) are under RPM control and this section is not
 206 an issue.
 207
 208 RPM will need to be informed of all the dependencies which were
 209 satisfied before RPM was installed.  Typically this only refers to
 210 libraries that are installed by the OS, but may include other
 211 libraries and packages which are availible at the time RPM is
 212 installed and will not under RPM control.  Another common example of
 213 libraries which may need dependency provisions are precompiled
 214 libraries which are installed by the OS package manager during system
 215 build time.  The list of dependencies you will wish to load into RPM
 216 will depend on exactly how you bootstrap RPM onto your system and what
 217 parts of the sytem you put into packages as well as on the specific OS
 218 you are using.
 219
 220 The script vpkg-provides.sh can be used to generate a package which
 221 will satisfy the dependencies on your system.  To run it you will need
 222 to create a specfile header for this empty package and run the progam
 223 with:
 224
 225     --spec_header '/path/to/os-base-header.spec
 226
 227 and if you wish to ensure that some directories are not traversed you
 228 can use the option:
 229
 230     --ignore_dirs 'grep-E|pattern|of|paths|to|ignore
 231
 232 By default the generated rpm will include a %verifyscript to verify
 233 checksum of all files traversed has not changed.  This additional
 234 check can be surpressed with:
 235
 236     --no_verify
 237
 238 The result of running the script will be a specfile which will create
 239 a package continging all the dependencies found on the system.  There
 240 will be one provides line for each depednecy. The package will contain
 241 none of the actual OS library files as it is assumed they are already
 242 on your system and managed by other means.  Here is a example
 243 (truncated) of the provides lines used by one user of Digital Unix. (I
 244 have put several provides on the same line for brevity)
 245
 246 provides: /bin/sh /usr/bin/ksh /usr/bin/csh
 247 provides: libc.so.osf.1 libm.so.osf.1 libcurses.so.xpg4 libdb.so.osf.1
 248 provides: libX11.so libXaw.so.6.0 libXext.so libXm.so.motif1.2 libXmu.so
 249 provides: libdnet_stub.so.osf.1 libsecurity.so.osf.1 libpthread.so.osf.1
 250 provides: libexc.so.osf.1 libmach.so.osf.1 libdps.so libdpstk.so
 251
 252
 253 The script vpkg-provides2.sh is underdevelopment as a more advanced
 254 version of vpkg-provides.sh which is aware of many different unix
 255 vendor packaging schemes.  It will create one "dependency package" for
 256 each unix package your OS vendor installed.
 257
 258
 259 rpmfilename:
 260 -----------
 261
 262 If you plan on packaging for more then one OS you may want to edit
 263 /etc/macros or /usr/lib/rpm/macros and change the line which has
 264 rpmfilename to something which include both the %{_target_os} and
 265 %{_target_cpu}.  This will cause the name of the generated rpm files
 266 to the operating system name as well as the architecture which the rpm
 267 runs under.  The line to change looks like:
 268
 269 %_rpmfilename           %%{ARCH}/%%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm
 270
 271 you may wish to include both the %{_target_os} and %{_target_cpu} in
 272 the final base name, so that it's easier to distinguish between what
 273 package is appropriate for a particular arch-os-version combo.  We
 274 suggest:
 275
 276 %_rpmfilename           %%{_target_platform/%%{NAME}-%%{VERSION}-%%{RELEASE}.%%{_target_platform}.rpm
 277
 278 There is no %{_target_os_version} tag, so if you need to also
 279 distinguish between RPMs for certain versions of the OS, you can
 280 hard-code the version in the rpmrc on the build machine, so that .rpm
 281 files are generated with the version as part of the filename.
 282
 283 For example when one user builds RPMs for Digital Unix 4.0b and 4.0d,
 284 optimization is important and he will build one set of RPMs for the
 285 EV4 processor and another set for the EV56 processor.  He specifies
 286 both the OS version (if it's important, as it is for a few packages)
 287 and the processor version by default by setting a special rpmfilename:
 288 on the particular build machine.
 289
 290 The "rpmfilename: "tag on one machine (Digital Unix 4.0d, EV56 PWS 433)
 291 looks like:
 292
 293 rpmfilename: %{_target_os}/4.0d/%{_target_cpu}/%{name}-%{version}-%{release}.%{_target_os}-%{_target_cpu}ev56.rpm
 294
 295 For package `foo-1.1', at build time that would translate into:
 296
 297     osf1/4.0d/alpha/foo-1.1-1.osf1-alphaev56.rpm
 298
 299 The hyphen between the %{_target_cpu} and ev56 is left out for compatibility
 300 with GNU Config.guess and because `alphaev56' looks more "normal" to
 301 people with an alpha than alpha-ev56 for someone on an Intel Pentium
 302 Pro would want `i586pro' over `i586-pro', but it does make parsing
 303 this filename by other programs a bit more difficult.
 304
 305
 306 GPG
 307 ---
 308
 309 To use the signing features of rpm, you will need to configure certain
 310 rpm macros in ~/.rpmmacros:
 311
 312         %_gpg_name      <GPG UID>
 313         %_gpg_path      %(echo $HOME)/.gnupg
 314