From c4581af5d910fd5d823f0c7c36fec4e0acd59388 Mon Sep 17 00:00:00 2001 From: Aleksander Morgado Date: Tue, 28 Feb 2012 10:47:38 +0100 Subject: docs: set `ModemManager' as module name instead of `mm' --- docs/reference/api/Makefile.am | 10 +- docs/reference/api/ModemManager-dbus-reference.xml | 179 +++++++++++++++++++++ docs/reference/api/ModemManager-docs.xml | 78 +++++++++ docs/reference/api/ModemManager-overview.xml | 95 +++++++++++ docs/reference/api/ModemManager-sections.txt | 34 ++++ docs/reference/api/ModemManager.types | 0 docs/reference/api/mm-dbus-reference.xml | 179 --------------------- docs/reference/api/mm-docs.xml | 78 --------- docs/reference/api/mm-overview.xml | 95 ----------- docs/reference/api/mm-sections.txt | 34 ---- docs/reference/api/mm.types | 0 11 files changed, 391 insertions(+), 391 deletions(-) create mode 100644 docs/reference/api/ModemManager-dbus-reference.xml create mode 100644 docs/reference/api/ModemManager-docs.xml create mode 100644 docs/reference/api/ModemManager-overview.xml create mode 100644 docs/reference/api/ModemManager-sections.txt create mode 100644 docs/reference/api/ModemManager.types delete mode 100644 docs/reference/api/mm-dbus-reference.xml delete mode 100644 docs/reference/api/mm-docs.xml delete mode 100644 docs/reference/api/mm-overview.xml delete mode 100644 docs/reference/api/mm-sections.txt delete mode 100644 docs/reference/api/mm.types (limited to 'docs') diff --git a/docs/reference/api/Makefile.am b/docs/reference/api/Makefile.am index bdb15ce0..2627d9e7 100644 --- a/docs/reference/api/Makefile.am +++ b/docs/reference/api/Makefile.am @@ -12,7 +12,7 @@ $(DIAGRAMS_PNG): $(DIAGRAMS) $(AM_V_GEN) $(DIA) -t png $^ 1>/dev/null 2>&1 # The name of the module. -DOC_MODULE = mm +DOC_MODULE = ModemManager # The top-level SGML file. DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml @@ -60,8 +60,8 @@ content_files = \ $(NULL) expand_content_files = \ - mm-overview.xml \ - mm-dbus-reference.xml \ + ModemManager-overview.xml \ + ModemManager-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 \ @@ -88,8 +88,8 @@ CLEANFILES = endif EXTRA_DIST += \ - mm-overview.xml \ - mm-dbus-reference.xml \ + ModemManager-overview.xml \ + ModemManager-dbus-reference.xml \ version.xml.in \ $(DIAGRAMS) \ $(NULL) diff --git a/docs/reference/api/ModemManager-dbus-reference.xml b/docs/reference/api/ModemManager-dbus-reference.xml new file mode 100644 index 00000000..3979731b --- /dev/null +++ b/docs/reference/api/ModemManager-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/ModemManager-docs.xml b/docs/reference/api/ModemManager-docs.xml new file mode 100644 index 00000000..17bc814a --- /dev/null +++ b/docs/reference/api/ModemManager-docs.xml @@ -0,0 +1,78 @@ + + +]> + + + ModemManager Reference Manual + For ModemManager version &version; + + + + Dan + Williams + +
+ dcbw@redhat.com +
+ + + + Aleksander + Morgado + +
+ aleksander@lanedo.com +
+ + + + + + 2008 + 2009 + 2010 + 2011 + 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.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 + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: +
+ The Free Software Foundation, Inc. + 51 Franklin Street, Suite 500 + Boston, MA 02110-1335 + USA +
+ + + + + + + + + + + + Index + + + + + diff --git a/docs/reference/api/ModemManager-overview.xml b/docs/reference/api/ModemManager-overview.xml new file mode 100644 index 00000000..95764795 --- /dev/null +++ b/docs/reference/api/ModemManager-overview.xml @@ -0,0 +1,95 @@ + + + + ModemManager Overview + + + Introduction + + ModemManager provides a unified high level API for communicating with + (mobile broadband) modems. While the basic commands are standardized, + the more advanced operations (like signal quality monitoring while + connected) varies a lot. + + + Using + + ModemManager is a system daemon and is not meant to be used directly from + the command line. However, a command line client (mmcli) is provided, which + may be used to test the different functionality provided during plugin + development. + + + + Implementation + + ModemManager is a DBus system bus activated service (meaning it's started + automatically when a request arrives). It is written in C. The devices are + queried from udev and automatically updated based on hardware events. There are + DBus-interface specific GInterfaces, which should be implemented by any device + specific implementation. There is a generic MMBroadbandModem implementation that + provides a generic implementation of the most common operations in both GSM and + CDMA modems. + + + + Plugins + + Plugins are loaded on startup, and must implement the MMPlugin interface. It + consists of a couple of methods which tell the daemon whether the plugin + supports a port and to create custom modem implementations. It most likely + makes sense to derive custom modem implementations from one of the generic + classes and just add (or override) operations which are not standard. Writing + new plugins is highly encouraged! + + + + + + State machine + + ModemManager implements support for each Modem by controlling their + behaviour following the steps given in the following state machine. + +
+ ModemManager states + +
+ + The state machine of a modem can be summarized in 5 main sequences: + initialization, enabling, connection, disconnection and disabling. + +
+ Initialization + + + +
+
+ Enabling + + + +
+
+ Connection + + + +
+
+ Disconnection + + + +
+
+ Disabling + + + +
+ + diff --git a/docs/reference/api/ModemManager-sections.txt b/docs/reference/api/ModemManager-sections.txt new file mode 100644 index 00000000..a50dc2a0 --- /dev/null +++ b/docs/reference/api/ModemManager-sections.txt @@ -0,0 +1,34 @@ +
+mm-enums +Flags and Enumerations +MMBearerIpMethod +MMModem3gppFacility +MMModem3gppNetworkAvailability +MMModem3gppRegistrationState +MMModem3gppUssdSessionState +MMModemAccessTechnology +MMModemBand +MMModemCapability +MMModemCdmaActivationState +MMModemCdmaRegistrationState +MMModemCdmaRmProtocol +MMModemContactsStorage +MMModemLocationSource +MMModemLock +MMModemMode +MMModemState +MMModemStateChangeReason +MMSmsState +MMSmsStorage +
+ +
+mm-errors +Errors +MMConnectionError +MMCoreError +MMMessageError +MMMobileEquipmentError +MMSerialError +MMCdmaActivationError +
diff --git a/docs/reference/api/ModemManager.types b/docs/reference/api/ModemManager.types new file mode 100644 index 00000000..e69de29b diff --git a/docs/reference/api/mm-dbus-reference.xml b/docs/reference/api/mm-dbus-reference.xml deleted file mode 100644 index 3979731b..00000000 --- a/docs/reference/api/mm-dbus-reference.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - 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 deleted file mode 100644 index be505735..00000000 --- a/docs/reference/api/mm-docs.xml +++ /dev/null @@ -1,78 +0,0 @@ - - -]> - - - ModemManager Reference Manual - For ModemManager version &version; - - - - Dan - Williams - -
- dcbw@redhat.com -
- - - - Aleksander - Morgado - -
- aleksander@lanedo.com -
- - - - - - 2008 - 2009 - 2010 - 2011 - 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.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 - Documentation License from the Free Software - Foundation by visiting their Web site or by writing - to: -
- The Free Software Foundation, Inc. - 51 Franklin Street, Suite 500 - Boston, MA 02110-1335 - USA -
- - - - - - - - - - - - Index - - - - - diff --git a/docs/reference/api/mm-overview.xml b/docs/reference/api/mm-overview.xml deleted file mode 100644 index 95764795..00000000 --- a/docs/reference/api/mm-overview.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - ModemManager Overview - - - Introduction - - ModemManager provides a unified high level API for communicating with - (mobile broadband) modems. While the basic commands are standardized, - the more advanced operations (like signal quality monitoring while - connected) varies a lot. - - - Using - - ModemManager is a system daemon and is not meant to be used directly from - the command line. However, a command line client (mmcli) is provided, which - may be used to test the different functionality provided during plugin - development. - - - - Implementation - - ModemManager is a DBus system bus activated service (meaning it's started - automatically when a request arrives). It is written in C. The devices are - queried from udev and automatically updated based on hardware events. There are - DBus-interface specific GInterfaces, which should be implemented by any device - specific implementation. There is a generic MMBroadbandModem implementation that - provides a generic implementation of the most common operations in both GSM and - CDMA modems. - - - - Plugins - - Plugins are loaded on startup, and must implement the MMPlugin interface. It - consists of a couple of methods which tell the daemon whether the plugin - supports a port and to create custom modem implementations. It most likely - makes sense to derive custom modem implementations from one of the generic - classes and just add (or override) operations which are not standard. Writing - new plugins is highly encouraged! - - - - - - State machine - - ModemManager implements support for each Modem by controlling their - behaviour following the steps given in the following state machine. - -
- ModemManager states - -
- - The state machine of a modem can be summarized in 5 main sequences: - initialization, enabling, connection, disconnection and disabling. - -
- Initialization - - - -
-
- Enabling - - - -
-
- Connection - - - -
-
- Disconnection - - - -
-
- Disabling - - - -
- - diff --git a/docs/reference/api/mm-sections.txt b/docs/reference/api/mm-sections.txt deleted file mode 100644 index a50dc2a0..00000000 --- a/docs/reference/api/mm-sections.txt +++ /dev/null @@ -1,34 +0,0 @@ -
-mm-enums -Flags and Enumerations -MMBearerIpMethod -MMModem3gppFacility -MMModem3gppNetworkAvailability -MMModem3gppRegistrationState -MMModem3gppUssdSessionState -MMModemAccessTechnology -MMModemBand -MMModemCapability -MMModemCdmaActivationState -MMModemCdmaRegistrationState -MMModemCdmaRmProtocol -MMModemContactsStorage -MMModemLocationSource -MMModemLock -MMModemMode -MMModemState -MMModemStateChangeReason -MMSmsState -MMSmsStorage -
- -
-mm-errors -Errors -MMConnectionError -MMCoreError -MMMessageError -MMMobileEquipmentError -MMSerialError -MMCdmaActivationError -
diff --git a/docs/reference/api/mm.types b/docs/reference/api/mm.types deleted file mode 100644 index e69de29b..00000000 -- cgit v1.2.3