From 87e476cf192b70c133a1bf00efa8586348326092 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Wed, 25 Nov 2015 09:19:19 +0200
Subject: New command line help setup

---
 bpkg/common-options.cli | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

(limited to 'bpkg/common-options.cli')

diff --git a/bpkg/common-options.cli b/bpkg/common-options.cli
index a8b6744..f07d70e 100644
--- a/bpkg/common-options.cli
+++ b/bpkg/common-options.cli
@@ -5,13 +5,38 @@
 include <bpkg/types>;
 
 "\section=1"
-"\name=bpkg-common"
-"\summary=common options for all commands"
+"\name=bpkg-common-options"
+"\summary=options common for all commands"
 
 namespace bpkg
 {
+  {
+    "<common-options>",
+
+    "\h|SYNOPSIS|
+
+     \c{\b{bpkg} [<common-options>] ...}
+
+     \h|DESCRIPTION|
+
+     The common options can be specified either before the command or after,
+     togethere with the command-specific options."
+  }
+
   class common_options = 0
   {
+    "\h|COMMON OPTIONS|"
+
+    // Retain this note only in the summary.
+    //
+    {
+      "",
+      "The common options are summarized below with a more detailed description
+       available as the \l{bpkg-common-options(1) \cb{common-options}} help
+       topic.",
+      ""
+    }
+
     bool -v
     {
       "Print underlying commands being executed. This is equivalent to
-- 
cgit v1.1