Return to gzexe.1 CVS log

Up to [local] / src / usr.bin / compress

Annotation of src/usr.bin/compress/gzexe.1, Revision 1.5

1.5     ! jmc         1: .\"    $OpenBSD: gzexe.1,v 1.4 2007/01/24 10:53:43 jmc Exp $
1.1       otto        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: .\"
1.5     ! jmc        17: .Dd $Mdocdate$
1.1       otto       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
1.2       jmc        46: .Nm .
1.1       otto       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
1.3       otto       54: .Nm ,
                     55: files in /bin or /sbin,
1.1       otto       56: or programs it needs to perform on-the-fly decompression:
                     57: .Xr sh 1 ,
1.3       otto       58: .Xr basename 1 ,
1.1       otto       59: .Xr mktemp 1 ,
                     60: .Xr rm 1 ,
                     61: .Xr echo 1 ,
                     62: .Xr tail 1 ,
1.2       jmc        63: .Xr gzip 1 ,
1.1       otto       64: and
                     65: .Xr chmod 1 .
                     66: .Sh SEE ALSO
1.4       jmc        67: .Xr compress 1 ,
1.1       otto       68: .Xr gzip 1
                     69: .Sh CAVEATS
                     70: The
                     71: .Nm
                     72: utility replaces files by overwriting them with the generated
                     73: compressed executable.
                     74: To be able to do this, it is required that the original files are writable.