bootmeth.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. .. SPDX-License-Identifier: GPL-2.0+:
  2. bootmeth command
  3. ================
  4. Synopis
  5. -------
  6. ::
  7. bootmeth list [-a] - list selected bootmeths (-a for all)
  8. bootmeth order "[<bm> ...]" - select the order of bootmeths\n"
  9. Description
  10. -----------
  11. The `bootmeth` command is used to manage bootmeths. It can list them and change
  12. the order in which they are used.
  13. See :doc:`../../develop/bootstd` for more information.
  14. .. _bootmeth_order:
  15. bootmeth order
  16. ~~~~~~~~~~~~~~
  17. Selects which bootmeths to use and the order in which they are invoked. When
  18. scanning bootdevs, each bootmeth is tried in turn to see if it can find a valid
  19. bootflow. You can use this command to adjust the order or even to omit some
  20. boomeths.
  21. The argument is a quoted list of bootmeths to use, by name. If global bootmeths
  22. are included, they must be at the end, otherwise the scanning mechanism will not
  23. work correctly.
  24. bootmeth list
  25. ~~~~~~~~~~~~~
  26. This lists the selected bootmeths, or all of them, if the `-a` flag is used.
  27. The format looks like this:
  28. ===== === ================== =================================
  29. Order Seq Name Description
  30. ===== === ================== =================================
  31. 0 0 extlinunx Extlinux boot from a block device
  32. 1 1 efi EFI boot from an .efi file
  33. 2 2 pxe PXE boot from a network device
  34. 3 3 sandbox Sandbox boot for testing
  35. glob 4 efi_mgr EFI bootmgr flow
  36. ===== === ================== =================================
  37. The fields are as follows:
  38. Order:
  39. The order in which these bootmeths are invoked for each bootdev. If this
  40. shows as a hyphen, then the bootmeth is not in the current ordering. If it
  41. shows as 'glob', then this is a global bootmeth and should be at the end.
  42. Seq:
  43. The sequence number of the bootmeth, i.e. the normal ordering if none is set
  44. Name:
  45. Name of the bootmeth
  46. Description:
  47. A friendly description for the bootmeth
  48. Example
  49. -------
  50. This shows listing bootmeths. All are present and in the normal order::
  51. => bootmeth list
  52. Order Seq Name Description
  53. ----- --- ------------------ ------------------
  54. 0 0 distro Extlinux boot from a block device
  55. 1 1 efi EFI boot from an .efi file
  56. 2 2 pxe PXE boot from a network device
  57. 3 3 sandbox Sandbox boot for testing
  58. 4 4 efi_mgr EFI bootmgr flow
  59. ----- --- ------------------ ------------------
  60. (5 bootmeths)
  61. Now the order is changed, to include only two of them::
  62. => bootmeth order "sandbox distro"
  63. => bootmeth list
  64. Order Seq Name Description
  65. ----- --- ------------------ ------------------
  66. 0 3 sandbox Sandbox boot for testing
  67. 1 0 distro Extlinux boot from a block device
  68. ----- --- ------------------ ------------------
  69. (2 bootmeths)
  70. The -a flag shows all bootmeths so you can clearly see which ones are used and
  71. which are not::
  72. => bootmeth list -a
  73. Order Seq Name Description
  74. ----- --- ------------------ ------------------
  75. 1 0 distro Extlinux boot from a block device
  76. - 1 efi EFI boot from an .efi file
  77. - 2 pxe PXE boot from a network device
  78. 0 3 sandbox Sandbox boot for testing
  79. - 4 efi_mgr EFI bootmgr flow
  80. ----- --- ------------------ ------------------
  81. (5 bootmeths)