docs/api/network-manager-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY version SYSTEM "version.xml">
   5 ]>
   6 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   7   <bookinfo>
   8     <title>NetworkManager D-Bus Reference Manual</title>
   9     <releaseinfo>Version &version;</releaseinfo>
  10
  11     <copyright>
  12       <year>2012</year>
  13       <holder>The NetworkManager Authors</holder>
  14     </copyright>
  15
  16     <legalnotice>
  17       <para>
  18         Permission is granted to copy, distribute and/or modify this
  19         document under the terms of the <citetitle>GNU Free
  20         Documentation License</citetitle>, Version 1.1 or any later
  21         version published by the Free Software Foundation with no
  22         Invariant Sections, no Front-Cover Texts, and no Back-Cover
  23         Texts. You may obtain a copy of the <citetitle>GNU Free
  24         Documentation License</citetitle> from the Free Software
  25         Foundation by visiting <ulink type="http"
  26         url="http://www.fsf.org">their Web site</ulink> or by writing
  27         to:
  28
  29         <address>
  30           The Free Software Foundation, Inc.,
  31           <street>51 Franklin Street</street> - Fifth Floor,
  32           <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
  33           <country>USA</country>
  34         </address>
  35       </para>
  36     </legalnotice>
  37   </bookinfo>
  38
  39   <chapter id="ref-dbus">
  40     <title>D-Bus API Reference</title>
  41     <para>
  42       This part documents the D-Bus interface used to access the
  43       NetworkManager daemon.
  44     </para>
  45     <ulink url="spec.html"/>
  46   </chapter>
  47
  48   <chapter id="ref-settings">
  49     <title>Network Configuration Setting Specification</title>
  50     <para>
  51       This part documents the properties and value types of each "Setting"
  52       object that composes the basic unit of NetworkManager configuration,
  53       the "Connection".  Each Connection object is simply a dictionary mapping
  54       setting names (like "802-3-ethernet" or "bluetooth") to a dictionary of
  55       key/value pairs that represents each itself.
  56     </para>
  57     <xi:include href="settings-spec.xml">
  58       <xi:fallback>
  59         <section>
  60           <title>Configuration Settings</title>
  61           <note><para>
  62             (NetworkManager was built without full introspection support. Setting
  63             documentation is not available.)
  64           </para></note>
  65         </section>
  66       </xi:fallback>
  67     </xi:include>
  68     <section id="secrets-flags">
  69       <title>Secret flag types</title>
  70       <para>
  71         Each secret property in a setting has an associated "flags" property
  72         that describes how to handle that secret.  The "flags" property is a
  73         bitfield that contains zero or more of the following values logically
  74         OR-ed together.
  75       </para>
  76       <para>
  77         <itemizedlist>
  78           <listitem>
  79             <literal>0x0 (none)</literal> - the system is responsible for providing
  80             and storing this secret.
  81           </listitem>
  82           <listitem>
  83             <literal>0x1 (agent-owned)</literal> - a user-session secret agent
  84             is responsible for providing and storing this secret; when it is
  85             required, agents will be asked to provide it.
  86           </listitem>
  87           <listitem>
  88             <literal>0x2 (not-saved)</literal> - this secret should not be saved
  89             but should be requested from the user each time it is required. This
  90             flag should be used for One-Time-Pad secrets, PIN codes from
  91             hardware tokens, or if the user simply does not want to save the
  92             secret.
  93           </listitem>
  94           <listitem>
  95             <literal>0x4 (not-required)</literal> - in some situations it cannot
  96             be automatically determined that a secret is required or not.  This
  97             flag hints that the secret is not required and should not be
  98             requested from the user.
  99           </listitem>
 100         </itemizedlist>
 101       </para>
 102     </section>
 103   </chapter>
 104
 105   <xi:include href="migrating-to-09.xml" />
 106
 107   <index>
 108     <title>Index</title>
 109   </index>
 110
 111   <!-- License -->
 112
 113   <appendix id="license">
 114     <title>License</title>
 115     <para>
 116 <programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
 117     </para>
 118   </appendix>
 119 </book>
 120