mirror of
https://github.com/GnoConsortium/gno.git
synced 2024-11-17 12:08:43 +00:00
131 lines
4.1 KiB
Groff
131 lines
4.1 KiB
Groff
.\" Copyright (c) 1980, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" 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. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" 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.
|
|
.\"
|
|
.\" @(#)pipe.2 8.1 (Berkeley) 6/4/93
|
|
.\"
|
|
.TH PIPE 2 "16 January 1997" GNO "System Calls"
|
|
.SH NAME
|
|
.BR pipe
|
|
\- create descriptor pair for interprocess communication
|
|
.SH SYNOPSIS
|
|
.br
|
|
#include <unistd.h>
|
|
.sp 1
|
|
int
|
|
\fBpipe\fR (int *\fIfildes\fR);
|
|
.SH DESCRIPTION
|
|
The
|
|
.BR pipe
|
|
function
|
|
creates a
|
|
.IR pipe ,
|
|
which is an object allowing
|
|
unidirectional data flow,
|
|
and allocates a pair of file descriptors.
|
|
The first descriptor connects to the
|
|
.IR read
|
|
end of the pipe,
|
|
and the second connects to the
|
|
.IR write
|
|
end, so that data written to
|
|
.I fildes[1]
|
|
appears on (i.e., can be read from)
|
|
.IR fildes[0] .
|
|
This allows the output of one program to be
|
|
sent
|
|
to another program:
|
|
The source's standard output is set up to be
|
|
the write end of the pipe,
|
|
and the sink's standard input is set up to be
|
|
the read end of the pipe.
|
|
The pipe itself persists until all its associated descriptors are
|
|
closed.
|
|
.LP
|
|
A pipe whose read or write end has been closed is considered
|
|
.IR widowed .
|
|
Writing on such a pipe causes the writing process to receive
|
|
a
|
|
.BR SIGPIPE
|
|
signal.
|
|
Widowing a pipe is the only way to deliver end-of-file to a reader:
|
|
after the reader consumes any buffered data, reading a widowed pipe
|
|
returns a zero count (end of file).
|
|
.SH LIMITS
|
|
Up to 4096 bytes of data are buffered before the writing process is
|
|
suspended. Should more than 4096 bytes be necessary in any pipe among
|
|
a loop of processes, deadlock will occur. This is not a limitation
|
|
specific to GNO but to multiprogramming in general.
|
|
.SH NOTES
|
|
This man page refers to the Unix
|
|
.BR read (2)
|
|
and
|
|
.BR write (2)
|
|
operations. On the IIgs, the described behavior refer to any system
|
|
calls doing I/O, including:
|
|
.RS
|
|
.nf
|
|
GS/OS ReadGS and WriteGS
|
|
TextTools calls
|
|
C stdio I/O routines
|
|
.fi
|
|
.RE
|
|
.SH RETURN VALUES
|
|
On successful creation of the pipe, zero is returned. Otherwise,
|
|
a value of -1 is returned and the variable
|
|
.IR errno
|
|
set to indicate the
|
|
error.
|
|
.SH ERRORS
|
|
The
|
|
.BR pipe
|
|
call will fail if:
|
|
.RS
|
|
.IP \fBEMFILE\fR
|
|
Too many descriptors are active.
|
|
.IP \fBENFILE\fR
|
|
The system file table is full.
|
|
.IP \fBEFAULT\fR
|
|
The
|
|
.I fildes
|
|
buffer is in an invalid area of the process's address
|
|
space.
|
|
.RE
|
|
.SH SEE ALSO
|
|
.BR sh (1),
|
|
.BR read (2),
|
|
.BR write (2),
|
|
.BR fork (2),
|
|
.BR socketpair (2)
|
|
.SH HISTORY
|
|
A
|
|
.BR pipe
|
|
function call appeared in Version 6 AT&T UNIX.
|