diff --git a/Makefile b/Makefile index 5bef2ab..b1762a7 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,7 @@ ARCHIVE_TARGETS := \ dist/stackctl/completion/fish \ dist/stackctl/completion/zsh \ dist/stackctl/doc/stackctl.1 \ + dist/stackctl/doc/stackctl.5 \ dist/stackctl/doc/stackctl-cat.1 \ dist/stackctl/doc/stackctl-capture.1 \ dist/stackctl/doc/stackctl-changes.1 \ @@ -56,6 +57,7 @@ install: $(INSTALL) -Dm644 completion/fish $(DESTDIR)$(PREFIX)/share/fish/vendor_completions.d/stackctl.fish $(INSTALL) -Dm644 completion/zsh $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_stackctl $(INSTALL) -Dm644 doc/stackctl.1 $(DESTDIR)$(MANPREFIX)/man1/stackctl.1 + $(INSTALL) -Dm644 doc/stackctl.5 $(DESTDIR)$(MANPREFIX)/man5/stackctl.5 $(INSTALL) -Dm644 doc/stackctl-cat.1 $(DESTDIR)$(MANPREFIX)/man1/stackctl-cat.1 $(INSTALL) -Dm644 doc/stackctl-capture.1 $(DESTDIR)$(MANPREFIX)/man1/stackctl-capture.1 $(INSTALL) -Dm644 doc/stackctl-changes.1 $(DESTDIR)$(MANPREFIX)/man1/stackctl-changes.1 @@ -69,6 +71,7 @@ uninstall: $(RM) $(DESTDIR)$(PREFIX)/share/fish/vendor_completions.d/stackctl.fish $(RM) $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_stackctl $(RM) $(DESTDIR)$(MANPREFIX)/man1/stackctl.1 + $(RM) $(DESTDIR)$(MANPREFIX)/man5/stackctl.5 $(RM) $(DESTDIR)$(MANPREFIX)/man1/stackctl-cat.1 $(RM) $(DESTDIR)$(MANPREFIX)/man1/stackctl-capture.1 $(RM) $(DESTDIR)$(MANPREFIX)/man1/stackctl-changes.1 diff --git a/man/index.txt b/man/index.txt index 793d09f..a697daa 100644 --- a/man/index.txt +++ b/man/index.txt @@ -1,4 +1,6 @@ # manuals included in this project: +stackctl(1) stackctl.1.ronn +stackctl(5) stackctl.5.ronn stackctl-cat(1) stackctl-cat.1.ronn stackctl-capture(1) stackctl-capture.1.ronn stackctl-changes(1) stackctl-changes.1.ronn diff --git a/man/stackctl.1.ronn b/man/stackctl.1.ronn index 3f86fa2..5f9ec2f 100644 --- a/man/stackctl.1.ronn +++ b/man/stackctl.1.ronn @@ -253,6 +253,11 @@ See stackctl-changes(1) and stackctl-deploy(1). If set, will be used as in commands that create new specifications. +## FILES + +* `.config/stackctl.yaml`: + The configuration file for Stackctl. See stackctl(5) for details. + ## AUTHOR Freckle Engineering diff --git a/man/stackctl.5.ronn b/man/stackctl.5.ronn new file mode 100644 index 0000000..dbf87dc --- /dev/null +++ b/man/stackctl.5.ronn @@ -0,0 +1,50 @@ +stackctl(5) - configuration file for Stackctl +============================================= + +## SYNOPSIS + +`.stackctl/config.yaml`
+`.stackctl/config.yml`
+`.stackctl.yaml`
+`.stackctl.yml`
+ +The first path to exist will be used. + +## DESCRIPTION + +The configuration file is a YAML object with the following keys: + + * `required_version` :: : + A constraint on the version of Stackctl that must be used. The constraint + can be an exact version, or use an operator to define a minimum, maximum, or + "loose" constraint (see [EXAMPLE](#EXAMPLE)). + + * `defaults.parameters` :: >: + Parameters to use for all deploys, in the same format as the `.Parameters` + key of a stack specification (see **stackctl(1)**). + + * `defaults.tags` :: >: + Tags to use for all deploys, in the same format as the `.Tags` key of a + stack specification (see **stackctl(1)**). + +All keys are optional. + +## EXAMPLE + + + required_version: "=~ 1.7.1" # means >= 1.7.1.0 and < 1.7.2.0 + + defaults: + parameters: # list-of-object syntax + - Key: Foo + Value: Bar + - Key: Baz + Value: Bat + + tags: # object syntax (recommended) + Foo: Bar + Baz: Bat + +## SEE ALSO + +**stackctl(1)**