diff options
| -rw-r--r-- | src/lib/conf.sh.3.ronn | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/src/lib/conf.sh.3.ronn b/src/lib/conf.sh.3.ronn index bad271d..1b26a06 100644 --- a/src/lib/conf.sh.3.ronn +++ b/src/lib/conf.sh.3.ronn @@ -10,9 +10,6 @@ conf.sh(3) -- easy loading of configuration files `conf.sh` is a Bash(1) library to easily load various configuration files related to Arch Linux/Parabola(7) and libretools(7). -I recommend reading the source yourself--it is mostly -self-explanatory, and is shorter than this document. - ### VARIABLES When loading configuration files in a program run with `sudo`(8), it @@ -56,23 +53,24 @@ The routines you will likely actually use are: variables. * `check_vars` <SLUG> <VARS>...: Checks to see if all of <VARS> are defined. If any of them - aren't, it prints a message to configure them in the - configuration files for <SLUG>, and returns with a non-zero + aren't, it prints a message telling the user to configure them in + the configuration files for <SLUG>, and returns with a non-zero status. * `get_var` <SLUG> <VAR> <DEFAULT>: - If <VAR> is set in the configuration for <SLUG>, print it's + If <VAR> is set in the configuration for <SLUG>, print its value, considering environmental variables. If it is not set, return <DEFAULT>. This does NOT work for array variables. * `set_var` <SLUG> <VAR> <VALUE>: Set the variable <VAR> equal to <VALUE> in the configuration file - for <SLUG> of highest precedence that already exists, and is + for <SLUG> of highest precedence that already exists and is writable. If no files fit this description, the routine does nothing and returns a non-zero exit status. This does NOT work for array variables. There are two more routines the above routines use internally that are -used internally by . You are unlikely to use them directly, but they -might be useful for debugging, or at least describing behavior. +used internally by by the above routines. You are unlikely to use +them directly, but they might be useful for debugging, or at least +describing behavior. * `list_files` <SLUG>: Lists (newline-separated) the configuration files that must be |