diff --git a/xCAT-client/pods/man1/sinv.1.pod b/xCAT-client/pods/man1/sinv.1.pod index 03f9bc4f0..6a75e56c9 100644 --- a/xCAT-client/pods/man1/sinv.1.pod +++ b/xCAT-client/pods/man1/sinv.1.pod @@ -29,7 +29,7 @@ The xdsh or rinv command to execute on the remote targets is specified by the which is followed by the fully qualified path to a file containing the command. -Note: do not add | xcoll to the command on the command line or in the +Note: do not add | xdshcoll to the command on the command line or in the command file, it is automatically added by sinv. The syntax for the B<-c> B parameter is as follows: @@ -68,7 +68,7 @@ that contains the configuration that you would like all nodes in your noderange to match. The admin can create the template by running the xdsh command on -the seed node, pipe to xcoll ( required) and store the output +the seed node, pipe to xdshcoll ( required) and store the output in the template path. See examples. B The admin can also edit the @@ -123,7 +123,7 @@ configuration. This requires the check of node output against template to be an exact match. If this flag is not set, B checks to see if the return from the xdsh command to the nodes contain a match for each line in the input -template (except for xcoll header and comments). If not in exactmatch mode, +template (except for xdshcoll header and comments). If not in exactmatch mode, there can exist more lines in the xdsh return from the nodes. For example, if running a "rpm -qa | grep xCAT" command, without exactmatch @@ -137,7 +137,7 @@ to the template. The xdsh or rinv command that will be run. The command should be enclosed in double quotes to insure correct shell interpretation. -B do not add the | xcoll to the command, +B do not add the | xdshcoll to the command, it is automatically added by sinv. =item B<-f>|B<--file> @@ -145,7 +145,7 @@ it is automatically added by sinv. The file containing the xdsh or rinv command that will be run. This should be the fully qualified name of the file. -B do not add the | xcoll to the command in the file, +B do not add the | xdshcoll to the command in the file, it is automatically added by sinv. =item B<-r>|B<--remove> @@ -184,19 +184,19 @@ Verbose mode. To setup sinv.template (name optional) for input to the B command , enter: -B I /tmp/sinv.template> +B I /tmp/sinv.template> Note: when setting up the template the output of xdsh must be piped - to xcoll, sinv processing depends on it. + to xdshcoll, sinv processing depends on it. =item * To setup rinv.template for input to the B command , enter: -B I /tmp/rinv.template> +B I /tmp/rinv.template> Note: when setting up the template the output of rinv must be piped - to xcoll, sinv processing depends on it. + to xdshcoll, sinv processing depends on it. =item * @@ -207,7 +207,7 @@ output report to /tmp/sinv.output, enter: B I< -c "xdsh testnodes rpm -qa | grep xCAT" -p /tmp/sinv.template -t 2 -r -o /tmp/sinv.output> -Note: do not add the pipe to xcoll on the -c flag, it is automatically +Note: do not add the pipe to xdshcoll on the -c flag, it is automatically added by the sinv routine. =item * @@ -251,4 +251,4 @@ Location of the sinv command. =head1 B -L , L, L +L , L diff --git a/xCAT-client/pods/man1/xcoll.1.pod b/xCAT-client/pods/man1/xcoll.1.pod index c6d14a05d..d0e78b6bf 100644 --- a/xCAT-client/pods/man1/xcoll.1.pod +++ b/xCAT-client/pods/man1/xcoll.1.pod @@ -11,14 +11,14 @@ B The B command formats and consolidates output from the B command. The B command takes, as input, lines in the following format: -host_name: line of output from remote command +groupname: line of output from remote command, will use group name, if defined The B command formats the lines as follows and writes them to standard output. Assume that the output from node3 and node4 is identical: ==================================== - node1 + node1 or nodegroup name ==================================== . . @@ -27,7 +27,7 @@ is identical: . ==================================== - node2 + node2 or nodegroup name ==================================== . . @@ -36,7 +36,7 @@ is identical: . ==================================== - node3, node4 + node3, node4 or nodegroup name ==================================== . . @@ -60,4 +60,4 @@ B I | B =head1 B -L, L +L, L ,L diff --git a/xCAT-client/pods/man1/xdshcoll.1.pod b/xCAT-client/pods/man1/xdshcoll.1.pod new file mode 100644 index 000000000..1fcdd2851 --- /dev/null +++ b/xCAT-client/pods/man1/xdshcoll.1.pod @@ -0,0 +1,63 @@ +=head1 B + +B - Formats and consolidates the output of the B commands. + +=head1 B + +B + +=head1 B + +The B command formats and consolidates output from the B command. The B +command takes, as input, lines in the following format: + +host_name: line of output from remote command + +The B command formats the lines as follows and writes them to +standard output. Assume that the output from node3 and node4 +is identical: + + ==================================== + node1 + ==================================== + . + . + lines from psh for node1 with hostnames stripped off + . + . + + ==================================== + node2 + ==================================== + . + . + lines from psh for node2 with hostnames stripped off + . + . + + ==================================== + node3, node4 + ==================================== + . + . + lines from psh for node 3 with hostnames stripped off + . + . + + +=head1 B + +=over 3 + +=item * + +To display the results of a command issued on several nodes, in +the format used in the Description, enter: + +B I | B + +=back + +=head1 B + +L