doc/catalyst-config.5.txt

   1 CATALYST-CONFIG(5)
   2 ================
   3 :man source:   catalyst {catalystversion}
   4 :man manual:   catalyst {catalystversion}
   5
   6
   7 NAME
   8 ----
   9 catalyst-config - Catalyst configuration files
  10
  11
  12 SYNOPSIS
  13 --------
  14 *catalyst* ['OPTIONS'] *-c* 'FILE'
  15
  16
  17 DESCRIPTION
  18 -----------
  19
  20 *catalyst(1)* reads the configuration file given with `-c` or
  21 `--config` on the command line.  The file contains keyword-argument
  22 pairs using a POSIX Shell variable syntax.  Lines starting with `#`
  23 and empty lines are interpreted as comments.  For example:
  24
  25 ---------------------------------
  26 # /etc/catalyst/catalyst.conf
  27 digests="md5 sha1 sha512 whirlpool"
  28 contents="auto"
  29 distdir="/usr/portage/distfiles"
  30 envscript="/etc/catalyst/catalystrc"
  31 options="autoresume bindist kerncache pkgcache seedcache snapcache"
  32 portdir="/usr/portage"
  33 sharedir="/usr/lib/catalyst"
  34 snapshot_cache="/var/tmp/catalyst/snapshot_cache"
  35 storedir="/var/tmp/catalyst"
  36 ---------------------------------
  37
  38 The possible keywords and their meanings are as follows:
  39
  40 Basic configuration
  41 ~~~~~~~~~~~~~~~~~~~
  42
  43 *digests*::
  44 Create a `.DIGESTS` file containing the hash output from any of the
  45 supported options below.  Adding them all may take a long time.
  46 (example: `md5 sha1 sha512 whirlpool`).  See the *SUPPORTED HASHES*
  47 section for a list of supported hashes.
  48
  49 *contents*::
  50 Create a `.CONTENTS` file listing the contents of the file.  If this
  51 variable is empty, no `.CONTENTS` will be generated at all.  Supported
  52 values:
  53 +
  54 --
  55 auto::
  56 Strongly recommended
  57
  58 tar-tv::
  59 Do `tar tvf FILE`
  60
  61 tar-tvz::
  62 Do `tar tvzf FILE`
  63
  64 tar-tvy::
  65 Do `tar tvyf FILE`
  66
  67 isoinfo-l::
  68 Do `isoinfo -l -i FILE`
  69
  70 isoinfo-f::
  71 Do `isoinfo -f -i FILE`.  'isoinfo-f' is the only option not chosen
  72 by the automatic algorithm.
  73 --
  74
  75 *distdir*::
  76 Distfiles location.  `/usr/portage/distfiles` should work for most
  77 default installations.
  78
  79 *envscript*::
  80 Environment script location, which allows users to set options such as
  81 HTTP proxies, `MAKEOPTS`, `GENTOO_MIRRORS`, or any other environment
  82 variables needed for building.  The envscript file sets environment
  83 variables using POSIX shell notation:
  84 +
  85 ---------------------------------
  86 export FOO="bar"
  87 ---------------------------------
  88
  89 *hash_function*::
  90 Internal hash function catalyst should use for things like autoresume,
  91 seedcache, etc.  The default and fastest is `crc32`.  You should not
  92 ever need to change this unless your OS does not support it.  See the
  93 *SUPPORTED HASHES* section for a list of supported hashes.
  94
  95 **options*::
  96 Set different build-time options (example: `autoresume bindist
  97 kerncache pkgcache seedcache snapcache`).  Supported values:
  98 +
  99 --
 100 autoresume::
 101 Attempt to resume a failed build.  Clear the autoresume flags with the
 102 `-a` option to the catalyst command line.  `-p` will clear the
 103 autoresume flags as well as your pkgcache and kerncache.
 104
 105 bindist::
 106 Enable the `bindist` `USE` flag.  This is recommended if you will be
 107 redistributing builds, but see the package specific definitions for
 108 details.
 109
 110 ccache::
 111 Enable build time ccache support.  WARNING: ccache has been known to
 112 cause random build failures and bugs reported with ccache enabled may
 113 be closed invalid.
 114
 115 distcc::
 116 Enable distcc support for building. You have to set distcc_hosts in
 117 your spec file.
 118
 119 icecream::
 120 Enable icecream compiler cluster support for building.
 121
 122 kerncache::
 123 Keep a copy of the built kernel and modules.  This is useful if your
 124 build dies during `livecd-stage2`.
 125
 126 pkgcache::
 127 Enable `--usepkg` and `--buildpkg` for most *emerge(1)* runs.  This is
 128 useful if your build dies prematurely.  However, you may experience
 129 linking problems.
 130
 131 seedcache::
 132 Use the build output of a previous target if it exists to speed up the
 133 creation of a new stage.  This avoids unpacking the seed tarball.
 134
 135 snapcache::
 136 Cache the snapshot so that it can be bind-mounted into the chroot.
 137 WARNING: moving parts of the portage tree from within fsscript *will*
 138 break your cache.  The cache is unlinked before any empty or rm
 139 processing.
 140 --
 141
 142 *portdir*::
 143 Portage tree location.  `/usr/portage/` should work for most default
 144 installations.
 145
 146 *sharedir*::
 147 Catalyst runtime script location.  `/usr/lib/catalyst` should work for
 148 most default installations.  If you are running catalyst from a Git
 149 checkout, you should change this to point to your checkout directory.
 150
 151 *storedir*::
 152 Location for built seeds, temporary files, and caches (example:
 153 `/var/tmp/catalyst`).
 154
 155 *port_logdir*::
 156 Location for build logs (example: `/var/tmp/catalyst/tmp`).  This dir
 157 will be automatically cleaned of all logs over 30 days old. If left
 158 undefined the logs will remain in the build directory as usual and get
 159 cleaned every time a stage build is restarted.
 160
 161 *var_tmpfs_portage*::
 162 Set the size of a `/var/tmp/portage` tmpfs in gigabytes (example:
 163 `16`).  If set, this mounts a tmpfs for `/var/tmp/portage` so building
 164 takes place in RAM.  This feature requires a pretty large tmpfs
 165 ({open,libre}office needs ~8GB to build).  WARNING: If you use too
 166 much RAM everything will fail horribly and it is not our fault.
 167
 168
 169 SUPPORTED HASHES
 170 ----------------
 171 Supported hashes: adler32, crc32, crc32b, gost, haval128, haval160,
 172 haval192, haval224, haval256, md2, md4, md5, ripemd128, ripemd160,
 173 ripemd256, ripemd320, sha1, sha224, sha256, sha384, sha512, snefru128,
 174 snefru256, tiger, tiger128, tiger160, whirlpool.
 175
 176
 177 FILES
 178 -----
 179 An example configuration file can be found at
 180 `/etc/catalyst/catalyst.conf`.
 181
 182
 183 BUGS
 184 ----
 185 An up-to-date list of Catalyst bugs can always be found listed on the Gentoo
 186 Linux bug-tracking system at `http://bugs.gentoo.org`.
 187
 188
 189 SEE ALSO
 190 --------
 191 *catalyst(1)*
 192 *catalyst-spec(5)*