aboutsummaryrefslogtreecommitdiff
path: root/bpkg/rep-info.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-01-11 15:14:32 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-01-11 15:14:32 +0200
commit1c13ae4ed5d84b32c2c1a0698f9e688c312de989 (patch)
tree4977cf7df549e275205e9ced6ae283ac89c685c4 /bpkg/rep-info.cli
parentad257079568746d71d913c6fca96852da6fe3bd6 (diff)
Documentation improvements
Diffstat (limited to 'bpkg/rep-info.cli')
-rw-r--r--bpkg/rep-info.cli44
1 files changed, 24 insertions, 20 deletions
diff --git a/bpkg/rep-info.cli b/bpkg/rep-info.cli
index 0db3004..7554620 100644
--- a/bpkg/rep-info.cli
+++ b/bpkg/rep-info.cli
@@ -6,27 +6,31 @@ include <bpkg/common.cli>;
"\section=1"
"\name=bpkg-rep-info"
-"\summary=print information about repository"
+"\summary=print repository information"
-/*
-"\h{SYNOPSIS}
+namespace bpkg
+{
+ {
+ "<options> <rep>",
-bpkg rep-info [<options>] <rep>"
+ "\h|SYNOPSIS|
-"\h{DESCRIPTION}
+ \c{\b{bpkg rep-info} [<options>] <rep>}
-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}."
-*/
+ \h|DESCRIPTION|
+
+ The \cb{rep-info} command prints various information about the specified
+ repository. By default it print the repository's name and location as the
+ first line followed by the list of complement and prerequisite
+ 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
{
+ "\h|REP-INFO OPTIONS|"
+
bool --name|-n
{
"Print the specified repository's name and location."
@@ -34,20 +38,20 @@ namespace bpkg
bool --repositories|-r
{
- "Print information about prerequisite/complement repositories."
+ "Print the list of complement and prerequisite repositories."
}
bool --packages|-p
{
- "Print information about available packages."
+ "Print the list of 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."
+ "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."
}
};
}