/usr/share/gtk-doc/html/libnm-util/NMSettingPPPOE.html is in libnm-util-dev 0.9.4.0-0ubuntu3.
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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NMSettingPPPOE</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libnm-util Reference Manual">
<link rel="up" href="ch01.html" title="libnm-util API Reference">
<link rel="prev" href="NMSettingPPP.html" title="NMSettingPPP">
<link rel="next" href="NMSettingVPN.html" title="NMSettingVPN">
<meta name="generator" content="GTK-Doc V1.18 (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="NMSettingPPP.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libnm-util Reference Manual</th>
<td><a accesskey="n" href="NMSettingVPN.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#NMSettingPPPOE.synopsis" class="shortcut">Top</a>
|
<a href="#NMSettingPPPOE.description" class="shortcut">Description</a>
|
<a href="#NMSettingPPPOE.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#NMSettingPPPOE.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="NMSettingPPPOE"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NMSettingPPPOE.top_of_page"></a>NMSettingPPPOE</span></h2>
<p>NMSettingPPPOE — Describes PPPoE connection properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="NMSettingPPPOE.synopsis"></a><h2>Synopsis</h2>
<a name="NMSettingPPPOEError"></a><pre class="synopsis">
#include <nm-setting-pppoe.h>
<a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE-struct" title="NMSettingPPPOE">NMSettingPPPOE</a>;
<a class="link" href="NMSettingPPPOE.html#NMSettingPPPOEClass" title="NMSettingPPPOEClass">NMSettingPPPOEClass</a>;
enum <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOEError-enum" title="enum NMSettingPPPOEError">NMSettingPPPOEError</a>;
#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-ERROR:CAPS" title="NM_SETTING_PPPOE_ERROR">NM_SETTING_PPPOE_ERROR</a>
#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-PASSWORD:CAPS" title="NM_SETTING_PPPOE_PASSWORD">NM_SETTING_PPPOE_PASSWORD</a>
#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-PASSWORD-FLAGS:CAPS" title="NM_SETTING_PPPOE_PASSWORD_FLAGS">NM_SETTING_PPPOE_PASSWORD_FLAGS</a>
#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-SERVICE:CAPS" title="NM_SETTING_PPPOE_SERVICE">NM_SETTING_PPPOE_SERVICE</a>
#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-SETTING-NAME:CAPS" title="NM_SETTING_PPPOE_SETTING_NAME">NM_SETTING_PPPOE_SETTING_NAME</a>
#define <a class="link" href="NMSettingPPPOE.html#NM-SETTING-PPPOE-USERNAME:CAPS" title="NM_SETTING_PPPOE_USERNAME">NM_SETTING_PPPOE_USERNAME</a>
<span class="returnvalue">GQuark</span> <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-error-quark" title="nm_setting_pppoe_error_quark ()">nm_setting_pppoe_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-password" title="nm_setting_pppoe_get_password ()">nm_setting_pppoe_get_password</a> (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);
<a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-password-flags" title="nm_setting_pppoe_get_password_flags ()">nm_setting_pppoe_get_password_flags</a>
(<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-service" title="nm_setting_pppoe_get_service ()">nm_setting_pppoe_get_service</a> (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-get-username" title="nm_setting_pppoe_get_username ()">nm_setting_pppoe_get_username</a> (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);
<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingPPPOE.html#nm-setting-pppoe-new" title="nm_setting_pppoe_new ()">nm_setting_pppoe_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="NMSettingPPPOE.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a>
+----NMSettingPPPOE
</pre>
<pre class="synopsis">
GEnum
+----NMSettingPPPOEError
</pre>
</div>
<div class="refsect1">
<a name="NMSettingPPPOE.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--password" title='The "password" property'>password</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--password-flags" title='The "password-flags" property'>password-flags</a>" <span class="type">guint</span> : Read / Write
"<a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--service" title='The "service" property'>service</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--username" title='The "username" property'>username</a>" <span class="type">gchar</span>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="NMSettingPPPOE.description"></a><h2>Description</h2>
<p>
The <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes
properties necessary for connection to networks that require PPPoE connections
to provide IP transport, for example cable or DSL modems.
</p>
</div>
<div class="refsect1">
<a name="NMSettingPPPOE.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="NMSettingPPPOE-struct"></a><h3>NMSettingPPPOE</h3>
<pre class="programlisting">typedef struct _NMSettingPPPOE NMSettingPPPOE;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NMSettingPPPOEClass"></a><h3>NMSettingPPPOEClass</h3>
<pre class="programlisting">typedef struct {
NMSettingClass parent;
/* Padding for future expansion */
void (*_reserved1) (void);
void (*_reserved2) (void);
void (*_reserved3) (void);
void (*_reserved4) (void);
} NMSettingPPPOEClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NMSettingPPPOEError-enum"></a><h3>enum NMSettingPPPOEError</h3>
<pre class="programlisting">typedef enum {
NM_SETTING_PPPOE_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/
NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING /*< nick=MissingPPPSetting >*/
} NMSettingPPPOEError;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="NM-SETTING-PPPOE-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPPOE_ERROR_UNKNOWN</code></span></p></td>
<td>unknown or unclassified error
</td>
</tr>
<tr>
<td><p><a name="NM-SETTING-PPPOE-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY</code></span></p></td>
<td>the property was invalid
</td>
</tr>
<tr>
<td><p><a name="NM-SETTING-PPPOE-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY</code></span></p></td>
<td>the property was missing and is
required
</td>
</tr>
<tr>
<td><p><a name="NM-SETTING-PPPOE-ERROR-MISSING-PPP-SETTING:CAPS"></a><span class="term"><code class="literal">NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING</code></span></p></td>
<td>the connection
did not contain a required PPP setting for PPP related options
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-PPPOE-ERROR:CAPS"></a><h3>NM_SETTING_PPPOE_ERROR</h3>
<pre class="programlisting">#define NM_SETTING_PPPOE_ERROR nm_setting_pppoe_error_quark ()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-PPPOE-PASSWORD:CAPS"></a><h3>NM_SETTING_PPPOE_PASSWORD</h3>
<pre class="programlisting">#define NM_SETTING_PPPOE_PASSWORD "password"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-PPPOE-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_PPPOE_PASSWORD_FLAGS</h3>
<pre class="programlisting">#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-PPPOE-SERVICE:CAPS"></a><h3>NM_SETTING_PPPOE_SERVICE</h3>
<pre class="programlisting">#define NM_SETTING_PPPOE_SERVICE "service"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-PPPOE-SETTING-NAME:CAPS"></a><h3>NM_SETTING_PPPOE_SETTING_NAME</h3>
<pre class="programlisting">#define NM_SETTING_PPPOE_SETTING_NAME "pppoe"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-PPPOE-USERNAME:CAPS"></a><h3>NM_SETTING_PPPOE_USERNAME</h3>
<pre class="programlisting">#define NM_SETTING_PPPOE_USERNAME "username"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="nm-setting-pppoe-error-quark"></a><h3>nm_setting_pppoe_error_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span> nm_setting_pppoe_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Registers an error quark for <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> 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 error quark used for <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> errors.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="nm-setting-pppoe-get-password"></a><h3>nm_setting_pppoe_get_password ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_password (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="nm-setting-pppoe-get-password-flags"></a><h3>nm_setting_pppoe_get_password_flags ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> nm_setting_pppoe_get_password_flags
(<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
<td>the <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="NMSetting.html#NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--password" title='The "password" property'><span class="type">"password"</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="nm-setting-pppoe-get-service"></a><h3>nm_setting_pppoe_get_service ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_service (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
<td>the <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--password" title='The "password" property'><span class="type">"password"</span></a> property of the setting</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="nm-setting-pppoe-get-username"></a><h3>nm_setting_pppoe_get_username ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_pppoe_get_username (<em class="parameter"><code><a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> *setting</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="nm-setting-pppoe-new"></a><h3>nm_setting_pppoe_new ()</h3>
<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_pppoe_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> object with default values.
</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 new empty <a class="link" href="NMSettingPPPOE.html" title="NMSettingPPPOE"><span class="type">NMSettingPPPOE</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="NMSettingPPPOE.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="NMSettingPPPOE--password"></a><h3>The <code class="literal">"password"</code> property</h3>
<pre class="programlisting"> "password" <span class="type">gchar</span>* : Read / Write</pre>
<p>
Password used to authenticate with the PPPoE service.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="NMSettingPPPOE--password-flags"></a><h3>The <code class="literal">"password-flags"</code> property</h3>
<pre class="programlisting"> "password-flags" <span class="type">guint</span> : Read / Write</pre>
<p>
Flags indicating how to handle <a class="link" href="NMSettingPPPOE.html#NMSettingPPPOE--password" title='The "password" property'><span class="type">"password"</span></a>:.
</p>
<p>Allowed values: <= 7</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="NMSettingPPPOE--service"></a><h3>The <code class="literal">"service"</code> property</h3>
<pre class="programlisting"> "service" <span class="type">gchar</span>* : Read / Write</pre>
<p>
If specified, instruct PPPoE to only initiate sessions with access
concentrators that provide the specified serivce. For most providers,
this should be left blank. It is only required if there are multiple
access concentrators or a specific service is known to be required.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="NMSettingPPPOE--username"></a><h3>The <code class="literal">"username"</code> property</h3>
<pre class="programlisting"> "username" <span class="type">gchar</span>* : Read / Write</pre>
<p>
Username used to authenticate with the PPPoE service.
</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|