lib/libcr/gen/popen.3

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)popen.3     8.2 (Berkeley) 5/3/95
  33 .\" $FreeBSD: src/lib/libc/gen/popen.3,v 1.10.2.4 2003/03/15 15:11:05 trhodes Exp $
  34 .\" $DragonFly: src/lib/libcr/gen/Attic/popen.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd May 3, 1995
  37 .Dt POPEN 3
  38 .Os
  39 .Sh NAME
  40 .Nm popen ,
  41 .Nm pclose
  42 .Nd process
  43 .Tn I/O
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In stdio.h
  48 .Ft FILE *
  49 .Fn popen "const char *command" "const char *type"
  50 .Ft int
  51 .Fn pclose "FILE *stream"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn popen
  55 function
  56 .Dq opens
  57 a process by creating a bidirectional pipe
  58 forking,
  59 and invoking the shell.
  60 Any streams opened by previous
  61 .Fn popen
  62 calls in the parent process are closed in the new child process.
  63 Historically,
  64 .Fn popen
  65 was implemented with a unidirectional pipe;
  66 hence many implementations of
  67 .Fn popen
  68 only allow the
  69 .Fa type
  70 argument to specify reading or writing, not both.
  71 Since
  72 .Fn popen
  73 is now implemented using a bidirectional pipe, the
  74 .Fa type
  75 argument may request a bidirectional data flow.
  76 The
  77 .Fa type
  78 argument is a pointer to a null-terminated string
  79 which must be
  80 .Ql r
  81 for reading,
  82 .Ql w
  83 for writing, or
  84 .Ql r+
  85 for reading and writing.
  86 .Pp
  87 The
  88 .Fa command
  89 argument is a pointer to a null-terminated string
  90 containing a shell command line.
  91 This command is passed to
  92 .Pa /bin/sh
  93 using the
  94 .Fl c
  95 flag; interpretation, if any, is performed by the shell.
  96 .Pp
  97 The return value from
  98 .Fn popen
  99 is a normal standard
 100 .Tn I/O
 101 stream in all respects
 102 save that it must be closed with
 103 .Fn pclose
 104 rather than
 105 .Fn fclose .
 106 Writing to such a stream
 107 writes to the standard input of the command;
 108 the command's standard output is the same as that of the process that called
 109 .Fn popen ,
 110 unless this is altered by the command itself.
 111 Conversely, reading from a
 112 .Dq popened
 113 stream reads the command's standard output, and
 114 the command's standard input is the same as that of the process that called
 115 .Fn popen .
 116 .Pp
 117 Note that output
 118 .Fn popen
 119 streams are fully buffered by default.
 120 .Pp
 121 The
 122 .Fn pclose
 123 function waits for the associated process to terminate
 124 and returns the exit status of the command
 125 as returned by
 126 .Fn wait4 .
 127 .Sh RETURN VALUES
 128 The
 129 .Fn popen
 130 function returns
 131 .Dv NULL
 132 if the
 133 .Xr fork 2
 134 or
 135 .Xr pipe 2
 136 calls fail,
 137 or if it cannot allocate memory.
 138 .Pp
 139 The
 140 .Fn pclose
 141 function
 142 returns \-1 if
 143 .Fa stream
 144 is not associated with a
 145 .Dq popened
 146 command, if
 147 .Fa stream
 148 already
 149 .Dq pclosed ,
 150 or if
 151 .Xr wait4
 152 returns an error.
 153 .Sh ERRORS
 154 The
 155 .Fn popen
 156 function does not reliably set
 157 .Va errno .
 158 .Sh SEE ALSO
 159 .Xr sh 1 ,
 160 .Xr fork 2 ,
 161 .Xr pipe 2 ,
 162 .Xr wait4 2 ,
 163 .Xr fclose 3 ,
 164 .Xr fflush 3 ,
 165 .Xr fopen 3 ,
 166 .Xr stdio 3 ,
 167 .Xr system 3
 168 .Sh BUGS
 169 Since the standard input of a command opened for reading
 170 shares its seek offset with the process that called
 171 .Fn popen ,
 172 if the original process has done a buffered read,
 173 the command's input position may not be as expected.
 174 Similarly, the output from a command opened for writing
 175 may become intermingled with that of the original process.
 176 The latter can be avoided by calling
 177 .Xr fflush 3
 178 before
 179 .Fn popen .
 180 .Pp
 181 Failure to execute the shell
 182 is indistinguishable from the shell's failure to execute command,
 183 or an immediate exit of the command.
 184 The only hint is an exit status of 127.
 185 .Pp
 186 The
 187 .Fn popen
 188 function
 189 always calls
 190 .Xr sh 1 ,
 191 never calls
 192 .Xr csh 1 .
 193 .Sh HISTORY
 194 A
 195 .Fn popen
 196 and a
 197 .Fn pclose
 198 function appeared in
 199 .At v7 .
 200 .Pp
 201 Bidirectional functionality was added in
 202 .Fx 2.2.6 .