From: Robbie Harwood <rharwood@redhat.com>
Date: Fri, 19 Aug 2022 21:02:26 +0000 (-0400)
Subject: docs: Document fwsetup command
X-Git-Tag: grub-2.12-rc1~272
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ce21bf557d26ef6500b47a4d3112e76c37bbb9f0;p=thirdparty%2Fgrub.git

docs: Document fwsetup command

Signed-off-by: Robbie Harwood <rharwood@redhat.com>
Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>
---

diff --git a/docs/grub.texi b/docs/grub.texi
index b848d0928..a3ca2c8a2 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -4242,6 +4242,7 @@ you forget a command, you can run the command @command{help}
 * eval::                        Evaluate agruments as GRUB commands
 * export::                      Export an environment variable
 * false::                       Do nothing, unsuccessfully
+* fwsetup::                     Reboot into the firmware setup menu
 * gettext::                     Translate a string
 * gptsync::                     Fill an MBR based on GPT entries
 * halt::                        Shut down your computer
@@ -4754,6 +4755,16 @@ such as @code{if} and @code{while} (@pxref{Shell-like scripting}).
 @end deffn
 
 
+@node fwsetup
+@subsection fwsetup
+
+@deffn Command fwsetup [@option{--is-supported}]
+Reboot into the firmware setup menu. If @option{--is-supported} option is
+specified, instead check whether the firmware supports a setup menu and
+exit successfully if so.
+@end deffn
+
+
 @node gettext
 @subsection gettext
 
@@ -5939,7 +5950,6 @@ GRUB shell may provide more information on parameters and usage.
 @item @command{fix_video} - Fix video problem.
 @item @command{fpswa} - Display FPSWA version.
 @item @command{functional_test} - Run all loaded functional tests.
-@item @command{fwsetup} - Reboot into firmware setup menu.
 @item @command{gdbstub_break} - Break into GDB
 @item @command{gdbstub} -  Start GDB stub on given port
 @item @command{gdbstub_stop} - Stop GDB stub