aboutsummaryrefslogtreecommitdiff
path: root/bpkg/pkg-status-options.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-01-11 10:04:02 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-01-11 10:04:02 +0200
commitad257079568746d71d913c6fca96852da6fe3bd6 (patch)
treed7a59392a1159c630c4fd0ccad816e9fd3acadf3 /bpkg/pkg-status-options.cli
parent302834a875804ff943dfb005682949fd3d404d01 (diff)
Reorganize .cli files, add man/xhtml page generation (via script for now)
Diffstat (limited to 'bpkg/pkg-status-options.cli')
-rw-r--r--bpkg/pkg-status-options.cli109
1 files changed, 0 insertions, 109 deletions
diff --git a/bpkg/pkg-status-options.cli b/bpkg/pkg-status-options.cli
deleted file mode 100644
index bd2959c..0000000
--- a/bpkg/pkg-status-options.cli
+++ /dev/null
@@ -1,109 +0,0 @@
-// file : bpkg/pkg-status-options.cli
-// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
-// license : MIT; see accompanying LICENSE file
-
-include <bpkg/configuration-options.cli>;
-
-"\section=1"
-"\name=bpkg-pkg-status"
-"\summary=print package status"
-
-namespace bpkg
-{
- {
- "<options> <pkg> <ver>",
-
- "\h|SYNOPSIS|
-
- \c{\b{bpkg pkg-status} [<options>] <pkg>[/<ver>]}
-
- \h|DESCRIPTION|
-
- 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}.
-
- The status format is regular. First always comes one of the following
- status words:
-
- \dl|
-
- \li|\cb{unknown}
-
- package is not part of the configuration nor available in one of the
- repositories|
-
- \li|\cb{available}
-
- package is not part of the configuration but is available in one of
- the repositories|
-
- \li|\cb{fetched}
-
- package is part of the configuration and is fetched|
-
- \li|\cb{unpacked}
-
- package is part of the configuration and is unpacked|
-
- \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.
-
- 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
- unknown
-
- bpkg pkg-status libbar/1.0.0
- unknown
-
- bpkg pkg-status libfoo/1.0.0
- configured hold_package
-
- bpkg pkg-status libfoo/1.1.0
- available
-
- bpkg pkg-status libfoo
- configured 1.0.0 hold_package; available 1.1.0 1.1.1
- \
-
- Assuming now that we dropped libfoo from the configuration:
-
- \
- bpkg pkg-status libfoo/1.0.0
- unknown
-
- bpkg pkg-status libfoo/1.1.0
- available
-
- bpkg pkg-status libfoo
- available 1.1.0 1.1.1
- \
- "
- }
-
- class pkg_status_options: configuration_options
- {
- "\h|PKG-STATUS OPTIONS|"
- };
-}