diff options
author | Karen Arutyunov <karen@codesynthesis.com> | 2021-07-19 19:26:34 +0300 |
---|---|---|
committer | Karen Arutyunov <karen@codesynthesis.com> | 2021-07-20 17:30:05 +0300 |
commit | d4c243bde6d3043b6e04adf249f13e8275ddd528 (patch) | |
tree | 361d57156be541189442a9e868c0b878e8f6ea20 /bpkg/cfg-info.cli | |
parent | 5d513688ae07d96910dd1eef83bdad4e9d780373 (diff) |
Add support for cfg-info
Diffstat (limited to 'bpkg/cfg-info.cli')
-rw-r--r-- | bpkg/cfg-info.cli | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/bpkg/cfg-info.cli b/bpkg/cfg-info.cli new file mode 100644 index 0000000..5ce41c1 --- /dev/null +++ b/bpkg/cfg-info.cli @@ -0,0 +1,62 @@ +// file : bpkg/cfg-info.cli +// license : MIT; see accompanying LICENSE file + +include <bpkg/configuration.cli>; + +"\section=1" +"\name=bpkg-cfg-info" +"\summary=print configuration information" + +namespace bpkg +{ + { + "<options> <dir>", + + "\h|SYNOPSIS| + + \c{\b{bpkg cfg-info} [<options>]} + + \h|DESCRIPTION| + + The \cb{cfg-info} command prints the current configuration's absolute + path, id, type, and name. Note that the information is written to + \cb{stdout}, not \cb{stderr}. + + The output format is regular with each value printed on a separate line + and prefixed with the value name. For example: + + \ + path: /path/to/cfg/ + uuid: 8d439f03-7342-4502-8b1c-74b173869478 + type: target + name: foo + \ + " + } + + class cfg_info_options: configuration_options + { + "\h|CFG-INFO OPTIONS|" + }; + + " + \h|DEFAULT OPTIONS FILES| + + See \l{bpkg-default-options-files(1)} for an overview of the default + options files. For the \cb{cfg-info} command the search start directory is + the configuration directory. The following options files are searched for + in each directory and, if found, loaded in the order listed: + + \ + bpkg.options + bpkg-cfg-info.options + \ + + The following \cb{cfg-info} command options cannot be specified in the + default options files: + + \ + --directory|-d + \ + " +} |