arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add and improve manpages

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@1002 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
lissav 2008-04-08 18:03:16 +00:00
parent bc8a229abb
commit 0a99872096
2 changed files with 73 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
xCAT-client-2.0/pods/man1/genimage.1.pod Normal file
View File

@ -0,0 +1,66 @@
=head1 NAME
B<genimage> - Generates a stateless image to be used for a diskless install.
=head1 SYNOPSIS
I<genimage [-h| --help]>
I<genimage [-v| --version]>
I<genimage [-i nodebootif] [ -n nodenetdrivers] [-r additional interfaces] [-o OS] [-p profile]>
=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.
This uses the package information from the /opt/xcat/share/xcat/netboot/[os] directory files for the profile input.
=head1 OPTIONS
B<-h> Display usage message.
B<-v> Command Version.
B<-o> Operating system (fedora8, rhel5, sles10,etc)
B<-p> Profile (compute,service)
B<-i> Node Boot Interface (e.g. eth0)
B<-r> Other Interface (e.g. eth0)
=head1 RETURN VALUE
0 The command completed successfully.
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:
I<genimage -i eth0 -n tg3 -o fedora8 -p compute>
This would use the profile information from the /opt/xcat/share/xcat/netboot/fedora/compute* files.
=head1 FILES
/opt/xcat/share/xcat/netboot/<OS>/genimage
=head1 NOTES
This command is part of the xCAT software product.
=head1 SEE ALSO
packimage(1)

10
xCAT-client-2.0/pods/man1/packimage.1.pod
View File

@ -1,6 +1,6 @@
=head1 NAME
B<packimage> - Builds the stateless image from the chroot file system.
B<packimage> - Packs the stateless image from the chroot file system.
=head1 SYNOPSIS
@ -14,7 +14,8 @@ I<packimage [-o OS] [ -p profile] [-a architecture] [-m method]>
=head1 DESCRIPTION
Builds the stateless image from the chroot file system.
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.
@ -27,7 +28,7 @@ B<-h> Display usage message.
B<-v> Command Version.
B<-o> Operating system (redora8, rhel5, sles10,etc)
B<-o> Operating system (fedora8, rhel5, sles10,etc)
B<-p> Profile (compute,service)
@ -59,5 +60,8 @@ This would use the package information from the /opt/xcat/share/xcat/netboot/fed
This command is part of the xCAT software product.
=head1 SEE ALSO
genimage(1)