static/freebsd/man5/portindex.5 3.html


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

<table class="head">
  <tr>
    <td class="head-ltitle">PORTINDEX(5)</td>
    <td class="head-vol">File Formats Manual</td>
    <td class="head-rtitle">PORTINDEX(5)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">INDEX</code> &#x2014; <span class="Nd">File
    containing information about the state of the ports tree</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The port index file in <span class="Pa">/usr/ports</span> contains
    various bits of information about the ports tree. Each major branch of
    <span class="Ux">FreeBSD</span> has a separate index file, named
    &#x201C;INDEX-<var class="Ar">N</var>&#x201D;, where <var class="Ar">N</var>
    is the major version number of the <span class="Ux">FreeBSD</span> branch,
    i.e.: <span class="Pa">INDEX-7</span>, or
  <span class="Pa">INDEX-8</span>.</p>
<dl class="Bl-tag">
  <dt id="name"><a class="permalink" href="#name"><code class="Cm">name</code></a></dt>
  <dd>The name of the package.</dd>
  <dt id="path"><a class="permalink" href="#path"><code class="Cm">path</code></a></dt>
  <dd>The path to the port directory.</dd>
  <dt id="install"><a class="permalink" href="#install"><code class="Cm">install
    prefix</code></a></dt>
  <dd>The default install prefix.</dd>
  <dt id="short"><a class="permalink" href="#short"><code class="Cm">short
    description</code></a></dt>
  <dd>A short description.</dd>
  <dt id="full"><a class="permalink" href="#full"><code class="Cm">full
    description</code></a></dt>
  <dd>The path to the full description.</dd>
  <dt id="maintainer"><a class="permalink" href="#maintainer"><code class="Cm">maintainer
    email</code></a></dt>
  <dd>The email address of the maintainer.</dd>
  <dt id="index"><a class="permalink" href="#index"><code class="Cm">index</code></a></dt>
  <dd>The categories this port is part of.</dd>
  <dt id="build"><a class="permalink" href="#build"><code class="Cm">build
    dependencies</code></a></dt>
  <dd>Ports required to be installed prior to building this port.</dd>
  <dt id="run"><a class="permalink" href="#run"><code class="Cm">run
    dependencies</code></a></dt>
  <dd>Ports required to be installed for this port to run.</dd>
  <dt id="website"><a class="permalink" href="#website"><code class="Cm">website</code></a></dt>
  <dd>The project website for the port.</dd>
  <dt id="e-deps"><a class="permalink" href="#e-deps"><code class="Cm">e-deps</code></a></dt>
  <dd>Ports that may be required to extract this port.</dd>
  <dt id="p-deps"><a class="permalink" href="#p-deps"><code class="Cm">p-deps</code></a></dt>
  <dd>Ports that may be required to patch this port.</dd>
  <dt id="f-deps"><a class="permalink" href="#f-deps"><code class="Cm">f-deps</code></a></dt>
  <dd>Ports that may be required to fetch this port.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag">
  <dt><span class="Pa">/usr/ports/INDEX-</span><var class="Ar">N</var></dt>
  <dd>where <var class="Ar">N</var> is the major version number of the
      <span class="Ux">FreeBSD</span> branch.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
<div class="Bd Li">
<pre>vim-6.3.15|/usr/ports/editors/vim|/usr/local|Vi &quot;workalike&quot;, with many additional features|/usr/ports/editors/vim/pkg-descr|obrien@FreeBSD.org|editors|libiconv-1.9.2_1|libiconv-1.9.2_1|http://www.vim.org/|||</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">build(7)</a>, <a class="Xr">ports(7)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">This manual page was written by <span class="An">Paul
    Armstrong</span> and <span class="An">Thomas Abthorpe</span>
    &lt;<a class="Mt" href="mailto:tabthorpe@FreeBSD.org">tabthorpe@FreeBSD.org</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">October 14, 2012</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>