From c5b4760b84bfd473c6dbbb0274b31f118ac4fde9 Mon Sep 17 00:00:00 2001
From: vallard <vallard@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Thu, 8 Apr 2010 22:24:18 +0000
Subject: [PATCH] man pages for img*port commands

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@5723 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 xCAT-client/pods/man1/imgexport.1.pod | 66 +++++++++++++++++++++++++++
 xCAT-client/pods/man1/imgimport.1.pod | 48 +++++++++++++++++++
 2 files changed, 114 insertions(+)
 create mode 100644 xCAT-client/pods/man1/imgexport.1.pod
 create mode 100644 xCAT-client/pods/man1/imgimport.1.pod

diff --git a/xCAT-client/pods/man1/imgexport.1.pod b/xCAT-client/pods/man1/imgexport.1.pod
new file mode 100644
index 000000000..7ba54f11e
--- /dev/null
+++ b/xCAT-client/pods/man1/imgexport.1.pod
@@ -0,0 +1,66 @@
+=head1 NAME
+
+B<imgexport> - Exports an xCAT image.
+
+=head1 SYNOPSIS
+
+B<imgexport [-h| --help]>
+
+B<imgexport [-v| --verbose] imagename exported_file_name >
+B<imgexport> I<imagename> 
+
+
+=head1 DESCRIPTION
+
+The imgexport command will export an image that is being used by xCAT.  To export images, you must have the images defined in the osimage table. 
+The following columns must be filled out for an image to be exported:
+osimage.imagename
+osimage.profile
+osimage.provmethod
+osimage.osvers
+osimage.osarch
+
+=head1 OPTIONS
+
+
+B<-h>          Display usage message.
+
+B<-v>          Verbose output.
+
+B<-extra srcfile:destdir>      Pack up extra files
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+1. Simplest way to export an image.  If there is an image in the osimage table named 'foo', then run:
+
+B<imgexport foo>
+
+foo.tgz will be built in the current working directory.  Make sure that you have enough space in the directory
+that you are in to run imgexport if you have a big image to tar up.
+
+2. To include extra files with your image:
+
+B<imgexport Default_Stateless_1265981465 foo.tgz --extra=/opt/xcat/share/xcat/netboot/centos/compute.centos5.4.pkglist:/install/custom/netboot/centos --extra=/opt/xcat/share/xcat/netboot/centos/compute.exlist:/install/custom/netboot/centos>
+
+This will export the image Default_stateless_1265981465 into a file called foo.tgz.  In addition, it will package up extra files as well:
+ compute.centos5.4.pkglist
+ compute.exlist
+It will also place the contents of the file in the manifest.xml file that is part of the bundle.
+
+=head1 FILES
+
+/opt/xcat/bin/imgexport
+
+
+=head1 SEE ALSO
+
+L<imgimport(1)|imgimport.1>
+
+
+
diff --git a/xCAT-client/pods/man1/imgimport.1.pod b/xCAT-client/pods/man1/imgimport.1.pod
new file mode 100644
index 000000000..a24e4ee4b
--- /dev/null
+++ b/xCAT-client/pods/man1/imgimport.1.pod
@@ -0,0 +1,48 @@
+=head1 NAME
+
+B<imgimport> - Imports an xCAT image or configuration file into the xCAT tables so that you can immediately begin
+deploying with it..
+
+=head1 SYNOPSIS
+
+B<imgimport [-h| --help]>
+
+B<imgimport> I<imagename> [-v]
+
+=head1 DESCRIPTION
+
+The imgimport command will import an image that has been exported by imgexport from xCAT.  This is the easiest way 
+to transfer/backup/ or share images created by xCAT whether they be stateless or stateful.
+
+=head1 OPTIONS
+
+
+B<-h>          Display usage message.
+
+B<-v>          Verbose output.
+
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+1. Simplest way to import an image.  If there is a bundle file named 'foo.gz', then run:
+
+I<imgimport foo.gz>
+
+foo.tgz will be unpacked in the current working directory.  The xCAT configuration will then be updated and the
+files will be copied to the appropriate directories.
+
+=head1 FILES
+
+/opt/xcat/bin/imgimport
+
+
+=head1 SEE ALSO
+
+L<imgexport(1)|imgexport.1>
+