From 1972c22a59ca0d1ac8ff9cefe311d4d44e1b53a1 Mon Sep 17 00:00:00 2001 From: Morris Jette <jette@schedmd.com> Date: Mon, 21 Nov 2011 10:32:28 -0800 Subject: [PATCH] clarify location of configuration files --- doc/man/man5/bluegene.conf.5 | 5 +++-- doc/man/man5/cgroup.conf.5 | 9 ++++++--- doc/man/man5/cray.conf.5 | 13 ++++++++----- doc/man/man5/gres.conf.5 | 5 +++-- doc/man/man5/slurm.conf.5 | 7 ++++--- doc/man/man5/slurmdbd.conf.5 | 7 ++++--- doc/man/man5/topology.conf.5 | 5 +++-- doc/man/man5/wiki.conf.5 | 5 +++-- 8 files changed, 34 insertions(+), 22 deletions(-) diff --git a/doc/man/man5/bluegene.conf.5 b/doc/man/man5/bluegene.conf.5 index 5bdb8e2a0c0..5b36c871f9e 100644 --- a/doc/man/man5/bluegene.conf.5 +++ b/doc/man/man5/bluegene.conf.5 @@ -4,11 +4,12 @@ bluegene.conf \- SLURM configuration file for BlueGene systems .SH "DESCRIPTION" -\fB/etc/bluegene.conf\fP is an ASCII file which describes IBM BlueGene specific +\fBbluegene.conf\fP is an ASCII file which describes IBM BlueGene specific SLURM configuration information. This includes specifications for bgblock layout, configuration, logging, etc. The file location can be modified at system build time using the -DEFAULT_SLURM_CONF parameter. The file will always be located in the +DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF +environment variable. The file will always be located in the same directory as the \fBslurm.conf\fP file. .LP Parameter names are case insensitive. diff --git a/doc/man/man5/cgroup.conf.5 b/doc/man/man5/cgroup.conf.5 index 81c70888f98..eaf47b2819d 100644 --- a/doc/man/man5/cgroup.conf.5 +++ b/doc/man/man5/cgroup.conf.5 @@ -6,9 +6,12 @@ cgroup.conf \- Slurm configuration file for the cgroup support .SH "DESCRIPTION" -\fB/etc/slurm/cgroup.conf\fP is an ASCII file which defines parameters used by -Slurm's Linux cgroup related plugins. The file will always be located in -the same directory as the \fBslurm.conf\fP file. +\fBcgroup.conf\fP is an ASCII file which defines parameters used by +Slurm's Linux cgroup related plugins. +The file location can be modified at system build time using the +DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF +environment variable. The file will always be located in the +same directory as the \fBslurm.conf\fP file. .LP Parameter names are case insensitive. Any text following a "#" in the configuration file is treated diff --git a/doc/man/man5/cray.conf.5 b/doc/man/man5/cray.conf.5 index 3284b5ccc48..71846034115 100644 --- a/doc/man/man5/cray.conf.5 +++ b/doc/man/man5/cray.conf.5 @@ -4,11 +4,14 @@ cray.conf \- Slurm configuration file for the Cray\-specific information .SH "DESCRIPTION" -\fB/etc/cray.conf\fP is an ASCII file which defines parameters used by -Slurm's select/cray plugin in support of Cray systems. The file will always -be located in the same directory as the \fBslurm.conf\fP file. The default -configuration parameters will work properly in a typical installation and -this file will not be required. +\fBcray.conf\fP is an ASCII file which defines parameters used by +Slurm's select/cray plugin in support of Cray systems. +The file location can be modified at system build time using the +DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF +environment variable. The file will always be located in the +same directory as the \fBslurm.conf\fP file. +The default configuration parameters will work properly in a typical +installation and this file will not be required. .LP Parameter names are case insensitive. Any text following a "#" in the configuration file is treated diff --git a/doc/man/man5/gres.conf.5 b/doc/man/man5/gres.conf.5 index 659f7d9ed1e..9cfb8f11e75 100644 --- a/doc/man/man5/gres.conf.5 +++ b/doc/man/man5/gres.conf.5 @@ -3,11 +3,12 @@ gres.conf \- Slurm configuration file for generic resource management. .SH "DESCRIPTION" -\fB/etc/gres.conf\fP is an ASCII file which describes the configuration +\fBgres.conf\fP is an ASCII file which describes the configuration of generic resources on each compute node. Each node must contain a gres.conf file if generic resources are to be scheduled by SLURM. The file location can be modified at system build time using the -DEFAULT_SLURM_CONF parameter. The file will always be located in the +DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF +environment variable. The file will always be located in the same directory as the \fBslurm.conf\fP file. If generic resource counts are set by the gres plugin function node_config_load(), this file may be optional. .LP diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5 index 3ceb2e3ce60..efcf3ae0222 100644 --- a/doc/man/man5/slurm.conf.5 +++ b/doc/man/man5/slurm.conf.5 @@ -3,14 +3,15 @@ .SH "NAME" slurm.conf \- Slurm configuration file .SH "DESCRIPTION" -\fB/etc/slurm.conf\fP is an ASCII file which describes general SLURM +\fBslurm.conf\fP is an ASCII file which describes general SLURM configuration information, the nodes to be managed, information about how those nodes are grouped into partitions, and various scheduling parameters associated with those partitions. This file should be consistent across all nodes in the cluster. .LP -You can use the \fBSLURM_CONF\fR environment variable to override the built\-in -location of this file. The SLURM daemons also allow you to override +The file location can be modified at system build time using the +DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF +environment variable. The SLURM daemons also allow you to override both the built\-in and environment\-provided location using the "\-f" option on the command line. .LP diff --git a/doc/man/man5/slurmdbd.conf.5 b/doc/man/man5/slurmdbd.conf.5 index 61e0527c430..bfcf88c66ed 100644 --- a/doc/man/man5/slurmdbd.conf.5 +++ b/doc/man/man5/slurmdbd.conf.5 @@ -3,10 +3,11 @@ slurmdbd.conf \- Slurm Database Daemon (SlurmDBD) configuration file .SH "DESCRIPTION" -\fB/etc/slurmdb.conf\fP is an ASCII file which describes Slurm Database +\fBslurmdb.conf\fP is an ASCII file which describes Slurm Database Daemon (SlurmDBD) configuration information. -You can use the \fBSLURM_CONF\fR environment variable to override the built\-in -location of this file. +The file location can be modified at system build time using the +DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF +environment variable. .LP The contents of the file are case insensitive except for the names of nodes and files. Any text following a "#" in the configuration file is treated diff --git a/doc/man/man5/topology.conf.5 b/doc/man/man5/topology.conf.5 index 20c96f6d54b..7bae1d7d4ee 100644 --- a/doc/man/man5/topology.conf.5 +++ b/doc/man/man5/topology.conf.5 @@ -4,10 +4,11 @@ topology.conf \- Slurm configuration file for defining the network topology .SH "DESCRIPTION" -\fB/etc/topology.conf\fP is an ASCII file which describes the +\fBtopology.conf\fP is an ASCII file which describes the cluster's network topology for optimized job resource allocation. The file location can be modified at system build time using the -DEFAULT_SLURM_CONF parameter. The file will always be located in the +DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF +environment variable. The file will always be located in the same directory as the \fBslurm.conf\fP file. .LP Parameter names are case insensitive. diff --git a/doc/man/man5/wiki.conf.5 b/doc/man/man5/wiki.conf.5 index 4fc45a72533..962fa873de0 100644 --- a/doc/man/man5/wiki.conf.5 +++ b/doc/man/man5/wiki.conf.5 @@ -2,10 +2,11 @@ .SH "NAME" wiki.conf \- Slurm configuration file for wiki and wiki2 scheduler plugins .SH "DESCRIPTION" -\fB/etc/wiki.conf\fP is an ASCII file which describes wiki and wiki2 +\fBwiki.conf\fP is an ASCII file which describes wiki and wiki2 scheduler specific SLURM configuration information. The file location can be modified at system build time using the -DEFAULT_SLURM_CONF parameter. The file will always be located in the +DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF +environment variable. The file will always be located in the same directory as the \fBslurm.conf\fP file. .LP Parameter names are case insensitive. -- GitLab