1 .\" Copyright (c) 1999 Global Technology Associates, Inc.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
18 .\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
19 .\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
20 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
22 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
23 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 This utility is deprecated.
43 Users are advised to use
45 and compress the kernel with
51 utility compresses a kernel or some other bootable binary.
53 is in two phases as follows:
56 A load image of the executable file is built which omits all but
62 This image is compressed using
64 and output as data in relocatable object format.
66 The object file is linked with a special self-hosting loader, producing
67 an executable suitable for booting with either the second- or
68 third-level bootstraps.
71 Supported object formats are 32-bit ELF and a.out ZMAGIC.
77 suffix, input is assumed to be for the link phase, and the first phase
85 Display object file information.
89 as the output format, where
95 The default format is ELF.
103 The default is to use the input name with the suffix
105 (for relocatables) or
110 Global variables equivalent to the following are defined in the output:
113 char ident[4]; /* identification: "KGZ" */
114 uint32_t dload; /* decoded image load address */
115 uint32_t dsize; /* decoded image size */
116 uint32_t isize; /* image size in memory */
117 uint32_t entry; /* entry point */
118 uint32_t nsize; /* encoded image size */
121 uint8_t kgz_ndata[]; /* encoded data */
124 The encoded data is simply
126 output: a header (with no optional fields); compressed data; and 32-bit
129 .Bl -tag -width /usr/lib/kgzldr.o -compact
130 .It Pa /usr/lib/kgzldr.o
143 .An Robert Nordier Aq Mt rnordier@FreeBSD.org
145 As symbols are lost, the usefulness of this utility for compressing
146 kernels is limited to situations where
151 is only available for the i386 and pc98 architectures.
153 The preferred method of compressing a kernel