From 5e5cf68068b83c740d919855a463821c2c54e450 Mon Sep 17 00:00:00 2001 From: lissav Date: Wed, 16 Oct 2013 06:08:30 -0400 Subject: [PATCH] put manpage back --- xCAT-client/pods/man1/xdshbak.1.pod | 127 ++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 xCAT-client/pods/man1/xdshbak.1.pod diff --git a/xCAT-client/pods/man1/xdshbak.1.pod b/xCAT-client/pods/man1/xdshbak.1.pod new file mode 100644 index 000000000..661f1f302 --- /dev/null +++ b/xCAT-client/pods/man1/xdshbak.1.pod @@ -0,0 +1,127 @@ +=head1 NAME + +B - Formats the output of the B command. + +=head1 B + +B [B<-c> | B<-x> | B<-h> | B<-q>] + +=head1 DESCRIPTION + +The B command formats 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, and the B<-c> (collapse) flag was specified: + + HOSTS -------------------------------------------------------- + node1 + -------------------------------------------------------------- + . + . + lines from xdsh for node1 with hostnames stripped off + . + . + HOSTS -------------------------------------------------------- + node2 + -------------------------------------------------------------- + . + . + lines from xdsh for node2 with hostnames stripped off + . + . + HOSTS -------------------------------------------------------- + node3, node4 + -------------------------------------------------------------- + . + . + lines from xdsh for node 3 with hostnames stripped off + . + . + +When output is displayed from more than one node in collapsed form, the +host names are displayed alphabetically. When output is not collapsed, +output is displayed sorted alphabetically by host name. + +If the B<-q> quiet flag is not set then B +command writes "." for each 1000 lines of output processed (to show progress), +since it won't display the output until it has processed all of it. + +If the B<-x> flag is specified, the extra header lines that xdshbak normally +displays for each node will be omitted, and the hostname at the beginning +of each line is not stripped off, but B still sorts +the output by hostname for easier viewing: + + node1: lines from xdsh for node1 + . + . + node2: lines from xdsh for node2 + . + . + +=head2 Standard Error + +When the B filter is used and standard error messages are generated, +all error messages on standard error appear before all standard +output messages. This is true with and without the B<-c> flag. + +=head1 OPTIONS + +=over 6 + +=item B<-c> + +If the output from multiple nodes is identical it will be collapsed +and displayed only once. + +=item B<-x> + +Omit the extra header lines that xdshbak normally displays for +each node. This provides +more compact output, but xdshbak still sorts the output by +node name for easier viewing. +This option should not be used with B<-c>. + +=item B<-h> + +Displays usage information. + +=item B<-q> + +Quiet mode, do not display "." for each 1000 lines of output. + +=back + +=head1 B + +=over 3 + +=item * + +To display the results of a command issued on several nodes, in +the format used in the Description, enter: + + xdsh node1,node2,node3 cat /etc/passwd | xdshbak + +=item * + +To display the results of a command issued on several nodes with +identical output displayed only once, enter: + + xdsh host1,host2,host3 pwd | xdshbak -c + +=item * + +To display the results of a command issued on several nodes with +compact output and be sorted alphabetically by host name, enter: + + xdsh host1,host2,host3 date | xdshbak -x + +=back + +=head1 B + +L, L