Fixed up the man page, which has been suffering for some time, and also reversed...

git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/catalyst/trunk@947 d1e1f19c-881f-0410-ab34-b69fee027534

diff --git a/ChangeLog b/ChangeLog
index 1e338b2c659cc5a68d2c9548beeee2ca005b18a0..f24a973282af54cf6a1d19a4fbee879e907acbf4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 # Copyright 2002-2005 Gentoo Foundation; Distributed under the GPL v2
-# $Header: /var/cvsroot/gentoo/src/catalyst/ChangeLog,v 1.434 2005/12/08 03:38:10 wolf31o2 Exp $
+# $Header: /var/cvsroot/gentoo/src/catalyst/ChangeLog,v 1.435 2005/12/08 14:48:58 wolf31o2 Exp $
+
+  08 Dec 2005; Chris Gianelloni <wolf31o2@gentoo.org> catalyst,
+  files/catalyst.1:
+  Fixed up the man page, which has been suffering for some time, and also
+  reversed -v/-V in the help message.
 
   08 Dec 2005; Chris Gianelloni <wolf31o2@gentoo.org>
   targets/support/livecdfs-update.sh:

diff --git a/catalyst b/catalyst
index 006e89e4bbf6826a218eacc5fa49119c7c00851c..4205eedc48ead96a0e0fb28c207955a4fbc16617 100755 (executable)
--- a/catalyst
+++ b/catalyst
@@ -1,7 +1,7 @@
 #!/usr/bin/python
 # Copyright 1999-2005 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo/src/catalyst/catalyst,v 1.110 2005/12/07 21:33:43 wolf31o2 Exp $
+# $Header: /var/cvsroot/gentoo/src/catalyst/catalyst,v 1.111 2005/12/08 14:48:58 wolf31o2 Exp $
 
 # Maintained in full by:
 # Eric Edgar <rocket@gentoo.org>
@@ -25,8 +25,8 @@ def usage():
        print " -h --help               print this help message"
        print " -p --purge              clear tmp dirs,package cache and autoresume flags"
        print " -s --snapshot           generate a Portage snapshot"
-       print " -V --version            display version information"
-       print " -v --verbose            verbose output"
+       print " -v --version            display version information"
+       print " -V --verbose            verbose output"
        print
        print "Usage examples:"
        print
@@ -34,7 +34,7 @@ def usage():
        print "catalyst -C target=snapshot version_stamp=my_date"
        print
        print "Using the snapshot option (-s, --snapshot) to build a Portage snapshot:"
-       print "catalyst -s 2005.0"
+       print "catalyst -s 20051208"
        print
        print "Using the specfile option (-f, --file) to build a stage target:"
        print "catalyst -f stage1-specfile.spec"

diff --git a/files/catalyst.1 b/files/catalyst.1
index c1e431c6f54c28e5e801a0f1b5ca39be9bbe1b96..4154760e61ce0a659bb98d875b368edd65c9c939 100644 (file)
--- a/files/catalyst.1
+++ b/files/catalyst.1
@@ -1,4 +1,4 @@
-.TH "CATALYST" "1" "August 12, 2004" "Catalyst 1.1.0" "Catalyst"
+.TH "CATALYST" "1" "December 8, 2005" "Catalyst 2.0" "Catalyst"
 
 .SH NAME
 catalyst \- The Gentoo Linux Release Engineering meta-tool
@@ -7,7 +7,7 @@ catalyst \- The Gentoo Linux Release Engineering meta-tool
 .TP
 
 .BR catalyst
-[\fIoptions\fR] [\fI\-f file\fR | \fI\-C keys\fR] ...
+[\fIoptions\fR] [\fI\-f file\fR | \fI\-C keys\fR | \fI\-s version_stamp\fR] ...
 .TP
 
 .BR catalyst
@@ -15,14 +15,14 @@ catalyst \- The Gentoo Linux Release Engineering meta-tool
 .TP
 
 .BR catalyst
