From 1f1a40518a180dee22eaf45f5967eeca526fa73a Mon Sep 17 00:00:00 2001
From: Eric Curtin <ecurtin@redhat.com>
Date: Fri, 5 Jan 2024 17:08:43 +0000
Subject: [PATCH] man: Add ostree admin status man page CLI options.

Document the various CLI options.

Signed-off-by: Eric Curtin <ecurtin@redhat.com>
---
 man/ostree-admin-status.xml          | 59 ++++++++++++++++++++++++++++
 src/ostree/ot-admin-builtin-status.c |  2 +-
 2 files changed, 60 insertions(+), 1 deletion(-)

diff --git a/man/ostree-admin-status.xml b/man/ostree-admin-status.xml
index dde099b00d..cc90312c91 100644
--- a/man/ostree-admin-status.xml
+++ b/man/ostree-admin-status.xml
@@ -61,6 +61,65 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
         </para>
     </refsect1>
 
+    <refsect1>
+        <title>Options</title>
+
+        <variablelist>
+            <varlistentry>
+                <term><option>--sysroot</option>="PATH"</term>
+
+                <listitem><para>
+                    Create a new OSTree sysroot at PATH
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>-V, --verify</option></term>
+
+                <listitem><para>
+                    Print the commit verification status
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>-S, --skip-signatures</option></term>
+
+                <listitem><para>
+                    Skip signatures in output
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>-Q, --query-booted</option></term>
+
+                <listitem><para>
+                    Output the string <literal>default</literal> if the default deployment
+                    is the booted one, <literal>not-default</literal> if we are booted in
+                    a non-default deployment (e.g. the user interactively chose a
+                    different entry in the bootloader menu, or the bootloader rolled back
+                    automatically, etc.). If we are not in a booted OSTree system, an
+                    error is returned.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>-v, --verbose</option></term>
+
+                <listitem><para>
+                    Print debug information during command processing
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--version</option>--version</term>
+
+                <listitem><para>
+                    Print version information and exit
+                </para></listitem>
+            </varlistentry>
+        </variablelist>
+    </refsect1>
+
     <refsect1>
         <title>Example</title>
         <para><command>$ ostree admin status</command></para>
diff --git a/src/ostree/ot-admin-builtin-status.c b/src/ostree/ot-admin-builtin-status.c
index d4822793ef..2e99ccb52e 100644
--- a/src/ostree/ot-admin-builtin-status.c
+++ b/src/ostree/ot-admin-builtin-status.c
@@ -36,7 +36,7 @@ static GOptionEntry options[] = {
   { "verify", 'V', 0, G_OPTION_ARG_NONE, &opt_verify, "Print the commit verification status",
     NULL },
   { "skip-signatures", 'S', 0, G_OPTION_ARG_NONE, &opt_skip_signatures,
-    "Print the commit verification status", NULL },
+    "Skip signatures in output", NULL },
   { "query-booted", 'Q', 0, G_OPTION_ARG_NONE, &opt_query_booted,
     "Output the string \"default\" if the default deployment is the booted one, \"not-default\" if "
     "we are booted in a non-default deployment (e.g. the user interactively chose a different "