From 7b25591329391d0b6e88c00c6a45a55a8635d02e Mon Sep 17 00:00:00 2001 From: Iustin Pop Date: Mon, 20 Apr 2009 13:13:17 +0200 Subject: [PATCH] Update man pages with the env variables This patch documents the environment variables in the man pages of hbal and hn1. --- hbal.1 | 17 +++++++++++------ hn1.1 | 17 +++++++++++------ 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/hbal.1 b/hbal.1 index 2d98c95..767b4ef 100644 --- a/hbal.1 +++ b/hbal.1 @@ -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 diff --git a/hn1.1 b/hn1.1 index 648d5cd..e683e2f 100644 --- a/hn1.1 +++ b/hn1.1 @@ -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 -- 1.7.10.4