added manpage for addkit/rmkit/addkitcomp/rmkitcomp/chkkitcomp commands

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@14100 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd

xCAT-client/pods/man1/addkit.1.pod

@@ -0,0 +1,70 @@
+=head1 NAME
+
+B<addkit> - Install a kit on the xCAT management node
+
+=head1 SYNOPSIS
+
+B<addkit> [-h|--help]
+
+B<addkit> [-V|--verbose] [-p|--path <path>] <kitlist>
+
+=head1 DESCRIPTION
+
+The B<addkit> command install a kit on the xCAT management node from a kit tarfile or directory, creating xCAT database definitions for kit, kitrepo, kitcomponent.
+
+=head1 OPTIONS
+
+B<-h|--help>
+
+Display usage message.
+
+B<-V|--verbose>
+
+Verbose mode.
+
+B<-p|--path <path>>
+
+The destination directory to which the contents of the kit tarfiles and/or kit deploy dirs will be copied.  When this option is not specified, the default destination directory will be formed from the installdir site attribute with ./kits subdirectory.
+
+B<kitlist>
+
+a comma delimited list of kit_tarball_files and kit_deploy_dirs that are to be added to the xCAT cluster.  Each entry can be an absolute or relative path.  For kit_tarball_files, these must be valid kits tarfiles added.  For kit_deploy_dirs, these must be fully populated directory structures that are identical to the contents of an expanded kit_tarball_file.
+
+=head1 RETURN VALUE
+
+0  The command completed successfully.
+
+1  An error has occurred.
+
+=head1 EXAMPLES
+
+1. To add two kits from tarball files.
+
+addkit kit-test1.tar.bz2,kit-test2.tar.bz2
+
+Output is similar to:
+
+Kit /kit/kit-test1.tar.bz2,/kit/kit-test2.tar.bz2 was successfully added.
+
+2. To add two kits from directories.
+
+addkit kit-test1,kit-test2
+
+Output is similar to:
+
+Kit /kit/kit-test1,/kit/kit-test2 was successfully added.
+
+3. To add a kit from tarball file to /install/test directory.
+
+addkit -p /install/test kit-test1.tar.bz2
+
+Output is similar to:
+
+Kit /kit/kit-test1.tar.bz2 was successfully added.
+
+
+=head1 SEE ALSO
+
+L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>
+
+

xCAT-client/pods/man1/addkitcomp.1.pod

@@ -0,0 +1,83 @@
+=head1 NAME
+
+B<addkitcomp> - Assign kit components to osimage.
+
+=head1 SYNOPSIS
+
+B<addkitcomp> [-h|--help]
+
+B<addkitcomp> [-a|--adddeps] [-f|--force] [-V|--verbose] -i <osimage> <kitcompname_list>
+
+=head1 DESCRIPTION
+
+The B<addkitcomp> command will assign kit components to osimage. The kit component meta rpm, package rpm and deploy parameters will be added to osimage's otherpkg.pkglist and postbootscripts will be added to osimages's postbootscripts attribute.
+
+=head1 OPTIONS
+
+B<-a|--adddeps>
+
+Assign kitcomponent dependencies to the osimage.
+
+B<-h|--help>
+
+Display usage message.
+
+B<-V|--verbose>
+
+Verbose mode.
+
+B<-f|--force>
+
+Add kit component to osimage even if there is a mismatch in OS, version, arch, serverrole, or kitcompdeps
+
+B<-i <osimage>>
+
+osimage name that kit component is assigning to
+
+B<kitcompname_list>
+
+A comma-delimited list of valid full kit component names or kit component basenames that are to be added to the osimage.
+
+
+=head1 RETURN VALUE
+
+0  The command completed successfully.
+
+1  An error has occurred.
+
+=head1 EXAMPLES
+
+1. To assign a kit component to osimage
+
+addkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
+
+Output is similar to:
+
+Assigning kit component comp-test1-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
+Kit components comp-test1-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
+
+2. To assign a kit component to osimage with its dependency.
+
+addkitcomp -a -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
+
+Output is similar to:
+
+Assigning kit component comp-test1-1.0-1-rhels-6.0-ppc64 to osimage rhels6.2-ppc64-netboot-compute
+Assigning kit component comp-test2-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
+Kit components comp-test1-1.0-1-rhels-6.0-ppc64,comp-test2-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
+
+3. To assign a kit component to osimage with incompatable osarch, osversion or ostype.
+
+addkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
+
+Output is similar to:
+
+Assigning kit component comp-test1-1.0-1-rhels-6.2-ppc64 to osimage rhels6.2-ppc64-netboot-compute
+Kit components comp-test1-1.0-1-rhels-6.2-ppc64 were added to osimage rhels6.2-ppc64-netboot-compute successfully
+
+
+=head1 SEE ALSO
+
+L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<rmkitcomp(1)|rmkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>
+
+

xCAT-client/pods/man1/chkkitcomp.1.pod

