usr.bin/kzip/kzip.8

   1 .\"
   2 .\" Copyright (c) 1996 David E. O'Brien
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/usr.bin/kzip/kzip.8,v 1.7.2.1 2000/12/27 13:50:36 ru Exp $
  27 .\"
  28 .Dd August 15, 1996
  29 .Dt KZIP 8
  30 .Os
  31 .Sh NAME
  32 .Nm kzip
  33 .Nd compresses kernels
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl v
  37 .Op Fl l Ar loadaddr
  38 .Ar kernel
  39 .Sh DESCRIPTION
  40 This program compresses a kernel using
  41 .Xr gzip 1
  42 to reduce its disk storage requirements.
  43 It does not reduce the memory footprint once loaded into memory.
  44 You lose all the symbols, so usability is limited.
  45 Its main usage is making kernels for install and fixit floppies, etc.
  46 .Pp
  47 The following options are available:
  48 .Bl -tag -width flag
  49 .It Fl v
  50 Verbose mode, reports how much memory is being used by the kernel
  51 after compression.  Also allows you to check to make sure your kernel
  52 is not going past the 4MB boundary.
  53 .It Fl l Ar loadaddr
  54 Specify the address to load the kernel into memory at.
  55 .El
  56 .Sh DIAGNOSTICS
  57 The
  58 .Nm
  59 utility returns with exit code 1 if given invalid arguments.
  60 Exit code two means
  61 .Nm
  62 was unable to read or process the kernel file.
  63 .Sh SEE ALSO
  64 .Xr gzip 1
  65 .\" .Sh STANDARDS
  66 .Sh HISTORY
  67 The
  68 .Nm
  69 command appeared in
  70 .Fx 2.0.5 .
  71 Obtained from Linux via
  72 .Bx 386
  73 -- based on tools/build.c by Linus Torvalds,
  74 and ported to
  75 .Bx 386
  76 by Serge Vakulenko.
  77 .Sh AUTHORS
  78 This man page was written by
  79 .An David E. O'Brien .
  80 .\" .Sh BUGS