Commit 7b255913 authored by Iustin Pop's avatar Iustin Pop
Browse files

Update man pages with the env variables

This patch documents the environment variables in the man pages of hbal
and hn1.
parent 8032b3b5
......@@ -250,16 +250,14 @@ the percentage of instances on offline nodes)
.TP
.BI "-n" nodefile ", --nodes=" nodefile
The name of the file holding node information (if not collecting via
RAPI), instead of the default
.I nodes
file.
RAPI), instead of the default \fInodes\fR file (but see below how to
customize the default value via the environment).
.TP
.BI "-i" instancefile ", --instances=" instancefile
The name of the file holding instance information (if not collecting
via RAPI), instead of the default
.I instances
file.
via RAPI), instead of the default \fIinstances\fR file (but see below
how to customize the default value via the environment).
.TP
.BI "-m" cluster
......@@ -288,6 +286,13 @@ Just show the program version and exit.
The exist status of the command will be zero, unless for some reason
the algorithm fatally failed (e.g. wrong node or instance data).
.SH ENVIRONMENT
If the variables \fBHTOOLS_NODES\fR and \fBHTOOLS_INSTANCES\fR are
present in the environment, they will override the default names for
the nodes and instances files. These will have of course no effect
when RAPI is used.
.SH BUGS
The program does not check its input data for consistency, and aborts
......
......@@ -219,16 +219,14 @@ percent of free disk
.TP
.BI "-n" nodefile ", --nodes=" nodefile
The name of the file holding node information (if not collecting via
RAPI), instead of the default
.I nodes
file.
RAPI), instead of the default \fInodes\fR file (but see below how to
customize the default value via the environment).
.TP
.BI "-i" instancefile ", --instances=" instancefile
The name of the file holding instance information (if not collecting
via RAPI), instead of the default
.I instances
file.
via RAPI), instead of the default \fIinstances\fR file (but see below
how to customize the default value via the environment).
.TP
.BI "-m" cluster
......@@ -263,6 +261,13 @@ Just show the program version and exit.
The exist status of the command will be zero, unless for some reason
the algorithm fatally failed (e.g. wrong node or instance data).
.SH ENVIRONMENT
If the variables \fBHTOOLS_NODES\fR and \fBHTOOLS_INSTANCES\fR are
present in the environment, they will override the default names for
the nodes and instances files. These will have of course no effect
when RAPI is used.
.SH BUGS
The program does not check its input data for consistency, and aborts
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment