usr.sbin/kgzip/kgzip.8

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