Skip to content

Commit

Permalink
man: Add ostree admin status man page CLI options.
Browse files Browse the repository at this point in the history
Document the various CLI options.

Signed-off-by: Eric Curtin <[email protected]>
  • Loading branch information
ericcurtin committed Jan 5, 2024
1 parent 1397ee2 commit 1f1a405
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 1 deletion.
59 changes: 59 additions & 0 deletions man/ostree-admin-status.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion src/ostree/ot-admin-builtin-status.c
Original file line number Diff line number Diff line change
Expand Up @@ -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 "
Expand Down

0 comments on commit 1f1a405

Please sign in to comment.