source: general/prog/scons.xml@ 7fc2719

<?xml version="1.0" encoding="UTF-8"?>
<!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 scons-download-http "&sourceforge-dl;/scons/SCons-&scons-version;.tar.gz">
  <!ENTITY scons-download-ftp  " ">
  <!ENTITY scons-md5sum        "68a13ef0d3515044544f8bd0949befa2">
  <!ENTITY scons-size          "3.1 MB">
  <!ENTITY scons-buildsize     "50 MB">
  <!ENTITY scons-time          "less than 0.1 SBU">
]>

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


  <title>SCons-&scons-version;</title>

  <indexterm zone="scons">
    <primary sortas="a-SCons">SCons</primary>
  </indexterm>

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

    <para>
      <application>SCons</application> is a tool for building software
      (and other files) implemented in <application>Python</application>.
    </para>

    <note>
      <para>
        When expanding the tarball the package expands to scons-4.8.0, not
        the expected SCons-4.8.0.
      </para>
    </note>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&scons-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&scons-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &scons-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &scons-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &scons-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &scons-time;
        </para>
      </listitem>
    </itemizedlist>
<!--
    The man pages are included in the tarball.
    <bridgehead renderas="sect3">SCons Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="docbook-xsl"/> and
      <xref role="runtime" linkend="libxslt"/>
    </para>
-->
  </sect2>

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

    <para>
      Build the package:
    </para>

    &build-wheel;

    <para>
      As the &root; user, install the package:
    </para>

    <screen role='root'><userinput>&install-wheel; SCons &amp;&amp;
install -v -m664 *.1 /usr/share/man/man1</userinput></screen>
  </sect2>

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

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

      <seglistitem>
        <seg>
          scons, scons-configure-cache, and sconsign
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/lib/python&python3-majorver;/site-packages/SCons{,-&scons-version;.dist-info}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="scons-prog">
        <term><command>scons</command></term>
        <listitem>
          <para>
            is a software construction tool
          </para>
          <indexterm zone="scons scons-prog">
            <primary sortas="b-scons">scons</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="scons-configure-cache">
        <term><command>scons-configure-cache</command></term>
        <listitem>
          <para>
            shows or converts the configuration of an
            <application>SCons</application> cache directory
          </para>
          <indexterm zone="scons scons-configure-cache">
            <primary sortas="b-scons-configure-cache">scons-configure-cache</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sconsign">
        <term><command>sconsign</command></term>
        <listitem>
          <para>
            prints <application>SCons</application>
            <filename>.sconsign</filename> file information
          </para>
          <indexterm zone="scons sconsign">
            <primary sortas="b-sconsign">sconsign</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>