Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1noz0c-0005ui-2y for mharc-grub-devel@gnu.org; Wed, 11 May 2022 22:56:58 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:36304) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1noz0a-0005nv-D5 for grub-devel@gnu.org; Wed, 11 May 2022 22:56:56 -0400 Received: from mail-vs1-xe29.google.com ([2607:f8b0:4864:20::e29]:42761) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1noz0Y-0008Ht-71 for grub-devel@gnu.org; Wed, 11 May 2022 22:56:56 -0400 Received: by mail-vs1-xe29.google.com with SMTP id i186so3850527vsc.9 for ; Wed, 11 May 2022 19:56:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=efficientek-com.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=proKSiB0u5qj708EvKKUgNTRrJbO2MCNQoJGe8T6I78=; b=s0H0T54xEfKnti0OEoJ2ZAdvPTP3ribLemSFTq3IfmBB8B02VW8y4dxuDcIAbbbQyc Pf+5oHhI6622B7wc5muQre7SoFzi/aCWdMImnXbnNpjD6wOWPYEC2X7mLfoUdy0cg6t5 mlaEIu4zYN1nnQxl0dY/QdT+FIn1Kko8pex3z9Lh24lH6WW8ING4vr1GcuJnVX2EJHu+ doyPYVukfPdNHIc0A6cGBrnrz2s2hbWUxJe4ZXkq5iGQUYCgdtBErpvjoyrUq2XlHyJo Z/EBdGsD6xqgI4hwu0o3huepbEljx9TzjH1qSqvA1ZJVxyrfHysmXJfiG63iRoLphrG4 LDmQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=proKSiB0u5qj708EvKKUgNTRrJbO2MCNQoJGe8T6I78=; b=Y3IQCMATxJVSx2Z2P46rCUHKyiUSuhqDVksacT/L3Pl5nPK4ISJQfCKwDAFS/eucO6 +X0CIkHyw2ksAx0WE3w1oHluKcY5P6undXUlPRtOhXjR2kXm/fHZ/7jFAj/ooSfPvCnF yEc0HfFff2+UAIwQBLOswbpCq+mHx+w9sIamkpbo+67TgHcM/HRay1sNNdDCbkE7oMx5 zkqmfRFZxnC7lcapQvhF/vm4PXF/Ai0OEzQSVfP/dwnR9Ymh68iNDZD9EfRFUt5BEsCS i/pKYYlIIL3p38NUMkGwKd50ptGaTRIgPI8ahwIMWwFT6h5C1NP7EugaCzvQTnZycc/b zaTw== X-Gm-Message-State: AOAM531Ytp3pSbtTP4u8mzrPuEFg1/xKjeFmcsrafbXQ4h+TLXYQqCpH RCHIrZ6O18j33EpKTJFc31x2brg7wu/UB/+r X-Google-Smtp-Source: ABdhPJx/BDNvWyLUkQZ3KFF+JISAceiX9L5vKDvXYCnKQr6roAMcNgYt8sw+FwKQY2GRSIJXgcYA0g== X-Received: by 2002:a67:f7d0:0:b0:32c:f2bb:13e3 with SMTP id a16-20020a67f7d0000000b0032cf2bb13e3mr15820759vsp.66.1652324212840; Wed, 11 May 2022 19:56:52 -0700 (PDT) Received: from localhost.localdomain ([37.218.244.249]) by smtp.gmail.com with ESMTPSA id m7-20020a05612210e700b0034e6f1fd05esm490769vko.40.2022.05.11.19.56.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 11 May 2022 19:56:52 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Glenn Washburn Subject: [PATCH 5/7] docs: Create command section for loader commands Date: Wed, 11 May 2022 21:56:22 -0500 Message-Id: <38c101d405aefd62c80e5aa4acfce2ba047656ac.1652323528.git.development@efficientek.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::e29; envelope-from=development@efficientek.com; helo=mail-vs1-xe29.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 12 May 2022 02:56:56 -0000 Move loader commands documented in the general commands list into the loader command section. Signed-off-by: Glenn Washburn --- docs/grub.texi | 220 ++++++++++++++++++++++++++----------------------- 1 file changed, 116 insertions(+), 104 deletions(-) diff --git a/docs/grub.texi b/docs/grub.texi index d96f08722..eea575e0c 100644 --- a/docs/grub.texi +++ b/docs/grub.texi @@ -3830,6 +3830,7 @@ shell}. @menu * Menu-specific commands:: +* Loader commands:: * General commands:: * Command-line and menu entry commands:: * Networking commands:: @@ -3917,6 +3918,121 @@ All options are the same as in the @command{menuentry} command @end deffn +@node Loader commands +@section The list of various loader commands + +These commands are used to load necessary components to boot desired OS. + +@menu +* chainloader:: Chain-load another boot loader +* initrd:: Load a Linux initrd +* initrd16:: Load a Linux initrd (16-bit mode) +* linux:: Load a Linux kernel +* linux16:: Load a Linux kernel (16-bit mode) +@comment * xen_*:: Xen boot commands for AArch64 +* xen_hypervisor:: Load xen hypervisor binary (only on AArch64) +* xen_module:: Load xen modules for xen hypervisor (only on AArch64) +@end menu + + +@node chainloader +@subsection chainloader + +@deffn Command chainloader [@option{--force}] file +Load @var{file} as a chain-loader. Like any other file loaded by the +filesystem code, it can use the blocklist notation (@pxref{Block list +syntax}) to grab the first sector of the current partition with @samp{+1}. +If you specify the option @option{--force}, then load @var{file} forcibly, +whether it has a correct signature or not. This is required when you want to +load a defective boot loader, such as SCO UnixWare 7.1. +@end deffn + + +@node initrd +@subsection initrd + +@deffn Command initrd file [file @dots{}] +Load, in order, all initial ramdisks for a Linux kernel image, and set +the appropriate parameters in the Linux setup area in memory. This may only +be used after the @command{linux} command (@pxref{linux}) has been run. See +also @ref{GNU/Linux}. +@end deffn + + +@node initrd16 +@subsection initrd16 + +@deffn Command initrd16 file [file @dots{}] +Load, in order, all initial ramdisks for a Linux kernel image to be booted in +16-bit mode, and set the appropriate parameters in the Linux setup area in +memory. This may only be used after the @command{linux16} command +(@pxref{linux16}) has been run. See also @ref{GNU/Linux}. + +This command is only available on x86 systems. +@end deffn + + +@node linux +@subsection linux + +@deffn Command linux file @dots{} +Load a Linux kernel image from @var{file}. The rest of the line is passed +verbatim as the @dfn{kernel command-line}. Any initrd must be reloaded +after using this command (@pxref{initrd}). + +On x86 systems, the kernel will be booted using the 32-bit boot protocol. +Note that this means that the @samp{vga=} boot option will not work; if you +want to set a special video mode, you will need to use GRUB commands such as +@samp{set gfxpayload=1024x768} or @samp{set gfxpayload=keep} (to keep the +same mode as used in GRUB) instead. GRUB can automatically detect some uses +of @samp{vga=} and translate them to appropriate settings of +@samp{gfxpayload}. The @command{linux16} command (@pxref{linux16}) avoids +this restriction. +@end deffn + + +@node linux16 +@subsection linux16 + +@deffn Command linux16 file @dots{} +Load a Linux kernel image from @var{file} in 16-bit mode. The rest of the +line is passed verbatim as the @dfn{kernel command-line}. Any initrd must +be reloaded after using this command (@pxref{initrd16}). + +The kernel will be booted using the traditional 16-bit boot protocol. As +well as bypassing problems with @samp{vga=} described in @ref{linux}, this +permits booting some other programs that implement the Linux boot protocol +for the sake of convenience. + +This command is only available on x86 systems. +@end deffn + + +@node xen_hypervisor +@subsection xen_hypervisor + +@deffn Command xen_hypervisor file [arguments] @dots{} +Load a Xen hypervisor binary from @var{file}. The rest of the line is passed +verbatim as the @dfn{kernel command-line}. Any other binaries must be +reloaded after using this command. +This command is only available on AArch64 systems. +@end deffn + + +@node xen_module +@subsection xen_module + +@deffn Command xen_module [--nounzip] file [arguments] +Load a module for xen hypervisor at the booting process of xen. +The rest of the line is passed verbatim as the module command line. +Modules should be loaded in the following order: + - dom0 kernel image + - dom0 ramdisk if present + - XSM policy if present +This command is only available on AArch64 systems. +@end deffn + + @node General commands @section The list of general commands @@ -4034,7 +4150,6 @@ you forget a command, you can run the command @command{help} * blocklist:: Print a block list * boot:: Start up your operating system * cat:: Show the contents of a file -* chainloader:: Chain-load another boot loader * clear:: Clear the screen * cmosclean:: Clear bit in CMOS * cmosdump:: Dump CMOS contents @@ -4058,12 +4173,8 @@ you forget a command, you can run the command @command{help} * halt:: Shut down your computer * hashsum:: Compute or check hash checksum * help:: Show help messages -* initrd:: Load a Linux initrd -* initrd16:: Load a Linux initrd (16-bit mode) * insmod:: Insert a module * keystatus:: Check key modifier status -* linux:: Load a Linux kernel -* linux16:: Load a Linux kernel (16-bit mode) * list_env:: List variables in environment block * list_trusted:: List trusted public keys * load_env:: Load variables from environment block @@ -4105,10 +4216,7 @@ you forget a command, you can run the command @command{help} @comment * vbeinfo:: List available video modes * verify_detached:: Verify detached digital signature * videoinfo:: List available video modes -@comment * xen_*:: Xen boot commands for AArch64 * wrmsr:: Write values to model-specific registers -* xen_hypervisor:: Load xen hypervisor binary (only on AArch64) -* xen_module:: Load xen modules for xen hypervisor (only on AArch64) @end menu @@ -4246,19 +4354,6 @@ endings. @end deffn -@node chainloader -@subsection chainloader - -@deffn Command chainloader [@option{--force}] file -Load @var{file} as a chain-loader. Like any other file loaded by the -filesystem code, it can use the blocklist notation (@pxref{Block list -syntax}) to grab the first sector of the current partition with @samp{+1}. -If you specify the option @option{--force}, then load @var{file} forcibly, -whether it has a correct signature or not. This is required when you want to -load a defective boot loader, such as SCO UnixWare 7.1. -@end deffn - - @node clear @subsection clear @@ -4612,30 +4707,6 @@ about each of the commands whose names begin with those @var{patterns}. @end deffn -@node initrd -@subsection initrd - -@deffn Command initrd file [file @dots{}] -Load, in order, all initial ramdisks for a Linux kernel image, and set -the appropriate parameters in the Linux setup area in memory. This may only -be used after the @command{linux} command (@pxref{linux}) has been run. See -also @ref{GNU/Linux}. -@end deffn - - -@node initrd16 -@subsection initrd16 - -@deffn Command initrd16 file [file @dots{}] -Load, in order, all initial ramdisks for a Linux kernel image to be booted in -16-bit mode, and set the appropriate parameters in the Linux setup area in -memory. This may only be used after the @command{linux16} command -(@pxref{linux16}) has been run. See also @ref{GNU/Linux}. - -This command is only available on x86 systems. -@end deffn - - @node insmod @subsection insmod @@ -4658,42 +4729,6 @@ only if checking key modifier status is supported. @end deffn -@node linux -@subsection linux - -@deffn Command linux file @dots{} -Load a Linux kernel image from @var{file}. The rest of the line is passed -verbatim as the @dfn{kernel command-line}. Any initrd must be reloaded -after using this command (@pxref{initrd}). - -On x86 systems, the kernel will be booted using the 32-bit boot protocol. -Note that this means that the @samp{vga=} boot option will not work; if you -want to set a special video mode, you will need to use GRUB commands such as -@samp{set gfxpayload=1024x768} or @samp{set gfxpayload=keep} (to keep the -same mode as used in GRUB) instead. GRUB can automatically detect some uses -of @samp{vga=} and translate them to appropriate settings of -@samp{gfxpayload}. The @command{linux16} command (@pxref{linux16}) avoids -this restriction. -@end deffn - - -@node linux16 -@subsection linux16 - -@deffn Command linux16 file @dots{} -Load a Linux kernel image from @var{file} in 16-bit mode. The rest of the -line is passed verbatim as the @dfn{kernel command-line}. Any initrd must -be reloaded after using this command (@pxref{initrd16}). - -The kernel will be booted using the traditional 16-bit boot protocol. As -well as bypassing problems with @samp{vga=} described in @ref{linux}, this -permits booting some other programs that implement the Linux boot protocol -for the sake of convenience. - -This command is only available on x86 systems. -@end deffn - - @node list_env @subsection list_env @@ -5532,29 +5567,6 @@ Note: The command is not allowed when lockdown is enforced (@pxref{Lockdown}). This is done to prevent subverting various security mechanisms. @end deffn -@node xen_hypervisor -@subsection xen_hypervisor - -@deffn Command xen_hypervisor file [arguments] @dots{} -Load a Xen hypervisor binary from @var{file}. The rest of the line is passed -verbatim as the @dfn{kernel command-line}. Any other binaries must be -reloaded after using this command. -This command is only available on AArch64 systems. -@end deffn - -@node xen_module -@subsection xen_module - -@deffn Command xen_module [--nounzip] file [arguments] -Load a module for xen hypervisor at the booting process of xen. -The rest of the line is passed verbatim as the module command line. -Modules should be loaded in the following order: - - dom0 kernel image - - dom0 ramdisk if present - - XSM policy if present -This command is only available on AArch64 systems. -@end deffn - @node Networking commands @section The list of networking commands -- 2.34.1