summary refs log tree commit diff
path: root/doc/pipeline.html
blob: 43039b3eaf76ee645f420b9da3f8e78f419f1db1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <meta http-equiv="Content-Language" content="en" />
  <title>execline: the pipeline command</title>
  <meta name="Description" content="execline: the pipeline command" />
  <meta name="Keywords" content="execline command pipeline" />
  <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
 </head>
<body>

<p>
<a href="index.html">execline</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>pipeline</tt> program </h1>

<p>
<tt>pipeline</tt> runs two commands with a pipe between them.
</p>

<h2> Interface </h2>

<p>
 In an <a href="execlineb.html">execlineb</a> script:
</p>

<pre>
     pipeline [ -d ] [ -r | -w ] { <em>prog1...</em> } <em>prog2...</em>
</pre>

<ul>
 <li> <tt>pipeline</tt> reads <em>prog1...</em> in a
<a href="el_semicolon.html">block</a> and unquotes it. </li>
 <li> It runs <em>prog1...</em> as a child process and execs into
<em>prog2...</em>, with a pipe between <em>prog1</em>'s stdout and
<em>prog2</em>'s stdin. </li>
 <li> <em>prog1</em>'s pid is available in <em>prog2</em> as the !
environment variable. </li>
</ul>

<h2> Options </h2>

<ul>
 <li> <tt>-d</tt>&nbsp;: run <em>prog1...</em>
as a grandchild of <tt>pipeline</tt>. This is meant to prevent a zombie
from hanging around if <em>prog2...</em> fails to wait for its children.</li>
 <li> <tt>-r</tt>&nbsp;: make <em>prog1...</em> the writer and
<em>prog2...</em> the reader. This is the default. </li>
 <li> <tt>-w</tt>&nbsp;: make <em>prog1...</em> the reader and
<em>prog2...</em> the writer. </li>
</ul>

<h2> Notes </h2>

<ul>
 <li> You can easily create a chain of pipes: <tt>execlineb -Pc 'pipeline { a } pipeline { b } c'</tt>
is roughly equivalent to
<tt>sh -c 'exec a | b | c'</tt>, except that shells usually run <tt>c</tt>
as a child process like <tt>a</tt> and <tt>b</tt>, and <tt>exec</tt> has no
effect. </li>
</ul>

</body>
</html>