source: general/genutils/tree.xml

<?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 tree-download-http "https://gitlab.com/OldManProgrammer/unix-tree/-/archive/&tree-version;/unix-tree-&tree-version;.tar.bz2">
<!ENTITY tree-download-ftp  " ">
<!ENTITY tree-md5sum        "85f9a6d1e48f1d5262a9b2d58d47431f">
<!ENTITY tree-size          "52 KB">
<!ENTITY tree-buildsize     "732 KB">
<!ENTITY tree-time          "less than 0.1 SBU">
]>

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


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

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

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

    <para>
      The <application>tree</application> application is useful to display a
      dictionary tree's contents, including files, directories, and links.
    </para>

    &lfs121_checked;

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

  </sect2>

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

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

<screen><userinput>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>

    <!-- Without MANDIR=/usr/share/man, it'll create /usr/share/man1/man1 and
         install 'tree.1' there. Also, without prefix=/usr, it'll install the
         'tree' command in /usr/local/bin. -->

<screen role="root"><userinput>make PREFIX=/usr MANDIR=/usr/share/man install</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>tree</seg>
        <seg>None</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="tree-app">
        <term><command>tree</command></term>
        <listitem>
          <para>
            displays a directory tree in a terminal
          </para>
          <indexterm zone="tree tree-app">
            <primary sortas="b-tree">tree</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>