Man page for new mkrrbc, updated manpage for mkrrnodes

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

xCAT-client-2.0/pods/man8/mkrrbc.8.pod

@@ -0,0 +1,78 @@
+=head1 NAME
+
+B<mkrrbc> - Adds or deletes BladeCenter management module and switch nodes in the xCAT cluster database.
+
+
+=head1 SYNOPSIS
+
+B<mkrrbc> [-d ]| [-C a|b|,...,r] -L [Start Rack number for CU] -R [startrange,endrange] [-t|--test]
+
+
+B<mkrrnodes> [B<-h> | B<--help>]
+
+
+=head1 DESCRIPTION
+
+The mkrrbc adds or deletes (-d) the BladeCenter management module and switch nodes requested by inputting the CU name (-C) flag and the start and end range (-R) flag.  It will also automatically define required nodegroups. 
+
+=head1 OPTIONS
+
+
+=over 10
+
+=item B<-h|--help>
+
+Display usage message.
+
+=item B<-t|--test>
+
+Test mode.  The script will print out all the commands that will be run, but will not actually run them.  Useful to verify that the command will create the nodes and groups the way you expect.
+
+=back
+
+
+=head1 RETURN VALUE
+
+=over 3
+
+=item 0
+
+The command completed successfully.
+
+=item 1
+
+An error has occurred.
+
+=back
+
+
+=head1 EXAMPLES
+
+=over 2
+
+=item *
+
+To build a cluster unit of nodelist entries that include nodes like this:
+     "bcd60","mm,cud,rack16",,,
+     "swd60","nortel,switch,cud,rack16",,,
+
+ B<mkrrbc>  -C d -L 2 -R 1,60
+
+
+To delete all the nodelist entries created in the previous step:
+
+B<mkrrbc> -d -C d -L 2 -R 1,60
+
+=item *
+
+
+=back
+
+
+=head1 FILES
+
+/opt/xcat/share/xcat/tools/mkrrbc
+
+See also:
+/opt/xcat/share/xcat/tools/mkrrnodes to create node definitions.
+

xCAT-client-2.0/pods/man8/mkrrnodes.8.pod

@@ -5,7 +5,7 @@ B<mkrrnodes> - Adds or deletes nodes in the xCAT cluster database.
 
 =head1 SYNOPSIS
 
-B<mkrrnodes> [-d ]| [-C a|b|,...,r] -L [Start Rack number for CU] -R [startrange,endrange]
+B<mkrrnodes> [-d ]| [-C a|b|,...,r] -L [Start Rack number for CU] -R [startrange,endrange] [-t|--test]
 
 
 B<mkrrnodes> [B<-h> | B<--help>]
@@ -24,6 +24,10 @@ The mkrrnodes add or delete (-d) the nodes requested by inputting the CU name (-
 
 Display usage message.
 
+=item B<-t|--test>
+
+Test mode.  The script will print out all the commands that will be run, but will not actually run them.  Useful to verify that the command will create the nodes and groups the way you expect.
+
 =back
 
 
@@ -48,13 +52,16 @@ An error has occurred.
 
 =item *
 
-To build a nodelist entry like this "rrb048c","rrb048,qs22,cub,cell,cell-c,cell-cub-c,compute,tb,all,rack20",,,,:
+To build nodelist entries like this:
+   "rrd171a","rrd171,ls21,cud,opteron,opteron-cud,compute,tb,all,rack16,bc57",,,
+   "rrd171b","rrd171,qs22,cud,cell,cell-b,cell-cud-b,cell-cud,compute,all,tb,rack16,bc57",,,
+   "rrd171c","rrd171,qs22,cud,cell,cell-c,cell-cud-c,cell-cud,compute,all,tb,rack16,bc57",,,
 
-B<mkrrnodes> -C b -L 45 -R 048,048
+B<mkrrnodes> -C d -L 2 -R 171,171
 
-To delete a nodelist entry like this "rrb048c","rrb048,qs22,cub,cell,cell-c,cell-cub-c,compute,tb,all,rack20",,,,:
+To delete the nodelist entries created above:
 
-B<mkrrnodes> -d -C b -L 45 -R 048,048
+B<mkrrnodes> -d -C d -L 2 -R 171,171
 
 =item *
 
@@ -66,4 +73,5 @@ B<mkrrnodes> -d -C b -L 45 -R 048,048
 
 /opt/xcat/share/xcat/tools/mkrrnodes
 
+See also /opt/xcat/share/xcat/tools/mkrrbc to create BladeCenter management module and switch node definitions