1CLUBAK(1)                  ClusterShell User Manual                  CLUBAK(1)
2
3
4

NAME

6       clubak - format output from clush/pdsh-like output and more
7

SYNOPSIS

9       clubak [ OPTIONS ]
10

DESCRIPTION

12       clubak  formats  text  from standard input containing lines of the form
13       "node:output".  It is fully backward compatible with dshbak(1) but pro‐
14       vides additional features. For instance, clubak always displays its re‐
15       sults sorted by node/nodeset.
16
17       You do not need to use clubak when using clush(1) as all output format‐
18       ting features are already included in. It is provided for other usages,
19       like post-processing results of the form "node:output".
20
21       Like clush(1), clubak uses the ClusterShell.MsgTree module of the Clus‐
22       terShell library (see pydoc ClusterShell.MsgTree).
23

INVOCATION

25       clubak should be started with connected standard input.
26

OPTIONS

28       --version
29              show clubak version number and exit
30
31       -b, -c gather nodes with same output (-c is provided for dshbak(1) com‐
32              patibility)
33
34       -d, --debug
35              output more messages for debugging purpose
36
37       -L     disable header block and order output by nodes
38
39       -r, --regroup
40              fold nodeset using node groups
41
42       -s GROUPSOURCE, --groupsource=GROUPSOURCE
43              optional groups.conf(5) group source to use
44
45       --groupsconf=FILE
46              use alternate config file for groups.conf(5)
47
48       -G, --groupbase
49              do not display group source prefix (always @groupname)
50
51       -S SEPARATOR, --separator=SEPARATOR
52              node / line content separator string (default: :)
53
54       -F, --fast
55              faster but memory hungry mode (preload all messages per node)
56
57       -T, --tree
58              message tree trace mode; switch to  enable  ClusterShell.MsgTree
59              trace  mode,  all keys/nodes being kept for each message element
60              of the tree, thus allowing special output gathering
61
62       --color=WHENCOLOR
63              clush can use NO_COLOR, CLICOLOR and CLICOLOR_FORCE  environment
64              variables.  --color  command line option always takes precedence
65              over environment variables. NO_COLOR takes precedence over  CLI‐
66              COLOR_FORCE  which takes precedence over CLICOLOR. --color tells
67              whether to use ANSI colors to  surround  node  or  nodeset  pre‐
68              fix/header with escape sequences to display them in color on the
69              terminal. WHENCOLOR is never, always or auto (which use color if
70              standard  output  refers  to  a  terminal). Color is set to [34m
71              (blue foreground text) and cannot be modified.
72
73       --diff show diff between gathered outputs
74

EXIT STATUS

76       An exit status of zero indicates success of the clubak command.
77

EXAMPLES

79       1. clubak can be used to gather some recorded clush(1) results:
80
81       Record clush(1) results in a file:
82              # clush -w node[1-7] uname -r >/tmp/clush_output
83              # clush -w node[32-159] uname -r >>/tmp/clush_output
84
85
86       Display file gathered results (in line-mode):
87              # clubak -bL </tmp/clush_output
88
89
90       2. Another example, iterate over node* text files in current  directory
91          and gather characters count for all of them:
92             # find -name "node*" -exec wc -c {} ; | awk '{ gsub("./","",$2); print $2": "$1 }' | clubak -bL
93             node[1,3]: 7
94             node2: 9
95
96

SEE ALSO

98       cluset(1), clush(1), nodeset(1), groups.conf(5).
99
100       http://clustershell.readthedocs.org/
101

BUG REPORTS

103       Use the following URL to submit a bug report or feedback:
104              https://github.com/cea-hpc/clustershell/issues
105

AUTHOR

107       Stephane Thiell <sthiell@stanford.edu>
108

110       GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
111
112
113
114
1151.9                               2022-11-25                         CLUBAK(1)
Impressum