summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2019-11-22 19:48:58 +0000
committerrillig <rillig@pkgsrc.org>2019-11-22 19:48:58 +0000
commit67b2a52bb102d147a3b60a3b92e95a94d57d4cf1 (patch)
tree85ec0608064dc8d899e88c6fddadb09f97054871
parent889e5576b9e8c45ccc7a581ac1f7638a47ced1b3 (diff)
downloadpkgsrc-67b2a52bb102d147a3b60a3b92e95a94d57d4cf1.tar.gz
doc/guide: document the show-all target in the help sections
-rw-r--r--doc/guide/files/help-devel.xml16
-rw-r--r--doc/guide/files/help-user.xml16
2 files changed, 30 insertions, 2 deletions
diff --git a/doc/guide/files/help-devel.xml b/doc/guide/files/help-devel.xml
index 945b3346a01..0722b9c09b4 100644
--- a/doc/guide/files/help-devel.xml
+++ b/doc/guide/files/help-devel.xml
@@ -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 --git a/doc/guide/files/help-user.xml b/doc/guide/files/help-user.xml
index e17be838eba..d52af631cb2 100644
--- a/doc/guide/files/help-user.xml
+++ b/doc/guide/files/help-user.xml
@@ -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