Debian Codegraph @

upstream/debian-unstable/man8/grub-install.8

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH GRUB-INSTALL "8" "February 2026" "GRUB 2.14-2" "System Administration Utilities"
3 .SH NAME
4 grub-install \- install GRUB to a device
5 .SH SYNOPSIS
6 .B grub-install
7 [\fI\,OPTION\/\fR...] [\fI\,OPTION\/\fR] [\fI\,INSTALL_DEVICE\/\fR]
8 .SH DESCRIPTION
9 Install GRUB on your drive.
10 .TP
11 \fB\-\-appended\-signature\-size\fR=\fI\,SIZE\/\fR
12 Add a note segment reserving SIZE bytes for an
13 appended signature
14 .TP
15 \fB\-\-compress\fR=\fI\,no\/\fR|xz|gz|lzo
16 compress GRUB files [optional]
17 .TP
18 \fB\-\-disable\-cli\fR
19 disabled command line interface access
20 .TP
21 \fB\-\-disable\-shim\-lock\fR
22 disable shim_lock verifier
23 .TP
24 \fB\-\-dtb\fR=\fI\,FILE\/\fR
25 embed a specific DTB
26 .TP
27 \fB\-d\fR, \fB\-\-directory\fR=\fI\,DIR\/\fR
28 use images and modules under DIR
29 [default=/usr/lib/grub/<platform>]
30 .TP
31 \fB\-\-fonts\fR=\fI\,FONTS\/\fR
32 install FONTS [default=unicode]
33 .TP
34 \fB\-\-install\-modules\fR=\fI\,MODULES\/\fR
35 install only MODULES and their dependencies
36 [default=all]
37 .TP
38 \fB\-k\fR, \fB\-\-pubkey\fR=\fI\,FILE\/\fR
39 embed FILE as public key for signature checking
40 .TP
41 \fB\-\-locale\-directory\fR=\fI\,DIR\/\fR use translations under DIR
42 [default=/usr/share/locale]
43 .TP
44 \fB\-\-locales\fR=\fI\,LOCALES\/\fR
45 install only LOCALES [default=all]
46 .TP
47 \fB\-\-modules\fR=\fI\,MODULES\/\fR
48 pre\-load specified modules MODULES
49 .TP
50 \fB\-\-sbat\fR=\fI\,FILE\/\fR
51 SBAT metadata
52 .TP
53 \fB\-\-themes\fR=\fI\,THEMES\/\fR
54 install THEMES [default=starfield]
55 .TP
56 \fB\-v\fR, \fB\-\-verbose\fR
57 print verbose messages.
58 .TP
59 \fB\-x\fR, \fB\-\-x509key\fR=\fI\,FILE\/\fR
60 embed FILE as an x509 certificate for appended
61 signature checking
62 .TP
63 \fB\-\-allow\-floppy\fR
64 make the drive also bootable as floppy (default
65 for fdX devices). May break on some BIOSes.
66 .TP
67 \fB\-\-boot\-directory\fR=\fI\,DIR\/\fR
68 install GRUB images under the directory DIR/grub
69 instead of the boot/grub directory
70 .TP
71 \fB\-\-bootloader\-id\fR=\fI\,ID\/\fR
72 the ID of bootloader. This option is only
73 available on EFI and Macs.
74 .TP
75 \fB\-\-core\-compress\fR=\fI\,xz\/\fR|none|auto
76 choose the compression to use for core image
77 .TP
78 \fB\-\-disk\-module\fR=\fI\,MODULE\/\fR
79 disk module to use (biosdisk or native). This
80 option is only available on BIOS target.
81 .TP
82 \fB\-\-efi\-directory\fR=\fI\,DIR\/\fR
83 use DIR as the EFI System Partition root.
84 .TP
85 \fB\-\-force\fR
86 install even if problems are detected
87 .TP
88 \fB\-\-force\-extra\-removable\fR
89 force installation to the removable media path
90 also. This option is only available on EFI.
91 .TP
92 \fB\-\-force\-file\-id\fR
93 use identifier file even if UUID is available
94 .TP
95 \fB\-\-label\-bgcolor\fR=\fI\,COLOR\/\fR
96 use COLOR for label background
97 .TP
98 \fB\-\-label\-color\fR=\fI\,COLOR\/\fR
99 use COLOR for label
100 .TP
101 \fB\-\-label\-font\fR=\fI\,FILE\/\fR
102 use FILE as font for label
103 .HP
104 \fB\-\-macppc\-directory\fR=\fI\,DIR\/\fR use DIR for PPC MAC install.
105 .TP
106 \fB\-\-no\-bootsector\fR
107 do not install bootsector
108 .TP
109 \fB\-\-no\-nvram\fR
110 don't update the `boot\-device'/`Boot*' NVRAM
111 variables. This option is only available on EFI
112 and IEEE1275 targets.
113 .TP
114 \fB\-\-no\-rs\-codes\fR
115 Do not apply any reed\-solomon codes when
116 embedding core.img. This option is only available
117 on x86 BIOS targets.
118 .TP
119 \fB\-\-no\-uefi\-secure\-boot\fR
120 do not install an image usable with UEFI Secure
121 Boot, even if the system was currently started
122 using it. This option is only available on EFI.
123 .TP
124 \fB\-\-product\-version\fR=\fI\,STRING\/\fR
125 use STRING as product version
126 .TP
127 \fB\-\-recheck\fR
128 delete device map if it already exists
129 .TP
130 \fB\-\-removable\fR
131 the installation device is removable. This option
132 is only available on EFI.
133 .TP
134 \fB\-s\fR, \fB\-\-skip\-fs\-probe\fR
135 do not probe for filesystems in DEVICE
136 .TP
137 \fB\-\-target\fR=\fI\,TARGET\/\fR
138 install GRUB for TARGET platform
139 [default=i386\-pc]; available targets:
140 arm\-coreboot, arm\-efi, arm\-uboot, arm64\-efi,
141 i386\-coreboot, i386\-efi, i386\-ieee1275,
142 i386\-multiboot, i386\-pc, i386\-qemu, i386\-xen,
143 i386\-xen_pvh, ia64\-efi, loongarch64\-efi,
144 mips\-arc, mips\-qemu_mips, mipsel\-arc,
145 mipsel\-loongson, mipsel\-qemu_mips,
146 powerpc\-ieee1275, riscv32\-efi, riscv64\-efi,
147 sparc64\-ieee1275, x86_64\-efi, x86_64\-xen
148 .TP
149 \fB\-\-uefi\-secure\-boot\fR
150 install an image usable with UEFI Secure Boot.
151 This option is only available on EFI and if the
152 grub\-efi\-amd64\-signed package is installed.
153 .TP
154 \-?, \fB\-\-help\fR
155 give this help list
156 .TP
157 \fB\-\-usage\fR
158 give a short usage message
159 .TP
160 \fB\-V\fR, \fB\-\-version\fR
161 print program version
162 .PP
163 Mandatory or optional arguments to long options are also mandatory or optional
164 for any corresponding short options.
165 .PP
166 INSTALL_DEVICE must be system device filename.
167 grub\-install copies GRUB images into boot/grub. On some platforms, it may
168 also install GRUB into the boot sector.
169 .SH "REPORTING BUGS"
170 Report bugs to <bug\[email protected]>.
171 .SH "SEE ALSO"
172 .BR grub-mkconfig (8),
173 .BR grub-mkimage (1),
174 .BR grub-mkrescue (1)
175 .PP
176 The full documentation for
177 .B grub-install
178 is maintained as a Texinfo manual. If the
179 .B info
180 and
181 .B grub-install
182 programs are properly installed at your site, the command
183 .IP
184 .B info grub-install
185 .PP
186 should give you access to the complete manual.