docs/70652: New man page: portindex(5)

[Paul Armstrong]

>Number:         70652
>Category:       docs
>Synopsis:       New man page: portindex(5)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Thu Aug 19 05:30:16 GMT 2004
>Closed-Date:
>Last-Modified:
>Originator:     Paul Armstrong
>Release:        
>Organization:
>Environment:
>Description:
      This man page describes the contents of the INDEX or INDEX-5 file on a FreeBSD system.
>How-To-Repeat:
      
>Fix:
.\"
.\" Copyright (c) 2004 Paul Armstrong
.\"
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd August 14, 2004
.Dt PORTINDEX 5
.Os
.Sh NAME
.Nm INDEX
.Nd File containing information about the ports tree
.Sh DESCRIPTION
The file
.Pa /usr/ports/INDEX-5
(or
.Pa /usr/ports/INDEX
on FreeBSD <= 4)
contains the following fields seperated by a pipe (``|''):
.\"http://lists.freebsd.org/mailman/htdig/freebsd-ports/2004-June/013462.html
.Bl -tag -compact -width indent
.It Cm \&name
The name of the port
.It Cm \&path
The full path to the port
.It Cm \&install prefix
The default install prefix
.It Cm \&short description
A short description
.It Cm \&full description
The path to the full description
.It Cm \&maintainer email
The email address of the maintainer
.It Cm \&index
The collections this port is part of
.It Cm \&build dependancies
Other ports required to build this port
.It Cm \&run dependancies
Other ports required for this port to run
.It Cm \&website
The project website for the port
.El

The following apply to
.Pa INDEX-5
only:
.Bl -tag -compact -width indent
.It Cm \&e-deps
Other ports required to extract this port
.It Cm \&p-deps
Other ports required to patch this port
.It Cm \&f-deps
Other ports required to fetch this port
.El
.Sh FILES
.Bl -tag -width /usr/ports/INDEX-5 -compact
.It Pa /usr/ports/INDEX-5
The INDEX file (FreeBSD >= 5)
.It Pa /usr/ports/INDEX
The INDEX file (FreeBSD <= 4)
.El
.Sh EXAMPLES
.Bd -literal
vim-6.3.15|/usr/ports/editors/vim|/usr/local|Vi "workalike", with many additional features|/usr/ports/editors/vim/pkg-descr|obrien at FreeBSD.org|editors|libiconv-1.9.2_1|libiconv-1.9.2_1|http://www.vim.org/|||
.Ed
.Sh SEE ALSO
.Xr ports 7
.Xr cvsup 1
.Sh AUTHORS
.An -nosplit
This man page was originated by
.An Paul Armstrong.
>Release-Note:
>Audit-Trail:
>Unformatted: