From owner-freebsd-doc@FreeBSD.ORG Mon Sep 13 05:30:38 2004 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 4C3EB16A4CE for ; Mon, 13 Sep 2004 05:30:38 +0000 (GMT) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 2952A43D6E for ; Mon, 13 Sep 2004 05:30:38 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.12.11/8.12.11) with ESMTP id i8D5UcRD092313 for ; Mon, 13 Sep 2004 05:30:38 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.11/8.12.11/Submit) id i8D5UcjH092312; Mon, 13 Sep 2004 05:30:38 GMT (envelope-from gnats) Date: Mon, 13 Sep 2004 05:30:38 GMT Message-Id: <200409130530.i8D5UcjH092312@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: Paul Armstrong Subject: Re: docs/70652: New man page: portindex(5) X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: Paul Armstrong List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 13 Sep 2004 05:30:38 -0000 The following reply was made to PR docs/70652; it has been noted by GNATS. From: Paul Armstrong To: Oliver Eikemeier Cc: freebsd-gnats-submit@FreeBSD.org Subject: Re: docs/70652: New man page: portindex(5) Date: Sun, 12 Sep 2004 22:30:04 -0700 On Sat, Aug 21, 2004 at 12:29:51PM +0200, Oliver Eikemeier wrote: > >The following apply to > >.Pa INDEX-5 > >only: > > Really? There is no code in `describe' that differs depending on > OSVERSION. Besides, methods to refresh the INDEX should be mentioned > (make index, make fetchindex), some internals (make describe) and > applications (make search) Is this better? \" \" 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 pre-compiled information about the ports tree Sh SYNOPSYS Nm /usr/ports/INDEX Nm /usr/ports/INDEX-5 Sh DESCRIPTION The Nm file can be used to quickly search through the available ports using the Nm Makefile in the base of the ports tree. Sh FILE FORMAT 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 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 USAGE The following targets in the ports Nm Makefile apply to the Nm file. Bl -tag -compact -width indent It Cm fetchindex fetches the latest copy of the index file from http://www.freebsd.org/ports/ It Cm index creates a version based on the local ports tree It Cm search key= searches the ports tree for ports containing Cm in any part of the port description It Cm search name= searches the ports tree for ports containing Cm in the port name It Cm print-index prints out the contents of the Nm file in a neat format El Sh FILES Bl -tag -width -compact It Pa /usr/ports/INDEX-5 The INDEX file (FreeBSD >= 5) It Pa /usr/ports/INDEX The INDEX file (FreeBSD <= 4) It Pa /usr/ports/Tools/make_index The main routines for building the Nm file. It Pa /usr/ports/Makefile The toplevel Makefile used to generate the Nm file. It Pa /usr/ports/Mk/bsd.port.mk This include provides the describe function for building short descriptions of each port. El Sh ENVIRONMENT Bl -tag -width -compact It Ev INDEX_JOBS The number of concurrent jobs to run when building the Nm file It Ev INDEX_QUIET Don't print the warning at the end of the build It Ev INDEX_VERBOSE Print out each port as it is processed 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@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 Aq psa+freebsd@otoh.org .