diff options
Diffstat (limited to 'lib/libc/sys/pipe.2')
| -rw-r--r-- | lib/libc/sys/pipe.2 | 34 |
1 files changed, 12 insertions, 22 deletions
diff --git a/lib/libc/sys/pipe.2 b/lib/libc/sys/pipe.2 index 3eb80aa5d3c..957f9bcf215 100644 --- a/lib/libc/sys/pipe.2 +++ b/lib/libc/sys/pipe.2 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pipe.2,v 1.7 1999/06/29 14:10:13 aaron Exp $ +.\" $OpenBSD: pipe.2,v 1.8 2000/10/18 05:12:10 aaron Exp $ .\" $NetBSD: pipe.2,v 1.6 1995/02/27 12:35:27 cgd Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -47,11 +47,9 @@ .Sh DESCRIPTION The .Fn pipe -function -creates a +function creates a .Em pipe , -which is an object allowing -unidirectional data flow, +which is an object allowing unidirectional data flow, and allocates a pair of file descriptors. The first descriptor connects to the .Em read end @@ -62,31 +60,24 @@ so that data written to .Fa fildes[1] appears on (i.e., can be read from) .Fa 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. +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. .Pp A pipe whose read or write end has been closed is considered .Em widowed . -Writing on such a pipe causes the writing process to receive -a +Writing on such a pipe causes the writing process to receive a .Dv 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. .Sh RETURN VALUES -On successful creation of the pipe, zero is returned. Otherwise, -a value of \-1 is returned and the variable +On successful creation of the pipe, zero is returned. +Otherwise, a value of \-1 is returned and the variable .Va errno -set to indicate the -error. +set to indicate the error. .Sh ERRORS The .Fn pipe @@ -99,8 +90,7 @@ The system file table is full. .It Bq Er EFAULT The .Fa fildes -buffer is in an invalid area of the process's address -space. +buffer is in an invalid area of the process's address space. .El .Sh SEE ALSO .Xr sh 1 , |