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