diff options
| author | Luke Shumaker <lukeshu@lukeshu.com> | 2018-04-24 16:15:19 -0400 |
|---|---|---|
| committer | Luke Shumaker <lukeshu@lukeshu.com> | 2018-04-24 16:48:47 -0400 |
| commit | 079d8c995bafd311471478dd9b36ab3b79107a94 (patch) | |
| tree | 107f2a06cfb1dcdfc0fb62f5e012b63847a33e3f | |
| parent | de6ec125dcadab66602a62cdaac440c2d9c5e3ba (diff) | |
conf.sh(3): Touch-up
- `codeblock` was disabling <VAR> in a place; use "" for filenames
instead of ``
- load_conf: use [] to emphasize that <VARS>... is optional
- load_conf: "each of them is", not "each of them are"
| -rw-r--r-- | src/lib/conf.sh.3.ronn | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/lib/conf.sh.3.ronn b/src/lib/conf.sh.3.ronn index fee0529..92267fb 100644 --- a/src/lib/conf.sh.3.ronn +++ b/src/lib/conf.sh.3.ronn @@ -43,11 +43,11 @@ Note that only the XDG_* variables are exported. The following routines take a "slug" to refer to a group of configuration files; that is the basename of the files. For example, -<SLUG>='abs' will identify `/etc/abs.conf` and `$<LIBREHOME>/.abs.conf`. +<SLUG>='abs' will identify "/etc/abs.conf" and "$<LIBREHOME>/.abs.conf". The routines you will likely actually use are: - * `load_conf` {<SLUG>.conf|<ABSPATH>} <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. Alternatively, instead of giving a <SLUG>, you may @@ -55,8 +55,8 @@ The routines you will likely actually use are: `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 + If any <VARS> are listed, check to make sure that each of them is + 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>: |