Put WARNS?=6 in usr.sbin/Makefile.inc (like in usr.bin/ etc.).
[dragonfly.git] / usr.sbin / kgzip / kgzip.8
CommitLineData
984263bc
MD
1.\" Copyright (c) 1999 Global Technology Associates, Inc.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
12.\"
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.
24.\"
25.\" $FreeBSD: src/usr.sbin/kgzip/kgzip.8,v 1.3.2.3 2001/08/16 15:56:02 ru Exp $
49781055 26.\" $DragonFly: src/usr.sbin/kgzip/kgzip.8,v 1.3 2006/02/17 19:40:16 swildner Exp $
984263bc
MD
27.\"
28.Dd July 19, 1999
29.Dt KGZIP 8
30.Os
31.Sh NAME
32.Nm kgzip
33.Nd compress a kernel
34.Sh SYNOPSIS
35.Nm
36.Op Fl cv
37.Op Fl f Ar format
38.Op Fl l Ar loader
39.Op Fl o Ar output
40.Ar file
41.Sh DESCRIPTION
42The
43.Nm
44utility compresses a kernel or some other bootable binary. Operation
45is in two phases as follows:
46.Bl -enum
47.It
48A load image of the executable file is built which omits all but
49the
50.Sq text
51and
52.Sq data
53segments. This image is compressed using
54.Xr gzip 1
55and output as data in relocatable object format.
56.It
57The object file is linked with a special self-hosting loader, producing
58an executable suitable for booting with either the second- or
59third-level bootstraps.
60.El
61.Pp
62Supported object formats are 32-bit ELF and a.out ZMAGIC.
63.Pp
64If the
65.Ar file
66operand has a
67.Sq .o
68suffix, input is assumed to be for the link phase, and the first phase
69is omitted.
70.Pp
71The options are:
72.Bl -tag -width Fl
73.It Fl c
74Omit the link phase.
75.It Fl v
76Display object file information.
77.It Fl f Ar format
78Use
79.Ar format
80as the output format, where
81.Ar format
82is
83.Sq aout
84or
85.Sq elf .
86The default format is ELF.
87.It Fl l Ar loader
88Link
89.Ar loader
90as the loader.
91.It Fl o Ar output
92Name the output file
93.Ar output .
94The default is to use the input name with the suffix
95.Sq .o
96(for relocatables) or
97.Sq .kgz
98(for executables).
99.El
100.Sh NOTES
101Global variables equivalent to the following are defined in the output:
102.Bd -literal
103struct kgz_hdr {
104 char ident[4]; /* identification: "KGZ" */
105 uint32_t dload; /* decoded image load address */
106 uint32_t dsize; /* decoded image size */
107 uint32_t isize; /* image size in memory */
108 uint32_t entry; /* entry point */
109 uint32_t nsize; /* encoded image size */
110} kgz;
111
112uint8_t kgz_ndata[]; /* encoded data */
113.Ed
114.Pp
115The encoded data is simply
116.Xr gzip 1
117output: a header (with no optional fields); compressed data; and 32-bit
118CRC and size values.
119.Sh FILES
120.Bl -tag -width /usr/lib/kgzldr.o -compact
121.It Pa /usr/lib/kgzldr.o
122The default loader
123.El
19fe1c42 124.Sh EXIT STATUS
49781055 125.Ex -std
984263bc
MD
126.Sh SEE ALSO
127.Xr gzip 1 ,
128.Xr ld 1 ,
129.Xr a.out 5 ,
130.Xr elf 5 ,
131.Xr boot 8 ,
132.Xr loader 8
984263bc
MD
133.Sh AUTHORS
134.An Robert Nordier Aq rnordier@FreeBSD.org .
135.Sh BUGS
136As symbols are lost, the usefulness of this utility for compressing
137kernels is limited to situations where
138.Xr loader 8
139cannot be used; otherwise the preferred method of compressing a kernel
140is simply to
141.Xr gzip 1
142it.