document retrieve-index

infrastructure/man/man1/retrieve-index.1

@@ -0,0 +1,46 @@
+.\"	$OpenBSD: retrieve-index.1,v 1.1 2010/09/13 11:43:39 espie Exp $
+.\"
+.\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: September 13 2010 $
+.Dt RETRIEVE-INDEX 1
+.Os
+.Sh NAME
+.Nm retrieve-index
+.Nd finds index entry in ports index according to selected
+criteria .
+.Sh SYNOPSIS
+.Nm retrieve-index
+.Ar index=file
+.Op Ar category=cat
+.Op Ar maintainer=person
+.Op Ar key=value
+.Sh DESCRIPTION
+.Nm
+scans index file
+.Ar file
+for index entry (or entries) according to selected criteria,
+such as category, maintainer name or actual name.
+.Pp
+Matching is done using perl regular expressions, and corresponding entries
+get printed as a list on a single line on standard output.
+.Nm
+is a helper script used for searches from the ports infrastructure.
+It relies on
+.Pa ${PORTSDIR}/INDEX
+being accurate.
+.Sh SEE ALSO
+.Xr perlre 1 ,
+.Xr ports 7 .