mirror of
https://github.com/Antynea/grub-btrfs.git
synced 2026-10-20 02:42:03 +08:00
manpages: correct some minor things
Signed-off-by: Pascal Jäger <pascal.jaeger@leimstift.de>
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
GRUB_BTRFS_VERSION=4.12-improve-config-2022-12-06T21:56:44+00:00
|
GRUB_BTRFS_VERSION=4.12-improve-config-2022-12-06T22:10:24+00:00
|
||||||
|
|
||||||
# Disable grub-btrfs.
|
# Disable grub-btrfs.
|
||||||
# Default: "false"
|
# Default: "false"
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.TH "grub-btrfs" "8"
|
.TH "grub-btrfs" "8"
|
||||||
|
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
.PP
|
.PP
|
||||||
@@ -193,13 +193,9 @@ Some distributions (like OpenSuSE) store those file at the snapshot directory
|
|||||||
instead of boot. Be aware that this direcory must be available for grub during
|
instead of boot. Be aware that this direcory must be available for grub during
|
||||||
startup of the system.
|
startup of the system.
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
Default: $GRUB\d\s-2BTRFS\s+2\u\d\s-2GRUB\s+2\u\d\s-2DIRNAME\s+2\u
|
Default: \fC$GRUB_BTRFS_GRUB_DIRNAME\fP
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
<<<<<<< HEAD
|
|
||||||
Example: \fCGRUB_BTRFS_GBTRFS_DIRNAME="/.snapshots"\fP
|
Example: \fCGRUB_BTRFS_GBTRFS_DIRNAME="/.snapshots"\fP
|
||||||
=======
|
|
||||||
Example \fCGRUB_BTRFS_GBTRFS_DIRNAME="/boot/grub2"\fP
|
|
||||||
>>>>>>> e76cdc4 (grub-btrfs: add custom kernel parameters option for snapshots)
|
|
||||||
|
|
||||||
.SS "\fCGRUB_BTRFS_GBTRFS_SEARCH_DIRNAME\fP"
|
.SS "\fCGRUB_BTRFS_GBTRFS_SEARCH_DIRNAME\fP"
|
||||||
.PP
|
.PP
|
||||||
@@ -216,7 +212,7 @@ NOTE: If variables of grub are used here like ${prefix}, they need to be escaped
|
|||||||
.PP
|
.PP
|
||||||
with `$\` before the `$`
|
with `$\` before the `$`
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
Example: GRUB\d\s-2BTRFS\s+2\u\d\s-2GBTRFS\s+2\u\d\s-2SEARCH\s+2\u\d\s-2DIRNAME\s+2\u=“\${prefix}”
|
Example: \fCGRUB_BTRFS_GBTRFS_SEARCH_DIRNAME="\${prefix}"\fP
|
||||||
|
|
||||||
.SS "\fCGRUB_BTRFS_MKCONFIG\fP"
|
.SS "\fCGRUB_BTRFS_MKCONFIG\fP"
|
||||||
.PP
|
.PP
|
||||||
@@ -256,7 +252,9 @@ and this comment \fIhttps://github.com/Antynea/grub-btrfs/issues/95#issuecomment
|
|||||||
Add authorized usernames separate by comma (userfoo,userbar).
|
Add authorized usernames separate by comma (userfoo,userbar).
|
||||||
When Grub’s password protection is enabled, the superuser is authorized by default, it is not necessary to add it
|
When Grub’s password protection is enabled, the superuser is authorized by default, it is not necessary to add it
|
||||||
.IP \(em 4
|
.IP \(em 4
|
||||||
Default: “- Example: \fCGRUB_BTRFS_PROTECTION_AUTHORIZED_USERS="userfoo,userbar"\fP
|
Default: “”
|
||||||
|
.IP \(em 4
|
||||||
|
Example: \fCGRUB_BTRFS_PROTECTION_AUTHORIZED_USERS="userfoo,userbar"\fP
|
||||||
|
|
||||||
.SS "\fCGRUB_BTRFS_DISABLE_PROTECTION_SUBMENU\fP"
|
.SS "\fCGRUB_BTRFS_DISABLE_PROTECTION_SUBMENU\fP"
|
||||||
.PP
|
.PP
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
#+title: grub-btrfs
|
#+title: grub-btrfs
|
||||||
#+author: Pascal Jaeger
|
#+author: Pascal Jaeger
|
||||||
#+man_class_option: :sectionid 8
|
#+MAN_CLASS_OPTIONS: :section-id "8"
|
||||||
|
|
||||||
* NAME
|
* NAME
|
||||||
grub-btrfs - Automatically add btrfs-Snapshots as a Grub submenu
|
grub-btrfs - Automatically add btrfs-Snapshots as a Grub submenu
|
||||||
@@ -141,7 +141,7 @@ For example, on Fedora with EFI : "/boot/efi/EFI/fedora"
|
|||||||
Some distributions (like OpenSuSE) store those file at the snapshot directory
|
Some distributions (like OpenSuSE) store those file at the snapshot directory
|
||||||
instead of boot. Be aware that this direcory must be available for grub during
|
instead of boot. Be aware that this direcory must be available for grub during
|
||||||
startup of the system.
|
startup of the system.
|
||||||
- Default: $GRUB_BTRFS_GRUB_DIRNAME
|
- Default: ~$GRUB_BTRFS_GRUB_DIRNAME~
|
||||||
- Example: ~GRUB_BTRFS_GBTRFS_DIRNAME="/.snapshots"~
|
- Example: ~GRUB_BTRFS_GBTRFS_DIRNAME="/.snapshots"~
|
||||||
|
|
||||||
*** ~GRUB_BTRFS_GBTRFS_SEARCH_DIRNAME~
|
*** ~GRUB_BTRFS_GBTRFS_SEARCH_DIRNAME~
|
||||||
@@ -153,10 +153,13 @@ startup of the system.
|
|||||||
installed. (like /boot/grub, /boot/efi/grub))
|
installed. (like /boot/grub, /boot/efi/grub))
|
||||||
- NOTE: If variables of grub are used here like ${prefix}, they need to be escaped
|
- NOTE: If variables of grub are used here like ${prefix}, they need to be escaped
|
||||||
with `\` before the `$`
|
with `\` before the `$`
|
||||||
- Example: GRUB_BTRFS_GBTRFS_SEARCH_DIRNAME="\${prefix}"
|
- Example: ~GRUB_BTRFS_GBTRFS_SEARCH_DIRNAME="\${prefix}"~
|
||||||
|
|
||||||
*** ~GRUB_BTRFS_MKCONFIG~
|
*** ~GRUB_BTRFS_MKCONFIG~
|
||||||
Name/path of the command to generate the grub menu, used by "grub-btrfs.service"
|
Name/path of the command to generate the grub menu, used by
|
||||||
|
#+BEGIN_MAN
|
||||||
|
.BR grub-btrfsd (8)
|
||||||
|
#+END_MAN
|
||||||
Might be 'grub2-mkconfig' on some systems (e.g. Fedora)
|
Might be 'grub2-mkconfig' on some systems (e.g. Fedora)
|
||||||
Default paths are /sbin:/bin:/usr/sbin:/usr/bin, if your path is missing, report it on the upstream project.
|
Default paths are /sbin:/bin:/usr/sbin:/usr/bin, if your path is missing, report it on the upstream project.
|
||||||
You can use the name of the command only or full the path.
|
You can use the name of the command only or full the path.
|
||||||
@@ -183,7 +186,8 @@ Refer to the Grub documentation https://www.gnu.org/software/grub/manual/grub/gr
|
|||||||
and this comment https://github.com/Antynea/grub-btrfs/issues/95#issuecomment-682295660
|
and this comment https://github.com/Antynea/grub-btrfs/issues/95#issuecomment-682295660
|
||||||
Add authorized usernames separate by comma (userfoo,userbar).
|
Add authorized usernames separate by comma (userfoo,userbar).
|
||||||
When Grub's password protection is enabled, the superuser is authorized by default, it is not necessary to add it
|
When Grub's password protection is enabled, the superuser is authorized by default, it is not necessary to add it
|
||||||
- Default: "- Example: ~GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS="userfoo,userbar"~
|
- Default: ""
|
||||||
|
- Example: ~GRUB_BTRFS_PROTECTION_AUTHORIZED_USERS="userfoo,userbar"~
|
||||||
|
|
||||||
*** ~GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU~
|
*** ~GRUB_BTRFS_DISABLE_PROTECTION_SUBMENU~
|
||||||
Disable authentication support for submenu of Grub-btrfs only (--unrestricted)
|
Disable authentication support for submenu of Grub-btrfs only (--unrestricted)
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.TH "grub-btrfsd" "8"
|
.TH "grub-btrfsd" "8"
|
||||||
|
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
.PP
|
.PP
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
#+title: grub-btrfsd
|
#+title: grub-btrfsd
|
||||||
#+author: Pascal Jaeger
|
#+author: Pascal Jaeger
|
||||||
#+man_class_option: :sectionid 8
|
#+MAN_CLASS_OPTIONS: :section-id "8"
|
||||||
|
|
||||||
* NAME
|
* NAME
|
||||||
grub-btrfsd - An OpenRC daemon to automatically update the grub menu with
|
grub-btrfsd - An OpenRC daemon to automatically update the grub menu with
|
||||||
|
|||||||
Reference in New Issue
Block a user