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