From 47994ec64a292df6b900a0d2d9a641d59b8b0fc1 Mon Sep 17 00:00:00 2001 From: Danny Auble <da@schedmd.com> Date: Wed, 29 Nov 2017 15:51:05 -0700 Subject: [PATCH] Wordsmithing of last commit --- doc/man/man1/sbatch.1 | 24 +++++++++++++----------- doc/man/man1/srun.1 | 19 +++++++++++-------- 2 files changed, 24 insertions(+), 19 deletions(-) diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1 index 092d84b501c..ab48ece7d07 100644 --- a/doc/man/man1/sbatch.1 +++ b/doc/man/man1/sbatch.1 @@ -500,19 +500,21 @@ partition's \fBOverSubscribe\fR option takes precedence over the job's option. .TP \fB\-\-export\fR=<\fIenvironment variables [ALL] | NONE\fR> -Identify which environment variables are propagated to the batch job. +Identify which environment variables are propagated to the launched application, +by default all are propagated. Multiple environment variable names should be comma separated. Environment variable names may be specified to propagate the current -value of those variables (e.g. "\-\-export=EDITOR") or specific values -for the variables may be exported (e.g. "\-\-export=EDITOR=/bin/emacs"). -By default all environment variables are propagated. -If the argument includes \fIALL\fR, all the current environment variables from -submit node are propagated (e.g. "\-\-export=EDITOR,ALL"). -If the argument is \fINONE\fR or specific environment variable names, -then the \fB\-\-get\-user\-env\fR option will implicitly be set to load other -environment variables based upon the user's configuration on the cluster which -executes the job. Regardless of this setting, the appropriate "SLURM_*" task -environment variables are always exported to the environment. +value (e.g. "\-\-export=EDITOR") or specific values +may be exported (e.g. "\-\-export=EDITOR=/bin/emacs"). In these two examples +the environment propagated will only contain the variable "EDITOR" +and nothing else. +If one desires to add to the environment instead of replacing it have the +argument include \fIALL\fR (e.g. "\-\-export=EDITOR,ALL"). This will propagate +"EDITOR" along with the current environment. +If one desires no environment variables be propagated use the argument +\fINONE\fR. +Regardless of this setting, the appropriate "SLURM_*" task environment variables +are always exported to the environment. This option particularly important for jobs that are submitted on one cluster and execute on a different cluster (e.g. with different paths). diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1 index 9383cf4b86e..642a9ff5415 100644 --- a/doc/man/man1/srun.1 +++ b/doc/man/man1/srun.1 @@ -743,16 +743,19 @@ See \fBEXAMPLE\fR below. .TP \fB\-\-export\fR=<\fIenvironment variables [ALL] | NONE\fR> -Identify which environment variables are propagated to the launched application. +Identify which environment variables are propagated to the launched application, +by default all are propagated. Multiple environment variable names should be comma separated. Environment variable names may be specified to propagate the current -value of those variables (e.g. "\-\-export=EDITOR") or specific values -for the variables may be exported (e.g. "\-\-export=EDITOR=/bin/emacs"). -By default all environment variables are propagated. -If the argument includes \fIALL\fR, all the current environment variables from -submit node are propagated (e.g. "\-\-export=EDITOR,ALL"). -If the argument is \fINONE\fR or specific environment variable names, no -other environment variables will be propagated unless explicitly listed. +value (e.g. "\-\-export=EDITOR") or specific values +may be exported (e.g. "\-\-export=EDITOR=/bin/emacs"). In these two examples +the environment propagated will only contain the variable "EDITOR" +and nothing else. +If one desires to add to the environment instead of replacing it have the +argument include \fIALL\fR (e.g. "\-\-export=EDITOR,ALL"). This will propagate +"EDITOR" along with the current environment. +If one desires no environment variables be propagated use the argument +\fINONE\fR. Regardless of this setting, the appropriate "SLURM_*" task environment variables are always exported to the environment. -- GitLab