source: gnome/add/gnome-netstatus.xml@ 1d41b80

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

  <!ENTITY gnome-netstatus-download-http "&gnome-download-http;/gnome-netstatus/&gnome-version;/gnome-netstatus-&gnome-netstatus-version;.tar.bz2">
  <!ENTITY gnome-netstatus-download-ftp  "&gnome-download-ftp;/gnome-netstatus/&gnome-version;/gnome-netstatus-&gnome-netstatus-version;.tar.bz2">
  <!ENTITY gnome-netstatus-md5sum        "a5f23731a3bf232969e82afef8792a36">
  <!ENTITY gnome-netstatus-size          "473 KB">
  <!ENTITY gnome-netstatus-buildsize     "8.1 MB">
  <!ENTITY gnome-netstatus-time          "0.1 SBU">
]>

<sect1 id="gnome-netstatus"
xreflabel="GNOME Netstatus-&gnome-netstatus-version;">
  <?dbhtml filename="gnome-netstatus.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">gnome-netstatus-&gnome-netstatus-version;.tar</keyword>
      <keyword role="ftpdir">gnome-netstatus</keyword>
    </keywordset>
  </sect1info>

  <title>GNOME Netstatus-&gnome-netstatus-version;</title>

  <indexterm zone="gnome-netstatus">
    <primary sortas="a-GNOME Netstatus">GNOME Netstatus</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Netstatus</title>

    <para>The <application>GNOME Netstatus</application> package contains a
    panel applet that monitors network interfaces. It provides indicators
    for incoming and outgoing data, packets received and transmitted, and
    information about the network interface such as IP information and
    Ethernet address.</para>

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

    <bridgehead renderas="sect3">GNOME Netstatus Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gnome-panel"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Netstatus</title>

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
            --libexecdir=`pkg-config \
            --variable=prefix ORBit-2.0`/lib/gnome-netstatus \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</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><parameter>--libexecdir=`pkg-config --variable=prefix
    ORBit-2.0`/lib/gnome-netstatus</parameter>: This switch puts libexec files
    in <filename class="directory">$GNOME_PREFIX/lib/gnome-netstatus</filename>
    instead of
    <filename class="directory">$GNOME_PREFIX/libexec</filename>.</para>

    <para><parameter>--sysconfdir=&gnome-etc-dir;</parameter>: This switch puts
    configuration files in <filename class="directory">&gnome-etc-dir;</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch
    puts <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>None</seg>
        <seg>gnome-netstatus-applet</seg>
        <seg>&gnome-etc-dir;/gconf/gconf.xml.defaults/[,schemas/]apps/netstatus_applet
        and $GNOME_PREFIX/share/[,gnome/help/ ,omf/]gnome-netstatus</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnome-netstatus-applet">
        <term><command>gnome-netstatus-applet</command></term>
        <listitem>
          <para>displays information about a network interface on
          your panel.</para>
          <indexterm zone="gnome-netstatus gnome-netstatus-applet">
            <primary
            sortas="b-gnome-netstatus-applet">gnome-netstatus-applet</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>