man info for rmosdistro

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@13661 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
immarvin 2012-08-30 10:55:18 +00:00
parent 367ae48231
commit f5eb1bc89c

View File

@ -0,0 +1,72 @@
=head1 NAME
B<rmosdistro> - remove OS Distro
=head1 SYNOPSIS
B<rmosdistro> [{B<-n|--name>}=I<osdistroname>] [B<-f|--force>]
B<rmosdistro> [B<-h>|B<--help>]
=head1 DESCRIPTION
The B<rmosdistro> command is an command to support PCM OS Distro management. It removes the specified OS Distro that was created by B<copycds>. If no osdistroname specified, all entries will be deleted. If the specified OS Distro is referenced by some osimage, B<[-f|force]> can be used to remove it.
=head1 OPTIONS
=over 6
=item {B<-n|--name>}=I<osdistroname>
The OSDistro name to remove. If not specified, try to delete all the OS Distros.
=item {B<-f|--force>}
Remove referenced OS Distros, never prompt.
=item {B<-h|--help>}
Show info of rmosdistro usage.
=back
=head1 RETURN VALUE
Zero:
The command completed successfully.
Nonzero:
An Error has occurred.
=head1 EXAMPLES
=over 2
=item *
To remove OS Distro "rhels6.2-ppc64":
B<rmosdistro rhels6.2-ppc64>
=item *
To remove OS Distro "rhels6.2-ppc64", regardless of whether is referenced by any osimage:
B<rmosdistro -f rhels6.2-ppc64>
=item *
To remove all OS Distros:
B<rmosdistro>
=back