Penguin
Recent Changes
Blame: kernel-img.conf(5)
EditPageHistoryDiffInfoLikePages
Annotated edit history of kernel-img.conf(5) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 KERNEL-IMG.CONF
2 !!!KERNEL-IMG.CONF
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 FILES
7 SEE ALSO
8 BUGS
9 AUTHOR
10 ----
11 !!NAME
12
13
14 kernel-img.conf - site wide configuration file for kernel image packages
15 !!SYNOPSIS
16
17
18 ''/etc/kernel-img.conf''
19 !!DESCRIPTION
20
21
22 The file ''/etc/kernel-img.conf'' is a simple file looked
23 at by the kernel image post installation process to allow
24 local options for handling some aspects of the installation,
25 overriding the defaults built into the image
26 itself.
27
28
29 The format of the file is a simple __VAR = VALUE__ pair.
30 Boolean values may be specified as ''Yes, True, 1,'' and
31 ''No, False, 0,'' and are case insensitive. This file is
32 automatically created by the installation script if it does
33 not exist, and neither does the symbolic link
34 ''/vmlinuz.'' The script asks the user whether the
35 symbolic link should be created, and stashes the answer into
36 ''/etc/kernel-img.conf''
37
38
39 At the moment, the user modifiable variables supported
40 are:
41
42
43 __image_in_boot__
44
45
46 Set to Yes if you want the kernel image ''vmlinuz'' in
47 ''/boot'' rather than the default ''/.'' Defaults to
48 No.
49
50
51 __do_symlinks__
52
53
54 By default, the kernel image post installation script shall
55 create or update the ''/vmlinuz'' and ''/vmlinuz.old''
56 symbolic links. This is true if a ''/vmlinuz'' link
57 already exists, however, in absence of ''/vmlinuz,'' the
58 script looks to see if this configuration file exists. If it
59 does not, the configuration script asks the user whether to
60 create the symbolic link, and stashes the answer in a newly
61 created ''/etc/kernel-img.conf.'' If the configuration
62 file already exists, and if this option is set to No, no
63 symbolic link is ever created. This for people who have
64 other means of booting their machines, and do not like the
65 symbolic links cluttering up their / directory. Defaults to
66 Yes.
67
68
69 __minimal_swap__
70
71
72 By default, if the /vmlinuz symbolic link does not point to
73 an image which is the same as the image being installed, the
74 postinst moves /vmlinuz to /vmlinuz.old, and creates a
75 symbolic link to the kernel image in /vmlinuz (the exception
76 is to prevent both /vmlinuz and /vmlinuz.old from pointing
77 to the current kernel image -- potentially disastrous if the
78 current image is defective or lacking in any way). However,
79 if this option is enabled, no action is taken if
80 /vmlinuz.old points to the currently installed image (by
81 default, the symbolic links are swapped). Defaults to
82 no.
83
84
85 __no_symlinks__
86
87
88 Whether to use symlinks to the ''image'' file. Mutually
89 exclusive to ''reverse_symlinks.'' Can be used with
90 ''image_in_boot.'' If set to Yes, the image is placed in
91 vmlinuz (instead of /boot/vmlinuz-X.X.XX). The old vmlinuz
92 is moved to vmlinuz.old unconditionally. (Normally, that is
93 only done if the version of the new image differs from the
94 old one). This restricts you to two images, unless you take
95 additional action and save copies of older images. This is
96 for people who have ''/boot'' on a system that does not
97 use symbolic links (and say, they use loadlin as a
98 bootloader). This is a Hack. Defaults to No.
99
100
101 __reverse_symlinks__
102
103
104 Whether to use reverse symlinks (that is, the real file is
105 the one without the version number, and the number version
106 is the link) to the ''image'' file. Mutually exclusive to
107 ''no_symlinks.'' Can be used with ''image_in_boot.''
108 Just like ''no_symlinks,'' except that the
109 /boot/vmlinuz-X.XX is a symbolic link to the real new image,
110 vmlinuz. This, too, restricts you to just two images unless
111 further action is taken. The older symlinks are left
112 dangling. This is for people with ''/boot'' on umsdos,
113 and who can't see the link in dos, but do want to know the
114 image version when in Linux. This is a Hack. Defaults to
115 No.
116
117
118 __image_dest__
119
120
121 If you want the symbolic link (or image, if
122 __move_image__ is set) to be stored elsewhere than
123 ''/'' set this variable to the dir where you want the
124 symbolic link. Please note that this is not a boolean
125 variable. This may be of help to __loadlin__ users, who
126 may set both this and __move_image__ Defaults to
127 ''/.'' This can be used in conjunction with all above
128 options except __image_in_boot,__ which would not make
129 sense. (If both __image_dest__ and __image_in_boot__
130 are set, __image_in_boot__ overrides)
131
132
133 __postinst_hook__
134
135
136 Set this variable to a script to be executed during
137 installation after all the symbolic links are created, but
138 before running the bootloader or offering to create a
139 floppy. This script shall be called with two arguments, the
140 first being the ''version'' of the kernel image, and the
141 second argument being the ''location'' of the kernel
142 image itself. Errors in the script shall produce a warning
143 message, but shall be otherwise ignored. An example script
144 for grub users is present in /usr/share/doc/kernel-package/
145 directory.
146
147
148 __postrm_hook__
149
150
151 Set this variable to a script to be executed in the postrm
152 (that is, after the image has been removed) after all the
153 remove actions have been performed. This script shall be
154 called with two arguments, the first being the
155 ''version'' of the kernel image, and the second argument
156 being the ''location'' of the kernel image itself. Errors
157 in the script shall produce a warning message, but shall be
158 otherwise ignored.
159
160
161 __preinst_hook__
162
163
164 Set this variable to a script to be executed before the
165 package is unpacked, and can be used to put in additional
166 checks. This script shall be called with two arguments, the
167 first being the ''version'' of the kernel image, and the
168 second argument being the ''location'' of the kernel
169 image itself.
170
171
172 __prerm_hook__
173
174
175 Set this variable to a script to be executed before the
176 package files are removed (so any added files may be
177 removed) . This script shall be called with two arguments,
178 the first being the ''version'' of the kernel image, and
179 the second argument being the ''location'' of the kernel
180 image itself. Errors in the script shall produce a warning
181 message, but shall be otherwise ignored.
182
183
184 __move_image__
185
186
187 Instead of creating symbolic links to (or, if
188 __reverse_symlinks__ is set, from) __image_dest,__ the
189 image is moved from its location in ''/boot'' into
190 __image_dest.__ If __reverse_symlinks__ is set,
191 ''/boot'' shall contain a symbolic link to the actual
192 image. This option can be useful to people using loadlin,
193 who may need the image to be moved to a different, dos
194 partition. This variable is unset by default.
195
196
197 __clobber_modules__
198
199
200 If set, the preinst shall silently try to move
201 /lib/modules/version out of the way if it is the same
202 version as the image being installed. Use at your own risk.
203 This variable is unset by default.
204
205
206 __do_boot_enable__
207
208
209 If set to NO, this short circuits all attempts to create
210 boot floppies, run lilo, etc. This has the additional side
211 effect that the postinst is silent. Setting both
212 __do_bootfloppy__ and __do_bootloader__ to NO implies
213 setting __do_boot_enable__ to NO. Defaults to
214 Yes.
215
216
217 __do_bootfloppy__
218
219
220 If set to NO, this prevents the postinst from asking
221 questions about creating a boot floppy. and no boot floppy
222 is created. The bootloader shall still be run. This may cut
223 down on the interaction the postinst has. (It still prompts
224 before formatting ''/dev/fd0)'' Defaults to
225 Yes.
226
227
228 __do_bootloader__
229
230
231 If set to NO, this prevents the postinst from running the
232 boot loader. The user may still be asked to create a floppy,
233 unless __do_bootfloppy__ is also set to NO. Defaults to
234 Yes.
235
236
237 __relative_links__
238
239
240 If set to yes, the kernel image postinst script shall go to
241 extra ordinary lengths to ensure that the symbolic links are
242 relative. Normally, the symbolic links are relative when it
243 is easily determinable that relative links shall work.
244 Defaults to No.
245
246
247 __do_initrd__
248
249
250 Set to YES to prevent the ''kernel-image'' post
251 installation script from issueing a warning when installing
252 an intrd kernel. This assumes you have correctly set up your
253 boot loader to be able to boot the initrd image. Default:
254 no. This is deprecated in favour of the more descriptive
255 __warn_initrd__ option (please note that the sense of the
256 option is inverted).
257
258
259 __warn_initrd__
260
261
262 Set to NO to prevent the ''kernel-image'' post
263 installation script from issueing a warning when installing
264 an intrd kernel. This assumes you have correctly set up your
265 boot loader to be able to boot the initrd image. This is now
266 preferred to __do_initrd,__ since ''warnings'' are
267 what are prevented. Default: YES
268
269
270 __use_hard_links__
271
272
273 This option has been put in for the people who can't handle
274 symbolic links (a boot loader that does not handle symbolic
275 links, for example). If set to YES, this shall cause the
276 kernel image postinst to use hard link instead of symbolic
277 links for the automatically handled /vmlinuz and
278 /vmlinuz.old. I have tried to make it compatible with
279 __move_image__ and __reverse_symlinks__ Caveat: It is
280 up to the end user to ensure that the __image_dest__
281 directory and the location of the image (nominally /boot)
282 live on the same file system (since one can't make hard
283 links scross file systems. __You have been
284 warned.__
285
286
287 __silent_modules__
288
289
290 This option has been put in for the people who are vastly
291 irritated on being warned about preexisting modules
292 directory That directory may belong to an old or defunct
293 package, in which case problems may arise with lefover
294 modules in that dir tree, or the directory may legitimately
295 exist due to a independent modules paqckage being installed
296 for this kernel version that has already been unpacked. In
297 this latter case the existence of the directory is benign.
298 If you set this varable, you shall no longer be given a
299 chance to abort if a preexisting modules directory is
300 detected. This is unset be default.
301
302
303 __silent_loader__
304
305
306 If set, this option shall cause the question asked before
307 running the boot laoder in the installation process to be
308 skipped. Whether or not the boot loader is run is unaffected
309 by this option ( see __do_bootloader__ to see how to
310 control whether the boot loader is run or not, and the
311 absense of the configuration file will also make the install
312 process voluble and interactive).
313 !!FILES
314
315
316 The file described here is
317 ''/etc/kernel-img.conf.''
318 !!SEE ALSO
319
320
4 perry 321 make-kpkg(1), __kernel-pkg.conf__(5),
1 perry 322 make(1), __The GNU Make manual.__
323 !!BUGS
324
325
326 There are no bugs. Any resemblance thereof is delirium.
327 Really.
328 !!AUTHOR
329
330
331 This manual page was written by Manoj Srivastava
332 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.