source: general/sysutils/modemmanager.xml@ 64b3927

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY ModemManager-download-http "https://www.freedesktop.org/software/ModemManager/ModemManager-&ModemManager-version;.tar.xz">
  <!ENTITY ModemManager-download-ftp  " ">
  <!ENTITY ModemManager-md5sum        "dad80b3b4f27c1d6eae7e019542338be">
  <!ENTITY ModemManager-size          "2.0 MB">
  <!ENTITY ModemManager-buildsize     "133 MB (with tests)">
  <!ENTITY ModemManager-time          "1.1 SBU (with tests)">
]>

<sect1 id="ModemManager" xreflabel="ModemManager-&ModemManager-version;">
  <?dbhtml filename="ModemManager.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>ModemManager-&ModemManager-version;</title>

  <indexterm zone="ModemManager">
    <primary sortas="a-ModemManager">ModemManager</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to ModemManager</title>

    <para>
      <application>ModemManager</application> provides a unified high level
      API for communicating with mobile broadband modems, regardless of the
      protocol used to communicate with the actual device.
    </para>

    &lfs84_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&ModemManager-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&ModemManager-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &ModemManager-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &ModemManager-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &ModemManager-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &ModemManager-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">ModemManager Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libgudev"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="libmbim"/>,
      <xref linkend="libqmi"/>,
      <xref linkend="polkit"/>, and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/ModemManager"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of ModemManager</title>

    <para>
      Install <application>ModemManager</application> by running the following
      commands:
    </para>

<screen revision="sysv"><userinput>./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var \
            --enable-more-warnings=no \
            --disable-static     &amp;&amp;
make</userinput></screen>

<screen revision="systemd"><userinput>./configure --prefix=/usr                 \
            --sysconfdir=/etc             \
            --localstatedir=/var          \
            --enable-more-warnings=no     \
            --with-systemd-journal        \
            --with-systemd-suspend-resume \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">

    <title>Command Explanations</title>

    <para revision="systemd">
      <parameter>--with-systemd-suspend-resume</parameter>: This
      switch forces <application>ModemManager</application> to use the systemd
      power management facilities.
    </para>

    <para revision="systemd">
      <parameter>--with-systemd-journal</parameter>: This switch forces
      <application>ModemManager</application> to use the systemd journal for
      logging.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>
  <sect2 role="configuration" revision="systemd">
    <title>Configuring ModemManager</title>

    <sect3 id="ModemManager-init">
      <title>Systemd Units</title>

      <para>
        To start the <command>ModemManager</command> daemon at boot, enable
        the previously installed systemd unit by running the following command
        as the <systemitem class="username">root</systemitem> user:
      </para>

      <indexterm zone="ModemManager ModemManager-init">
        <primary sortas="f-ModemManager">ModemManager</primary>
      </indexterm>

<screen role="root"><userinput>systemctl enable ModemManager</userinput></screen>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          mmcli and ModemManager
        </seg>
        <seg>
          libmm-glib.so
        </seg>
        <seg>
          /usr/include/libmm-glib,
          /usr/include/ModemManager,
          /usr/lib/ModemManager,
          /usr/share/ModemManager,
          /usr/share/gtk-doc/html/libmm-glib, and
          /usr/share/gtk-doc/html/ModemManager
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="mmcli">
        <term><command>mmcli</command></term>
        <listitem>
          <para>
            is an utility used to control and monitor the
            <application>ModemManager</application>.
          </para>
          <indexterm zone="ModemManager mmcli">
            <primary sortas="b-mmcli">mmcli</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ModemManager-prog">
        <term><command>ModemManager</command></term>
        <listitem>
          <para>
            is a <application>D-Bus</application> service used
            to communicate with modems.
          </para>
          <indexterm zone="ModemManager ModemManager-prog">
            <primary sortas="b-ModemManager">ModemManager</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmm-glib">
        <term><filename class="libraryfile">libmm-glib.so</filename></term>
        <listitem>
          <para>
            contains API functions for communicating with mobile broadband
            modems, regardless of the  protocol used to communicate with
            the actual device.
          </para>
          <indexterm zone="ModemManager libmm-glib">
            <primary sortas="c-libmm-glib">libmm-glib.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>