usr.bin/gzip/gzexe.1

   1 .\"     $NetBSD: gzexe.1,v 1.3 2003/12/28 12:49:41 wiz Exp $
   2 .\"     $OpenBSD: gzexe.1,v 1.1 2003/07/31 07:32:47 otto Exp $
   3 .\"
   4 .\" Copyright (c) 2003 Otto Moerbeek <otto@drijf.net>
   5 .\"
   6 .\" Permission to use, copy, modify, and distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .Dd July 30, 2003
  19 .Dt GZEXE 1
  20 .Os
  21 .Sh NAME
  22 .Nm gzexe
  23 .Nd create auto-decompressing executables
  24 .Sh SYNOPSIS
  25 .Nm gzexe
  26 .Op Fl d
  27 .Ar
  28 .Sh DESCRIPTION
  29 The
  30 .Nm
  31 utility uses
  32 .Xr gzip 1
  33 to compress executables, producing executables that decompress on-the-fly
  34 when executed.
  35 This saves disk space, at the cost of slower execution times.
  36 The original executables are saved by copying each of them to a file with
  37 the same name with a
  38 .Sq ~
  39 suffix appended.
  40 After verifying that the compressed executables work as expected, the backup
  41 files can be removed.
  42 .Pp
  43 The options are as follows:
  44 .Bl -tag -width Ds
  45 .It Fl d
  46 Decompress executables previously compressed by
  47 .Nm .
  48 .El
  49 .Pp
  50 The
  51 .Nm
  52 program refuses to compress non-regular or non-executable files,
  53 files with a setuid or setgid bit set, files that are already
  54 compressed using
  55 .Nm
  56 or programs it needs to perform on-the-fly decompression:
  57 .Xr sh 1 ,
  58 .Xr mktemp 1 ,
  59 .Xr rm 1 ,
  60 .Xr echo 1 ,
  61 .Xr tail 1 ,
  62 .Xr gzip 1 ,
  63 and
  64 .Xr chmod 1 .
  65 .Sh SEE ALSO
  66 .Xr gzip 1
  67 .Sh CAVEATS
  68 The
  69 .Nm
  70 utility replaces files by overwriting them with the generated
  71 compressed executable.
  72 To be able to do this, it is required that the original files are writable.