diff --git a/docs/reference/api/Makefile.am b/docs/reference/api/Makefile.am
index 413bc63b..69c11548 100644
--- a/docs/reference/api/Makefile.am
+++ b/docs/reference/api/Makefile.am
@@ -45,6 +45,7 @@ content_files = \
expand_content_files = \
mm-overview.xml \
+ mm-dbus-reference.xml \
$(top_builddir)/libmm-common/mm-gdbus-doc-org.freedesktop.ModemManager1.xml \
$(top_builddir)/libmm-common/mm-gdbus-doc-org.freedesktop.ModemManager1.Sim.xml \
$(top_builddir)/libmm-common/mm-gdbus-doc-org.freedesktop.ModemManager1.Sms.xml \
@@ -72,6 +73,7 @@ endif
EXTRA_DIST += \
mm-overview.xml \
+ mm-dbus-reference.xml \
version.xml.in \
$(NULL)
diff --git a/docs/reference/api/mm-dbus-reference.xml b/docs/reference/api/mm-dbus-reference.xml
new file mode 100644
index 00000000..3979731b
--- /dev/null
+++ b/docs/reference/api/mm-dbus-reference.xml
@@ -0,0 +1,179 @@
+
+
+
+ D-Bus Reference
+
+
+ The <literal>org.freedesktop.ModemManager1</literal> bus name
+
+ The D-Bus name org.freedesktop.ModemManager1
+ on the system bus is used by the ModemManager daemon.
+
+
+ If this daemon isn't running, it will be started if D-Bus messages are
+ sent to the name.
+
+
+
+
+ Standard interfaces
+
+ Please refer to the
+
+ DBus specification at freedesktop.org
+ for more information on how to use these standard interfaces.
+
+
+ org.freedesktop.DBus.Properties
+
+ All objects (Manager,
+ Modems,
+ Bearers,
+ SIMs,
+ SMSs) exported at the
+ org.freedesktop.ModemManager1
+ bus name implement the standard
+
+ org.freedesktop.DBus.Properties
+ interface. Objects implementing this interface provide a
+ common way to query for property values and also a generic signal to
+ get notified about changes in those properties.
+
+
+
+ org.freedesktop.DBus.Introspectable
+
+ All objects (Manager,
+ Modems,
+ Bearers,
+ SIMs,
+ SMSs) exported at the
+ org.freedesktop.ModemManager1
+ bus name implement the standard
+
+ org.freedesktop.DBus.Introspectable
+ interface. Objects implementing this interface will provide an
+ XML-based description of the object and its interfaces.
+
+
+
+ org.freedesktop.DBus.ObjectManager
+
+ The Manager object
+ exported at the
+ org.freedesktop.ModemManager1
+ bus name implements the standard
+
+ org.freedesktop.DBus.ObjectManager
+ interface. This interface, included in rev. 0.17 of the DBus
+ specification, allows a generic way to control the addition and removal
+ of Modem objects, as well as the addition and removal of interfaces in
+ the given objects.
+
+
+
+
+
+ Common types
+
+
+
+
+
+ The <literal>/org/freedesktop/ModemManager1</literal> object
+
+ The ModemManager process will export an object at the well-known
+ path /org/freedesktop/ModemManager1.
+
+
+ This object, which implements the standard
+ org.freedesktop.DBus.ObjectManager, is responsible for managing the list of
+ Modem objects.
+
+
+ This object also controls any process-wide operation, such as the log
+ level being used by the daemon.
+
+
+
+
+
+ The <literal>/org/freedesktop/ModemManager/Modems</literal> objects
+
+ Modem objects are exported in DBus with the following path base:
+ /org/freedesktop/ModemManager1/Modems/#, where
+ # indicates a unique unsigned integer which identifies
+ the object.
+
+
+ The Modem objects will export a generic
+ Modem interface
+ which includes common features and actions applicable to most modem types.
+ This interface, among other actions, allows the management (creation,
+ listing, deletion) of
+ Bearer objects which can
+ then be used to request the modem to get in connected state.
+
+
+ Modem objects will also export the generic
+ Simple interface.
+ This interface provides an easy access to the most simple and common
+ operations that may be performed with the modem, including connection and
+ disconnection. Users of the Simple interface do not need to take care of
+ getting the modem registered, and they also don't need to manage the
+ creation of bearers themselves. All the logic required to get the modem
+ connected or disconnected is handled by the Simple interface.
+
+
+ Modems with specific 3GPP and/or CDMA capabilities will export modem type
+ specific interfaces, like the
+ 3GPP interface
+ or the
+ CDMA interface.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The <literal>/org/freedesktop/ModemManager/Bearers</literal> objects
+
+ Bearer objects are owned and managed by specific
+ Modem objects. A single Modem
+ may expose one or more Bearer objects, which can then be used to get the
+ modem into connected state.
+
+
+
+
+
+ The <literal>/org/freedesktop/ModemManager/SIMs</literal> objects
+
+ Broadband modems usually need a SIM card to operate. Each
+ Modem object will therefore
+ expose up to one SIM object, which allows SIM-specific actions such as PIN
+ unlocking.
+
+
+
+
+
+ The <literal>/org/freedesktop/ModemManager/SMSs</literal> objects
+
+ Modems implementing the
+ Messaging interface
+ will export one SMS object for each SMS stored in the device.
+
+
+
+
+
diff --git a/docs/reference/api/mm-docs.xml b/docs/reference/api/mm-docs.xml
index dd8c7843..be505735 100644
--- a/docs/reference/api/mm-docs.xml
+++ b/docs/reference/api/mm-docs.xml
@@ -6,33 +6,43 @@
ModemManager Reference Manual
- Version &version;
+ For ModemManager version &version;
+
+
+
+ Dan
+ Williams
+
+
+ dcbw@redhat.com
+
+
+
+
+ Aleksander
+ Morgado
+
+
+ aleksander@lanedo.com
+
+
+
+
-
- 2008
- Novell, Inc.
- 2008200920102011
- Red Hat, Inc.
-
-
- 2011
- The Chromium OS Authors
-
-
- 2011
- Google, Inc.
+ 2012
+ The ModemManager Authors
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free
- Documentation License, Version 1.1 or any later
+ Documentation License, Version 1.3 or any later
version published by the Free Software Foundation with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the GNU Free
@@ -41,6 +51,7 @@
url="http://www.fsf.org">their Web site or by writing
to:
+ The Free Software Foundation, Inc.
51 Franklin Street, Suite 500
Boston, MA02110-1335USA
@@ -49,90 +60,19 @@
+
-
- D-Bus API Reference
-
-
- Objects & Names
-
- The <literal>org.freedesktop.ModemManager1</literal> bus name
-
- The D-Bus name org.freedesktop.ModemManager1
- on the system bus is used by the ModemManager daemon. If this daemon
- isn't running, it will be started if D-Bus messages are sent to the
- name.
-
-
-
-
- The <literal>/org/freedesktop/ModemManager</literal>
- and <literal>/org/freedesktop/ModemManager/Modems</literal> objects
-
-
- The ModemManager process will export an object at the well-known
- path /org/freedesktop/ModemManager1. This object can
- be used to list available modem objects, which will also be exposed
- on paths with the folowing pattern
- /org/freedesktop/ModemManager1/Modems/#.
-
-
-
-
-
- Common types
-
-
-
-
- Manager interface
-
-
-
- SIM interface
-
-
-
- SMS interface
-
-
-
- Bearer interface
-
-
-
- Modem interfaces
-
- Generic
-
-
-
-
- 3GPP specific
-
-
-
-
- CDMA specific
-
-
-
- Other
-
-
-
-
-
-
-
+
+ Index
-
+
+