[pkgsrc/trunk]: pkgsrc/doc/guide/files doc/guide: document the show-all targe...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/c542e3cfe6af
branches:  trunk
changeset: 418205:c542e3cfe6af
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Fri Nov 22 19:48:58 2019 +0000

description:
doc/guide: document the show-all target in the help sections

diffstat:

 doc/guide/files/help-devel.xml |  16 +++++++++++++++-
 doc/guide/files/help-user.xml  |  16 +++++++++++++++-
 2 files changed, 30 insertions(+), 2 deletions(-)

diffs (60 lines):

diff -r 33e09e70125b -r c542e3cfe6af doc/guide/files/help-devel.xml
--- a/doc/guide/files/help-devel.xml    Fri Nov 22 19:30:23 2019 +0000
+++ b/doc/guide/files/help-devel.xml    Fri Nov 22 19:48:58 2019 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: help-devel.xml,v 1.2 2019/04/28 15:22:24 rillig Exp $ -->
+<!-- $NetBSD: help-devel.xml,v 1.3 2019/11/22 19:48:58 rillig Exp $ -->
 
 <chapter id="help-devel">
 <title>Getting help</title>
@@ -23,6 +23,20 @@
 </listitem>
 
 <listitem><para>
+       To see the value of a single variable, run <command>bmake
+       show-var VARNAME=<replaceable>X</replaceable></command>.
+</para></listitem>
+
+<listitem><para>
+       To see the values of the most common variables, run
+       <command>bmake show-all</command>. These variables are grouped by
+       topic. To see the variables for a single topic, run
+       <command>bmake
+       show-all-<replaceable>topic</replaceable></command>, for example
+       <command>bmake show-all-fetch</command>.
+</para></listitem>
+
+<listitem><para>
        The tech-pkg mailing list, to which
        <ulink url="https://www.NetBSD.org/mailinglists/#tech-pkg";>you
        can subscribe</ulink> and then <ulink
diff -r 33e09e70125b -r c542e3cfe6af doc/guide/files/help-user.xml
--- a/doc/guide/files/help-user.xml     Fri Nov 22 19:30:23 2019 +0000
+++ b/doc/guide/files/help-user.xml     Fri Nov 22 19:48:58 2019 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: help-user.xml,v 1.2 2019/04/28 15:22:24 rillig Exp $ -->
+<!-- $NetBSD: help-user.xml,v 1.3 2019/11/22 19:48:58 rillig Exp $ -->
 
 <chapter id="help-user">
 <title>Getting help</title>
@@ -24,6 +24,20 @@
 </listitem>
 
 <listitem><para>
+       To see the value of a single variable, run <command>bmake
+       show-var VARNAME=<replaceable>X</replaceable></command>.
+</para></listitem>
+
+<listitem><para>
+       To see the values of the most common variables, run
+       <command>bmake show-all</command>. These variables are grouped by
+       topic. To see the variables for a single topic, run
+       <command>bmake
+       show-all-<replaceable>topic</replaceable></command>, for example
+       <command>bmake show-all-fetch</command>.
+</para></listitem>
+
+<listitem><para>
        The pkgsrc-users mailing list, to which
        <ulink url="https://www.NetBSD.org/mailinglists/#pkgsrc-users";>you
        can subscribe</ulink> and then <ulink