files/catalyst.1

   1 .TH "CATALYST" "1" "August 12, 2004" "Catalyst 1.1.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] ...
  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 Platform (GRP)
  24 sets. \fBcatalyst\fR is also capable of providing a simple tinderbox
  25 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 "\-\-cli " (\fB\-C\fR)
  34 This option is to be used in place of a specfile. All options are passed
  35 to \fBcatalyst\fR on the commandline. Please note that this option must
  36 be the last option passed to \fBcatalyst\fR for everything to work correctly.
  37 .TP
  38
  39 .BR "\-\-config " (\fB\-c\fR)
  40 Tell \fBcatalyst\fR to use a user-defined configuration file. A sample
  41 configuration file is installed at /etc/catalyst/catalyst.conf.
  42 .TP
  43
  44 .BR "\-\-debug " (\fB\-d\fR)
  45 Enable debugging mode
  46 .TP
  47
  48 .BR "\-\-file " (\fB\-f\fR)
  49 Tell \fBcatalyst\fR to use the user supplied specfile.
  50 .TP
  51
  52 .BR "\-\-help " (\fB\-h\fR)
  53 Print the help message and exit
  54 .TP
  55
  56 .BR "\-\-snapshot " (\fB\-s\fR)
  57 Create a Portage snapshot using the specified identifier stamp.
  58 .TP
  59
  60 .BR "\-\-verbose " (\fB\-v\fR)
  61 Enable verbose mode.
  62
  63 .BR "\-\-version " (\fB\-V\fR)
  64 Print the version information and exit
  65 .TP
  66
  67 .SH EXAMPLES
  68 .TP
  69 Using the commandline option (\-C, \-\-cli) to build a Portage snapshot:
  70 catalyst \-C target=snapshot version_stamp=my_date
  71 .TP
  72 Using the specfile option (\-f, \-\-file) to build a stage target:
  73 catalyst \-f stage1\-specfile.spec
  74 .TP
  75 Using the snapshot option (\-s, \-\-snapshot) to package a Portage snapshot using the datestamp 20041006:
  76 catalyst \-s 20041006
  77
  78 .SH FILES
  79 .TP
  80 Example specfiles can be found in /usr/share/doc/catalyst-<version>/examples. An example configuration file can be found at /etc/catalyst/catalyst.conf.
  81
  82 .SH BUGS
  83 .TP
  84 An up-to-date list of Catalyst bugs can always be found listed on the Gentoo Linux bug-tracking system at <http://bugs.gentoo.org>.
  85
  86 .SH SEE ALSO
  87 .TP
  88 A more in-depth examination of Catalyst options and procedures can be found linked from the \fBcatalyst\fR project page, which is located at <http://www.gentoo.org/proj/en/releng/catalyst>.
  89
  90 .SH NOTES
  91 .TP
  92 \fBCatalyst\fR is conceptually derived from the Gentoo livecd-ng and Gentoo stager projects, both of which were used to create pre-1.4 Gentoo releases.
  93 .LP
  94 \fBCatalyst\fR was originally conceived and coded by both Daniel Robbins and John Davis.
  95
  96 .SH AUTHOR
  97 John Davis <zhen@gentoo.org>
  98
  99 .SH "CVS HEADER"
 100 $Id: catalyst.1,v 1.4 2005/12/05 18:13:12 rocket Exp $