diff options
Diffstat (limited to 'bpkg/pkg-status-options.cli')
| -rw-r--r-- | bpkg/pkg-status-options.cli | 126 |
1 files changed, 64 insertions, 62 deletions
diff --git a/bpkg/pkg-status-options.cli b/bpkg/pkg-status-options.cli index c3ea3d6..f106ddc 100644 --- a/bpkg/pkg-status-options.cli +++ b/bpkg/pkg-status-options.cli @@ -8,100 +8,102 @@ include <bpkg/configuration-options.cli>; "\name=bpkg-pkg-status" "\summary=print package status" +namespace bpkg { -"<options> <pkg> <ver>", - -"\h|SYNOPSIS| + { + "<options> <pkg> <ver>", -\c{\b{bpkg pkg-status} [<options>] <pkg>[/<ver>]} + "\h|SYNOPSIS| -\h|DESCRIPTION| + \c{\b{bpkg pkg-status} [<options>] <pkg>[/<ver>]} -The \cb{pkg-status} command prints the status of the specified package or, if -<ver> is specified, package version. Note that the status is written to -\cb{STDOUT}, not \cb{STDERR}. + \h|DESCRIPTION| -The status format is regular. First always comes one of the following status -words: + The \cb{pkg-status} command prints the status of the specified package or, + if <ver> is specified, package version. Note that the status is written + to \cb{STDOUT}, not \cb{STDERR}. -\dl| + The status format is regular. First always comes one of the following + status words: -\li|\cb{unknown} + \dl| - package is not part of the configuration nor available in one of the - repositories| + \li|\cb{unknown} -\li|\cb{available} + package is not part of the configuration nor available in one of the + repositories| - package is not part of the configuration but is available in one of the - repositories| + \li|\cb{available} -\li|\cb{fetched} + package is not part of the configuration but is available in one of + the repositories| - package is part of the configuration and is fetched| + \li|\cb{fetched} -\li|\cb{unpacked} + package is part of the configuration and is fetched| - package is part of the configuration and is unpacked| + \li|\cb{unpacked} -\li|\cb{configured} + package is part of the configuration and is unpacked| - package is part of the configuration and is configured|| + \li|\cb{configured} + package is part of the configuration and is configured|| -If only the package name was specified without the package version, then the -\cb{available} status word is followed by the list of available versions. -Similarly, if only the package name was specified, then the \cb{fetched}, -\cb{unpacked}, and \cb{configured} status words are followed by the version -of the package. After the possible package version, these status words may -be followed by one or more sub-status words. Currently, these can be -\cb{hold_package} (package should not be automatically dropped) and -\cb{hold_version} (package should not be automatically upgraded). Finally, -if only the package name was specified and newer versions are available -in the repositories, then the sub-status words are followed by '\cb{;}', -the \cb{available} status word, and the list of newer versions. + If only the package name was specified without the package version, then + the \cb{available} status word is followed by the list of available + versions. -Below are some examples, assuming the configuration has libfoo 1.0.0 -configured and held as well as libfoo 1.1.0 and 1.1.1 available from a -repository. + Similarly, if only the package name was specified, then the \cb{fetched}, + \cb{unpacked}, and \cb{configured} status words are followed by the + version of the package. After the possible package version, these status + words may be followed by one or more sub-status words. Currently, these + can be \cb{hold_package} (package should not be automatically dropped) + and \cb{hold_version} (package should not be automatically upgraded). + Finally, if only the package name was specified and newer versions are + available in the repositories, then the sub-status words are followed + by '\cb{;}', the \cb{available} status word, and the list of newer + versions. -\ -bpkg pkg-status libbar -unknown + Below are some examples, assuming the configuration has libfoo 1.0.0 + configured and held as well as libfoo 1.1.0 and 1.1.1 available from a + repository. -bpkg pkg-status libbar/1.0.0 -unknown + \ + bpkg pkg-status libbar + unknown -bpkg pkg-status libfoo/1.0.0 -configured hold_package + bpkg pkg-status libbar/1.0.0 + unknown -bpkg pkg-status libfoo/1.1.0 -available + bpkg pkg-status libfoo/1.0.0 + configured hold_package -bpkg pkg-status libfoo -configured 1.0.0 hold_package; available 1.1.0 1.1.1 -\ + bpkg pkg-status libfoo/1.1.0 + available -Assuming now that we dropped libfoo from the configuration: + bpkg pkg-status libfoo + configured 1.0.0 hold_package; available 1.1.0 1.1.1 + \ -\ -bpkg pkg-status libfoo/1.0.0 -unknown + Assuming now that we dropped libfoo from the configuration: -bpkg pkg-status libfoo/1.1.0 -available + \ + bpkg pkg-status libfoo/1.0.0 + unknown -bpkg pkg-status libfoo -available 1.1.0 1.1.1 -\ + bpkg pkg-status libfoo/1.1.0 + available -\h|OPTIONS|" -} + bpkg pkg-status libfoo + available 1.1.0 1.1.1 + \ + " + } -namespace bpkg -{ class pkg_status_options: configuration_options { + "\h|PKG-STATUS OPTIONS|" }; } |