/usr/share/gtk-doc/html/vte-0.0/VteReaper.html is in libvte-doc 1:0.28.2-5ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 69 70 71 72 73 74 75 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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>VteReaper</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="VTE Reference Manual">
<link rel="up" href="deprecated-objects.html" title="Deprecated">
<link rel="prev" href="deprecated-objects.html" title="Deprecated">
<link rel="next" href="object-hierarchy.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="deprecated-objects.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="deprecated-objects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">VTE Reference Manual</th>
<td><a accesskey="n" href="object-hierarchy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#VteReaper.synopsis" class="shortcut">Top</a>
|
<a href="#VteReaper.description" class="shortcut">Description</a>
|
<a href="#VteReaper.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#VteReaper.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="VteReaper"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="VteReaper.top_of_page"></a>VteReaper</span></h2>
<p>VteReaper — A singleton object which catches <code class="literal">SIGCHLD</code> signals and
converts them into GObject-style "child-exited" signals</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="VteReaper.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="VteReaper.html#VteReaper-struct" title="VteReaper">VteReaper</a>;
<span class="returnvalue">int</span> <a class="link" href="VteReaper.html#vte-reaper-add-child" title="vte_reaper_add_child ()">vte_reaper_add_child</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GPid"><span class="type">GPid</span></a> pid</code></em>);
<a class="link" href="VteReaper.html" title="VteReaper"><span class="returnvalue">VteReaper</span></a> * <a class="link" href="VteReaper.html#vte-reaper-get" title="vte_reaper_get ()">vte_reaper_get</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="VteReaper.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----VteReaper
</pre>
</div>
<div class="refsect1">
<a name="VteReaper.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="VteReaper.html#VteReaper-child-exited" title='The "child-exited" signal'>child-exited</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="VteReaper.description"></a><h2>Description</h2>
<p>
Because an application may need to be notified when child processes
exit, and because there is only one <code class="literal">SIGCHLD</code> handler, the <a class="link" href="VteTerminal.html" title="VteTerminal"><span class="type">VteTerminal</span></a>
widget relies on a <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> to watch for <code class="literal">SIGCHLD</code> notifications and
retrieve the exit status of child processes which have exited. When
glib provides child_watch functionality, the <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> merely acts as
a proxy for glib's own functionality.
</p>
<p>
Since 0.11.11
</p>
</div>
<div class="refsect1">
<a name="VteReaper.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="VteReaper-struct"></a><h3>VteReaper</h3>
<pre class="programlisting">typedef struct _VteReaper VteReaper;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">VteReaper</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
The reaper object.
</p>
</div>
<hr>
<div class="refsect2">
<a name="vte-reaper-add-child"></a><h3>vte_reaper_add_child ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> vte_reaper_add_child (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GPid"><span class="type">GPid</span></a> pid</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">vte_reaper_add_child</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Ensures that child-exited signals will be emitted when <em class="parameter"><code>pid</code></em> exits. This is
necessary for correct operation when running with glib versions >= 2.4.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pid</code></em> :</span></p></td>
<td>the ID of a child process which will be monitored
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the new source ID
Since 0.11.11
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="vte-reaper-get"></a><h3>vte_reaper_get ()</h3>
<pre class="programlisting"><a class="link" href="VteReaper.html" title="VteReaper"><span class="returnvalue">VteReaper</span></a> * vte_reaper_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">vte_reaper_get</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Finds the address of the global <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> object, creating the object if
necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the global <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> object, which should not be unreffed.
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="VteReaper.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="VteReaper-child-exited"></a><h3>The <code class="literal">"child-exited"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> *vtereaper,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg2,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when the <a class="link" href="VteReaper.html" title="VteReaper"><span class="type">VteReaper</span></a> object detects that a child of the
current process has exited.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vtereaper</code></em> :</span></p></td>
<td>the object which received the signal
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>the process ID of the exited child
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
<td>the status of the exited child, as returned by <code class="function">waitpid()</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.11.11</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15.1</div>
</body>
</html>
|