xref: /openbsd/share/man/man1/port-search-helper.1 (revision 73471bf0)
1.\"	$OpenBSD: port-search-helper.1,v 1.3 2018/11/30 18:40:57 danj Exp $
2.\"
3.\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: November 30 2018 $
18.Dt PORT-SEARCH-HELPER 1
19.Os
20.Sh NAME
21.Nm port-search-helper
22.Nd find index entry in ports index according to selected criteria
23.Sh SYNOPSIS
24.Nm
25.Cm index Ns = Ns Ar file
26.Op Cm category Ns = Ns Ar cat
27.Op Cm maintainer Ns = Ns Ar person
28.Op Cm key Ns = Ns Ar value
29.Sh DESCRIPTION
30.Nm
31scans index file
32.Ar file
33for index entry (or entries) according to selected criteria,
34such as category, maintainer name or actual name.
35.Pp
36Matching is done using perl regular expressions, and corresponding entries
37get printed as a list on a single line on standard output.
38.Nm
39is a helper script used by
40.Pa ${PORTSDIR}/Makefile
41for searches.
42.Pp
43It relies on
44.Pa ${LOCALBASE}/share/ports-INDEX
45being accurate.
46Note the portslist package must be installed.
47.Sh SEE ALSO
48.Xr perlre 1 ,
49.Xr ports 7
50