From 8cdb7917c39f6af407c39287383d76d401cb2832 Mon Sep 17 00:00:00 2001
From: linggao <linggao@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Fri, 2 Oct 2009 23:39:55 +0000
Subject: [PATCH] update man pages for nodeset,genimage and packimage with
 osimage

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@4292 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 xCAT-client/pods/man1/genimage.1.pod  | 16 +++++++++++++---
 xCAT-client/pods/man1/packimage.1.pod |  8 +++++++-
 xCAT-client/pods/man8/nodeset.8.pod   |  6 +++++-
 3 files changed, 25 insertions(+), 5 deletions(-)

diff --git a/xCAT-client/pods/man1/genimage.1.pod b/xCAT-client/pods/man1/genimage.1.pod
index dea6bc915..8c2d9f946 100644
--- a/xCAT-client/pods/man1/genimage.1.pod
+++ b/xCAT-client/pods/man1/genimage.1.pod
@@ -6,14 +6,20 @@ B<genimage> - Generates a stateless image to be used for a diskless install.
 
 B<genimage> B<-i> I<nodebootif> B<-n> I<nodenetdrivers> B<-o> I<OS> B<-p> I<profile> [B<-l> I<rootlimit>] [B<-r> I<additional_nics>] [B<-k> I<kernel_version>]
 
+B<genimage> B<-i> I<nodebootif> B<-n> I<nodenetdrivers> B<-o> [B<-l> I<rootlimit>] [B<-r> I<additional_nics>] [B<-k> I<kernel_version>] imagename
+
 B<genimage> [B<-h> | B<--help> | B<-v> | B<--version>]
 
 
 =head1 DESCRIPTION
 
-Generates a stateless image that can be used to boot xCAT nodes in a diskless mode.  The default packages included
+Generates a stateless image that can be used to boot xCAT nodes in a diskless mode.  
+If I<imagename> is not specified, the default packages included
 (and excluded) in the image are specified by /opt/xcat/share/xcat/netboot/<OS>/<profile>.pkglist and
-/opt/xcat/share/xcat/netboot/<OS>/<profile>.exlist. Customized package lists can be specified under /install/custom/netboot/<OS> directory. The generated image will be put in /install/netboot/<OS>/<arch>/<profile>.
+/opt/xcat/share/xcat/netboot/<OS>/<profile>.exlist. 
+Additional packages that are not from the os distro can be specified in a <profile>.otherpkgs.pkglist file.
+Customized package list files can be specified under /install/custom/netboot/<OS> directory. The generated image will be put in /install/netboot/<OS>/<arch>/<profile>.
+If I<imagename> is specified, the package list files are specified in the I<osimage> table and I<linuximage> table. 
 
 The B<genimage> command must be run on a system that is the same architecture as the nodes it will be
 used on.  If the management node is not the same architecture, copy the contents of
@@ -25,6 +31,10 @@ you want to rebuild the initrd.)  After your image is created, you can chroot to
 image, install any additional software you would like, or make modifications to files, and then run
 B<packimage> to prepare the image for deployment.
 
+=head1 Parameters
+
+I<imagename> specifies the name of a os image definition to be used. The specification for the image is storted in the I<osimage> table and I<linuximage> table.
+
 
 =head1 OPTIONS
 
@@ -105,4 +115,4 @@ This would use the profile information from the /opt/xcat/share/xcat/netboot/fed
 
 =head1 SEE ALSO
 
-L<geninitrd(1)|geninitrd.1>, L<packimage(1)|packimage.1>
\ No newline at end of file
+L<geninitrd(1)|geninitrd.1>, L<packimage(1)|packimage.1>
diff --git a/xCAT-client/pods/man1/packimage.1.pod b/xCAT-client/pods/man1/packimage.1.pod
index 29efec147..a69869544 100644
--- a/xCAT-client/pods/man1/packimage.1.pod
+++ b/xCAT-client/pods/man1/packimage.1.pod
@@ -11,6 +11,7 @@ I<packimage  [-v| --version]>
 
 I<packimage [-o OS] [ -p profile] [-a architecture] [-m method]>
 
+I<packimage imagename>
 
 =head1 DESCRIPTION
 
@@ -19,7 +20,12 @@ sent to the node for a diskless install.
 The install dir is setup by using "installdir" attribute set in the site table.
 The nodetype table "profile" attribute for the node should reflect the profile of the install image.
 
-This uses the package information from the /opt/xcat/share/xcat/netboot/[os] directory files for the profile input. However, you can customize the information and store it under /install/custom/netboot/[os] directory. The customized information will be used if any. 
+If no I<imagename> is specified, this command uses the os image definition files from /install/custom/netboot/[os] directory first. If not found, it falls back to the default directory  /opt/xcat/share/xcat/netboot/[os]. 
+If a I<imagename> is specified, this command will get all the necessary os image definition files from the I<osimage> and I<linuximage> tables.
+
+=head1 Parameters
+
+I<imagename> specifies the name of a os image definition to be used. The specification for the image is storted in the I<osimage> table and I<linuximage> table.
 
 =head1 OPTIONS
 
diff --git a/xCAT-client/pods/man8/nodeset.8.pod b/xCAT-client/pods/man8/nodeset.8.pod
index 55c8c5519..e56b87199 100644
--- a/xCAT-client/pods/man8/nodeset.8.pod
+++ b/xCAT-client/pods/man8/nodeset.8.pod
@@ -4,7 +4,7 @@ B<nodeset> - set the boot state for a noderange
 
 =head1 B<Synopsis>
 
-B<nodeset> [I<noderange>] [I<boot>|I<install>|I<stat>|I<iscsiboot>|I<netboot>|I<runcmd=bmcsetup>]
+B<nodeset> [I<noderange>] [I<boot>|I<install>|I<stat>|I<iscsiboot>|I<netboot>|I<runcmd=bmcsetup>|I<osimage=<imagename>>]
 
 B<nodeset> [I<-h>|I<--help>|I<-v>|I<--version>]
 
@@ -44,6 +44,10 @@ Prepare server for installing a node according to the table configuration.  This
 typically mean an unattended install file is created (i.e. kickstart or autoyast),
 install resources will be verified in tftp and the bulk transfer method (http, ftp, or nfs for example), and the boot loader configuration file will be written.
 
+=item B<osimage=<imagename>>
+
+Prepare server for installing a node using the sepcified os image. The os image is defined in the I<osimage> table and I<linuximage> table.  
+
 =item B<stat>
 
 Display the current boot loader config file description for the nodes requested