popen(3posix)
NAME
popen --- initiate pipe streams to or from a process
SYNOPSIS
#include <stdio.h> FILE *popen(const char *command, const char *mode);
DESCRIPTION
The popen() function shall execute the command specified by the string
command. It shall create a pipe between the calling program and the
executed command, and shall return a pointer to a stream that can be
used to either read from or write to the pipe.
The environment of the executed command shall be as if a child process
were created within the popen() call using the fork() function, and the
child invoked the sh utility using the call:
execl(shell path, "sh", "-c", command, (char *)0);
where shell path is an unspecified pathname for the sh utility.
The popen() function shall ensure that any streams from previous
popen() calls that remain open in the parent process are closed in the
new child process.
The mode argument to popen() is a string that specifies I/O mode:
1. If mode is r, when the child process is started, its file
descriptor STDOUT_FILENO shall be the writable end of the pipe, and
the file descriptor fileno(stream) in the calling process, where
stream is the stream pointer returned by popen(), shall be the
readable end of the pipe.
2. If mode is w, when the child process is started its file descriptor
STDIN_FILENO shall be the readable end of the pipe, and the file
descriptor fileno(stream) in the calling process, where stream is
the stream pointer returned by popen(), shall be the writable end
of the pipe.
3. If mode is any other value, the result is unspecified.
After popen(), both the parent and the child process shall be capable
of executing independently before either terminates.
Pipe streams are byte-oriented.
RETURN VALUE
Upon successful completion, popen() shall return a pointer to an open stream that can be used to read or write to the pipe. Otherwise, it shall return a null pointer and may set errno to indicate the error.
ERRORS
The popen() function shall fail if:
EMFILE {STREAM_MAX} streams are currently open in the calling process.
The popen() function may fail if:
EMFILE {FOPEN_MAX} streams are currently open in the calling process.
EINVAL The mode argument is invalid.
The popen() function may also set errno values as described by fork()
or pipe().
The following sections are informative.
EXAMPLES
Using popen() to Obtain a List of Files from the ls Utility
The following example demonstrates the use of popen() and pclose() to
execute the command ls* in order to obtain a list of files in the
current directory:
#include <stdio.h>
...
FILE *fp;
int status;
char path[PATH_MAX];
fp = popen("ls *", "r");
if (fp == NULL)
/* Handle error */;
while (fgets(path, PATH_MAX, fp) != NULL)
printf("%s", path);
status = pclose(fp);
if (status == 1) {
/* Error reported by pclose() */
...
} else {
/* Use macros described under wait() to inspect `status' in order
to determine success/failure of command executed by popen() */
...
}
APPLICATION USAGE
Since open files are shared, a mode r command can be used as an input
filter and a mode w command as an output filter.
Buffered reading before opening an input filter may leave the standard
input of that filter mispositioned. Similar problems with an output
filter may be prevented by careful buffer flushing; for example, with
fflush().
A stream opened by popen() should be closed by pclose().
The behavior of popen() is specified for values of mode of r and w.
Other modes such as rb and wb might be supported by specific
implementations, but these would not be portable features. Note that
historical implementations of popen() only check to see if the first
character of mode is r. Thus, a mode of robert the robot would be
treated as mode r, and a mode of anything else would be treated as mode
w.
If the application calls waitpid() or waitid() with a pid argument
greater than 0, and it still has a stream that was called with popen()
open, it must ensure that pid does not refer to the process started by
popen().
To determine whether or not the environment specified in the Shell and
Utilities volume of POSIX.12008 is present, use the function call:
sysconf(_SC_2_VERSION)
(See sysconf()).
RATIONALE
The popen() function should not be used by programs that have set user (or group) ID privileges. The fork() and exec family of functions (except execlp() and execvp()), should be used instead. This prevents any unforeseen manipulation of the environment of the user that could cause execution of commands not anticipated by the calling program. If the original and popen()ed processes both intend to read or write or read and write a common file, and either will be using FILE-type C functions (fread(), fwrite(), and so on), the rules for sharing file handles must be observed (see Section 2.5.1, Interaction of File Descriptors and Standard I/O Streams).
FUTURE DIRECTIONS
None.
SEE ALSO
Section 2.5, Standard I/O Streams, fork(), pclose(), pipe(), sysconf(), system(), wait(), waitid() The Base Definitions volume of POSIX.12008, <stdio.h> The Shell and Utilities volume of POSIX.12008, sh
COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, Copyright (C) 2013 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. (This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.unix.org/online.html . Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
