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.Dd October 14, 2012 28.Dt PORTINDEX 5 29.Os 30.Sh NAME 31.Nm INDEX 32.Nd "File containing information about the state of the ports tree" 33.Sh DESCRIPTION 34The port index file in 35.Pa /usr/ports 36contains various bits of information about the ports tree. 37Each major branch of 38.Fx 39has a separate index file, named 40.Dq INDEX- Ns Ar N , 41where 42.Ar N 43is the major version number of the 44.Fx 45branch, i.e.: 46.Pa INDEX-7 , 47or 48.Pa INDEX-8 . 49.Bl -tag -width XXXXXXXXXX 50.It Cm \&name 51The name of the package. 52.It Cm \&path 53The path to the port directory. 54.It Cm \&install prefix 55The default install prefix. 56.It Cm \&short description 57A short description. 58.It Cm \&full description 59The path to the full description. 60.It Cm \&maintainer email 61The email address of the maintainer. 62.It Cm \&index 63The categories this port is part of. 64.It Cm \&build dependencies 65Ports required to be installed prior to building this port. 66.It Cm \&run dependencies 67Ports required to be installed for this port to run. 68.It Cm \&website 69The project website for the port. 70.It Cm \&e-deps 71Ports that may be required to extract this port. 72.It Cm \&p-deps 73Ports that may be required to patch this port. 74.It Cm \&f-deps 75Ports that may be required to fetch this port. 76.El 77.Sh FILES 78.Bl -tag -width /usr/ports/INDEX-8XX 79.It Pa /usr/ports/INDEX- Ns Ar N 80where 81.Ar N 82is the major version number of the 83.Fx 84branch. 85.El 86.Sh EXAMPLES 87.Bd -literal 88vim-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/||| 89.Ed 90.Sh SEE ALSO 91.Xr build 7 , 92.Xr ports 7 93.Sh AUTHORS 94.An -nosplit 95This manual page was written by 96.An Paul Armstrong 97and 98.An Thomas Abthorpe Aq Mt tabthorpe@FreeBSD.org . 99