From 5a0b29f758944cfb06acd3ab0dd8473d0a74e5e9 Mon Sep 17 00:00:00 2001
From: lissav <lissav@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Fri, 8 Jun 2012 11:54:32 +0000
Subject: [PATCH] add fanout interface to man pages for p* command

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/branches/2.7@13047 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 xCAT-client/pods/man1/prsync.1.pod | 16 +++++++++++++++-
 xCAT-client/pods/man1/pscp.1.pod   | 15 ++++++++++++++-
 xCAT-client/pods/man1/psh.1.pod    | 17 ++++++++++++++++-
 3 files changed, 45 insertions(+), 3 deletions(-)

diff --git a/xCAT-client/pods/man1/prsync.1.pod b/xCAT-client/pods/man1/prsync.1.pod
index 57fdbd429..9394a4ab2 100644
--- a/xCAT-client/pods/man1/prsync.1.pod
+++ b/xCAT-client/pods/man1/prsync.1.pod
@@ -6,7 +6,7 @@ prsync - parallel rsync
 
 B<prsync> I<filename> [I<filename> I<...>] I<noderange:destinationdirectory>
 
-B<prsync>  [I<-o rsync options>] [I<filename> I<filename> I<...>] [I<directory> I<directory> I<...>]
+B<prsync>  [I<-o rsync options>] [B<-f> I<fanout>] [I<filename> I<filename> I<...>] [I<directory> I<directory> I<...>]
 I<noderange:destinationdirectory>
 
 B<prsync> {B<-h>|B<--help>|B<-v>|B<--version>}
@@ -28,6 +28,11 @@ B<prsync> is NOT multicast, but is parallel unicasts.
 
 rsync options.  See B<rsync(1)>.
 
+=item B<-f> I<fanout>
+
+Specifies a fanout value for the maximum number of  concur-
+rently  executing  remote shell processes.
+
 =item B<filename>
 
 A space delimited list of files to rsync.
@@ -50,6 +55,15 @@ Print version.
 
 =back
 
+=over 4
+
+=item B<XCATPSHFANOUT>
+
+Specifies  the fanout value. This variable is overridden by
+the B<-f> flag.  Default is 64.
+
+=back
+
 
 =head1 B<Examples>
 
diff --git a/xCAT-client/pods/man1/pscp.1.pod b/xCAT-client/pods/man1/pscp.1.pod
index f6fe172f6..2c67c1e07 100644
--- a/xCAT-client/pods/man1/pscp.1.pod
+++ b/xCAT-client/pods/man1/pscp.1.pod
@@ -4,7 +4,7 @@ B<pscp> - parallel remote copy
 
 =head1 B<Synopsis>
 
-B<pscp> [-i I<suffix>] [I<scp options> I<...>] I<filename> [I<filename> I<...>] I<noderange:destinationdirectory>
+B<pscp> [-i I<suffix>] [I<scp options> I<...>] [B<-f> I<fanout>] I<filename> [I<filename> I<...>] I<noderange:destinationdirectory>
 
 B<pscp> {B<-h>|B<--help>|B<-v>|B<--version>}
 
@@ -23,6 +23,11 @@ B<pscp> is NOT multicast, but is parallel unicasts.
 
 =over 7
 
+=item B<-f> I<fanout>
+
+Specifies a fanout value for the maximum number of  concur-
+rently  executing  remote shell processes.
+
 =item B<-i> I<suffix>
 
 Interfaces to be used.
@@ -49,6 +54,14 @@ Print version.
 
 =back
 
+=over 4
+
+=item B<XCATPSHFANOUT>
+
+Specifies  the fanout value. This variable is overridden by
+the B<-f> flag.  Default is 64.
+
+=back
 
 =head1 B<Examples>
 
diff --git a/xCAT-client/pods/man1/psh.1.pod b/xCAT-client/pods/man1/psh.1.pod
index 4d965fc25..aa7047603 100644
--- a/xCAT-client/pods/man1/psh.1.pod
+++ b/xCAT-client/pods/man1/psh.1.pod
@@ -4,7 +4,7 @@ psh - parallel remote shell
 
 =head1 B<Synopsis>
 
-B<psh> [B<-i> I<interface>] [B<-l> I<user>] I<noderange> I<command>
+B<psh> [B<-i> I<interface>] [B<-f> I<fanout>] [B<-l> I<user>] I<noderange> I<command>
 
 B<psh> {B<-h>|B<--help>|B<-v>|B<--version>}
 
@@ -28,6 +28,11 @@ The NIC on the node that psh should communicate with.  For example, if I<interfa
 then psh will concatenate B<-eth1> to the end of every node name before ssh'ing to it.  This
 assumes those host names have been set up to resolve to the IP address of each of the eth1 NICs.
 
+=item B<-f> I<fanout>
+
+Specifies a fanout value for the maximum number of  concur-
+rently  executing  remote shell processes. 
+
 =item B<-l> I<user>
 
 Log into the nodes as the specified username.  The default is to use the same username as you
@@ -50,6 +55,16 @@ Print help.
 
 =back
 
+=head1 B<Environment> B<Variables>
+
+=over 4
+
+=item B<XCATPSHFANOUT>
+
+Specifies  the fanout value. This variable is overridden by
+the B<-f> flag.  Default is 64.
+
+=back
 
 =head1 B<Examples>