1.\" 2.\" Copyright (c) 2004 Paul Armstrong 3.\" Copyright (c) 2009 Thomas Abthorpe 4.\" 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26.\" 27.\" $FreeBSD$ 28.\" 29.Dd October 14, 2012 30.Dt PORTINDEX 5 31.Os 32.Sh NAME 33.Nm INDEX 34.Nd "File containing information about the state of the ports tree" 35.Sh DESCRIPTION 36The port index file in 37.Pa /usr/ports 38contains various bits of information about the ports tree. 39Each major branch of 40.Fx 41has a separate index file, named 42.Dq INDEX- Ns Ar N , 43where 44.Ar N 45is the major version number of the 46.Fx 47branch, i.e.: 48.Pa INDEX-7 , 49or 50.Pa INDEX-8 . 51.Bl -tag -width XXXXXXXXXX 52.It Cm \&name 53The name of the package. 54.It Cm \&path 55The path to the port directory. 56.It Cm \&install prefix 57The default install prefix. 58.It Cm \&short description 59A short description. 60.It Cm \&full description 61The path to the full description. 62.It Cm \&maintainer email 63The email address of the maintainer. 64.It Cm \&index 65The categories this port is part of. 66.It Cm \&build dependencies 67Ports required to be installed prior to building this port. 68.It Cm \&run dependencies 69Ports required to be installed for this port to run. 70.It Cm \&website 71The project website for the port. 72.It Cm \&e-deps 73Ports that may be required to extract this port. 74.It Cm \&p-deps 75Ports that may be required to patch this port. 76.It Cm \&f-deps 77Ports that may be required to fetch this port. 78.El 79.Sh FILES 80.Bl -tag -width /usr/ports/INDEX-8XX 81.It Pa /usr/ports/INDEX- Ns Ar N 82where 83.Ar N 84is the major version number of the 85.Fx 86branch. 87.El 88.Sh EXAMPLES 89.Bd -literal 90vim-6.3.15|/usr/ports/editors/vim|/usr/local|Vi "workalike", 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/||| 91.Ed 92.Sh SEE ALSO 93.Xr build 7 , 94.Xr ports 7 95.Sh AUTHORS 96.An -nosplit 97This manual page was written by 98.An Paul Armstrong 99and 100.An Thomas Abthorpe Aq Mt tabthorpe@FreeBSD.org . 101