man page for cfm2xcat

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@4038 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd

xCAT-client/pods/man1/cfm2xcat.1.pod

@@ -0,0 +1,54 @@
+=head1 NAME
+
+B<cfm2xcat> - Migrates the CFM setup in CSM to the xdcp rsync setup in xCAT. 
+
+=head1 B<SYNOPSIS>
+
+B<csm2xcat> [{B<-i>} I<path of the CFM distribution files generated >] [{B<-o>} I<path of the xdcp rsync files generated from the CFM distribution files >]
+
+B<csm2xcat> [B<-h>] 
+
+
+=head1 B<DESCRIPTION>
+
+Copy the cfm2xcat command to the CSM Management Server.  Run the command, indicating where you want your files saved with the -i and -o flags. They can be in the same directory.   
+The cfm2xcat command will run cfmupdatenode -a, saving the generated CFM distribution files. From those distribution files, it will generate xdcp rsync input files (-F option on xdcp).   
+Check the rsync files generated.  There will be a file generated from the input -o option on the command, and the same file with a (.nr) extension generated for each different noderange that will used to sync files based on your CFM setup in CSM. The file will contain the rsync file list.   The file.nr will contain the noderange. If multiple noderanges then the input name will be appended with a number. 
+
+=head1 OPTIONS
+
+B<-h>          Display usage message.
+
+B<-i>          Path of the CFM distribution files generated from the cfmupdatenode -a command.
+
+B<-o>          Path of the xdcp rsync input file generated from the CFM distribution files.
+
+
+=head1 RETURN VALUE
+
+0 The command completed successfully.
+
+1 An error has occurred.
+
+=head1 EXAMPLES
+
+1. To build xCAT rsync files to use with xdcp -F , enter on the CSM Management Server, make sure the path exists:
+
+B<cfm2xcat -i /tmp/cfm/cfmdistfiles -o /tmp/cfm/rsyncfiles>
+
+
+2. To use the file on the xCAT Management Node, after copying to /tmp/cfm:
+
+B<xdcp ^/tmp/cfm/rsyncfiles.nr -F /tmp/cfm/rsyncfiles>
+
+
+
+=head1 FILES
+
+/opt/xcat/share/xcat/tools/cfm2xcat
+
+
+
+
+
+