~ubuntu-branches/ubuntu/karmic/cedar-backup2/karmic

« back to all changes in this revision

Viewing changes to doc/interface/public/popen2.Popen3-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2006-12-18 22:59:17 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20061218225917-gwos76xdo3jewj6i
Tags: 2.9.0-1
* New upstream release.
  - Provide way to configure dev=/dev/cdrw and the like (closes: #403546).
  - Fix, clean up and reorganize parts of user manual (closes: #403448, #403662).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="iso-8859-1"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
 
          "DTD/xhtml1-transitional.dtd">
4
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<head>
6
 
  <title>popen2.Popen3</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8
 
</head>
9
 
<body bgcolor="white" text="black" link="blue" vlink="#204080"
10
 
      alink="#204080">
11
 
 
12
 
<!-- =========== START OF NAVBAR =========== -->
13
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14
 
  <tr valign="center">
15
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="CedarBackup2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
19
 
    <th class="navbar" align="right" width="100%">
20
 
      <table border="0" cellpadding="0" cellspacing="0">
21
 
      <tr><th class="navbar" align="center">
22
 
        <p class="nomargin">
23
 
          <a class="navbar" target="_top" href="http://cedar-solutions.com/software/cedar-backup">CedarBackup2</a>
24
 
      </p></th></tr></table>
25
 
    </th>
26
 
  </tr>
27
 
</table>
28
 
<table width="100%" cellpadding="0" cellspacing="0">
29
 
  <tr valign="top">
30
 
    <td width="100%">
31
 
      <font size="-1"><b class="breadcrumbs">
32
 
        Module&nbsp;popen2 ::
33
 
        Class&nbsp;Popen3
34
 
      </b></font></br>
35
 
    </td>
36
 
    <td><table cellpadding="0" cellspacing="0">
37
 
      <tr><td align="right"><font size="-2">[<a href="../private/popen2.Popen3-class.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
38
 
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="popen2.Popen3-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
39
 
    </table></td>
40
 
</tr></table>
41
 
 
42
 
<!-- =========== START OF CLASS DESCRIPTION =========== -->
43
 
<h2 class="class">Class Popen3</h2>
44
 
 
45
 
<dl><dt><b>Known Subclasses:</b></dt>
46
 
<dd>
47
 
    <a href="popen2.Popen4-class.html"><code>Popen4</code></a></dd></dl>
48
 
 
49
 
<hr/>
50
 
 
51
 
Class representing a child process. Normally instances are created by 
52
 
the factory functions popen2() and popen3().
53
 
<hr/>
54
 
 
55
 
 
56
 
<!-- =========== START OF METHOD SUMMARY =========== -->
57
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
58
 
<tr bgcolor="#70b0f0" class="summary">
59
 
  <th colspan="2">Method Summary</th></tr>
60
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
61
 
  <td><code><span class="summary-sig"><a href="popen2.Popen3-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
62
 
          <span class=summary-sig-arg>cmd</span>,
63
 
          <span class=summary-sig-arg>capturestderr</span>,
64
 
          <span class=summary-sig-arg>bufsize</span>)</span></code>
65
 
<br />
66
 
The parameter 'cmd' is the shell command to execute in a 
67
 
sub-process.</td></tr>
68
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
69
 
  <td><code><span class="summary-sig"><a href="popen2.Popen3-class.html#poll" class="summary-sig-name"><code>poll</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
70
 
<br />
71
 
Return the exit status of the child process if it has finished, or -1 
72
 
if it hasn't finished yet.</td></tr>
73
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
74
 
  <td><code><span class="summary-sig"><a href="popen2.Popen3-class.html#wait" class="summary-sig-name"><code>wait</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
75
 
<br />
76
 
Wait for and return the exit status of the child process.</td></tr>
77
 
</table><br />
78
 
 
79
 
 
80
 
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
81
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
82
 
<tr bgcolor="#70b0f0" class="summary">
83
 
  <th colspan="2">Class Variable Summary</th></tr>
84
 
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
85
 
<td><b><a href="popen2.Popen3-class.html#sts"><code>sts</code></a></b> = <span title="-1">-1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
86
 
</table><br />
87
 
 
88
 
 
89
 
<!-- =========== START OF METHOD DETAILS =========== -->
90
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
91
 
<tr bgcolor="#70b0f0" class="details">
92
 
  <th colspan="2">Method Details</th></tr>
93
 
</table>
94
 
 
95
 
<a name="__init__"></a>
96
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
97
 
  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
98
 
          <span class=sig-arg>cmd</span>,
99
 
          <span class=sig-arg>capturestderr</span>=<span class=sig-default>False</span>,
100
 
          <span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span>
101
 
    <br /><i>(Constructor)</i>
102
 
  </h3>
103
 
  The parameter 'cmd' is the shell command to execute in a 
104
 
  sub-process. The 'capturestderr' flag, if true, specifies that the 
105
 
  object should capture standard error output of the child process. The 
106
 
  default is false. If the 'bufsize' parameter is specified, it specifies 
107
 
  the size of the I/O buffers to/from the child process.
108
 
  <dl><dt></dt><dd>
109
 
  </dd></dl>
110
 
</td></tr></table>
111
 
 
112
 
<a name="poll"></a>
113
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
114
 
  <h3><span class="sig"><span class="sig-name">poll</span>(<span class=sig-arg>self</span>)</span>
115
 
  </h3>
116
 
  Return the exit status of the child process if it has finished, or 
117
 
  -1 if it hasn't finished yet.
118
 
  <dl><dt></dt><dd>
119
 
  </dd></dl>
120
 
</td></tr></table>
121
 
 
122
 
<a name="wait"></a>
123
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
124
 
  <h3><span class="sig"><span class="sig-name">wait</span>(<span class=sig-arg>self</span>)</span>
125
 
  </h3>
126
 
  Wait for and return the exit status of the child process.
127
 
  <dl><dt></dt><dd>
128
 
  </dd></dl>
129
 
</td></tr></table>
130
 
<br />
131
 
 
132
 
 
133
 
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
134
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
135
 
<tr bgcolor="#70b0f0" class="details">
136
 
  <th colspan="2">Class Variable Details</th></tr>
137
 
</table>
138
 
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
139
 
<a name="sts"></a>
140
 
<h3>sts</h3>
141
 
<dl>
142
 
  <dt></dt>
143
 
  <dd>
144
 
    <dl>
145
 
      <dt><b>Type:</b></dt>
146
 
      <dd>
147
 
          <code>int</code>
148
 
 
149
 
      </dd>
150
 
<span title="-1">      <dt><b>Value:</b></dt>
151
 
      <dd><table><tr><td>
152
 
<pre class="variable">
153
 
-1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
154
 
        </td></tr></table></dd>
155
 
</span>    </dl>
156
 
  </dd>
157
 
</dl></td></tr></table>
158
 
<br />
159
 
 
160
 
 
161
 
<!-- =========== START OF NAVBAR =========== -->
162
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
163
 
  <tr valign="center">
164
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="CedarBackup2-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
165
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
166
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
167
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
168
 
    <th class="navbar" align="right" width="100%">
169
 
      <table border="0" cellpadding="0" cellspacing="0">
170
 
      <tr><th class="navbar" align="center">
171
 
        <p class="nomargin">
172
 
          <a class="navbar" target="_top" href="http://cedar-solutions.com/software/cedar-backup">CedarBackup2</a>
173
 
      </p></th></tr></table>
174
 
    </th>
175
 
  </tr>
176
 
</table>
177
 
 
178
 
<table border="0" cellpadding="0" cellspacing="0" width="100%">
179
 
  <tr>
180
 
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep  4 13:49:34 2006</font></td>
181
 
    <td align="right"><a href="http://epydoc.sourceforge.net"
182
 
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
183
 
  </tr>
184
 
</table>
185
 
</body>
186
 
</html>