xref: /freebsd-12.1/usr.bin/minigzip/minigzip.1 (revision ba21c2b4)
1.\" Copyright (c) 1997
2.\"	Michael Smith
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd May 22, 2012
28.Dt MINIGZIP 1
29.Os
30.Sh NAME
31.Nm minigzip
32.Nd minimal implementation of the 'gzip' compression tool
33.Sh SYNOPSIS
34.Nm
35.Op Fl cd
36.Op Ar
37.Sh DESCRIPTION
38The
39.Nm
40utility is a minimal implementation of the
41.Xr gzip 1
42utility.
43It supports
44compression and decompression of individual files, as well as
45streaming compression and decompression via standard input and
46output.
47.Pp
48The default operation is compression, decompression can be
49selected by supplying the
50.Fl d
51flag on the command line.
52.Pp
53If any
54.Ar file
55arguments are supplied, the operation is performed on each file
56separately.
57Compression replaces the original file with one having a
58.Pa .gz
59suffix.
60Decompression will remove a
61.Pa .gz
62suffix if one is present.
63.Pp
64If no
65.Ar file
66arguments are supplied,
67.Nm
68reads from standard input and writes the results of the operation
69to standard output.
70.Pp
71If the
72.Fl c
73option is specified,
74.Nm
75writes the results to standard output and keep the original files
76unchanged.
77.Sh SEE ALSO
78.Xr gzip 1
79.Sh AUTHORS
80The
81.Nm
82utility was written by
83.An Jean-loup Gailly .
84