summaryrefslogtreecommitdiff
path: root/src/lib/conf.sh.3.ronn
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/conf.sh.3.ronn')
-rw-r--r--src/lib/conf.sh.3.ronn16
1 files changed, 10 insertions, 6 deletions
diff --git a/src/lib/conf.sh.3.ronn b/src/lib/conf.sh.3.ronn
index c17a3ee..fee0529 100644
--- a/src/lib/conf.sh.3.ronn
+++ b/src/lib/conf.sh.3.ronn
@@ -47,14 +47,18 @@ configuration files; that is the basename of the files. For example,
The routines you will likely actually use are:
- * `load_conf` <SLUG>.conf <VARS>...:
+ * `load_conf` {<SLUG>.conf|<ABSPATH>} <VARS>...:
Loads the configuration files for <SLUG>, loading the files in
the correct order, and checking the appropriate environmental
- variables. If any <VARS> are listed, check to make sure that
- each of them are defined. If any of them are not defined, it
- prints a message telling the user to configure them in the
- configuration files for <SLUG>, and returns with a non-zero
- status.
+ variables. Alternatively, instead of giving a <SLUG>, you may
+ give an absolute filepath to a configuration file (bypassing
+ `list_files`, see below) which will be loaded with no
+ environmental overrides (bypassing `list_envvars`, see below).
+
+ If any <VARS> are listed, check to make sure that each of them
+ are defined. If any of them are not defined, it prints a message
+ telling the user to configure them in the appropriate files, and
+ returns with a non-zero status.
* `get_var` <SLUG> <VAR> <DEFAULT>:
If <VAR> is set in the configuration for <SLUG>, print its
value, considering environmental variables. If it is not set,