aboutsummaryrefslogtreecommitdiffstats
path: root/general/genutils/tree.xml
blob: 545f02c80d71bf1c0f3e751681e8ae26f14b6083 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?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        "9be227932ab457c29f33196544cd1e13">
<!ENTITY tree-size          "56 KB">
<!ENTITY tree-buildsize     "560 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>

    &lfs122_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>