xref: /freebsd/usr.bin/gzip/gzexe.1 (revision 1da7f3f6f72b2245e458fc7195733268ae4a1136)
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.Dd January 26, 2007
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
28The
29.Nm
30utility uses
31.Xr gzip 1
32to compress executables, producing executables that decompress on-the-fly
33when executed.
34This saves disk space, at the cost of slower execution times.
35The original executables are saved by copying each of them to a file with
36the same name with a
37.Sq ~
38suffix appended.
39After verifying that the compressed executables work as expected, the backup
40files can be removed.
41.Pp
42The options are as follows:
43.Bl -tag -width Ds
44.It Fl d
45Decompress executables previously compressed by
46.Nm .
47.El
48.Pp
49The
50.Nm
51program refuses to compress non-regular or non-executable files,
52files with a setuid or setgid bit set, files that are already
53compressed using
54.Nm
55or 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 ,
62and
63.Xr chmod 1 .
64.Sh SEE ALSO
65.Xr gzip 1
66.Sh CAVEATS
67The
68.Nm
69utility replaces files by overwriting them with the generated
70compressed executable.
71To be able to do this, it is required that the original files are writable.
72