aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2013-10-27 10:23:40 +0100
committerTrygve Laugstøl <trygvis@inamo.no>2013-10-27 10:23:40 +0100
commitebf5da2c7932f05f23fcb8dccd74023c306a3aa3 (patch)
tree9fdbce94f1d7a8cda28ef58b6df2591ddf25de56 /docs
parent91052dfc0d9e23b2baf499f6c5aab21b1544a236 (diff)
downloadapp.sh-ebf5da2c7932f05f23fcb8dccd74023c306a3aa3.tar.gz
app.sh-ebf5da2c7932f05f23fcb8dccd74023c306a3aa3.tar.bz2
app.sh-ebf5da2c7932f05f23fcb8dccd74023c306a3aa3.tar.xz
app.sh-ebf5da2c7932f05f23fcb8dccd74023c306a3aa3.zip
o More TODOs.
Diffstat (limited to 'docs')
-rw-r--r--docs/app-cat-conf.txt10
-rw-r--r--docs/app.txt1
-rw-r--r--docs/appinternals.txt5
3 files changed, 16 insertions, 0 deletions
diff --git a/docs/app-cat-conf.txt b/docs/app-cat-conf.txt
index 0b4f83a..fe2a5b4 100644
--- a/docs/app-cat-conf.txt
+++ b/docs/app-cat-conf.txt
@@ -52,6 +52,16 @@ Support comments::
1) ignore comments (lines that start with #), 2) add a flag (-C) to
include comments in the output but still filter the lines. (2) is
required for app-conf set to work. (1) can be done first.
+Better support for scripting::
+ Support _required keys_: exit with non-null value when a key is
+ missing. Suggested option: '-r'.
++
+Support _default values_: when a key is missing, return the default
+value instead. Suggested option: '-d'.
++
+Support _$APP_HOME_: If '$APP_HOME' is set, use that when reading the
+app's config values. Makes it easier to script as the user may move
+around directories, but still read values from the right place.
SEE ALSO
--------
diff --git a/docs/app.txt b/docs/app.txt
index c0d92f6..c578c5d 100644
--- a/docs/app.txt
+++ b/docs/app.txt
@@ -69,6 +69,7 @@ SEE ALSO
--------
linkman:app-conf[1],
+linkman:app-cat-conf[1],
linkman:appinternals[1],
// vim: set ft=asciidoc:
diff --git a/docs/appinternals.txt b/docs/appinternals.txt
index 743cb03..9291fa0 100644
--- a/docs/appinternals.txt
+++ b/docs/appinternals.txt
@@ -29,5 +29,10 @@ Configuration properties:
The installed version of the application. Is updated by
`app-set-version`.
+ENVIRONMENT VARIABLES
+---------------------
+
+`APPSH_HOME`::
+`APP_HOME`::
// vim: set ft=asciidoc: