diff options
author | Glenn Washburn <development@efficientek.com> | 2021-09-18 19:33:05 +0000 |
---|---|---|
committer | Daniel Kiper <daniel.kiper@oracle.com> | 2021-09-20 13:52:55 +0200 |
commit | 710cb5da349d9f03f966b19ec4087912f038fbde (patch) | |
tree | d5450d50c23a6db783341b996c80ed8ad1123abe | |
parent | da5f6dffbabcdc438bdaa78fd422a673e6ad26eb (diff) | |
download | grub-710cb5da349d9f03f966b19ec4087912f038fbde.tar.gz |
docs/grub: Improve search documentation, by adding short options and section on hints
Signed-off-by: Glenn Washburn <development@efficientek.com>
Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>
-rw-r--r-- | docs/grub.texi | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/docs/grub.texi b/docs/grub.texi index 255a781c2..99d0a0149 100644 --- a/docs/grub.texi +++ b/docs/grub.texi @@ -5006,16 +5006,25 @@ Search devices by file (@option{-f}, @option{--file}), filesystem label (@option{-l}, @option{--label}), or filesystem UUID (@option{-u}, @option{--fs-uuid}). -If the @option{--set} option is used, the first device found is set as the -value of environment variable @var{var}. The default variable is +If the (@option{-s}, @option{--set}) option is used, the first device found is +set as the value of environment variable @var{var}. The default variable is @samp{root}. -The @option{--no-floppy} option prevents searching floppy devices, which can -be slow. +The (@option{-n}, @option{--no-floppy}) option prevents searching floppy +devices, which can be slow. The @samp{search.file}, @samp{search.fs_label}, and @samp{search.fs_uuid} commands are aliases for @samp{search --file}, @samp{search --label}, and @samp{search --fs-uuid} respectively. + +Also hints as to which device may be the most likely to contain the item +searched for may be given via the (@option{-h}, @option{--hint}) option with +a device name as an argument. If the argument ends with a comma, then partitions +on the device are also searched. Furthermore, platform specific hints may be +given via the options @option{--hint-ieee1275}, @option{--hint-bios}, +@option{--hint-baremetal}, @option{--hint-efi}, and @option{--hint-arc}. When +specified, these options take an argument and operate like @option{--hint}, but +only on the specified platform. @end deffn |