diff --git a/perl-xCAT/db2man b/perl-xCAT/db2man index 0e3937ba2..283d54acf 100755 --- a/perl-xCAT/db2man +++ b/perl-xCAT/db2man @@ -19,13 +19,24 @@ use Pod::Html; my $poddir = 'pods'; my $mandir = 'share/man'; my $htmldir = 'share/doc'; +my $cachedir = '/tmp'; my $poddir5 = 'pods/man5'; +my $poddir7 = 'pods/man7'; if (system("mkdir -p $poddir5")) { die "Error: could not create $poddir5.\n"; } +if (system("mkdir -p $poddir7")) { die "Error: could not create $poddir7.\n"; } # Build the DB overview page. print "Building PODs pages for the database tables...\n"; -writesummarypage("$poddir5/xcatdb.5.pod", xCAT::Table->getDescriptions()), +writesummarypage("$poddir5/xcatdb.5.pod", xCAT::Table->getDescriptions(), \%{xCAT::Schema::defspec}); + +# Build the pad man page for each object definition +my $defspecref = \%{xCAT::Schema::defspec}; +foreach my $defkey (keys %$defspecref) { + my $def = $defspecref->{$defkey}; + my $attrs = $def->{'attrs'}; + writedefmanpage("$poddir7/$defkey.7.pod", $defkey, $attrs); +} # Build the pod man page for each table. my $tabspecref = \%xCAT::Schema::tabspec; @@ -57,6 +68,8 @@ foreach my $podfile (@pods) { # Build the html page for each pod. #mkdir($htmldir) or die "Error: could not create $htmldir.\n"; print "Converting PODs to HTML pages...\n"; +# have to clear the cache, because old entries can cause a problem +unlink("$cachedir/pod2htmd.tmp", "$cachedir/pod2htmi.tmp"); foreach my $podfile (@pods) { my $htmlfile = $podfile; $htmlfile =~ s/^$poddir/$htmldir/; # change the beginning of the path @@ -77,13 +90,13 @@ sub getPodList { # 1st get toplevel dir listing opendir(DIR, $poddir) or die "Error: could not read $poddir.\n"; - my @topdir = grep !/^\./, readdir(DIR); + my @topdir = grep !/^\./, readdir(DIR); # / close(DIR); # Now go thru each subdir (these are man1, man3, etc.) foreach my $mandir (@topdir) { opendir(DIR, "$poddir/$mandir") or die "Error: could not read $poddir/$mandir.\n"; - my @dir = grep !/^\./, readdir(DIR); + my @dir = grep !/^\./, readdir(DIR); # / close(DIR); foreach my $file (@dir) { push @files, "$poddir/$mandir/$file"; @@ -100,11 +113,11 @@ sub convertpod2html { #TODO: use --css= and --title= to make the pages look better pod2html($podfile, "--outfile=$htmlfile", - "--podpath=man5", + "--podpath=man5:man7", "--podroot=$poddir", "--htmldir=$htmldir", "--recurse", - "--cachedir=/tmp", + "--cachedir=$cachedir", ); } @@ -123,6 +136,7 @@ sub convertpod2man { sub writesummarypage { my $file = shift; # relative path file name of the man page my $descriptions = shift; # a hash containing the description of each table + my $defdescriptions = shift; # a hash containing the description of each object definition open(FILE, ">$file") or die "Error: could not open $file for writing.\n"; @@ -138,6 +152,11 @@ It consists of a series of tables, which are described below. To get more infor particular table, run man for that table name. The tables can be manipulated directly using the B or B commands. They can be viewed using B or B. +Alternatively, the xCAT database can be viewed and edited as logical objects, instead of flat tables. +In this mode, xCAT takes care of which table each attribute should go in. To treat the database +as logical object definitions, use the commands: lsdef, mkdef, chdef, rmdef. See Object Definitions +below. + xCAT allows the use of different database applications, depending on the needs of your cluster. The default database is SQLite, which is a daemonless, zero-config database. But you could instead choose to use something like postgresql for greater scalability and remote access in the @@ -230,18 +249,42 @@ expression B<($1-1)%14+1> will evaluate to 6. See http://www.perl.com/doc/manual/html/pod/perlre.html for information on perl regular expressions. +=head1 OBJECT DEFINITIONS + Because it can get confusing what attributes need to go in what tables, the xCAT database can also -be viewed and edited as logical objects, instead of flat tables. Run B to see the list of -objects supported by xCAT. Use B, B, and B to create, change, and delete objects. +be viewed and edited as logical objects, instead of flat tables. Use B, B, B, +and B to create, change, list, and delete objects. When using these commands, the object attributes will be stored in the same tables, as if you edited the tables by hand. The only difference is that the object commands take care of knowing which tables all of the information should go in. -=head1 TABLES +To run man for any of the object definitions below, use section 7. For example: B + +The object types are: =over 2 EOS1 +foreach my $def (sort keys %$defdescriptions) { + print FILE "\n=item L<$def(7)|$def.7>\n"; +} + + print FILE <<"EOS2"; + +=back + +=head1 TABLES + +To manipulate the tables directly, use B, B, B, B, +B, B. + +To run man for any of the table descriptions below, use section 5. For example: B + +The tables are: + +=over 2 +EOS2 + foreach my $table (sort keys %$descriptions) { print FILE "\n=item L<$table(5)|$table.5>\n\n".$descriptions->{$table}."\n"; } @@ -259,6 +302,89 @@ EOS3 } +# Create the man page for one object definition. +sub writedefmanpage { + my $file = shift; # relative path file name of the man page + my $defname = shift; # name of object + my $attrs = shift; # reference to the array of attributes + + # Go thru the attributes, collecting the descriptions + # Note: this logic is loosely taken from DBobjectdefs.pm + my %attrlist; # holds the attr name as the key, and the description & tables as value + foreach my $this_attr (@$attrs) { + my $attr = $this_attr->{attr_name}; + my $desc = $this_attr->{description}; + my ($table, $at) = split(/\./, $this_attr->{tabentry}); + if (!defined($desc)) { + # description key not there, so go to the corresponding + # entry in tabspec to get the description + my $schema = xCAT::Table->getTableSchema($table); + $desc = $schema->{descriptions}->{$at}; + } + + # Attr names can appear more than once, if they are in multiple tables. + # We will keep track of that based on the table attribute, because that can be duplicated too + if (!defined($attrlist{$attr})) { + $attrlist{$attr}->{'tables'} = []; # initialize the array, so we can check it below + } + my $tableattr = "$table.$at"; + if (!grep(/^$tableattr$/, @{$attrlist{$attr}->{'tables'}})) { + # there can be multiple entries that refer to the same table attribute + # if this is a new table attribute, then save the attr name and description + push @{$attrlist{$attr}->{'tables'}}, $tableattr; + push @{$attrlist{$attr}->{'descriptions'}}, $desc; + } + } + + open(FILE, ">$file") or die "Error: could not open $file for writing.\n"; + + print FILE <<"EOS1"; +=head1 NAME + +B<$defname> - a logical object definition in the xCAT database. + +=head1 SYNOPSIS + +EOS1 + + print FILE "B<$defname Attributes:> I<" . join('>, I<',sort(keys(%attrlist))) . ">\n"; + + print FILE <<"EOS2"; + +=head1 DESCRIPTION + +Logical objects of this type are stored in the xCAT database in one or more tables. Use the following commands +to manipulate the objects: B, B, B, and B. These commands will take care of +knowing which tables the object attributes should be stored in. The attribute list below shows, in +parentheses, what tables each attribute is stored in. + +=head1 $defname Attributes: + +=over 6 + +EOS2 + +foreach my $a (sort keys %attrlist) { + my $d = join("\nor\n", @{$attrlist{$a}->{'descriptions'}}); + $d =~ s/\n/\n\n/sg; # if there are newlines, double them so pod sees a blank line, otherwise pod will ignore them + my $t = '(' . join(', ',@{$attrlist{$a}->{'tables'}}) . ')'; + #print FILE "\nB<$a> - $d\n"; + print FILE "\n=item B<$a> $t\n\n$d\n"; +} + + print FILE <<"EOS3"; + +=back + +=head1 SEE ALSO + +B, B, B, B +EOS3 + + close FILE; +} + + # Create the man page for one table. sub writepodmanpage { my $file = shift; # relative path file name of the man page @@ -276,10 +402,9 @@ B<$tablename> - a table in the xCAT database. =head1 SYNOPSIS -B<$tablename Attributes:> EOS1 -foreach my $a (@$colorder) { print FILE " I<$a>\n"; } + print FILE "B<$tablename Attributes:> I<" . join('>, I<',@$colorder) . ">\n"; print FILE <<"EOS2"; @@ -295,7 +420,7 @@ EOS2 foreach my $a (@$colorder) { my $d = $descriptions->{$a}; - $d =~ s/\n/\n\n/; # if there are newlines, double them so pod sees a blank line, otherwise pod will ignore them + $d =~ s/\n/\n\n/sg; # if there are newlines, double them so pod sees a blank line, otherwise pod will ignore them #print FILE "\nB<$a> - $d\n"; print FILE "\n=item B<$a>\n\n$d\n"; } diff --git a/perl-xCAT/perl-xCAT.spec b/perl-xCAT/perl-xCAT.spec index b022ae884..38f9abb0a 100644 --- a/perl-xCAT/perl-xCAT.spec +++ b/perl-xCAT/perl-xCAT.spec @@ -28,17 +28,10 @@ Includes xCAT::Table, xCAT::NodeRange, among others. # All of the tarball source has been unpacked there and is in the same file structure # as it is in svn. -# Build the pod version of the man pages for each DB table. It puts them in the man5 subdir. -# The convert the pods to man pages and html pages. +# Build the pod version of the man pages for each DB table. It puts them in the man5 and man7 subdirs. +# Then convert the pods to man pages and html pages. ./db2man -# Convert pods to man pages, e.g.: pod2man pods/man5/chain.5.pod share/man/man5/chain.1 -# for i in pods/*/*.pod; do -# man="share/man${i#pods}" # the substitute form is not supported on aix: ${i/pods/share\/man} -# mkdir -p ${man%/*} -# pod2man $i ${man%.pod} -# done - %install # The install phase puts all of the files in the paths they should be in when the rpm is # installed on a system. The RPM_BUILD_ROOT is a simulated root file system and usually @@ -50,6 +43,8 @@ mkdir -p $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/data mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/packages/perl-xCAT mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/man/man5 mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/man5 +mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/man/man7 +mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/man7 cp -r xCAT/* $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/ chmod 644 $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/* @@ -66,6 +61,10 @@ cp share/man/man5/* $RPM_BUILD_ROOT/%{prefix}/share/man/man5 chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/man/man5/* cp share/doc/man5/* $RPM_BUILD_ROOT/%{prefix}/share/doc/man5 chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/doc/man5/* +cp share/man/man7/* $RPM_BUILD_ROOT/%{prefix}/share/man/man7 +chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/man/man7/* +cp share/doc/man7/* $RPM_BUILD_ROOT/%{prefix}/share/doc/man7 +chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/doc/man7/* %clean # This step does not happen until *after* the %files packaging below diff --git a/perl-xCAT/xCAT/Schema.pm b/perl-xCAT/xCAT/Schema.pm index 70ce1bd15..1c5ace1fa 100644 --- a/perl-xCAT/xCAT/Schema.pm +++ b/perl-xCAT/xCAT/Schema.pm @@ -460,9 +460,9 @@ site => { " dhcpinterfaces (network interfaces DHCP should listen on. If same for all nodes, use simple comma-separated list of NICs. Also support: mn|eth1,eth2;service|bond0;compute|eth0)\n". " forwarders (DNS servers at your site that can provide names outside of the cluster)\n". " genpasswords (automatically generate random passwords for BMCs when configuring them)\n". - " defserialport (default if not specified for the node in nodehm table)\n". - " defserialspeed (default if not specified for the node in nodehm table)\n". - " defserialflow (default if not specified for the node in nodehm table)\n", + " defserialport (default serial port - currently only used by mknb)\n". + " defserialspeed (default serial speed - currently only used by mknb)\n". + " defserialflow (default serial flow - currently only used by mknb)\n", value => 'The value of the attribute specified in the "key" column.', comments => 'Any user-written notes.', disable => "Set to 'yes' or '1' to comment out this row.", diff --git a/xCAT-client/pods/man1/chdef.1.pod b/xCAT-client/pods/man1/chdef.1.pod index fd4cecf75..616b30704 100644 --- a/xCAT-client/pods/man1/chdef.1.pod +++ b/xCAT-client/pods/man1/chdef.1.pod @@ -132,4 +132,4 @@ This command is part of the xCAT software product. =head1 SEE ALSO -See the mkdef(1), lsdef(1), rmdef(1), and xcatstanzafile(5) commands. +L, L, L, L diff --git a/xCAT-client/pods/man1/chvm.1.pod b/xCAT-client/pods/man1/chvm.1.pod index a1466c3e7..8a0cb0523 100644 --- a/xCAT-client/pods/man1/chvm.1.pod +++ b/xCAT-client/pods/man1/chvm.1.pod @@ -1,9 +1,9 @@ =head1 NAME - -B - Changes HMC- and IVM-managed partition profiles. - + +B - Changes HMC- and IVM-managed partition profiles. + =head1 SYNOPSIS - + I I @@ -23,9 +23,9 @@ B<-h> Display usage message. B<-p profile> Name of an existing partition profile. -B<-v> Command Version. +B<-v> Command Version. -B<-V> Verbose output. +B<-V> Verbose output. =head1 RETURN VALUE @@ -36,17 +36,17 @@ B<-V> Verbose output. =head1 EXAMPLES -1. To change the partition profile for lpar4 using the configuration data in the file /tmp/lparfile, enter: +1. To change the partition profile for lpar4 using the configuration data in the file /tmp/lparfile, enter: -I +I Output is similar to: lpar4: Success -2. To change the partition profile for lpar4 to the existing profile 'prof1', enter: +2. To change the partition profile for lpar4 to the existing profile 'prof1', enter: -I +I Output is similar to: @@ -54,14 +54,14 @@ lpar4: Success =head1 FILES - + /opt/xcat/bin/chvm -=head1 NOTES +=head1 SEE ALSO + +L, L, L -This command is part of the xCAT software product. - diff --git a/xCAT-client/pods/man1/dumpxCATdb.1.pod b/xCAT-client/pods/man1/dumpxCATdb.1.pod index ab1d96a0c..c7f914117 100644 --- a/xCAT-client/pods/man1/dumpxCATdb.1.pod +++ b/xCAT-client/pods/man1/dumpxCATdb.1.pod @@ -42,10 +42,9 @@ B /opt/xcat/sbin/dumpxCATdb -=head1 NOTES +=head1 SEE ALSO -This command is part of the xCAT software product. -See restorexCATdb +L diff --git a/xCAT-client/pods/man1/genimage.1.pod b/xCAT-client/pods/man1/genimage.1.pod index d4d65acb0..40ef260b2 100644 --- a/xCAT-client/pods/man1/genimage.1.pod +++ b/xCAT-client/pods/man1/genimage.1.pod @@ -1,40 +1,78 @@ =head1 NAME - -B - Generates a stateless image to be used for a diskless install. - + +B - Generates a stateless image to be used for a diskless install. + =head1 SYNOPSIS - -I -I +B B<-i> I B<-n> I B<-o> I B<-p> I [B<-l> I] [B<-r> I] [B<-k> I] - -I +B [B<-h> | B<--help> | B<-v> | B<--version>] =head1 DESCRIPTION -Generates the stateless image . -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. +Generates a stateless image that can be used to boot xCAT nodes in a diskless mode. The packages included +(and excluded) in the image are specified by /opt/xcat/share/xcat/netboot//.pkglist and +/opt/xcat/share/xcat/netboot//.exlist. The generated image will be put in +/install/netboot///. + +The B 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 +/opt/xcat/share/xcat/netboot/ to a system that is the proper architecture, and mount /install from +the management node to that system. + +The B command will run geninitrd automatically. (You can run geninitrd yourself at a later time, if +you want to rebuild the initrd.) After your image is created, you can chroot to the +image, install any additional software you would like, or make modifications to files, and then run +B to prepare the image for deployment. -This uses the package information from the /opt/xcat/share/xcat/netboot/[os] directory files for the profile input. =head1 OPTIONS +=over 12 -B<-h> Display usage message. +=item B<-o> I -B<-v> Command Version. +The operating system for the image: fedora8, rhel5, sles10, etc. The OS packages must be in +/install// (use L). -B<-o> Operating system (fedora8, rhel5, sles10,etc) +=item B<-p> I -B<-p> Profile (compute,service) +The profile (e.g. compute, service) to use to create the image. This determines what package lists are +used from /opt/xcat/share/xcat/netboot/ to create the image with. When deploying nodes with this image, +the nodes' nodetype.profile attribute must be set to this same value. -B<-i> Node Boot Interface (e.g. eth0) +=item B<-i> I -B<-r> Other Interface (e.g. eth0) +The network interface the diskless node will boot over (e.g. eth0). +=item B<-n> I + +The driver modules needed for the network interface. Note: the order that the drivers are specified in +is important. + +=item B<-l> I + +The maximum size allowed for the root file system in the image. Specify in bytes, or can append k, m, or g. + +=item B<-r> I + +Other network interfaces (e.g. eth1) in the image that should be configured via DHCP. + +=item B<-k> I + +Use this flag if you want to use a specific version of the kernel in the image. Defaults to the first kernel found +in the install image. + +=item B<-v|--version> + +Display version. + +=item B<-h|--help> + +Display usage message. + +=back =head1 RETURN VALUE @@ -43,24 +81,29 @@ B<-r> Other Interface (e.g. eth0) 1 An error has occurred. + =head1 EXAMPLES -1. To generate a fedora8 image for a compute node architecture x86_64 and place it in the /install/netboot/fedora8/x86_64/compute/rootimg directory. Change diretory to /opt/xcat/share/xcat/netboot/fedora and run: +=over 3 -I +=item 1. + +To generate a fedora8 image for a compute node architecture x86_64 and place it in the +/install/netboot/fedora8/x86_64/compute/rootimg directory: change directory to +/opt/xcat/share/xcat/netboot/fedora and run: + + genimage -i eth0 -n tg3,bnx2 -o fedora8 -p compute This would use the profile information from the /opt/xcat/share/xcat/netboot/fedora/compute* files. +=back + + =head1 FILES - + /opt/xcat/share/xcat/netboot//genimage -=head1 NOTES - -This command is part of the xCAT software product. - =head1 SEE ALSO -packimage(1) - +L, L \ No newline at end of file diff --git a/xCAT-client/pods/man1/geninitrd.1.pod b/xCAT-client/pods/man1/geninitrd.1.pod new file mode 100644 index 000000000..ffa150a7b --- /dev/null +++ b/xCAT-client/pods/man1/geninitrd.1.pod @@ -0,0 +1,96 @@ +=head1 NAME + +B - Regenerates the initrd for a stateless image to be used for a diskless install. + +=head1 SYNOPSIS + +B B<-i> I B<-n> I B<-o> I B<-p> I [B<-l> I] [B<-k> I] + +B [B<-h> | B<--help> | B<-v> | B<--version>] + + +=head1 DESCRIPTION + +Regenerates the initrd that is part of a stateless image that is used to boot xCAT nodes in a diskless mode. +The generated initrd will be put in /install/netboot///. + +The B 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 +/opt/xcat/share/xcat/netboot/ to a system that is the proper architecture, and mount /install from +the management node to that system. + + +=head1 OPTIONS + +=over 12 + +=item B<-o> I + +The operating system for the image: fedora8, rhel5, sles10, etc. The OS packages must be in +/install// (use L). + +=item B<-p> I + +The profile (e.g. compute, service) to use to create the image. This determines what package lists are +used from /opt/xcat/share/xcat/netboot/ to create the image with. When deploying nodes with this image, +the nodes' nodetype.profile attribute must be set to this same value. + +=item B<-i> I + +The network interface the diskless node will boot over (e.g. eth0). + +=item B<-n> I + +The driver modules needed for the network interface. Note: the order that the drivers are specified in +is important. + +=item B<-l> I + +The maximum size allowed for the root file system in the image. Specify in bytes, or can append k, m, or g. + +=item B<-k> I + +Use this flag if you want to use a specific version of the kernel in the image. Defaults to the first kernel found +in the install image. + +=item B<-v> + +Display version. + +=item B<-h> + +Display usage message. + +=back + + +=head1 RETURN VALUE + +0 The command completed successfully. + +1 An error has occurred. + + +=head1 EXAMPLES + +=over 3 + +=item 1. + +To regenerate the initrd for a fedora8 image for a compute node architecture x86_64 and place it in the +/install/netboot/fedora8/x86_64/compute/rootimg directory: change directory to +/opt/xcat/share/xcat/netboot/fedora and run: + + geninitrd -i eth0 -n tg3,bnx2 -o fedora8 -p compute + +=back + + +=head1 FILES + +/opt/xcat/share/xcat/netboot//geninitrd + + +=head1 SEE ALSO + +L, L \ No newline at end of file diff --git a/xCAT-client/pods/man1/getmacs.1.pod b/xCAT-client/pods/man1/getmacs.1.pod index 8491fdb68..8a95841d4 100644 --- a/xCAT-client/pods/man1/getmacs.1.pod +++ b/xCAT-client/pods/man1/getmacs.1.pod @@ -1,14 +1,14 @@ =head1 NAME - -B - Collects node MAC address. - + +B - Collects node MAC address. + =head1 SYNOPSIS - + I I -I [-f][-d][-S server -G gateway -C client] +I [-f][-d][-S server -G gateway -C client] =head1 DESCRIPTION @@ -20,7 +20,7 @@ Note than on AIX systems, the returned MAC address is not colon-seperated (for e B<-C> IP address of the partition. -B<-d> Display MAC only. The default is to write the first adapter MAC to the xCAT database. +B<-d> Display MAC only. The default is to write the first adapter MAC to the xCAT database. B<-f> Force immediate shutdown of the partition. @@ -28,29 +28,29 @@ B<-G> Gateway IP address of the partition specified with the -C option. B<-h> Display usage message. -B<-S> The IP address of the machine to ping. +B<-S> The IP address of the machine to ping. -B<-v> Command Version. +B<-v> Command Version. -B<-V> Verbose output. +B<-V> Verbose output. =head1 RETURN VALUE 0 The command completed successfully. - + 1 An error has occurred. =head1 EXAMPLES -1. To retrieve the MAC address for the HMC-managed partition lpar4 and write the first adapter MAC to the xCAT database, enter: +1. To retrieve the MAC address for the HMC-managed partition lpar4 and write the first adapter MAC to the xCAT database, enter: -I +I Output is similar to: -lpar4: +lpar4: #Type Location Code MAC Address Full Path Name Ping Result @@ -58,13 +58,13 @@ ent U9133.55A.10B7D1G-V12-C4-T1 8e:e2:24:5c:f0:04 /vdevice/l-lan@30000004 virtu -2. To retrieve the MAC address for the HMC-managed partition lpar4 and display the result only, enter: +2. To retrieve the MAC address for the HMC-managed partition lpar4 and display the result only, enter: -I +I Output is similar to: -lpar4: +lpar4: #Type Location Code MAC Address Full Path Name Ping Result @@ -72,7 +72,7 @@ ent U9133.55A.10B7D1G-V12-C4-T1 8ee2245cf004 /vdevice/l-lan@30000004 virtual -3. To retrieve the MAC address while performing a ping test for the HMC-managed partition lpar4 and display the result only, enter: +3. To retrieve the MAC address while performing a ping test for the HMC-managed partition lpar4 and display the result only, enter: I @@ -81,16 +81,14 @@ I ent U9133.55A.10B7D1G-V12-C4-T1 8e:e2:24:5c:f0:04 /vdevice/l-lan@30000004 successful virtual =head1 FILES - -/opt/xcat/bin/getmac + +/opt/xcat/bin/getmacs -=head1 NOTES +=head1 SEE ALSO + +L -This command is part of the xCAT software product. - - - diff --git a/xCAT-client/pods/man1/gettab.1.pod b/xCAT-client/pods/man1/gettab.1.pod index 77a8dfe56..88b4f6d8b 100644 --- a/xCAT-client/pods/man1/gettab.1.pod +++ b/xCAT-client/pods/man1/gettab.1.pod @@ -73,4 +73,4 @@ The output would be similar to: =head1 SEE ALSO -nodels(1), chtab(1), tabdump(1) +L, L, L diff --git a/xCAT-client/pods/man1/lsdef.1.pod b/xCAT-client/pods/man1/lsdef.1.pod index 4fa539a69..b70cc5d1e 100644 --- a/xCAT-client/pods/man1/lsdef.1.pod +++ b/xCAT-client/pods/man1/lsdef.1.pod @@ -153,4 +153,4 @@ This command is part of the xCAT software product. =head1 SEE ALSO -See the mkdef(1), chdef(1), rmdef(1), and xcatstanzafile(5) commands. \ No newline at end of file +L, L, L, L \ No newline at end of file diff --git a/xCAT-client/pods/man1/lsslp.1.pod b/xCAT-client/pods/man1/lsslp.1.pod index 2204ac9ee..481367c47 100644 --- a/xCAT-client/pods/man1/lsslp.1.pod +++ b/xCAT-client/pods/man1/lsslp.1.pod @@ -131,9 +131,9 @@ Output is similar to: /opt/xcat/bin/lsslp -=head1 NOTES +=head1 SEE ALSO -This command is part of the xCAT software product. +L diff --git a/xCAT-client/pods/man1/lsvm.1.pod b/xCAT-client/pods/man1/lsvm.1.pod index 9e7096861..30ee86c49 100644 --- a/xCAT-client/pods/man1/lsvm.1.pod +++ b/xCAT-client/pods/man1/lsvm.1.pod @@ -58,10 +58,9 @@ Output is similar to: /opt/xcat/bin/lsvm -=head1 NOTES - -This command is part of the xCAT software product. +=head1 SEE ALSO +L, L, L diff --git a/xCAT-client/pods/man1/mkdef.1.pod b/xCAT-client/pods/man1/mkdef.1.pod index 3d96690f3..7b8bb799a 100644 --- a/xCAT-client/pods/man1/mkdef.1.pod +++ b/xCAT-client/pods/man1/mkdef.1.pod @@ -132,4 +132,4 @@ This command is part of the xCAT software product. =head1 SEE ALSO -See the chdef(1), lsdef(1), rmdef(1), and xcatstanzafile(5) commands. \ No newline at end of file +L, L, L, L \ No newline at end of file diff --git a/xCAT-client/pods/man1/mkdsklsnode.1.pod b/xCAT-client/pods/man1/mkdsklsnode.1.pod index fa0042c2d..240baf3ed 100644 --- a/xCAT-client/pods/man1/mkdsklsnode.1.pod +++ b/xCAT-client/pods/man1/mkdsklsnode.1.pod @@ -1,22 +1,22 @@ =head1 NAME - -B - Use this xCAT command to define and initialize AIX/NIM diskless machines. + +B - Use this xCAT command to define and initialize AIX/NIM diskless machines. =head1 SYNOPSIS B -B +B =head1 DESCRIPTION This xCAT command can be used to define and/or initialize AIX/NIM diskless machines. Once this step is completed the xCAT rnetboot command may be used to initiate a network boot of the nodes. - + The command can be used to define and initialize a new NIM machine object or it may be used to reinitialize an existing machine to use a different operating system image. -When creating a new NIM machine definition the default is to use the same name as the xCAT node name that is provided. +When creating a new NIM machine definition the default is to use the same name as the xCAT node name that is provided. -You can use the "-n" option of the mkdsklsnode command to create and initialize an alternate NIM machine definition for the same physical nodes. This option allows you to set up a new image to use when a node is next rebooted while the node is currently running. This is possible because the NIM name for a machine definition does not have to be the hostname of the node. This allows you to have multiple NIM machine definitions for the same physical node. The naming convention for the new NIM machine name is "_", (Ex. "node01_61spot"). Since all the NIM initialization can be done while the node is running the downtime for for the node is reduced to the time it takes to reboot. +You can use the "-n" option of the mkdsklsnode command to create and initialize an alternate NIM machine definition for the same physical nodes. This option allows you to set up a new image to use when a node is next rebooted while the node is currently running. This is possible because the NIM name for a machine definition does not have to be the hostname of the node. This allows you to have multiple NIM machine definitions for the same physical node. The naming convention for the new NIM machine name is "_", (Ex. "node01_61spot"). Since all the NIM initialization can be done while the node is running the downtime for for the node is reduced to the time it takes to reboot. You can use the force option to reinitialize a node if it already has resources allocated or it is in the wrong NIM state. This option will reset the NIM node and deallocate resources before reinititializing. Use this option with caution since reinitializing a node will stop the node if it is currently running. @@ -35,15 +35,15 @@ Valid values: =over 3 -=item B +=item B Specifies the duplex setting (optional). Used when defining the NIM machine. Use this setting to configure the client's network interface. This value can be full or half. The default is full. (ex. "duplex=full") -=item B +=item B Specifies the speed setting (optional). Used when defining the NIM machine. This is the communication speed to use when configuring the client's network interface. This value can be 10, 100, or 1000. The default is 100. (ex. "speed=100") -=item B +=item B Specifies the size in Megabytes of the paging space for the diskless node.(optional) Used when initializing the NIM machine. The minimum and default size is 64 MB of paging space. (ex. "psize=64") @@ -51,7 +51,7 @@ Specifies the size in Megabytes of the paging space for the diskless node.(optio =item B<-f |--force> -Use the force option to reinitialize the NIM machines. +Use the force option to reinitialize the NIM machines. =item B<-h |--help> @@ -79,11 +79,11 @@ Verbose mode. =over 3 -=item 0 +=item 0 The command completed successfully. -=item 1 +=item 1 An error has occurred. @@ -124,8 +124,8 @@ B This command is part of the xCAT software product. -=head1 SEE ALSO +=head1 SEE ALSO -rmdsklsnode(1) +L diff --git a/xCAT-client/pods/man1/mknimimage.1.pod b/xCAT-client/pods/man1/mknimimage.1.pod index 914cf2c44..a17f277df 100644 --- a/xCAT-client/pods/man1/mknimimage.1.pod +++ b/xCAT-client/pods/man1/mknimimage.1.pod @@ -1,6 +1,6 @@ =head1 NAME - -B - Use this xCAT command to create AIX image definitions. + +B - Use this xCAT command to create AIX image definitions. =head1 SYNOPSIS @@ -10,7 +10,7 @@ B -The source of software to use when creating the new NIM lpp_source resource. This could be a source directory, (ex. /dev/cd0), or a previously defined lpp_source resource name. +The source of software to use when creating the new NIM lpp_source resource. This could be a source directory, (ex. /dev/cd0), or a previously defined lpp_source resource name. =item B<-t nimtype> @@ -86,11 +86,11 @@ Verbose mode. =over 3 -=item 0 +=item 0 The command completed successfully. -=item 1 +=item 1 An error has occurred. @@ -118,7 +118,7 @@ This command will use node27 to create a mksysb backup image and use that to def B -This command defines a NIM mksysb resource using mysysbimage. +This command defines a NIM mksysb resource using mysysbimage. 5) Create a diskless image called 61spot using the AIX product media. @@ -141,8 +141,8 @@ B This command is part of the xCAT software product. -=head1 SEE ALSO +=head1 SEE ALSO -rmnimimage(1) +L diff --git a/xCAT-client/pods/man1/mkvm.1.pod b/xCAT-client/pods/man1/mkvm.1.pod index 79ba4e0cb..98c484f65 100644 --- a/xCAT-client/pods/man1/mkvm.1.pod +++ b/xCAT-client/pods/man1/mkvm.1.pod @@ -1,9 +1,9 @@ =head1 NAME - -B - Creates HMC- and IVM-managed partitions. - + +B - Creates HMC- and IVM-managed partitions. + =head1 SYNOPSIS - + I I @@ -22,15 +22,15 @@ The mkvm command creates new partition(s) with the same profile/resources as the B<-h> Display usage message. -B<-c> Copy partitions from srccec to destcec on single HMC. +B<-c> Copy partitions from srccec to destcec on single HMC. -B<-i> Starting numeric id of the newly created partitions. +B<-i> Starting numeric id of the newly created partitions. -B<-n> New partition name. +B<-n> New partition name. -B<-v> Command Version. +B<-v> Command Version. -B<-V> Verbose output. +B<-V> Verbose output. =head1 RETURN VALUE @@ -41,18 +41,18 @@ B<-V> Verbose output. =head1 EXAMPLES -1. To create a new partition lpar5 based on the profile/resources of lpar4, enter: +1. To create a new partition lpar5 based on the profile/resources of lpar4, enter: -I +I Output is similar to: lpar5: Success -2. To create new partitions lpar5-lpar8 based on the profile/resources of lpar4, enter: +2. To create new partitions lpar5-lpar8 based on the profile/resources of lpar4, enter: -I +I Output is similar to: @@ -65,24 +65,23 @@ lpar7: Success lpar8: Success -3. To duplicate all the partitions associated with cec01 on cec02, enter: +3. To duplicate all the partitions associated with cec01 on cec02, enter: -I +I Output is similar to: cec01: Success =head1 FILES - + /opt/xcat/bin/mkvm -=head1 NOTES +=head1 SEE ALSO -This command is part of the xCAT software product. +L, L, L - diff --git a/xCAT-client/pods/man1/monls.1.pod b/xCAT-client/pods/man1/monls.1.pod index 75b5db58d..b9ce4b930 100644 --- a/xCAT-client/pods/man1/monls.1.pod +++ b/xCAT-client/pods/man1/monls.1.pod @@ -79,11 +79,7 @@ The output looks like this: /opt/xcat/bin/monls -=head1 NOTES - -See monstart monstop - -This command is part of the xCAT software product. - +=head1 SEE ALSO +L, L diff --git a/xCAT-client/pods/man1/monstart.1.pod b/xCAT-client/pods/man1/monstart.1.pod index 1d84569ca..64d49fe49 100644 --- a/xCAT-client/pods/man1/monstart.1.pod +++ b/xCAT-client/pods/man1/monstart.1.pod @@ -68,11 +68,9 @@ where 2 is the number of minutes between the pings. /opt/xcat/bin/monstart -=head1 NOTES +=head1 SEE ALSO -See monstop monls - -This command is part of the xCAT software product. +L, L diff --git a/xCAT-client/pods/man1/monstop.1.pod b/xCAT-client/pods/man1/monstop.1.pod index 306cb667a..350154cb3 100644 --- a/xCAT-client/pods/man1/monstop.1.pod +++ b/xCAT-client/pods/man1/monstop.1.pod @@ -1,10 +1,10 @@ =head1 NAME - + B - Stops a monitoring plug-in module to monitor the xCAT cluster. - + =head1 SYNOPSIS - + I I @@ -15,20 +15,20 @@ I =head1 DESCRIPTION -This command is used to unregister a monitoring plug-in module from the I table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. Once unregistered, xCAT will ask the monitoring plug-in to stop the 3rd party software to monitor the xCAT cluster. +This command is used to unregister a monitoring plug-in module from the I table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. Once unregistered, xCAT will ask the monitoring plug-in to stop the 3rd party software to monitor the xCAT cluster. =head1 Parameters -I is the name of the monitoring plug-in module in the I table. +I is the name of the monitoring plug-in module in the I table. =head1 OPTIONS B<-h | -help> Display usage message. -B<-v | -version > Command Version. +B<-v | -version > Command Version. -B<-V | -verbose> Verbose output. +B<-V | -verbose> Verbose output. =head1 RETURN VALUE @@ -43,20 +43,18 @@ B<-V | -verbose> Verbose output. monstop gangliamon -Please note that gangliamon must have been registered in the xCAT I table. For a list of registered plug-in modules, use command I. +Please note that gangliamon must have been registered in the xCAT I table. For a list of registered plug-in modules, use command I. -=head1 FILES - +=head1 FILES + /opt/xcat/bin/monstop -=head1 NOTES +=head1 SEE ALSO + +L, L -See monstart monls - -This command is part of the xCAT software product. - diff --git a/xCAT-client/pods/man1/nimnodeset.1.pod b/xCAT-client/pods/man1/nimnodeset.1.pod index cb36e7c2d..cb2ad2032 100644 --- a/xCAT-client/pods/man1/nimnodeset.1.pod +++ b/xCAT-client/pods/man1/nimnodeset.1.pod @@ -1,12 +1,12 @@ =head1 NAME - -B - Use this xCAT command to initialize AIX/NIM standalone machines. + +B - Use this xCAT command to initialize AIX/NIM standalone machines. =head1 SYNOPSIS B -B +B =head1 DESCRIPTION @@ -33,7 +33,7 @@ val pairs must be specified last on the command line. These are used to specify =item B<-f |--force> -Use the force option to reinitialize the NIM machines. +Use the force option to reinitialize the NIM machines. =item B<-h |--help> @@ -41,7 +41,7 @@ Display usage message. =item B<-i image_name> -The name of an existing xCAT osimage definition. +The name of an existing xCAT osimage definition. =item B @@ -57,11 +57,11 @@ Verbose mode. =over 3 -=item 0 +=item 0 The command completed successfully. -=item 1 +=item 1 An error has occurred. @@ -102,8 +102,8 @@ B This command is part of the xCAT software product. -=head1 SEE ALSO +=head1 SEE ALSO -mknimimage(1), rnetboot(1) +L, L diff --git a/xCAT-client/pods/man1/nodech.1.pod b/xCAT-client/pods/man1/nodech.1.pod index 3faac00cb..25ff470c5 100644 --- a/xCAT-client/pods/man1/nodech.1.pod +++ b/xCAT-client/pods/man1/nodech.1.pod @@ -101,4 +101,4 @@ B< nodech> I =head1 SEE ALSO -nodels(1), nodeadd(1), noderange(5) \ No newline at end of file +L, L, L \ No newline at end of file diff --git a/xCAT-client/pods/man1/nodels.1.pod b/xCAT-client/pods/man1/nodels.1.pod index 0f7ae6873..e6e6f972c 100644 --- a/xCAT-client/pods/man1/nodels.1.pod +++ b/xCAT-client/pods/man1/nodels.1.pod @@ -1,6 +1,6 @@ =head1 NAME -B - lists the nodes in the noderange. +B - lists the nodes, and their attributes, from the xCAT database. =head1 SYNOPSIS @@ -9,43 +9,41 @@ B [I] [B<-H> | B<--with-fieldname>] [I | I [I] [B<-H> | B<--with-fieldname>] [I] -B {B<-v> | B<--version>} - -B [B<-?> | B<-h> | B<--help>] +B [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>] =head1 DESCRIPTION -The nodels command lists the nodes specified in the node range. If no noderange is provided, then all nodes are listed. +The B command lists the nodes specified in the node range. If no noderange is provided, then all nodes are listed. Additional attributes of the nodes will also be displayed if the table names and attribute names are specified after the noderange in the form: I . A few shortcut names can also be used as aliases to common attributes: -=over 10 +=over 15 -=item I +=item B nodelist.groups -=item I +=item B nodelist.groups -=item I +=item B nodehm.mgt -=item I +=item B switch.switch =back -The nodels command with a specific node and one or more table.attribute parameters is a good substitute -for grep'ing through the tab files, like was done in xCAT 1.x. This is because nodels will translate +The B command with a specific node and one or more table.attribute parameters is a good substitute +for grep'ing through the tab files, as was typically done in xCAT 1.x. This is because nodels will translate any regular expression rows in the tables into their meaning for the specified node. The tab* commands -will not do this, instead they will just display the single regular expression row. +will not do this, instead they will just display the regular expression row verbatim. =head1 OPTIONS @@ -58,7 +56,7 @@ Command Version. =item B<-H|--with-fieldname> -Force display table name and column name context for each result +Force display of table name and column name context for each result =item B<-?|-h|--help> @@ -84,9 +82,9 @@ An error has occurred. =head1 EXAMPLES -=over 2 +=over 3 -=item * +=item 1. To list all defined nodes, enter: @@ -98,7 +96,7 @@ Output is similar to: node2 node3 -=item * +=item 2. To list all defined attributes in a table for a node or noderange, enter: @@ -114,7 +112,7 @@ Output is similar to: rra001a: noderes.node: rra001a -=item * +=item 3. To list nodes in node group ppc, enter: @@ -126,7 +124,7 @@ Output is similar to: ppcnode2 ppcnode3 -=item * +=item 4. To list the groups each node is part of: @@ -138,7 +136,7 @@ Output is similar to: node2: groups: all,storage node3: groups: all,blade -=item * +=item 5. To list the groups each node is part of: @@ -150,7 +148,7 @@ Output is similar to: node2: nodehm.power: ipmi node3: nodehm.power: ipmi -=item * +=item 6. To list the out-of-band mgt method for blade1: @@ -170,5 +168,5 @@ Output is similar to: =head1 SEE ALSO -noderange(5) +L, L, L diff --git a/xCAT-client/pods/man1/noderm.1.pod b/xCAT-client/pods/man1/noderm.1.pod index 7e2dabfd4..8516864de 100644 --- a/xCAT-client/pods/man1/noderm.1.pod +++ b/xCAT-client/pods/man1/noderm.1.pod @@ -1,10 +1,10 @@ =head1 NAME - + B -Removes the nodes in the noderange from all database table. - + =head1 SYNOPSIS - -I + +I @@ -13,7 +13,7 @@ I =head1 DESCRIPTION - The noderm command removes the nodes in the input node range. + The noderm command removes the nodes in the input node range. =head1 OPTIONS @@ -30,19 +30,19 @@ B<-h> Display usage message. =head1 EXAMPLES -1. To remove the nodes in noderange node1-node4, enter: +1. To remove the nodes in noderange node1-node4, enter: -I +I =head1 FILES - + /opt/xcat/bin/noderm -=head1 NOTES +=head1 SEE ALSO + +L, L, L -This command is part of the xCAT software product. - diff --git a/xCAT-client/pods/man1/packimage.1.pod b/xCAT-client/pods/man1/packimage.1.pod index 91671bcaa..78c2e5df0 100644 --- a/xCAT-client/pods/man1/packimage.1.pod +++ b/xCAT-client/pods/man1/packimage.1.pod @@ -1,9 +1,9 @@ =head1 NAME - -B - Packs the stateless image from the chroot file system. - + +B - Packs the stateless image from the chroot file system. + =head1 SYNOPSIS - + I I @@ -14,10 +14,10 @@ I =head1 DESCRIPTION -Packs the stateless image from the chroot file system into a file system to be +Packs the stateless image from the chroot file system into a file system to be 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. +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. @@ -26,15 +26,15 @@ This uses the package information from the /opt/xcat/share/xcat/netboot/[os] dir B<-h> Display usage message. -B<-v> Command Version. +B<-v> Command Version. -B<-o> Operating system (fedora8, rhel5, sles10,etc) +B<-o> Operating system (fedora8, rhel5, sles10,etc) -B<-p> Profile (compute,service) +B<-p> Profile (compute,service) -B<-a> Architecture (ppc64,x86_64,etc) +B<-a> Architecture (ppc64,x86_64,etc) -B<-m> Method (default cpio) +B<-m> Method (default cpio) =head1 RETURN VALUE @@ -45,14 +45,14 @@ B<-m> Method (default cpio) =head1 EXAMPLES -1. To pack a fedora8 image for a compute node architecture x86_64 and place it in the /install/netboot/fedora8/x86_64/compute/rootimg directory enter: +1. To pack a fedora8 image for a compute node architecture x86_64 and place it in the /install/netboot/fedora8/x86_64/compute/rootimg directory enter: -I +I This would use the package information from the /opt/xcat/share/xcat/netboot/fedora/compute* files. =head1 FILES - + /opt/xcat/sbin/packimage @@ -62,6 +62,6 @@ This command is part of the xCAT software product. =head1 SEE ALSO -genimage(1) +L + - diff --git a/xCAT-client/pods/man1/pcons.1.pod b/xCAT-client/pods/man1/pcons.1.pod index 17642f118..faf362fc9 100644 --- a/xCAT-client/pods/man1/pcons.1.pod +++ b/xCAT-client/pods/man1/pcons.1.pod @@ -26,8 +26,8 @@ Runs the a command to the noderange using the console. -=head1 AUTHOR +=head1 SEE ALSO -Egan Ford Eegan@us.ibm.comE +L diff --git a/xCAT-client/pods/man1/pping.1.pod b/xCAT-client/pods/man1/pping.1.pod index 159dddd6c..261024cd3 100644 --- a/xCAT-client/pods/man1/pping.1.pod +++ b/xCAT-client/pods/man1/pping.1.pod @@ -49,8 +49,7 @@ B<-v | version> version node2: noping -=head1 AUTHOR - -Egan Ford Eegan@us.ibm.comE +=head1 SEE ALSO +L diff --git a/xCAT-client/pods/man1/ppping.1.pod b/xCAT-client/pods/man1/ppping.1.pod index 5fc261532..70a169864 100644 --- a/xCAT-client/pods/man1/ppping.1.pod +++ b/xCAT-client/pods/man1/ppping.1.pod @@ -45,8 +45,7 @@ B<-v | version> version -=head1 AUTHOR - -Egan Ford Eegan@us.ibm.comE +=head1 SEE ALSO +L, L diff --git a/xCAT-client/pods/man1/rbeacon.1.pod b/xCAT-client/pods/man1/rbeacon.1.pod index 6b610a00c..7f2de147d 100644 --- a/xCAT-client/pods/man1/rbeacon.1.pod +++ b/xCAT-client/pods/man1/rbeacon.1.pod @@ -26,10 +26,4 @@ B Turns beacon (a light on the front of the physical server) on/off/bli =head1 SEE ALSO -noderange(3), rpower(1) - -=head1 AUTHOR - -Egan Ford Eegan@us.ibm.comE - - +L, L diff --git a/xCAT-client/pods/man1/rbootseq.1.pod b/xCAT-client/pods/man1/rbootseq.1.pod index a859c6556..a7635f06a 100644 --- a/xCAT-client/pods/man1/rbootseq.1.pod +++ b/xCAT-client/pods/man1/rbootseq.1.pod @@ -79,10 +79,5 @@ Display the current boot sequence. =head1 SEE ALSO -rsetboot(1) - -=head1 AUTHOR - -Egan Ford Eegan@us.ibm.comE - +L diff --git a/xCAT-client/pods/man1/rcons.1.pod b/xCAT-client/pods/man1/rcons.1.pod index 0c05c880f..dae6950fb 100644 --- a/xCAT-client/pods/man1/rcons.1.pod +++ b/xCAT-client/pods/man1/rcons.1.pod @@ -39,10 +39,6 @@ method. B I -=head1 B - -Egan Ford - =head1 B B -B, L, B +L diff --git a/xCAT-client/pods/man1/regnotif.1.pod b/xCAT-client/pods/man1/regnotif.1.pod index 0bf03427d..59b33555a 100644 --- a/xCAT-client/pods/man1/regnotif.1.pod +++ b/xCAT-client/pods/man1/regnotif.1.pod @@ -1,10 +1,10 @@ =head1 NAME - + B - Registers a Perl module or a command that will get called when changes occur in the desired xCAT database tables. - - + + =head1 SYNOPSIS - + I I @@ -20,19 +20,19 @@ This command is used to register a Perl module or a command to the xCAT notifica =head1 Parameters -I is the full path name of the Perl module or command to be registered. -I is the name of the table that the user is interested in. +I is the full path name of the Perl module or command to be registered. +I is the name of the table that the user is interested in. =head1 OPTIONS B<-h | -help> Display usage message. -B<-v | -version > Command Version. +B<-v | -version > Command Version. -B<-V | -verbose> Verbose output. +B<-V | -verbose> Verbose output. -B<-o | -operation> specifies the database table actions that the user is interested in. It is a comma separated list. 'a' for row addition, 'd' for row deletion and 'u' for row update. +B<-o | -operation> specifies the database table actions that the user is interested in. It is a comma separated list. 'a' for row addition, 'd' for row deletion and 'u' for row update. =head1 RETURN VALUE @@ -45,21 +45,17 @@ B<-o | -operation> specifies the database table actions that the user is int 1. To register a Perl module that gets invoked when rows get added or deleted. in the nodelist and the nodehm tables, enter: regnotif /opt/xcat/lib/perl/xCAT_monitoring/mycode.pm nodelist,nodhm -o a,d - + 2. To register a command that gets invoked when rows get updated in the switch table, enter: regnotif /usr/bin/mycmd switch -o u =head1 FILES - + /opt/xcat/bin/regnotif -=head1 NOTES +=head1 SEE ALSO -See unregnotif +L -This command is part of the xCAT software product. - - - diff --git a/xCAT-client/pods/man1/replaycons.1.pod b/xCAT-client/pods/man1/replaycons.1.pod new file mode 100644 index 000000000..9142cc1fa --- /dev/null +++ b/xCAT-client/pods/man1/replaycons.1.pod @@ -0,0 +1,82 @@ +=head1 NAME + +B - replay the console output for a node + + +=head1 SYNOPSIS + +B [I] [I] [I] + +B [B<-h> | B<--help> | B<-v> | B<--version>] + + +=head1 DESCRIPTION + +The B command reads the console log stored by conserver for this node, and displays it +in a way that simulates the original output of the console. Using the I value, it will throttle +the speed of the output play back. (The conserver logs are stored in /var/log/consoles.) + +For now, replaycons must be run locally on the system on which the console log is stored. This is normally +that management node, but in a hierarchical cluster will usually be the service node. + + +=head1 OPTIONS + +=over 10 + +=item I] + +The display rate to use to play back the console output. Default is 19200. + +=item I + +The place in the console log file to start play back, specified as the # of lines from the end. + +=item B<-v|--version> + +Command Version. + +=item B<-h|--help> + +Display usage message. + +=back + + +=head1 RETURN VALUE + +=over 3 + +=item 0 + +The command completed successfully. + +=item 1 + +An error has occurred. + +=back + + +=head1 EXAMPLES + +=over 3 + +=item 1. + +To replay the console for node1 at the default rate, starting 2000 lines from the end: + + replaycons 19200 2000 + +=back + + +=head1 FILES + +/opt/xcat/bin/replaycons + + +=head1 SEE ALSO + +L + diff --git a/xCAT-client/pods/man1/restorexCATdb.1.pod b/xCAT-client/pods/man1/restorexCATdb.1.pod index daa2b83a3..79179c860 100644 --- a/xCAT-client/pods/man1/restorexCATdb.1.pod +++ b/xCAT-client/pods/man1/restorexCATdb.1.pod @@ -42,10 +42,8 @@ B /opt/xcat/sbin/restorexCATdb -=head1 NOTES - -This command is part of the xCAT software product. -See dumpxCATdb +=head1 SEE ALSO +L diff --git a/xCAT-client/pods/man1/reventlog.1.pod b/xCAT-client/pods/man1/reventlog.1.pod index 6578a5508..3fd9c7e78 100644 --- a/xCAT-client/pods/man1/reventlog.1.pod +++ b/xCAT-client/pods/man1/reventlog.1.pod @@ -61,6 +61,6 @@ B I I node4: clear node5: clear -=head1 B +=head1 SEE ALSO -rpower(1), monstart(1) +L, L diff --git a/xCAT-client/pods/man1/rinv.1.pod b/xCAT-client/pods/man1/rinv.1.pod index a0e460e81..5c336ff64 100644 --- a/xCAT-client/pods/man1/rinv.1.pod +++ b/xCAT-client/pods/man1/rinv.1.pod @@ -84,11 +84,13 @@ Print version. =head1 B +=over 4 + =item * To retrieve all information available from blade node4, enter: -B I I + rinv node5 all node5: Machine Type/Model 865431Z node5: Serial Number 23C5030 @@ -115,12 +117,14 @@ B I I To retrieve 'config' information from the HMC-managed LPAR node3, enter: -B I I + rinv node3 config node5: Machine Configuration Info node5: Number of Processors: 1 node5: Total Memory (MB): 1024 -=head1 B +=back -rpower(1) +=head1 SEE ALSO + +L diff --git a/xCAT-client/pods/man1/rmdef.1.pod b/xCAT-client/pods/man1/rmdef.1.pod index 2a07dbdac..ad17fe14b 100644 --- a/xCAT-client/pods/man1/rmdef.1.pod +++ b/xCAT-client/pods/man1/rmdef.1.pod @@ -99,4 +99,4 @@ This command is part of the xCAT software product. =head1 SEE ALSO -See the mkdef(1), chdef(1), lsdef(1), and xcatstanzafile(5) commands. \ No newline at end of file +L, L, L, L \ No newline at end of file diff --git a/xCAT-client/pods/man1/rmdsklsnode.1.pod b/xCAT-client/pods/man1/rmdsklsnode.1.pod index d2e0e1ce9..6cd0ff532 100644 --- a/xCAT-client/pods/man1/rmdsklsnode.1.pod +++ b/xCAT-client/pods/man1/rmdsklsnode.1.pod @@ -1,20 +1,20 @@ =head1 NAME - -B - Use this xCAT command to remove AIX/NIM diskless machine definitions. + +B - Use this xCAT command to remove AIX/NIM diskless machine definitions. =head1 SYNOPSIS B -B +B =head1 DESCRIPTION -Use this command to remove all NIM machine names that were created for the specified xCAT nodes. +Use this command to remove all NIM machine names that were created for the specified xCAT nodes. The xCAT node definitions will not be removed. -The default is to assume that the NIM machine names are the same as the xCAT node names. If you had used the "-n" option when you created the NIM machine definitions with the mkdsklsnode command then the NIM machine names would be a combination of the xCAT node name and the osimage name used to initialize the NIM machine. To remove these definitions you must provide the name of the osimage that was used. +The default is to assume that the NIM machine names are the same as the xCAT node names. If you had used the "-n" option when you created the NIM machine definitions with the mkdsklsnode command then the NIM machine names would be a combination of the xCAT node name and the osimage name used to initialize the NIM machine. To remove these definitions you must provide the name of the osimage that was used. Use the xCAT rmdef command to remove xCAT node definitions. @@ -24,7 +24,7 @@ Use the xCAT rmdef command to remove xCAT node definitions. =item B<-f |--force> -Use the force option to stop and remove running nodes. This handles the situation where a NIM machine definition indicates that a node is still running even though it is not. +Use the force option to stop and remove running nodes. This handles the situation where a NIM machine definition indicates that a node is still running even though it is not. =item B<-h |--help> @@ -48,11 +48,11 @@ Verbose mode. =over 3 -=item 0 +=item 0 The command completed successfully. -=item 1 +=item 1 An error has occurred. @@ -80,8 +80,8 @@ B This command is part of the xCAT software product. -=head1 SEE ALSO +=head1 SEE ALSO -mkdsklsnode(1) +L diff --git a/xCAT-client/pods/man1/rmnimimage.1.pod b/xCAT-client/pods/man1/rmnimimage.1.pod index cfde89507..59c47da34 100644 --- a/xCAT-client/pods/man1/rmnimimage.1.pod +++ b/xCAT-client/pods/man1/rmnimimage.1.pod @@ -1,12 +1,12 @@ =head1 NAME - -B - Use this xCAT command to remove an xCAT osimage definition and the associated NIM resources. + +B - Use this xCAT command to remove an xCAT osimage definition and the associated NIM resources. =head1 SYNOPSIS B -B +B =head1 DESCRIPTION @@ -40,11 +40,11 @@ Verbose mode. =over 3 -=item 0 +=item 0 The command completed successfully. -=item 1 +=item 1 An error has occurred. @@ -64,6 +64,6 @@ B This command is part of the xCAT software product. -=head1 SEE ALSO +=head1 SEE ALSO -mknimimage(1) +L diff --git a/xCAT-client/pods/man1/rmvm.1.pod b/xCAT-client/pods/man1/rmvm.1.pod index 39ed17c30..d68d5bb2a 100644 --- a/xCAT-client/pods/man1/rmvm.1.pod +++ b/xCAT-client/pods/man1/rmvm.1.pod @@ -1,9 +1,9 @@ =head1 NAME - -B - Removes HMC- and IVM-managed partitions. - + +B - Removes HMC- and IVM-managed partitions. + =head1 SYNOPSIS - + I I @@ -21,9 +21,9 @@ The rmvm command removes the partitions specified in noderange. If noderange is B<-h> Display usage message. -B<-v> Command Version. +B<-v> Command Version. -B<-V> Verbose output. +B<-V> Verbose output. =head1 RETURN VALUE @@ -34,9 +34,9 @@ B<-V> Verbose output. =head1 EXAMPLES -1. To remove the partition lpar3, enter: +1. To remove the partition lpar3, enter: -I +I Output is similar to: @@ -54,14 +54,13 @@ Output is similar to: =head1 FILES - + /opt/xcat/bin/rmvm -=head1 NOTES +=head1 SEE ALSO -This command is part of the xCAT software product. +L, L, L - diff --git a/xCAT-client/pods/man1/rnetboot.1.pod b/xCAT-client/pods/man1/rnetboot.1.pod index b543a5cb7..004c94f76 100644 --- a/xCAT-client/pods/man1/rnetboot.1.pod +++ b/xCAT-client/pods/man1/rnetboot.1.pod @@ -18,7 +18,7 @@ system p nodes. =head1 OPTIONS B<-f> Force immediate shutdown of the partition. - + B<-V> Verbose output. B<-h> Display usage message. @@ -43,3 +43,7 @@ B B + +=head1 SEE ALSO + +L diff --git a/xCAT-client/pods/man1/rpower.1.pod b/xCAT-client/pods/man1/rpower.1.pod index f165a3cec..da81d94a0 100644 --- a/xCAT-client/pods/man1/rpower.1.pod +++ b/xCAT-client/pods/man1/rpower.1.pod @@ -79,6 +79,6 @@ B I =head1 SEE ALSO -noderange(3), rcons(1), rinv(1), rvitals(1), rscan(1) +L, L, L, L, L diff --git a/xCAT-client/pods/man1/rscan.1.pod b/xCAT-client/pods/man1/rscan.1.pod index 678357fd3..9e171d6cc 100644 --- a/xCAT-client/pods/man1/rscan.1.pod +++ b/xCAT-client/pods/man1/rscan.1.pod @@ -1,9 +1,9 @@ =head1 NAME - + B - Collects node information from one or more hardware control points. - + =head1 SYNOPSIS - + I I @@ -16,7 +16,7 @@ I The rscan command lists hardware information for each node managed by the hardware control points specified in noderange. Note that the first line of the output always contains information about the hardware control point itself. When using the rscan command to generate output for HMC or IVM hardware control points, note that FSPs and BPAs are included in the output. - + =head1 OPTIONS @@ -25,15 +25,15 @@ Note that the first line of the output always contains information about the har B<-h> Display usage message. -B<-v> Command Version. +B<-v> Command Version. -B<-V> Verbose output. +B<-V> Verbose output. -B<-w> Writes output to xCAT database. +B<-w> Writes output to xCAT database. -B<-x> XML format. +B<-x> XML format. -B<-z> Stanza formated output. +B<-z> Stanza formated output. =head1 RETURN VALUE @@ -44,9 +44,9 @@ B<-z> Stanza formated output. =head1 EXAMPLES -1. To list all nodes managed by HMC hmc01 in tabular format, enter: +1. To list all nodes managed by HMC hmc01 in tabular format, enter: -I +I Output is similar to: @@ -61,7 +61,7 @@ Output is similar to: lpar p6vios 1 9117-MMA 10F6F3D -2. To list all nodes managed by IVM ivm02 in XML format and write the output to the xCAT database, enter: +2. To list all nodes managed by IVM ivm02 in XML format and write the output to the xCAT database, enter: I @@ -125,7 +125,7 @@ Output is similar to: groups=bpa,all mgt=hmc - Server-9119-590-SN02C5F9E: + Server-9119-590-SN02C5F9E: objtype=node type=fsp id=10 @@ -163,15 +163,12 @@ Output is similar to: =head1 FILES - + /opt/xcat/bin/rscan -=head1 NOTES +=head1 SEE ALSO -This command is part of the xCAT software product. - - - +L diff --git a/xCAT-client/pods/man1/rsetboot.1.pod b/xCAT-client/pods/man1/rsetboot.1.pod index 2644e4db5..2f36fcd8d 100644 --- a/xCAT-client/pods/man1/rsetboot.1.pod +++ b/xCAT-client/pods/man1/rsetboot.1.pod @@ -49,10 +49,4 @@ Display the current boot setting. =head1 SEE ALSO -rsetboot(1) - -=head1 AUTHOR - -Egan Ford Eegan@us.ibm.comE - - +L diff --git a/xCAT-client/pods/man1/rspconfig.1.pod b/xCAT-client/pods/man1/rspconfig.1.pod index 8788258dc..965253663 100644 --- a/xCAT-client/pods/man1/rspconfig.1.pod +++ b/xCAT-client/pods/man1/rspconfig.1.pod @@ -21,7 +21,7 @@ B I B={B|I} B I {B|B|B|B|B} B I B={I