[5b8f578d] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY ModemManager-download-http "https://www.freedesktop.org/software/ModemManager/ModemManager-&ModemManager-version;.tar.xz">
|
---|
[5b8f578d] | 8 | <!ENTITY ModemManager-download-ftp " ">
|
---|
[baeafab] | 9 | <!ENTITY ModemManager-md5sum "88a9fd4373fedd5c9faa83d82a195767">
|
---|
[8000e557] | 10 | <!ENTITY ModemManager-size "2.2 MB">
|
---|
[baeafab] | 11 | <!ENTITY ModemManager-buildsize "115 MB (with tests)">
|
---|
[6aa4b2e8] | 12 | <!ENTITY ModemManager-time "0.5 SBU (Using parallelism=4; with tests)">
|
---|
[5b8f578d] | 13 | ]>
|
---|
| 14 |
|
---|
[7d645679] | 15 | <sect1 id="ModemManager" xreflabel="ModemManager-&ModemManager-version;">
|
---|
[5b8f578d] | 16 | <?dbhtml filename="ModemManager.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>ModemManager-&ModemManager-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="ModemManager">
|
---|
| 25 | <primary sortas="a-ModemManager">ModemManager</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to ModemManager</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
| 32 | <application>ModemManager</application> provides a unified high level
|
---|
| 33 | API for communicating with mobile broadband modems, regardless of the
|
---|
| 34 | protocol used to communicate with the actual device.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[4f68434f] | 37 | &lfs110_checked;
|
---|
[5b8f578d] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&ModemManager-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&ModemManager-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &ModemManager-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &ModemManager-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &ModemManager-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &ModemManager-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">ModemManager Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 76 | <para role="required">
|
---|
| 77 | <xref linkend="libgudev"/>
|
---|
| 78 | </para>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 81 | <para role="recommended">
|
---|
[51dfb3e] | 82 | <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
|
---|
[5b8f578d] | 83 | <xref linkend="gobject-introspection"/>,
|
---|
| 84 | <xref linkend="libmbim"/>,
|
---|
| 85 | <xref linkend="libqmi"/>,
|
---|
| 86 | <xref linkend="polkit"/>, and
|
---|
| 87 | <xref linkend="vala"/>
|
---|
| 88 | </para>
|
---|
| 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 91 | <para role="optional">
|
---|
| 92 | <xref linkend="gtk-doc"/>
|
---|
| 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <para condition="html" role="usernotes">User Notes:
|
---|
| 96 | <ulink url="&blfs-wiki;/ModemManager"/>
|
---|
| 97 | </para>
|
---|
| 98 | </sect2>
|
---|
| 99 |
|
---|
| 100 | <sect2 role="installation">
|
---|
| 101 | <title>Installation of ModemManager</title>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | Install <application>ModemManager</application> by running the following
|
---|
| 105 | commands:
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
[51dfb3e] | 108 | <screen revision="sysv"><userinput>./configure --prefix=/usr \
|
---|
| 109 | --sysconfdir=/etc \
|
---|
| 110 | --localstatedir=/var \
|
---|
| 111 | --disable-static \
|
---|
| 112 | --with-systemd-journal=no \
|
---|
| 113 | --with-systemd-suspend-resume &&
|
---|
[5b8f578d] | 114 | make</userinput></screen>
|
---|
| 115 |
|
---|
[0e107e3] | 116 | <screen revision="systemd"><userinput>./configure --prefix=/usr \
|
---|
[6d3a3af] | 117 | --sysconfdir=/etc \
|
---|
| 118 | --localstatedir=/var \
|
---|
[dbb8c43] | 119 | --with-systemd-journal \
|
---|
| 120 | --with-systemd-suspend-resume \
|
---|
[6d3a3af] | 121 | --disable-static &&
|
---|
| 122 | make</userinput></screen>
|
---|
| 123 |
|
---|
[5b8f578d] | 124 | <para>
|
---|
| 125 | To test the results, issue: <command>make check</command>.
|
---|
[816a0aa] | 126 | <!--One test, filename/MM/stub/modem/interface filename, is known to fail.-->
|
---|
[5b8f578d] | 127 | </para>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
| 130 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
| 133 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 134 |
|
---|
| 135 | </sect2>
|
---|
| 136 |
|
---|
| 137 | <sect2 role="commands">
|
---|
| 138 |
|
---|
| 139 | <title>Command Explanations</title>
|
---|
| 140 |
|
---|
[51dfb3e] | 141 | <para>
|
---|
[dbb8c43] | 142 | <parameter>--with-systemd-suspend-resume</parameter>: This
|
---|
[51dfb3e] | 143 | switch forces <application>ModemManager</application> to use the
|
---|
| 144 | <phrase revision="sysv"><application>elogind</application></phrase>
|
---|
| 145 | <phrase revision="systemd"><application>systemd</application></phrase>
|
---|
[6d3a3af] | 146 | power management facilities.
|
---|
| 147 | </para>
|
---|
| 148 |
|
---|
[51dfb3e] | 149 | <para>
|
---|
[279fc64] | 150 | <phrase revision="systemd"><parameter>--with-systemd-journal</parameter></phrase>
|
---|
| 151 | <phrase revision="sysv"><parameter>--with-systemd-journal=no</parameter></phrase>
|
---|
| 152 | : This switch forces <application>ModemManager</application>
|
---|
[51dfb3e] | 153 | <phrase revision="sysv">not</phrase> to use the systemd journal for
|
---|
[dbb8c43] | 154 | logging.
|
---|
| 155 | </para>
|
---|
| 156 |
|
---|
[5b8f578d] | 157 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 158 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 159 |
|
---|
| 160 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 161 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 162 |
|
---|
| 163 | </sect2>
|
---|
[30ad1f9] | 164 | <sect2 role="configuration" revision="systemd">
|
---|
[5b8f578d] | 165 | <title>Configuring ModemManager</title>
|
---|
| 166 |
|
---|
| 167 | <sect3 id="ModemManager-init">
|
---|
| 168 | <title>Systemd Units</title>
|
---|
| 169 |
|
---|
| 170 | <para>
|
---|
| 171 | To start the <command>ModemManager</command> daemon at boot, enable
|
---|
| 172 | the previously installed systemd unit by running the following command
|
---|
| 173 | as the <systemitem class="username">root</systemitem> user:
|
---|
| 174 | </para>
|
---|
| 175 |
|
---|
| 176 | <indexterm zone="ModemManager ModemManager-init">
|
---|
| 177 | <primary sortas="f-ModemManager">ModemManager</primary>
|
---|
| 178 | </indexterm>
|
---|
| 179 |
|
---|
| 180 | <screen role="root"><userinput>systemctl enable ModemManager</userinput></screen>
|
---|
| 181 |
|
---|
| 182 | </sect3>
|
---|
| 183 |
|
---|
| 184 | </sect2>
|
---|
| 185 |
|
---|
| 186 | <sect2 role="content">
|
---|
| 187 | <title>Contents</title>
|
---|
| 188 |
|
---|
| 189 | <segmentedlist>
|
---|
| 190 | <segtitle>Installed Programs</segtitle>
|
---|
| 191 | <segtitle>Installed Libraries</segtitle>
|
---|
| 192 | <segtitle>Installed Directories</segtitle>
|
---|
| 193 |
|
---|
| 194 | <seglistitem>
|
---|
| 195 | <seg>
|
---|
| 196 | mmcli and ModemManager
|
---|
| 197 | </seg>
|
---|
| 198 | <seg>
|
---|
| 199 | libmm-glib.so
|
---|
| 200 | </seg>
|
---|
| 201 | <seg>
|
---|
| 202 | /usr/include/libmm-glib,
|
---|
| 203 | /usr/include/ModemManager,
|
---|
| 204 | /usr/lib/ModemManager,
|
---|
[64b3927] | 205 | /usr/share/ModemManager,
|
---|
[5b8f578d] | 206 | /usr/share/gtk-doc/html/libmm-glib, and
|
---|
| 207 | /usr/share/gtk-doc/html/ModemManager
|
---|
| 208 | </seg>
|
---|
| 209 | </seglistitem>
|
---|
| 210 | </segmentedlist>
|
---|
| 211 |
|
---|
| 212 | <variablelist>
|
---|
| 213 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 214 | <?dbfo list-presentation="list"?>
|
---|
| 215 | <?dbhtml list-presentation="table"?>
|
---|
| 216 |
|
---|
| 217 | <varlistentry id="mmcli">
|
---|
| 218 | <term><command>mmcli</command></term>
|
---|
| 219 | <listitem>
|
---|
| 220 | <para>
|
---|
| 221 | is an utility used to control and monitor the
|
---|
[4c24eb0a] | 222 | <application>ModemManager</application>
|
---|
[5b8f578d] | 223 | </para>
|
---|
| 224 | <indexterm zone="ModemManager mmcli">
|
---|
| 225 | <primary sortas="b-mmcli">mmcli</primary>
|
---|
| 226 | </indexterm>
|
---|
| 227 | </listitem>
|
---|
| 228 | </varlistentry>
|
---|
| 229 |
|
---|
| 230 | <varlistentry id="ModemManager-prog">
|
---|
| 231 | <term><command>ModemManager</command></term>
|
---|
| 232 | <listitem>
|
---|
| 233 | <para>
|
---|
| 234 | is a <application>D-Bus</application> service used
|
---|
[4c24eb0a] | 235 | to communicate with modems
|
---|
[5b8f578d] | 236 | </para>
|
---|
| 237 | <indexterm zone="ModemManager ModemManager-prog">
|
---|
| 238 | <primary sortas="b-ModemManager">ModemManager</primary>
|
---|
| 239 | </indexterm>
|
---|
| 240 | </listitem>
|
---|
| 241 | </varlistentry>
|
---|
| 242 |
|
---|
| 243 | <varlistentry id="libmm-glib">
|
---|
| 244 | <term><filename class="libraryfile">libmm-glib.so</filename></term>
|
---|
| 245 | <listitem>
|
---|
| 246 | <para>
|
---|
| 247 | contains API functions for communicating with mobile broadband
|
---|
| 248 | modems, regardless of the protocol used to communicate with
|
---|
[4c24eb0a] | 249 | the actual device
|
---|
[5b8f578d] | 250 | </para>
|
---|
| 251 | <indexterm zone="ModemManager libmm-glib">
|
---|
| 252 | <primary sortas="c-libmm-glib">libmm-glib.so</primary>
|
---|
| 253 | </indexterm>
|
---|
| 254 | </listitem>
|
---|
| 255 | </varlistentry>
|
---|
| 256 |
|
---|
| 257 | </variablelist>
|
---|
| 258 |
|
---|
| 259 | </sect2>
|
---|
| 260 |
|
---|
| 261 | </sect1>
|
---|