1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
.\" Man page generated from reStructeredText.
.
.TH CLUSH.CONF 5 "2012-02-15" "1.6" "ClusterShell User Manual"
.SH NAME
clush.conf \- Configuration file for clush
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
\fBclush\fP(1) obtains configuration options from the following sources in the
following order:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP 1. 3
.
command\-line options
.IP 2. 3
.
user configuration file (\fI~/.clush.conf\fP)
.IP 3. 3
.
system\-wide configuration file (\fI/etc/clustershell/clush.conf\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
For each parameter, the first obtained value will be used.
.sp
The configuration file has a format in the style of RFC 822 composed
of one main section:
.INDENT 0.0
.TP
.B Main
.
Program options definition
.UNINDENT
.SS [Main]
.sp
Configuration parameters of the \fBMain\fP section are described below.
.INDENT 0.0
.TP
.B fanout
.
Size of the sliding window of ssh connectors.
.TP
.B connect_timeout
.
Timeout in seconds to allow a connection to establish. This parameter is
passed to ssh. If set to \fI0\fP, no timeout occurs.
.TP
.B command_timeout
.
Timeout in seconds to allow a command to complete since the connection has
been established. This parameter is passed to ssh. In addition, the
ClusterShell library ensures that any commands complete in less than
( connect_timeout + command_timeout ). If set to \fI0\fP, no timeout occurs.
.TP
.B color
.
Whether to use ANSI colors to surround node or nodeset prefix/header with
escape sequences to display them in color on the terminal. Valid arguments
are \fBnever\fP, \fBalways\fP or \fBauto\fP (which use color if standard
output/error refer to a terminal). Colors are set to [34m (blue foreground
text) for stdout and [31m (red foreground text) for stderr, and cannot be
modified.
.TP
.B fd_max
.
Maximum number of open file descriptors permitted per clush process (soft
resource limit for open files). This limit can never exceed the system
(hard) limit. The \fIfd_max\fP (soft) and system (hard) limits should be high
enough to run \fBclush\fP, although their values depend on your \fIfanout\fP value.
.TP
.B history_size
.
Set the maximum number of history entries saved in the GNU readline history
list. Negative values imply unlimited history file size.
.TP
.B node_count
.
Should \fBclush\fP display additional (node count) information in buffer
header? (\fIyes\fP/\fIno\fP)
.TP
.B verbosity
.
Set the verbosity level: \fI0\fP (quiet), \fI1\fP (default), \fI2\fP (verbose) or more
(debug).
.TP
.B ssh_user
.
Set the ssh user to use for remote connection (default is to not specify).
.TP
.B ssh_path
.
Set the ssh binary path to use for remote connection (default is
\fI/usr/bin/ssh\fP).
.TP
.B ssh_options
.
Set additional options to pass to the underlying ssh command.
.UNINDENT
.SH EXAMPLES
.sp
Simple configuration file.
.SS \fIclush.conf\fP
.nf
[Main]
fanout: 128
connect_timeout: 15
command_timeout: 0
history_size: 100
color: auto
fd_max: 10240
node_count: yes
.fi
.sp
.SH FILES
.INDENT 0.0
.TP
.B \fI~/.clush.conf\fP
.sp
This is the per\-user configuration file.
.TP
.B \fI/etc/clustershell/clush.conf\fP
.sp
System\-wide configuration file.
.UNINDENT
.SH HISTORY
.sp
As of ClusterShell version 1.3, the \fBExternal\fP section has been removed
from \fIclush.conf\fP. External commands whose outputs were used by \fBclush\fP
(\-a, \-g, \-X) are now handled by the library itself and defined in
\fBgroups.conf\fP(5).
.SH SEE ALSO
.sp
\fBclush\fP(1), \fBnodeset\fP(1), \fBgroups.conf\fP(5)
.sp
\fI\%http://clustershell.sourceforge.net/\fP
.SH AUTHOR
Stephane Thiell, CEA DAM <stephane.thiell@cea.fr>
.SH COPYRIGHT
CeCILL-C V1
.\" Generated by docutils manpage writer.
.\"
.
|
