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