files/catalyst.1

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