source: gnome/applications/network-manager-applet.xml@ 5e0d750

<?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 network-manager-applet-download-http
           "&gnome-download-http;/network-manager-applet/1.8/network-manager-applet-&network-manager-applet-version;.tar.xz">
  <!ENTITY network-manager-applet-download-ftp
           "&gnome-download-ftp;/network-manager-applet/1.8/network-manager-applet-&network-manager-applet-version;.tar.xz">
  <!ENTITY network-manager-applet-md5sum    "06aafa851762146034351aa72ebb23d4">
  <!ENTITY network-manager-applet-size      "1.5 MB">
  <!ENTITY network-manager-applet-buildsize "60 MB (with tests)">
  <!ENTITY network-manager-applet-time      "0.4 SBU (with tests)">
]>

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

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

  <title>network-manager-applet-&network-manager-applet-version;</title>

  <indexterm zone="network-manager-applet">
    <primary sortas="a-network-manager-applet">network-manager-applet</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to NetworkManager Applet</title>

    <para>
      The <application>NetworkManager Applet</application> provides a tool and
      a panel applet used to configure wired and wireless network connections
      through GUI. It's designed for use with any desktop environment that uses
      <application>GTK+</application>, such as <application>Xfce</application>
       and <application>LXDE</application>.
    </para>
    <!-- This version of NewtorkManager Applet removes the deprecated libnm-gtk.so
    library. It's possible that this may cause breakage. If needed, we can
    enable it again with -Dlibnm-gtk=true -->

    &lfs83_checked;

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

    <bridgehead renderas="sect3">NetworkManager Applet Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk3"/>,
      <xref linkend="iso-codes"/>,
      <xref linkend="libsecret"/>,
      <xref linkend="libnotify"/>, and
      <xref linkend="NetworkManager"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="ModemManager"/>
    </para>

    <bridgehead renderas="sect4">Required (Runtime)</bridgehead>
    <para role="required">
      <xref role="runtime" linkend="polkit-gnome"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional" revision="sysv">
      <xref linkend="gc"/> (for linker garbage collection),
      <xref linkend="jansson"/>,
      <ulink url="&gnome-download-http;/gnome-bluetooth/">
        GNOME Bluetooth</ulink>, and
      <ulink url="&gnome-download-http;/mobile-broadband-provider-info">
        mobile-broadband-provider-info</ulink> (runtime)
    </para>
    <para role="optional" revision="systemd">
      <xref linkend="gc"/> (for linker garbage collection),
      <xref linkend="gnome-bluetooth"/>,
      <xref linkend="jansson"/>, and
      <ulink url="&gnome-download-http;/mobile-broadband-provider-info">
       mobile-broadband-provider-info</ulink> (runtime)
    </para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of NetworkManager Applet</title>

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr     \
      --sysconfdir=/etc \
      -Dselinux=false   \
      -Dteam=false      \
      -Dmobile_broadband_provider_info=false .. &amp;&amp;
ninja</userinput></screen>

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

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

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

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-Dteam=false</parameter>: This switch disables the team
      configuration editor since it requires <xref linkend="jansson"/>. If
      you have Jansson installed, remove this option or set it to "true".
    </para>

    <para>
      <parameter>-Denable-selinux=false</parameter>: This switch forcibly
      disables <application>SELinux</application> support since it is not
      currently in BLFS and the build will fail without it.
    </para>
    <para>
      <parameter>-Dmobile_broadband_provider_info=false</parameter>: This
      switch forcibly disables Mobile Broadband Provider support because it
      is not currently available in BLFS.
    </para>

    <para>
      <option>-Dwwan=false</option>: This switch disables WWAN support.
      Use this if you do not have <xref linkend="ModemManager"/> installed.
    </para>
    <para>
      <option>-Dintrospection=false</option>: Use this if you do not have <xref linkend="gobject-introspection"/> installed.
    </para>
    <para>
      <option>-Dgtk_doc=false</option>: Use this if you do not have <xref linkend="gtk-doc"/> installed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          nm-applet and nm-connection-editor
        </seg>
        <seg>
           libnma.so <!-- and libnm-gtk.so -->
        </seg>
        <seg>
          <!--/usr/include/{libnma,libnm-gtk},--> 
          /usr/include/libnma and /usr/share/gtk-doc/libnma
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="nm-connection-editor">
        <term><command>nm-connection-editor</command></term>
        <listitem>
          <para>
            allows users to view and edit network connection settings.
          </para>
          <indexterm zone="network-manager-applet nm-connection-editor">
            <primary sortas="b-nm-connection-editor">nm-connection-editor</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnma">
        <term><filename class="libraryfile">libnma.so</filename></term>
        <listitem>
          <para>
            contains internal functions for the 
            <application>Network Manager GTK+ Interface</application>.
          </para>
          <indexterm zone="network-manager-applet libnma">
            <primary sortas="c-libnma">libnma.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
<!--
      <varlistentry id="libnm-gtk">
        <term><filename class="libraryfile">libnm-gtk.so</filename></term>
        <listitem>
          <para>
            contains the <application>NetworkManager</application>
            <application>GTK+</application> bindings.
          </para>
          <indexterm zone="network-manager-applet libnm-gtk">
            <primary sortas="c-libnm-gtk">libnm-gtk.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->

    </variablelist>

  </sect2>

</sect1>