/usr/share/gtk-doc/html/PackageKit/PackageKit-PkClientHelper.html is in packagekit-docs 1.1.9-1ubuntu2.
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 187 188 189 190 191 192 193 194 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PkClientHelper: PackageKit Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="PackageKit Reference Manual">
<link rel="up" href="lpackagekit-glib2.html" title="packagekit-glib2">
<link rel="prev" href="PackageKit-PkClient.html" title="PkClient">
<link rel="next" href="PackageKit-PkControl.html" title="PkControl">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#PackageKit-PkClientHelper.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="lpackagekit-glib2.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="PackageKit-PkClient.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="PackageKit-PkControl.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="PackageKit-PkClientHelper"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PackageKit-PkClientHelper.top_of_page"></a>PkClientHelper</span></h2>
<p>PkClientHelper — helper object to run a helper session process for the lifetime of a transaction</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="PackageKit-PkClientHelper.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">PkClientHelper</span> *
</td>
<td class="function_name">
<a class="link" href="PackageKit-PkClientHelper.html#pk-client-helper-new" title="pk_client_helper_new ()">pk_client_helper_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PackageKit-PkClientHelper.html#pk-client-helper-stop" title="pk_client_helper_stop ()">pk_client_helper_stop</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PackageKit-PkClientHelper.html#pk-client-helper-start" title="pk_client_helper_start ()">pk_client_helper_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PackageKit-PkClientHelper.description"></a><h2>Description</h2>
<p>This GObject can be used to run a session helper program out of band
with the normal PackageKit transaction. This allows an external program
such as debconf to be used that needs direct console access.</p>
<p> client ----> packagekit-glib ---> dbus ---> packagekitd ---> apt
.------------^ ^
debconf ___________________ (SetHints) |
| ___| PkClientHelper __.____.____.______/_.____.____.__/
^-----|___________________/ (socket in tmp)
(stdin & stdout )</p>
<p> ------------.------------------/ ------------.---------/
| |
user session system context</p>
</div>
<div class="refsect1">
<a name="PackageKit-PkClientHelper.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="pk-client-helper-new"></a><h3>pk_client_helper_new ()</h3>
<pre class="programlisting"><span class="returnvalue">PkClientHelper</span> *
pk_client_helper_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="pk-client-helper-new.returns"></a><h4>Returns</h4>
<p> a new <span class="type">PkClientHelper</span> object.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-6-10.html#api-index-0.6.10">0.6.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="pk-client-helper-stop"></a><h3>pk_client_helper_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
pk_client_helper_stop (<em class="parameter"><code><span class="type">PkClientHelper</span> *client_helper</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Stops the helper process, by killing the helper process and deleting
the socket.</p>
<div class="refsect3">
<a name="pk-client-helper-stop.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client_helper</p></td>
<td class="parameter_description"><p>a valid <span class="type">PkClientHelper</span> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span> or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="pk-client-helper-stop.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> for success</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-6-10.html#api-index-0.6.10">0.6.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="pk-client-helper-start"></a><h3>pk_client_helper_start ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
pk_client_helper_start (<em class="parameter"><code><span class="type">PkClientHelper</span> *client_helper</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *socket_filename</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **argv</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **envp</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Starts the helper process, by running the helper process and setting
up the socket for use.</p>
<div class="refsect3">
<a name="pk-client-helper-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client_helper</p></td>
<td class="parameter_description"><p>a valid <span class="type">PkClientHelper</span> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>socket_filename</p></td>
<td class="parameter_description"><p>a socket filename that does not already exist</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>argv</p></td>
<td class="parameter_description"><p>the executable, along with any arguments</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>envp</p></td>
<td class="parameter_description"><p>the environment</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span> or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="pk-client-helper-start.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> for success</p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-6-10.html#api-index-0.6.10">0.6.10</a></p>
</div>
</div>
<div class="refsect1">
<a name="PackageKit-PkClientHelper.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|