xref: /freebsd/share/man/man5/portindex.5 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
12ea9e545SThomas Abthorpe.\"
22ea9e545SThomas Abthorpe.\" Copyright (c) 2004 Paul Armstrong
32ea9e545SThomas Abthorpe.\" Copyright (c) 2009 Thomas Abthorpe
42ea9e545SThomas Abthorpe.\"
52ea9e545SThomas Abthorpe.\" All rights reserved.
62ea9e545SThomas Abthorpe.\"
72ea9e545SThomas Abthorpe.\" Redistribution and use in source and binary forms, with or without
82ea9e545SThomas Abthorpe.\" modification, are permitted provided that the following conditions
92ea9e545SThomas Abthorpe.\" are met:
102ea9e545SThomas Abthorpe.\" 1. Redistributions of source code must retain the above copyright
112ea9e545SThomas Abthorpe.\" notice, this list of conditions and the following disclaimer.
122ea9e545SThomas Abthorpe.\" 2. Redistributions in binary form must reproduce the above copyright
132ea9e545SThomas Abthorpe.\" notice, this list of conditions and the following disclaimer in the
142ea9e545SThomas Abthorpe.\" documentation and/or other materials provided with the distribution.
152ea9e545SThomas Abthorpe.\"
162ea9e545SThomas Abthorpe.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
172ea9e545SThomas Abthorpe.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
182ea9e545SThomas Abthorpe.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
192ea9e545SThomas Abthorpe.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
202ea9e545SThomas Abthorpe.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
212ea9e545SThomas Abthorpe.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
222ea9e545SThomas Abthorpe.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
232ea9e545SThomas Abthorpe.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
242ea9e545SThomas Abthorpe.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
252ea9e545SThomas Abthorpe.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
262ea9e545SThomas Abthorpe.\"
27a28832efSJoel Dahl.Dd October 14, 2012
282ea9e545SThomas Abthorpe.Dt PORTINDEX 5
292ea9e545SThomas Abthorpe.Os
302ea9e545SThomas Abthorpe.Sh NAME
312ea9e545SThomas Abthorpe.Nm INDEX
322ea9e545SThomas Abthorpe.Nd "File containing information about the state of the ports tree"
332ea9e545SThomas Abthorpe.Sh DESCRIPTION
342ea9e545SThomas AbthorpeThe port index file in
352ea9e545SThomas Abthorpe.Pa /usr/ports
362ea9e545SThomas Abthorpecontains various bits of information about the ports tree.
372ea9e545SThomas AbthorpeEach major branch of
382ea9e545SThomas Abthorpe.Fx
392ea9e545SThomas Abthorpehas a separate index file, named
402ea9e545SThomas Abthorpe.Dq INDEX- Ns Ar N ,
412ea9e545SThomas Abthorpewhere
422ea9e545SThomas Abthorpe.Ar N
432ea9e545SThomas Abthorpeis the major version number of the
442ea9e545SThomas Abthorpe.Fx
452ea9e545SThomas Abthorpebranch, i.e.:
462ea9e545SThomas Abthorpe.Pa INDEX-7 ,
472ea9e545SThomas Abthorpeor
482ea9e545SThomas Abthorpe.Pa INDEX-8 .
49a28832efSJoel Dahl.Bl -tag -width XXXXXXXXXX
502ea9e545SThomas Abthorpe.It Cm \&name
512ea9e545SThomas AbthorpeThe name of the package.
522ea9e545SThomas Abthorpe.It Cm \&path
532ea9e545SThomas AbthorpeThe path to the port directory.
542ea9e545SThomas Abthorpe.It Cm \&install prefix
552ea9e545SThomas AbthorpeThe default install prefix.
562ea9e545SThomas Abthorpe.It Cm \&short description
572ea9e545SThomas AbthorpeA short description.
582ea9e545SThomas Abthorpe.It Cm \&full description
592ea9e545SThomas AbthorpeThe path to the full description.
602ea9e545SThomas Abthorpe.It Cm \&maintainer email
612ea9e545SThomas AbthorpeThe email address of the maintainer.
622ea9e545SThomas Abthorpe.It Cm \&index
632ea9e545SThomas AbthorpeThe categories this port is part of.
642ea9e545SThomas Abthorpe.It Cm \&build dependencies
652ea9e545SThomas AbthorpePorts required to be installed prior to building this port.
662ea9e545SThomas Abthorpe.It Cm \&run dependencies
672ea9e545SThomas AbthorpePorts required to be installed for this port to run.
682ea9e545SThomas Abthorpe.It Cm \&website
692ea9e545SThomas AbthorpeThe project website for the port.
702ea9e545SThomas Abthorpe.It Cm \&e-deps
712ea9e545SThomas AbthorpePorts that may be required to extract this port.
722ea9e545SThomas Abthorpe.It Cm \&p-deps
732ea9e545SThomas AbthorpePorts that may be required to patch this port.
742ea9e545SThomas Abthorpe.It Cm \&f-deps
752ea9e545SThomas AbthorpePorts that may be required to fetch this port.
762ea9e545SThomas Abthorpe.El
772ea9e545SThomas Abthorpe.Sh FILES
78a28832efSJoel Dahl.Bl -tag -width /usr/ports/INDEX-8XX
792ea9e545SThomas Abthorpe.It Pa /usr/ports/INDEX- Ns Ar N
802ea9e545SThomas Abthorpewhere
812ea9e545SThomas Abthorpe.Ar N
822ea9e545SThomas Abthorpeis the major version number of the
832ea9e545SThomas Abthorpe.Fx
842ea9e545SThomas Abthorpebranch.
852ea9e545SThomas Abthorpe.El
862ea9e545SThomas Abthorpe.Sh EXAMPLES
872ea9e545SThomas Abthorpe.Bd -literal
882ea9e545SThomas Abthorpevim-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/|||
892ea9e545SThomas Abthorpe.Ed
902ea9e545SThomas Abthorpe.Sh SEE ALSO
91814b16baSGlen Barber.Xr build 7 ,
922ea9e545SThomas Abthorpe.Xr ports 7
932ea9e545SThomas Abthorpe.Sh AUTHORS
942ea9e545SThomas Abthorpe.An -nosplit
952ea9e545SThomas AbthorpeThis manual page was written by
962ea9e545SThomas Abthorpe.An Paul Armstrong
972ea9e545SThomas Abthorpeand
98*a63d6c94SBaptiste Daroussin.An Thomas Abthorpe Aq Mt tabthorpe@FreeBSD.org .
99