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