@@ -0,0 +1,65 @@
+=head1 NAME
+
+B<chkkitcomp> - Check if kit component fits to osimage.
+
+=head1 SYNOPSIS
+
+B<chkkitcomp> [-h|--help]
+
+B<chkkitcomp> [-o|--overwrite] [-V|--verbose] -i <osimage> <kitcompname_list>
+
+=head1 DESCRIPTION
+
+The B<chkkitcomp> command will check if the kit components are fitting to the osimage or not.  This command will ignore the current osimage.kitcomponents setting, and just to check if the kitcompname_list in the cmdline is fitting to the osimage by osversion/ostype/osarch/ and kit component dependencies.
+
+=head1 OPTIONS
+
+B<-o|--overwrite>
+
+Fully replace the kit component list in osimage.kitcomponents with <kitcompname_list>.
+
+B<-h|--help>
+
+Display usage message.
+
+B<-V|--verbose>
+
+Verbose mode.
+
+B<-i <osimage>>
+
+osimage name that is used for checking if kit components are fitting to it.
+
+B<kitcompname_list>
+
+A comma-delimited list of valid full kit component names or kit component basenames that are to be checking to the osimage.
+
+
+=head1 RETURN VALUE
+
+0  The command completed successfully.
+
+1  An error has occurred.
+
+=head1 EXAMPLES
+
+1. To check if a kit component is fitting to an osimage
+
+chkkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
+
+Output is similar to:
+
+Kit components comp-test1-1.0-1-rhels-6.2-ppc64 fit to osimage rhels6.2-ppc64-netboot-compute
+
+3. To check if a kit component is fitting to an osimage and write the current kitcompname_list specified in command line to osimage.kitcomponents attribute. 
+
+chkkitcomp -o -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
+
+Output is similar to:
+
+kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
+
+
+=head1 SEE ALSO
+
+L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>

xCAT-client/pods/man1/rmkit.1.pod

@@ -0,0 +1,68 @@
+=head1 NAME
+
+Usage:
+        rmkit [-h|--help]
+        rmkit [-f|--force] [-V|--verbose] <kitlist>] 
+
+
+B<addkit> - Remove Kits from xCAT
+
+=head1 SYNOPSIS
+
+B<addkit> [-h|--help]
+
+B<addkit> [-V|--verbose] [-f|--force] <kitlist>
+
+=head1 DESCRIPTION
+
+The B<rmkit> command removes kits on the xCAT management node from kit names.
+
+=head1 OPTIONS
+
+B<-h|--help>
+
+Display usage message.
+
+B<-V|--verbose>
+
+Verbose mode.
+
+B<-f|--force>
+
+Remove this kit even there is any component in this kit is listed by osimage.kitcomponents.  If this option is not specified, this kit will not be removed if any kit components listed in an osimage.kitcomponents
+
+B<kitlist>
+
+a comma delimited list of kits that are to be removed from the xCAT cluster.  Each entry can be a kitname or kit basename. For kit basename, rmkit command will remove all the kits that have that kit basename.
+
+=head1 RETURN VALUE
+
+0  The command completed successfully.
+
+1  An error has occurred.
+
+=head1 EXAMPLES
+
+1. To remove two kits from tarball files.
+
+rmkit kit-test1,kit-test2
+
+Output is similar to:
+
+Kit kit-test1-1.0-Linux,kit-test2-1.0-Linux was successfully removed.
+
+2. To remove two kits from tarball files even the kit components in them are still being used by osimages.
+
+rmkit kit-test1,kit-test2 --force
+
+Output is similar to:
+
+Kit kit-test1-1.0-Linux,kit-test2-1.0-Linux was successfully removed.
+
+
+=head1 SEE ALSO
+
+L<addkit(1)|addkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<rmkitcomp(1)|rmkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>
+
+
+~

xCAT-client/pods/man1/rmkitcomp.1.pod

@@ -0,0 +1,77 @@
+=head1 NAME
+
+B<rmkitcomp> - Remove kit components from osimage.
+
+=head1 SYNOPSIS
+
+B<rmkitcomp> [-h|--help]
+
+B<rmkitcomp> [-u|--uninstall] [-f|--force] [-V|--verbose] -i <osimage> <kitcompname_list>
+
+=head1 DESCRIPTION
+
+The B<rmkitcomp> command removes kit components from osimage.  All the kit component attributes that attached to the osimage will be removed from osimage attributes, and the kit comoponent meta rpm and package rpm could be uninstalled by <-u|--uninstall> option.
+
+=head1 OPTIONS
+
+B<-u|--uninstall>
+
+all the kit component meta rpm and package rpm in otherpkglist will be uninstalled during genimage for stateless image and updatenode for statefull nodes.
+
+B<-h|--help>
+
+Display usage message.
+
+B<-V|--verbose>
+
+Verbose mode.
+
+B<-f|--force>
+
+Remove this kit component from osimage no matter it is a dependency of other kit components.
+
+B<-i <osimage>>
+
+osimage name that include this kit component.
+
+B<kitcompname_list>
+
+A comma-delimited list of valid full kit component names or kit component basenames that are to be removed from the osimage.
+
+
+=head1 RETURN VALUE
+
+0  The command completed successfully.
+
+1  An error has occurred.
+
+=head1 EXAMPLES
+
+1. To remove a kit component from osimage
+
+rmkitcomp -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
+
+Output is similar to:
+
+kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
+
+2. To remove a kit component even it is still used as a dependency of other kit component.
+
+rmkitcomp -f -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
+
+Output is similar to:
+
+kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
+
+3. To remove a kit component from osimage and also remove the kit component meta RPM and package RPM.  So in next genimage for statelss image and updatenode for statefull nodes, the kit component meta RPM and package RPM will be uninstalled.
+
+rmkitcomp -u -i rhels6.2-ppc64-netboot-compute comp-test1-1.0-1-rhels-6.2-ppc64
+
+Output is similar to:
+
+kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
+
+
+=head1 SEE ALSO
+
+L<addkit(1)|addkit.1>, L<rmkit(1)|rmkit.1>, L<addkitcomp(1)|addkitcomp.1>, L<chkkitcomp(1)|chkkitcomp.1>