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