From 7d03940f6816329fa9ae131591717749bc76be5a Mon Sep 17 00:00:00 2001
From: Karen Arutyunov <karen@codesynthesis.com>
Date: Wed, 30 Oct 2019 16:56:24 +0300
Subject: Document default options files for commands

---
 bpkg/pkg-update.cli | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'bpkg/pkg-update.cli')

diff --git a/bpkg/pkg-update.cli b/bpkg/pkg-update.cli
index 9eb98b8..57e46ad 100644
--- a/bpkg/pkg-update.cli
+++ b/bpkg/pkg-update.cli
@@ -52,4 +52,25 @@ namespace bpkg
        \cb{install} or \cb{test}."
     }
   };
+
+  "
+   \h|DEFAULT OPTIONS FILES|
+
+   See \l{bpkg-default-options-files(1)} for an overview of the default
+   options files. For the \cb{pkg-update} command the search start
+   directory is the configuration directory. The following options files are
+   searched for in each directory and, if found, loaded in the order listed:
+
+   \
+   bpkg.options
+   bpkg-pkg-update.options
+   \
+
+   The following \cb{pkg-update} command options cannot be specified in the
+   default options files:
+
+   \
+   --directory|-d
+   \
+  "
 }
-- 
cgit v1.1