source: general/graphlib/newt.xml@ 3c89223b

<?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 newt-download-http "https://releases.pagure.org/newt/newt-&newt-version;.tar.gz">
  <!ENTITY newt-download-ftp  " ">
  <!ENTITY newt-md5sum        "70aefeff0f3e9444a69dbdae9a931442">
  <!ENTITY newt-size          "173 KB">
  <!ENTITY newt-buildsize     "5.5 MB">
  <!ENTITY newt-time          "less than 0.1 SBU">
]>

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


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

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

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

    <para>
      <application>Newt</application> is a programming library for color text
      mode, widget based user interfaces.  It can be used to add stacked
      windows, entry widgets, checkboxes, radio buttons, labels, plain text
      fields, scrollbars, etc., to text mode user interfaces.
      <application>Newt</application> is based on the S-Lang library.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="popt"/> and
      <xref linkend="slang"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <!-- <xref linkend="tcl"/> and -->
      <xref role="runtime" linkend="gpm"/> (runtime)
    </para>
<!-- Python 3 can be used, do not tell about python2
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="python2"/>
    </para>
-->
  </sect2>

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

    <para>
      Install <application>newt</application> by running the following
      command:
    </para>

<screen><userinput>sed -e '/install -m 644 $(LIBNEWT)/ s/^/#/' \
    -e '/$(LIBNEWT):/,/rv/ s/^/#/'          \
    -e 's/$(LIBNEWT)/$(LIBNEWTSH)/g'        \
    -i Makefile.in                          &amp;&amp;

./configure --prefix=/usr           \
            --with-gpm-support      \
            --with-python=python&python3-majorver; &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>
      <command>sed -e ... -i Makefile.in</command>: Disables installation of a
      static library.
    </para>

    <para>
      <parameter>--with-gpm-support</parameter>: This switch enables mouse support for newt
      applications through GPM.
    </para>

    <para>
      <parameter>--with-python=python&python3-majorver;</parameter>: By giving
      explicitly the name of the directory where python modules reside, this
      switch prevents building the python2 module.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg> whiptail </seg>
        <seg> libnewt.so, whiptcl.so, and
        /usr/lib/python&python3-majorver;/site-packages/_snack.so </seg>
        <seg> None </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="whiptail-prog">
        <term><command>whiptail</command></term>
        <listitem>
          <para>
            displays dialog boxes from shell scripts
          </para>
          <indexterm zone="newt whiptail-prog">
            <primary sortas="b-whiptail">whiptail</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnewt-lib">
        <term><filename class="libraryfile">libnewt.so</filename></term>
        <listitem>
          <para>
            is the library for color text mode, widget based user interfaces
          </para>
          <indexterm zone="newt libnewt-lib">
            <primary sortas="b-libnewt-lib">libnewt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>