xref: /freebsd/contrib/libarchive/cat/bsdcat.1 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1.\" Copyright (c) 2011-2014, Mike Kazantsev
2.\" All rights reserved.
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 March 1, 2014
28.Dt BSDCAT 1
29.Os
30.Sh NAME
31.Nm bsdcat
32.Nd expand files to standard output
33.Sh SYNOPSIS
34.Nm
35.Op options
36.Op files
37.Sh DESCRIPTION
38.Nm
39expands files to standard output.
40.Sh OPTIONS
41.Nm
42typically takes a filename as an argument or reads standard input when used in a
43pipe.
44In both cases decompressed data it written to standard output.
45.Sh EXAMPLES
46To decompress a file:
47.Pp
48.Dl bsdcat example.txt.gz > example.txt
49.Pp
50To decompress standard input in a pipe:
51.Pp
52.Dl cat example.txt.gz | bsdcat > example.txt
53.Pp
54Both examples achieve the same results - a decompressed file by redirecting
55output.
56.Sh SEE ALSO
57.Xr bzcat 1 ,
58.Xr uncompress 1 ,
59.Xr xzcat 1 ,
60.Xr zcat 1 ,
61.Xr libarchive-formats 5
62