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 .\" $DragonFly: src/usr.bin/kzip/kzip.8,v 1.4 2008/01/01 23:19:46 swildner Exp $
  28 .\"
  29 .Dd August 15, 1996
  30 .Os
  31 .Dt KZIP 8
  32 .Sh NAME
  33 .Nm kzip
  34 .Nd compresses kernels
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl v
  38 .Op Fl l Ar loadaddr
  39 .Ar kernel
  40 .Sh DESCRIPTION
  41 This program compresses a kernel using
  42 .Xr gzip 1
  43 to reduce its disk storage requirements.
  44 It does not reduce the memory footprint once loaded into memory.
  45 You lose all the symbols, so usability is limited.
  46 Its main usage is making kernels for install and fixit floppies, etc.
  47 .Pp
  48 The following options are available:
  49 .Bl -tag -width flag
  50 .It Fl v
  51 Verbose mode, reports how much memory is being used by the kernel
  52 after compression.  Also allows you to check to make sure your kernel
  53 is not going past the 4MB boundary.
  54 .It Fl l Ar loadaddr
  55 Specify the address to load the kernel into memory at.
  56 .El
  57 .Sh DIAGNOSTICS
  58 The
  59 .Nm
  60 utility returns with exit code 1 if given invalid arguments.
  61 Exit code two means
  62 .Nm
  63 was unable to read or process the kernel file.
  64 .Sh SEE ALSO
  65 .Xr gzip 1
  66 .\" .Sh STANDARDS
  67 .Sh HISTORY
  68 The
  69 .Nm
  70 command appeared in
  71 .Fx 2.0.5 .
  72 Obtained from Linux via
  73 .Bx 386
  74 -- based on tools/build.c by Linus Torvalds,
  75 and ported to
  76 .Bx 386
  77 by Serge Vakulenko.
  78 .Sh AUTHORS
  79 This man page was written by
  80 .An David E. O'Brien .
  81 .\" .Sh BUGS