From 5fd64b4e8a16bfbdf9980d5af2b09e9fdae6e873 Mon Sep 17 00:00:00 2001
From: lissav <lissav@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Thu, 22 Sep 2011 18:22:53 +0000
Subject: [PATCH]  xcatdebug manpage

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

diff --git a/xCAT-client/pods/man8/xcatdebug.8.pod b/xCAT-client/pods/man8/xcatdebug.8.pod
new file mode 100644
index 000000000..bed72b6ce
--- /dev/null
+++ b/xCAT-client/pods/man8/xcatdebug.8.pod
@@ -0,0 +1,51 @@
+=head1 NAME
+
+B<xcatdebug> - Starts the xCAT daemon (xcatd) with Perl Debug Trace.
+
+B<xcatdebug. {B<levelnumber}
+
+B<xcatsnap> {B<-v>|B<--version>}
+
+B<xcatsnap> {B<-B>|B<--BYPASS>}
+
+B<xcatsnap> {B<-d>|B<--dir>} 
+
+=head1 DESCRIPTION
+
+B<xcatdebug> -  The xcatdebug command starts the xcatd daemon in Perl Debug Trace mode. It is to be used for diagnosing xCAT problems. The trace outputs the par
+amters passed into the xcatd subroutines, listed in the tracefiles. The tracefil
+es are located in /opt/xcat/share/xcat/tools/tracelevel<levelnumber>.  The amount of trace data collected varies with the levelnumber. levelnumber 0 being the least amount of trace and increasing with the number.
+
+Before running this command, you should stop xcatd on your system.
+After running the command, you will have to kill all the xcatd processes and possibly the xcatdebug process.
+Run ps -ef | grep xcatd and kill any processes
+Run ps -ef | grep xcatdebug
+=head1 OPTIONS
+
+=over 6
+
+=item B<levelnumber>
+
+The levelnumber that will be run. This determines the filename of trace input from /opt/xcat/share/xcat/tools/tracelevel<levelnumber>
+
+=back
+
+=head1 ENVIRONMENT VARIABLES
+
+=head1 EXAMPLES
+
+=over 2
+
+=item *
+
+Run the xcatdebug routine with /opt/xcat/share/xcat/tools/tracelevel0 and output to the screen:
+
+B<xcatdebug>  I<0>
+
+=item *
+
+Run the xcatdebug routine with /opt/xcat/share/xcat/tools/tracelevel1 and output to /tmp/traceoutput:
+
+B<xcatdebug>  I<1> > /tmp/traceoutput 2>&1
+
+=back