add manpage

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@921 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
lissav 2008-03-28 11:59:37 +00:00
parent f1db7a8e2b
commit fa90360881

View File

@ -0,0 +1,38 @@
=head1 NAME
B<xCATWorld> - Sample client program for xCAT.
=head1 SYNOPSIS
I<xCATWorld {noderange}>
=head1 DESCRIPTION
The xCATWorld program gives you a sample client program that interfaces to the /opt/xcat/lib/perl/xCAT_plugin/xCATWorld.pm plugin.
For debugging purposes we have an Environment Variable XCATBYPASS. If export XCATBYPASS=yes, the client will call the plugin without going through the xcat daemon, xcatd.
=head1 OPTIONS
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1.To run , enter:
I<xCATWorld nodegrp1>
=head1 FILES
/opt/xcat/bin/xCATWorld
=head1 NOTES
This command is part of the xCAT software product.