NetBSD/bin/cat/cat.1

160 lines
4.2 KiB
Groff
Raw Normal View History

2003-08-27 20:27:35 +04:00
.\" $NetBSD: cat.1,v 1.30 2003/08/27 16:27:35 junyoung Exp $
1995-03-21 12:01:59 +03:00
.\"
1994-09-20 05:24:07 +04:00
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
1993-03-21 12:45:37 +03:00
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
1993-03-21 12:45:37 +03:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
1995-09-07 10:12:53 +04:00
.\" @(#)cat.1 8.3 (Berkeley) 5/2/95
1993-03-22 11:04:00 +03:00
.\"
1995-09-07 10:12:53 +04:00
.Dd May 2, 1995
1993-03-21 12:45:37 +03:00
.Dt CAT 1
.Os
1993-03-21 12:45:37 +03:00
.Sh NAME
.Nm cat
.Nd concatenate and print files
.Sh SYNOPSIS
1997-10-20 12:50:59 +04:00
.Nm
.Op Fl beflnstuv
1993-03-21 12:45:37 +03:00
.Op Fl
.Op Ar
.Sh DESCRIPTION
The
1997-10-20 12:50:59 +04:00
.Nm
1993-03-21 12:45:37 +03:00
utility reads files sequentially, writing them to the standard output.
The
.Ar file
operands are processed in command line order.
A single dash represents the standard input,
and may appear multiple times in the
.Ar file
list.
.Pp
The word
.Dq concatenate
is just a verbose synonym for
.Dq catenate .
1993-03-21 12:45:37 +03:00
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl b
Implies the
.Fl n
option but doesn't number blank lines.
.It Fl e
Implies the
.Fl v
option, and displays a dollar sign
.Pq Ql \&$
at the end of each line
as well.
.It Fl f
Only attempt to display regular files.
.It Fl l
Set an exclusive advisory lock on the standard output file descriptor.
This lock is set using
.Xr fcntl 2
with the
.Dv F_SETLKW
command.
If the output file is already locked,
.Nm
will block until the lock is acquired.
1993-03-21 12:45:37 +03:00
.It Fl n
1995-09-07 10:12:53 +04:00
Number the output lines, starting at 1.
1993-03-21 12:45:37 +03:00
.It Fl s
Squeeze multiple adjacent empty lines, causing the output to be
single spaced.
.It Fl t
Implies the
.Fl v
option, and displays tab characters as
1994-11-04 12:59:07 +03:00
.Ql ^I
1993-03-21 12:45:37 +03:00
as well.
.It Fl u
The
.Fl u
option guarantees that the output is unbuffered.
.It Fl v
Displays non-printing characters so they are visible.
1994-09-20 05:24:07 +04:00
Control characters print as
1993-03-21 12:45:37 +03:00
.Ql ^X
for control-X; the delete
character (octal 0177) prints as
2003-08-27 20:27:35 +04:00
.Ql ^? .
1993-03-21 12:45:37 +03:00
Non-ascii characters (with the high bit set) are printed as
.Ql M-
(for meta) followed by the character for the low 7 bits.
.El
.Sh EXIT STATUS
1993-03-21 12:45:37 +03:00
The
1997-10-20 12:50:59 +04:00
.Nm
utility exits 0 on success, and \*[Gt]0 if an error occurs.
1993-03-21 12:45:37 +03:00
.Sh SEE ALSO
.Xr head 1 ,
.Xr hexdump 1 ,
.Xr lpr 1 ,
1993-03-21 12:45:37 +03:00
.Xr more 1 ,
.Xr pr 1 ,
1995-09-07 10:12:53 +04:00
.Xr tail 1 ,
.Xr view 1 ,
.Xr vis 1 ,
.Xr fcntl 2
1993-03-21 12:45:37 +03:00
.Rs
.%A Rob Pike
.%T "UNIX Style, or cat -v Considered Harmful"
.%J "USENIX Summer Conference Proceedings"
.%D 1983
.Re
.Sh STANDARDS
The
.Nm
utility is expected to conform to the
.St -p1003.2-92
specification.
.Pp
The flags
2002-07-03 05:27:23 +04:00
.Op Fl belnstv
are extensions to the specification.
2001-12-20 23:01:15 +03:00
.Sh HISTORY
A
.Nm
utility appeared in
.At v1 .
Dennis Ritchie designed and wrote the first man page.
It appears to have been
.Xr cat 1 .
.Sh BUGS
Because of the shell language mechanism used to perform output
redirection, the command
.Dq Li cat file1 file2 \*[Gt] file1
2001-12-20 23:01:15 +03:00
will cause the original data in file1 to be destroyed!
This is performed by the shell before
.Nm
is run.