popen(3) [php man page]

POPEN(3)								 1								  POPEN(3)

popen - Opens process file pointer

SYNOPSIS

       resource popen (string  $command, string  $mode)

DESCRIPTION

	Opens a pipe to a process executed by forking the command given by $command.

PARAMETERS

	      o $command
		- The command

	      o $mode
		- The mode

RETURN VALUES

	Returns  a file pointer identical to that returned by fopen(3), except that it is unidirectional (may only be used for reading or writing)
       and must be closed with pclose(3). This pointer may be used with fgets(3), fgetss(3), and fwrite(3). When the mode  is  'r',  the  returned
       file pointer equals to the STDOUT of the command, when the mode is 'w', the returned file pointer equals to the STDIN of the command.

	If an error occurs, returns FALSE.

EXAMPLES

       Example #1

	      popen(3) example

	      <?php
	      $handle = popen("/bin/ls", "r");
	      ?>

	If  the  command  to  be  executed  could not be found, a valid resource is returned. This may seem odd, but makes sense; it allows you to
       access any error message returned by the shell:

       Example #2

	      popen(3) example

	      <?php
	      error_reporting(E_ALL);

	      /* Add redirection so we can get stderr. */
	      $handle = popen('/path/to/executable 2>&1', 'r');
	      echo "'$handle'; " . gettype($handle) . "
";
	      $read = fread($handle, 2096);
	      echo $read;
	      pclose($handle);
	      ?>

NOTES

       Note

	       If you're looking for bi-directional support (two-way), use proc_open(3).

       Note

	      When safe mode is enabled, you can only execute files within the safe_mode_exec_dir. For practical  reasons,  it	is  currently  not
	      allowed to have .. components in the path to the executable.

       Warning

	      With safe mode enabled, the command string is escaped with escapeshellcmd(3). Thus, echo y | echo x becomes echo y | echo x.

SEE ALSO

       pclose(3), fopen(3), proc_open(3).

PHP Documentation Group 														  POPEN(3)

POPEN(3)						   BSD Library Functions Manual 						  POPEN(3)

NAME

     popen, pclose -- process I/O

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <stdio.h>

     FILE *
     popen(const char *command, const char *type);

     int
     pclose(FILE *stream);

DESCRIPTION

     The popen() function ``opens'' a process by creating a bidirectional pipe forking, and invoking the shell.  Any streams opened by previous
     popen() calls in the parent process are closed in the new child process.  Historically, popen() was implemented with a unidirectional pipe;
     hence many implementations of popen() only allow the type argument to specify reading or writing, not both.  Since popen() is now implemented
     using a bidirectional pipe, the type argument may request a bidirectional data flow.  The type argument is a pointer to a null-terminated
     string which must be 'r' for reading, 'w' for writing, or 'r+' for reading and writing.

     A letter 'e' may be appended to that to request that the underlying file descriptor be set close-on-exec.

     The command argument is a pointer to a null-terminated string containing a shell command line.  This command is passed to /bin/sh using the
     -c flag; interpretation, if any, is performed by the shell.

     The return value from popen() is a normal standard I/O stream in all respects save that it must be closed with pclose() rather than fclose().
     Writing to such a stream writes to the standard input of the command; the command's standard output is the same as that of the process that
     called popen(), unless this is altered by the command itself.  Conversely, reading from a ``popened'' stream reads the command's standard
     output, and the command's standard input is the same as that of the process that called popen().

     Note that output popen() streams are fully buffered by default.

     The pclose() function waits for the associated process to terminate and returns the exit status of the command as returned by wait4(2).

RETURN VALUES

     The popen() function returns NULL if the fork(2) or pipe(2) calls fail, or if it cannot allocate memory.

     The pclose() function returns -1 if stream is not associated with a ``popened'' command, if stream already ``pclosed'', or if wait4(2)
     returns an error.

ERRORS

     The popen() function does not reliably set errno.

SEE ALSO

     sh(1), fork(2), pipe(2), wait4(2), fclose(3), fflush(3), fopen(3), stdio(3), system(3)

HISTORY

     A popen() and a pclose() function appeared in Version 7 AT&T UNIX.

     Bidirectional functionality was added in FreeBSD 2.2.6.

BUGS

     Since the standard input of a command opened for reading shares its seek offset with the process that called popen(), if the original process
     has done a buffered read, the command's input position may not be as expected.  Similarly, the output from a command opened for writing may
     become intermingled with that of the original process.  The latter can be avoided by calling fflush(3) before popen().

     Failure to execute the shell is indistinguishable from the shell's failure to execute command, or an immediate exit of the command.  The only
     hint is an exit status of 127.

     The popen() function always calls sh(1), never calls csh(1).

BSD
								   May 20, 2013 							       BSD