aboutsummaryrefslogtreecommitdiff
path: root/bpkg/rep-info.cli
diff options
context:
space:
mode:
Diffstat (limited to 'bpkg/rep-info.cli')
-rw-r--r--bpkg/rep-info.cli53
1 files changed, 53 insertions, 0 deletions
diff --git a/bpkg/rep-info.cli b/bpkg/rep-info.cli
new file mode 100644
index 0000000..0db3004
--- /dev/null
+++ b/bpkg/rep-info.cli
@@ -0,0 +1,53 @@
+// file : bpkg/rep-info.cli
+// copyright : Copyright (c) 2014-2016 Code Synthesis Ltd
+// license : MIT; see accompanying LICENSE file
+
+include <bpkg/common.cli>;
+
+"\section=1"
+"\name=bpkg-rep-info"
+"\summary=print information about repository"
+
+/*
+"\h{SYNOPSIS}
+
+bpkg rep-info [<options>] <rep>"
+
+"\h{DESCRIPTION}
+
+The \cb{rep-info} command prints information about the specified repository.
+By default it print the repository's name and location as the first line
+followed by the list of prerequisite/complement repositories and the list
+of available packages. This default behavior, however, can be altered in
+various ways using options listed below. Note that the information is
+written to \cb{STDOUT}, not \cb{STDERR}."
+*/
+
+namespace bpkg
+{
+ class rep_info_options: common_options
+ {
+ bool --name|-n
+ {
+ "Print the specified repository's name and location."
+ }
+
+ bool --repositories|-r
+ {
+ "Print information about prerequisite/complement repositories."
+ }
+
+ bool --packages|-p
+ {
+ "Print information about available packages."
+ }
+
+ bool --manifest|-m
+ {
+ "Instead of printing the information in the human-readable form, dump
+ it as manifest(s). Normally you would use this option in combination
+ with \cb{--packages|-p} or \cb{--repositories|-r} to only dump one
+ of the manifests."
+ }
+ };
+}