xref: /original-bsd/bin/cat/cat.1 (revision 95a66346)
1.\" Copyright (c) 1989, 1990 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)cat.1	6.14 (Berkeley) 03/14/91
7.\"
8.Dd
9.Dt CAT 1
10.Os BSD 3
11.Sh NAME
12.Nm cat
13.Nd concatenate and print files
14.Sh SYNOPSIS
15.Nm cat
16.Op Fl benstuv
17.Op Fl
18.Op Ar
19.Sh DESCRIPTION
20The
21.Nm cat
22utility reads files sequentially, writing them to the standard output.
23The
24.Ar file
25operands are processed in command line order.
26A single dash represents standard input.
27.Pp
28The options are as follows:
29.Bl -tag -width Ds
30.It Fl b
31Implies the
32.Fl n
33option but doesn't number blank lines.
34.It Fl e
35Implies the
36.Fl v
37option, and displays a dollar sign
38.Pq Ql \&$
39at the end of each line
40as well.
41.It Fl n
42Number the
43.Ar output
44lines, starting at 1.
45.It Fl s
46Squeeze multiple adjacent empty lines, causing the output to be
47single spaced.
48.It Fl t
49Implies the
50.Fl v
51option, and displays tab characters as
52.Pq Ql ^I
53as well.
54.It Fl u
55The
56.Fl u
57option guarantees that the output is unbuffered.
58.It Fl v
59Displays non-printing characters so they are visible.
60Control characters print line
61.Ql ^X
62for control-X; the delete
63character (octal 0177) prints as
64.Ql ^?
65Non-ascii characters (with the high bit set) are printed as
66.Ql M-
67(for meta) followed by the character for the low 7 bits.
68.El
69.Pp
70.Nm Cat
71is useful for getting files into a pipe, for instance, to sort
72two files together,
73the command
74.Pp
75.Dl cat file1 file2 | sort > sfile
76.Pp
77reads the contents of
78file1 and file2 sequentially, pipes it all to sort and places the
79newly sorted data in file3.
80.Pp
81Because of the shell language mechanism used to perform output
82redirection, the command
83.Dq Li cat file1 file 2 > file1
84will cause
85original data in file1 to be destroyed!
86.Pp
87.Nm Cat
88The cat utility exits 0 on success, and >0 if an error
89occurs.
90.Sh SEE ALSO
91.Xr head 1 ,
92.Xr more 1 ,
93.Xr pr 1 ,
94.Xr tail 1
95.Rs
96.%A Rob Pike
97.%T "UNIX Style, or cat -v Considered Harmful"
98.%J "USENIX Summer Conference Proceedings"
99.%D 1983
100.Re
101.Sh HISTORY
102A
103.Nm
104command appeared in Version 6 AT&T UNIX.
105