source: general/sysutils/modemmanager.xml@ e7d893b

elogind
Last change on this file since e7d893b was e7d893b, checked in by DJ Lucas <dj@…>, 2 years ago

Merge to HEAD 21602.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/BOOK-elogind@21603 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 7.8 KB
Line 
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
7 <!ENTITY ModemManager-download-http "https://www.freedesktop.org/software/ModemManager/ModemManager-&ModemManager-version;.tar.xz">
8 <!ENTITY ModemManager-download-ftp " ">
9 <!ENTITY ModemManager-md5sum "92d25176d0cc9d588ca29700b33c7d98">
10 <!ENTITY ModemManager-size "2.1 MB">
11 <!ENTITY ModemManager-buildsize "130 MB (with tests)">
12 <!ENTITY ModemManager-time "1.0 SBU (with tests)">
13]>
14
15<sect1 id="ModemManager" xreflabel="ModemManager-&ModemManager-version;">
16 <?dbhtml filename="ModemManager.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>ModemManager-&ModemManager-version;</title>
24
25 <indexterm zone="ModemManager">
26 <primary sortas="a-ModemManager">ModemManager</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to ModemManager</title>
31
32 <para>
33 <application>ModemManager</application> provides a unified high level
34 API for communicating with mobile broadband modems, regardless of the
35 protocol used to communicate with the actual device.
36 </para>
37
38 &lfs84_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&ModemManager-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&ModemManager-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &ModemManager-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &ModemManager-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &ModemManager-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &ModemManager-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">ModemManager Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="libgudev"/>
79 </para>
80
81 <bridgehead renderas="sect4">Recommended</bridgehead>
82 <para role="recommended">
83 <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
84 <xref linkend="gobject-introspection"/>,
85 <xref linkend="libmbim"/>,
86 <xref linkend="libqmi"/>,
87 <xref linkend="polkit"/>, and
88 <xref linkend="vala"/>
89 </para>
90
91 <bridgehead renderas="sect4">Optional</bridgehead>
92 <para role="optional">
93 <xref linkend="gtk-doc"/>
94 </para>
95
96 <para condition="html" role="usernotes">User Notes:
97 <ulink url="&blfs-wiki;/ModemManager"/>
98 </para>
99 </sect2>
100
101 <sect2 role="installation">
102 <title>Installation of ModemManager</title>
103
104 <para>
105 Install <application>ModemManager</application> by running the following
106 commands:
107 </para>
108
109<screen revision="sysv"><userinput>./configure --prefix=/usr \
110 --sysconfdir=/etc \
111 --localstatedir=/var \
112 --disable-static \
113 --enable-more-warnings=no \
114 --with-systemd-journal=no \
115 --with-systemd-suspend-resume &amp;&amp;
116make</userinput></screen>
117
118<screen revision="systemd"><userinput>./configure --prefix=/usr \
119 --sysconfdir=/etc \
120 --localstatedir=/var \
121 --enable-more-warnings=no \
122 --with-systemd-journal \
123 --with-systemd-suspend-resume \
124 --disable-static &amp;&amp;
125make</userinput></screen>
126
127 <para>
128 To test the results, issue: <command>make check</command>.
129 </para>
130
131 <para>
132 Now, as the <systemitem class="username">root</systemitem> user:
133 </para>
134
135<screen role="root"><userinput>make install</userinput></screen>
136
137 </sect2>
138
139 <sect2 role="commands">
140
141 <title>Command Explanations</title>
142
143 <para>
144 <parameter>--with-systemd-suspend-resume</parameter>: This
145 switch forces <application>ModemManager</application> to use the
146 <phrase revision="sysv"><application>elogind</application></phrase>
147 <phrase revision="systemd"><application>systemd</application></phrase>
148 power management facilities.
149 </para>
150
151 <para>
152 <parameter>--with-systemd-journal</parameter>: This switch forces
153 <application>ModemManager</application>
154 <phrase revision="sysv">not</phrase> to use the systemd journal for
155 logging.
156 </para>
157
158 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
159 href="../../xincludes/static-libraries.xml"/>
160
161 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
162 href="../../xincludes/gtk-doc-rebuild.xml"/>
163
164 </sect2>
165 <sect2 role="configuration" revision="systemd">
166 <title>Configuring ModemManager</title>
167
168 <sect3 id="ModemManager-init">
169 <title>Systemd Units</title>
170
171 <para>
172 To start the <command>ModemManager</command> daemon at boot, enable
173 the previously installed systemd unit by running the following command
174 as the <systemitem class="username">root</systemitem> user:
175 </para>
176
177 <indexterm zone="ModemManager ModemManager-init">
178 <primary sortas="f-ModemManager">ModemManager</primary>
179 </indexterm>
180
181<screen role="root"><userinput>systemctl enable ModemManager</userinput></screen>
182
183 </sect3>
184
185 </sect2>
186
187 <sect2 role="content">
188 <title>Contents</title>
189
190 <segmentedlist>
191 <segtitle>Installed Programs</segtitle>
192 <segtitle>Installed Libraries</segtitle>
193 <segtitle>Installed Directories</segtitle>
194
195 <seglistitem>
196 <seg>
197 mmcli and ModemManager
198 </seg>
199 <seg>
200 libmm-glib.so
201 </seg>
202 <seg>
203 /usr/include/libmm-glib,
204 /usr/include/ModemManager,
205 /usr/lib/ModemManager,
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
222 <application>ModemManager</application>.
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
235 to communicate with modems.
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
249 the actual device.
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>
Note: See TracBrowser for help on using the repository browser.