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