diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 6 | ||||
| -rw-r--r-- | docs/app-cat-conf.txt | 53 | ||||
| -rw-r--r-- | docs/app-conf.txt | 1 | ||||
| -rw-r--r-- | docs/app.txt | 16 |
4 files changed, 73 insertions, 3 deletions
diff --git a/docs/Makefile b/docs/Makefile index c62e70c..8b8cf8b 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,10 +4,12 @@ MAN=$(patsubst %.txt,%.1,$(TXT)) all: $(HTML) $(MAN) %.html: %.txt - asciidoc -a data-uri -a icons -a toc -a max-width=55em $< + @echo asciidoc $< + @asciidoc -a data-uri -a icons -a toc -a max-width=55em $< %.1: %.txt - a2x --doctype manpage --format manpage $< + @echo a2x $< + @a2x --doctype manpage --format manpage $< clean: rm -rf $(wildcard *.html) $(wildcard *.1) diff --git a/docs/app-cat-conf.txt b/docs/app-cat-conf.txt new file mode 100644 index 0000000..0411390 --- /dev/null +++ b/docs/app-cat-conf.txt @@ -0,0 +1,53 @@ +app-cat-conf(1) +=============== + +NAME +---- +app-cat-conf - outputs a combined configuration file in a parseable +format + +SYNOPSIS +-------- +[verse] +'app-cat-conf' [-f <file>] [-D] [-l <location>] [-k <key>] + +DESCRIPTION +----------- +Outputs the combined file from all the input files. It will only +output a key once, the last value for each key seen will win. + +A configuration file is a collection of grouped keys and values, +similar to Git. + +The keys consits of two parts: a _group_ and a _name_. Both have to +match the regex `[a-zA-Z0-9]` and are combined with a dot. + +OPTIONS +------- +-f:: + The config file to use. If the value is '-', stdin will be used as + input. The option can be given multiple times. +-D:: + Disables the inclusion of the default files. +-k:: + Looks up the given key. +-l:: + Selects the location to use. + +LOCATIONS AND DEFAULT FILES +--------------------------- + +'app-cat-conf' will by default look for configuration files in three places: + +. $APPSH_HOME/lib/default-config + +. $HOME/.appconfig + +. .app/config + +SEE ALSO +-------- + +git-config(1) + +// vim: set ft=asciidoc: diff --git a/docs/app-conf.txt b/docs/app-conf.txt index 27d995a..c686960 100644 --- a/docs/app-conf.txt +++ b/docs/app-conf.txt @@ -5,7 +5,6 @@ NAME ---- app-conf - configuration management - SYNOPSIS -------- [verse] diff --git a/docs/app.txt b/docs/app.txt index 4756ef2..49ed59e 100644 --- a/docs/app.txt +++ b/docs/app.txt @@ -11,6 +11,16 @@ SYNOPSIS [verse] 'app' <options> +QUICK START +~~~~~~~~~~~ + + $ app init -d my-app maven org.example:my-app:1.0-SNAPSHOT + $ cd my-app + $ app start + $ app conf set app.version 1.0 + $ app upgrade + $ app restart + INSTALLING AN APPLICATION ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -80,4 +90,10 @@ TODOs * Find a way to check if an application is running. +SEE ALSO +-------- + +* app-conf +* app-cat-conf + // vim: set ft=asciidoc: |