doc/catalyst.1.txt

   1 CATALYST(1)
   2 ===========
   3 :man source:   catalyst {catalystversion}
   4 :man manual:   catalyst {catalystversion}
   5
   6
   7 NAME
   8 ----
   9 catalyst - The Gentoo Linux Release Engineering meta-tool
  10
  11
  12 SYNOPSIS
  13 --------
  14 *catalyst* ['OPTIONS'] [*-f* 'FILE' | *-C* 'KEY'='VALUE' ... | *-s* 'DATE']
  15
  16
  17 DESCRIPTION
  18 -----------
  19 *catalyst* is the tool that the Gentoo Release Engineering team
  20 utilizes to build all Gentoo Linux releases. It is capable of building
  21 installation stages, bootable LiveCDs, netboot images, and Gentoo Reference
  22 Platform (GRP) sets. *catalyst* is also capable of providing a simple
  23 tinderbox environment for ebuild/package testing.
  24
  25 For more information, please visit the *catalyst* project page
  26 on the web at 'http://www.gentoo.org/proj/en/releng/catalyst'.
  27
  28
  29 OPTIONS
  30 -------
  31 *--clear-autoresume*::
  32 *-a*::
  33 This option is to be used to clear any autoresume points that have been saved
  34 for this target. It is used in conjunction with *-f*, *-C*, or both.
  35
  36 *--cli*|*-C* 'KEY'='VALUE' ...::
  37 This option is to be used in place of a specfile. All options are passed
  38 to *catalyst* on the commandline. Please note that this option must
  39 be the last option passed to *catalyst* for everything to work correctly.
  40
  41 *--config*|*-c* 'FILE'::
  42 Tell *catalyst* to use a user-defined configuration file. A sample
  43 configuration file is installed at '/etc/catalyst/catalyst.conf'.
  44
  45 *--debug*::
  46 *-d*::
  47 Enable debugging mode
  48
  49 *--fetchonly*::
  50 *-F*::
  51 This tells *catalyst* to only fetch distfiles for the given packages without
  52 performing any building.
  53
  54 *--file*|*-f* 'FILE'::
  55 Tell *catalyst* to use the user supplied specfile.
  56
  57 *--help*::
  58 *-h*::
  59 Print the help message and exit
  60
  61 *--purge*::
  62 *-p*::
  63 Tell *catalyst* to clear all temporary directories, package caches, and
  64 autoresume flags for the given target.
  65
  66 *--snapshot*|*-s* 'DATE'::
  67 Create a Portage snapshot using the specified identifier stamp.
  68
  69 *--verbose*::
  70 *-v*::
  71 Enable verbose mode.
  72
  73 *--version*::
  74 *-V*::
  75 Print the version information and exit
  76
  77
  78 EXAMPLES
  79 --------
  80 Using the commandline option (*-C*, *--cli*) to build a Portage snapshot:
  81 ---------------------------------------------------
  82 # catalyst -C target=snapshot version_stamp=my_date
  83 ---------------------------------------------------
  84
  85 Using the specfile option (*-f*, *--file*) to build a stage target:
  86 ---------------------------------------------------
  87 # catalyst -f stage1-specfile.spec
  88 ---------------------------------------------------
  89
  90 Using the snapshot option (*-s*, *--snapshot*) to package a Portage snapshot
  91 using the datestamp 20051208:
  92 ---------------------------------------------------
  93 # catalyst -s 20051208
  94 ---------------------------------------------------
  95
  96
  97 FILES
  98 -----
  99 Example specfiles can be found in '/usr/share/doc/catalyst-{catalystversion}/examples'.
 100 An example configuration file can be found at '/etc/catalyst/catalyst.conf'.
 101
 102
 103 SUPPORTED ARCHITECTURES
 104 -----------------------
 105 The following table shows the list of supported architectures as well as
 106 the list of valid strings for key 'subarch'.
 107
 108 include::subarches.generated.txt[tabsize=4]
 109
 110
 111 BUGS
 112 ----
 113 An up-to-date list of Catalyst bugs can always be found listed on the Gentoo
 114 Linux bug-tracking system at 'http://bugs.gentoo.org'.
 115
 116
 117 NOTES
 118 -----
 119 *catalyst* is conceptually derived from the Gentoo livecd-ng and Gentoo
 120 stager projects, both of which were used to create pre-1.4 Gentoo releases.
 121
 122 *catalyst* was originally conceived and coded by both Daniel Robbins and
 123 John Davis. It is currently maintained by Chris Gianelloni and Eric Edgar and
 124 has been mostly re-written.
 125
 126
 127 AUTHORS
 128 -------
 129 - John Davis <zhen@gentoo.org>
 130 - Chris Gianelloni <wolf31o2@gentoo.org>
 131 - Raul Porcel <armin76@gentoo.org>
 132 - Sebastian Pipping <sping@gentoo.org>
 133 - Matt Turner <mattst88@gentoo.org>
 134
 135
 136 SEE ALSO
 137 --------
 138 *catalyst-spec(5)*
 139
 140 Also, a more in-depth examination of Catalyst options and procedures can be found
 141 linked from the *catalyst* project page, which is located at
 142 'http://www.gentoo.org/proj/en/releng/catalyst'.