xref: /freebsd/bin/cat/cat.1 (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
1.\" Copyright (c) 1989, 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the Institute of Electrical and Electronics Engineers, Inc.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"     @(#)cat.1	8.1 (Berkeley) 6/29/93
36.\"	$Id$
37.\"
38.Dd June 29, 1993
39.Dt CAT 1
40.Os BSD 3
41.Sh NAME
42.Nm cat
43.Nd concatenate and print files
44.Sh SYNOPSIS
45.Nm cat
46.Op Fl benstuv
47.Op Fl
48.Op Ar
49.Sh DESCRIPTION
50The
51.Nm cat
52utility reads files sequentially, writing them to the standard output.
53The
54.Ar file
55operands are processed in command line order.
56A single dash represents the standard input.
57.Pp
58The options are as follows:
59.Bl -tag -width Ds
60.It Fl b
61Implies the
62.Fl n
63option but doesn't number blank lines.
64.It Fl e
65Implies the
66.Fl v
67option, and displays a dollar sign
68.Pq Ql \&$
69at the end of each line
70as well.
71.It Fl n
72Number the
73.Ar output
74lines, starting at 1.
75.It Fl s
76Squeeze multiple adjacent empty lines, causing the output to be
77single spaced.
78.It Fl t
79Implies the
80.Fl v
81option, and displays tab characters as
82.Pq Ql ^I
83as well.
84.It Fl u
85The
86.Fl u
87option guarantees that the output is unbuffered.
88.It Fl v
89Displays non-printing characters so they are visible.
90Control characters print as
91.Ql ^X
92for control-X; the delete
93character (octal 0177) prints as
94.Ql ^?
95Non-ascii characters (with the high bit set) are printed as
96.Ql M-
97(for meta) followed by the character for the low 7 bits.
98.El
99.Pp
100The
101.Nm cat
102utility exits 0 on success, and >0 if an error occurs.
103.Sh BUGS
104Because of the shell language mechanism used to perform output
105redirection, the command
106.Dq Li cat file1 file 2 > file1
107will cause the original data in file1 to be destroyed!
108.Sh SEE ALSO
109.Xr head 1 ,
110.Xr more 1 ,
111.Xr pr 1 ,
112.Xr tail 1
113.Rs
114.%A Rob Pike
115.%T "UNIX Style, or cat -v Considered Harmful"
116.%J "USENIX Summer Conference Proceedings"
117.%D 1983
118.Re
119.Sh HISTORY
120A
121.Nm
122command appeared in Version 6 AT&T UNIX.
123