From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1qOjY7-0004cq-RB for mharc-grub-devel@gnu.org; Wed, 26 Jul 2023 14:47:51 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qOjY6-0004ci-Vp for grub-devel@gnu.org; Wed, 26 Jul 2023 14:47:50 -0400 Received: from mail-ua1-x936.google.com ([2607:f8b0:4864:20::936]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qOjY5-0003FQ-3s for grub-devel@gnu.org; Wed, 26 Jul 2023 14:47:50 -0400 Received: by mail-ua1-x936.google.com with SMTP id a1e0cc1a2514c-79a31d66002so79550241.3 for ; Wed, 26 Jul 2023 11:47:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=efficientek-com.20221208.gappssmtp.com; s=20221208; t=1690397267; x=1691002067; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=XriF7946TBgoFNL9gNRVwqLzkxMxhP+A0vRPfZ1cZ/M=; b=Od8utloGSRsE5yfmqPA/Vz8XOxEA4JkwNEHPoteKZtexIN6sG9CmLk1LBwf/DjaCJY M89pM2spQSzNSEJ6BYereLhQ3lHF1XtVdZ847qk2r8LfE4Ol0N4wSFMhmr/7t/8PnOmy H9OLBbdH15skVhtJ0ladVKc5JejWBb/O804lcCNbEoH/OVpmdwv+cm4SJaQH1aj15mSL mEj1hxBLvbKYRRM2qwIUNUflLtLpiwmA1AmCBgmXe2VH6B5Ayr/UXqSBUNHH2xGwbB9x HxMsa4SRXys0XU612jBNofhRFdV/FKpJlqFvsy/8zHIRRNmClLxtLiq2S7/sYI6QLl+f feoQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1690397267; x=1691002067; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=XriF7946TBgoFNL9gNRVwqLzkxMxhP+A0vRPfZ1cZ/M=; b=ckKc4uUt9NKPqcEjfM+WYOR6XLuJDERjhQHRGZvLhJs1uoWGqXok4DWasX8/jr2iPp iqMaqs3kfyMJpaYLOVEDvpZZFb1ZvssZWcb5hwO3jzZJb7ZFvUe82CECwOt05LIPvvmG IkdUSyI68ax5GPGaj8iOzhaPcjBjouIoccjYgRWRuE+ClCtM+3RwVLa/VSP9qMyLdvzz ZtzVxuGoKB+6wPT6coMcg3OYXQH+iYGAE+fClroH0ttUB0pxZchR+/LZ/I/Co/MYvOBJ ytwFRKKwyoVUQHvctfuqCYAOafGWh6CMCwa9UEBmoVTgyx3RMjTjFK9YJd9FLIolm5wq bsbQ== X-Gm-Message-State: ABy/qLa+LpqO1Sl8tpfNND2twn/KlW67ylP9Dq6wRAukMJZRoOBy/O+W vJ0VuIzPvEy6uV6P18MnViCY26QgOwSPh3Ow0P8= X-Google-Smtp-Source: APBJJlGuP3P/BEsjj1kkzyg2BD4/VFTJtAEWs8ZRIoVrmisOZmHaQFdFkXeiaGr850DJoJEKio4MyA== X-Received: by 2002:a1f:dd44:0:b0:486:4c0e:9ae5 with SMTP id u65-20020a1fdd44000000b004864c0e9ae5mr2076875vkg.13.1690397267074; Wed, 26 Jul 2023 11:47:47 -0700 (PDT) Received: from localhost.localdomain ([37.218.244.249]) by smtp.gmail.com with ESMTPSA id n14-20020ac5cd4e000000b00474e3a611ccsm2155563vkm.33.2023.07.26.11.47.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 26 Jul 2023 11:47:46 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Glenn Washburn Subject: [PATCH] docs: Group usage of user-space utilities into single chapter Date: Wed, 26 Jul 2023 13:47:24 -0500 Message-Id: <20230726184724.1286479-1-development@efficientek.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::936; envelope-from=development@efficientek.com; helo=mail-ua1-x936.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: Wed, 26 Jul 2023 18:47:51 -0000 Signed-off-by: Glenn Washburn --- docs/grub.texi | 42 +++++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/docs/grub.texi b/docs/grub.texi index fe94ef9e94fc..dae10621b99f 100644 --- a/docs/grub.texi +++ b/docs/grub.texi @@ -104,15 +104,7 @@ This edition documents version @value{VERSION}. * Platform-specific operations:: Platform-specific operations * Supported kernels:: Supported kernels * Troubleshooting:: Error messages produced by GRUB -* Invoking grub-install:: How to use the GRUB installer -* Invoking grub-mkconfig:: Generate a GRUB configuration file -* Invoking grub-mkpasswd-pbkdf2:: - Generate GRUB password hashes -* Invoking grub-mkrelpath:: Make system path relative to its root -* Invoking grub-mkrescue:: Make a GRUB rescue image -* Invoking grub-mount:: Mount a file system using GRUB -* Invoking grub-probe:: Probe device information for GRUB -* Invoking grub-script-check:: Check GRUB script file for syntax errors +* User-space utilities:: Usage of user-space utilities * Obtaining and Building GRUB:: How to obtain and build GRUB * Reporting bugs:: Where you should send a bug report * Future:: Some future plans on GRUB @@ -7034,8 +7026,24 @@ entry which claims partition start at block 0. This change will not hamper bootability on other machines. +@node User-space utilities +@chapter User-space utilities + +@menu +* Invoking grub-install:: How to use the GRUB installer +* Invoking grub-mkconfig:: Generate a GRUB configuration file +* Invoking grub-mkpasswd-pbkdf2:: + Generate GRUB password hashes +* Invoking grub-mkrelpath:: Make system path relative to its root +* Invoking grub-mkrescue:: Make a GRUB rescue image +* Invoking grub-mount:: Mount a file system using GRUB +* Invoking grub-probe:: Probe device information for GRUB +* Invoking grub-script-check:: Check GRUB script file for syntax errors +@end menu + + @node Invoking grub-install -@chapter Invoking grub-install +@section Invoking grub-install The program @command{grub-install} generates a GRUB core image using @command{grub-mkimage} and installs it on your system. You must specify the @@ -7101,7 +7109,7 @@ outside of the MBR. Disable the Reed-Solomon codes with this option. @end table @node Invoking grub-mkconfig -@chapter Invoking grub-mkconfig +@section Invoking grub-mkconfig The program @command{grub-mkconfig} generates a configuration file for GRUB (@pxref{Simple configuration}). @@ -7127,7 +7135,7 @@ it to standard output. @node Invoking grub-mkpasswd-pbkdf2 -@chapter Invoking grub-mkpasswd-pbkdf2 +@section Invoking grub-mkpasswd-pbkdf2 The program @command{grub-mkpasswd-pbkdf2} generates password hashes for GRUB (@pxref{Security}). @@ -7155,7 +7163,7 @@ Length of the salt. Defaults to 64. @node Invoking grub-mkrelpath -@chapter Invoking grub-mkrelpath +@section Invoking grub-mkrelpath The program @command{grub-mkrelpath} makes a file system path relative to the root of its containing file system. For instance, if @file{/usr} is a @@ -7182,7 +7190,7 @@ Print the version number of GRUB and exit. @node Invoking grub-mkrescue -@chapter Invoking grub-mkrescue +@section Invoking grub-mkrescue The program @command{grub-mkrescue} generates a bootable GRUB rescue image (@pxref{Making a GRUB bootable CD-ROM}). @@ -7240,7 +7248,7 @@ built-in default. @node Invoking grub-mount -@chapter Invoking grub-mount +@section Invoking grub-mount The program @command{grub-mount} performs a read-only mount of any file system or file system image that GRUB understands, using GRUB's file system @@ -7327,7 +7335,7 @@ Print verbose messages. @node Invoking grub-probe -@chapter Invoking grub-probe +@section Invoking grub-probe The program @command{grub-probe} probes device information for a given path or device. @@ -7413,7 +7421,7 @@ Print verbose messages. @node Invoking grub-script-check -@chapter Invoking grub-script-check +@section Invoking grub-script-check The program @command{grub-script-check} takes a GRUB script file (@pxref{Shell-like scripting}) and checks it for syntax errors, similar to -- 2.34.1