-\fI\-\-version \-v\fR
+\fI\-\-version \-V\fR
 
 .SH DESCRIPTION
 \fBcatalyst\fR is the tool that the Gentoo Release Engineering team
 utilizes to build all Gentoo Linux releases. It is capable of building
-installation stages, bootable LiveCDs, netboot images, and Gentoo Reference Platform (GRP)
-sets. \fBcatalyst\fR is also capable of providing a simple tinderbox
-environment for ebuild/package testing.
+installation stages, bootable LiveCDs, netboot images, and Gentoo Reference
+Platform (GRP) sets. \fBcatalyst\fR is also capable of providing a simple
+tinderbox environment for ebuild/package testing.
 
 For more information, please visit the \fBcatalyst\fR project page
 on the web at <http://www.gentoo.org/proj/en/releng/catalyst>.
@@ -30,6 +30,11 @@ on the web at <http://www.gentoo.org/proj/en/releng/catalyst>.
 .SH OPTIONS
 .TP
 
+.BR "\-\-clear\-autoresume " (\fB\-a\fR)
+This option is to be used to clear any autoresume points that have been saved
+for this target. It is used in conjunction with \-f, \-C, or both.
+.TP
+
 .BR "\-\-cli " (\fB\-C\fR)
 This option is to be used in place of a specfile. All options are passed
 to \fBcatalyst\fR on the commandline. Please note that this option must
@@ -45,6 +50,11 @@ configuration file is installed at /etc/catalyst/catalyst.conf.
 Enable debugging mode
 .TP
 
+.BR "\-\-fetchonly " (\fB\-F\fR)
+This tells \fBcatalyst\fR to only fetch distfiles for the given packages without
+performing any building.
+.TP
+
 .BR "\-\-file " (\fB\-f\fR)
 Tell \fBcatalyst\fR to use the user supplied specfile.
 .TP
@@ -53,6 +63,11 @@ Tell \fBcatalyst\fR to use the user supplied specfile.
 Print the help message and exit
 .TP
 
+.BR "\-\-purge " (\fB\-p\fR)
+Tell \fBcatalyst\fR to clear all temporary directories, package caches, and
+autoresume flags for the given target.
+.TP
+
 .BR "\-\-snapshot " (\fB\-s\fR)
 Create a Portage snapshot using the specified identifier stamp.
 .TP
@@ -72,29 +87,38 @@ catalyst \-C target=snapshot version_stamp=my_date
 Using the specfile option (\-f, \-\-file) to build a stage target:
 catalyst \-f stage1\-specfile.spec
 .TP
-Using the snapshot option (\-s, \-\-snapshot) to package a Portage snapshot using the datestamp 20041006:
-catalyst \-s 20041006
+Using the snapshot option (\-s, \-\-snapshot) to package a Portage snapshot
+using the datestamp 20051208:
+catalyst \-s 20051208
 
 .SH FILES
 .TP
-Example specfiles can be found in /usr/share/doc/catalyst-<version>/examples. An example configuration file can be found at /etc/catalyst/catalyst.conf.
+Example specfiles can be found in /usr/share/doc/catalyst-<version>/examples.
+An example configuration file can be found at /etc/catalyst/catalyst.conf.
 
 .SH BUGS
 .TP
-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>.
+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>.
 
 .SH SEE ALSO
 .TP
-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>.
+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>.
 
 .SH NOTES
 .TP
-\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.
+\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.
 .LP
-\fBCatalyst\fR was originally conceived and coded by both Daniel Robbins and John Davis.
+\fBCatalyst\fR was originally conceived and coded by both Daniel Robbins and
+John Davis. It is currently maintained by Chris Gianelloni and Eric Edgar and
+hass been mostly re-written.
 
 .SH AUTHOR
 John Davis <zhen@gentoo.org>
+Chris Gianelloni <wolf31o2@gentoo.org>
 
 .SH "CVS HEADER"
-$Id: catalyst.1,v 1.4 2005/12/05 18:13:12 rocket Exp $
+$Id: catalyst.1,v 1.5 2005/12/08 14:48:58 wolf31o2 Exp $