From d484b31c737b4427794962e1ccd866aa68d5861b Mon Sep 17 00:00:00 2001
From: lissav <lissav@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Fri, 20 Aug 2010 14:39:33 +0000
Subject: [PATCH] add new xcatsnap routine manpage

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@7174 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 xCAT-client/pods/man8/xcatsnap.8.pod | 60 ++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 xCAT-client/pods/man8/xcatsnap.8.pod

diff --git a/xCAT-client/pods/man8/xcatsnap.8.pod b/xCAT-client/pods/man8/xcatsnap.8.pod
new file mode 100644
index 000000000..3983c5ec2
--- /dev/null
+++ b/xCAT-client/pods/man8/xcatsnap.8.pod
@@ -0,0 +1,60 @@
+=head1 NAME
+
+B<xcatsnap> - Gathers information for service about the current running xCAT environment.  
+
+B<xcatsnap> {B<-h>|B<--help>}
+
+B<xcatsnap> {B<-v>|B<--version>}
+
+B<xcatsnap> {B<-B>|B<--BYPASS>}
+
+B<xcatsnap> {B<-d>|B<--dir>} 
+
+=head1 DESCRIPTION
+
+B<xcatsnap> -  The xcatsnap command gathers configuration, log and trace information about the xCAT components that are installed. This command only collects the data on the local node on which this command is run. This command is typically executed when a problem is encountered with any of these components in order to provide service information to the IBM Support Center.
+
+This command should only be executed at the instruction of the IBM Support Center.
+ 
+=head1 OPTIONS
+
+=over 6
+
+=item B<-h|--help>
+
+Displays the usage message.
+
+=item B<-v|--version>
+
+Displays the release version of the code.
+
+=item B<-B|--bypass>
+
+Runs in bypass mode, use if the xcatd daemon is hung.
+
+=item B<-d|--directory>
+
+The directory to put the snap information.  Default is /tmp/xcatsnap.
+
+=back
+
+=head1 ENVIRONMENT VARIABLES
+
+=head1 EXAMPLES
+
+=over 2
+
+=item *
+
+To run the xcatsnap routine in bypass mode and put info in /tmp/mydir :
+
+B<xcatsnap> I<-B> I<-d> /tmp/mydir
+
+=item * 
+
+To run the xcatsnap routine and use default directory /tmp/xcatsnap :
+
+B<xcatsnap>
+
+
+=back