home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / gnu / ixemul-39.47-env-bin.lha / man / cat3 / popen.0 < prev    next >
Encoding:
Text File  |  1993-12-07  |  3.5 KB  |  133 lines
  1.  
  2. POPEN(3)                   UNIX Programmer's Manual                   POPEN(3)
  3.  
  4. NNAAMMEE
  5.      ppooppeenn, ppcclloossee - process I/O
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssttddiioo..hh>>
  9.  
  10.      _F_I_L_E _*
  11.      ppooppeenn(_c_o_n_s_t _c_h_a_r _*_c_o_m_m_a_n_d, _c_o_n_s_t _c_h_a_r _*_t_y_p_e)
  12.  
  13.      _i_n_t
  14.      ppcclloossee(_F_I_L_E _*_s_t_r_e_a_m)
  15.  
  16. DDEESSCCRRIIPPTTIIOONN
  17.      The ppooppeenn() function ``opens'' a process by creating a pipe, forking, and
  18.      invoking the shell.  Since a pipe is by definition unidirectional, the
  19.      _t_y_p_e argument may specify only reading or writing, not both; the result­
  20.      ing stream is correspondingly read­only or write­only.
  21.  
  22.      The _c_o_m_m_a_n_d argument is a pointer to a null­terminated string containing
  23.      a shell command line.  This command is passed to _/_b_i_n_/_s_h using the --cc
  24.      flag; interpretation, if any, is performed by the shell.  The _m_o_d_e argu­
  25.      ment is a pointer to a null­terminated string which must be either `r'
  26.      for reading or `w' for writing.
  27.  
  28.      The return value from ppooppeenn() is a normal standard I/O stream in all re­
  29.      spects save that it must be closed with ppcclloossee() rather than ffcclloossee().
  30.      Writing to such a stream writes to the standard input of the command; the
  31.      command's standard output is the same as that of the process that called
  32.      ppooppeenn(), unless this is altered by the command itself.  Conversely, read­
  33.      ing from a ``popened'' stream reads the command's standard output, and
  34.      the command's standard input is the same as that of the process that
  35.      called ppooppeenn().
  36.  
  37.      Note that output ppooppeenn() streams are fully buffered by default.
  38.  
  39.      The ppcclloossee() function waits for the associated process to terminate and
  40.      returns the exit status of the command as returned by wwaaiitt44().
  41.  
  42. RREETTUURRNN VVAALLUUEE
  43.      The ppooppeenn() function returns NULL if the fork(2) or pipe(2) calls fail,
  44.      or if it cannot allocate memory.
  45.  
  46.      The ppcclloossee() function returns -1 if _s_t_r_e_a_m is not associated with a
  47.      ``popened'' command, if _s_t_r_e_a_m already ``pclosed'', or if wait4 returns
  48.      an error.
  49.  
  50. EERRRROORRSS
  51.      The ppooppeenn() function does not reliably set _e_r_r_n_o.
  52.  
  53. SSEEEE AALLSSOO
  54.      fork(2),  sh(1),  pipe(2),  wait4(2),  fflush(3),  fclose(3),  fopen(3),
  55.      stdio(3),  system(3)
  56.  
  57. BBUUGGSS
  58.      Since the standard input of a command opened for reading shares its seek
  59.      offset with the process that called ppooppeenn(), if the original process has
  60.      done a buffered read, the command's input position may not be as expect­
  61.      ed.  Similarly, the output from a command opened for writing may become
  62.      intermingled with that of the original process.  The latter can be avoid­
  63.      ed by calling fflush(3) before ppooppeenn().
  64.  
  65.  
  66.      Failure to execute the shell is indistinguishable from the shell's fail­
  67.      ure to execute command, or an immediate exit of the command.  The only
  68.      hint is an exit status of 127.
  69.  
  70.      The ppooppeenn() argument always calls sh,  never calls csh.
  71.  
  72. HHIISSTTOORRYY
  73.      A ppooppeenn() and a ppcclloossee() function appeared in Version 7 AT&T UNIX.
  74.  
  75. BSD Experimental                April 30, 1991                               2
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.