rename pure helper script, not for user consumption
authorespie <espie@openbsd.org>
Mon, 9 Jul 2018 13:51:08 +0000 (13:51 +0000)
committerespie <espie@openbsd.org>
Mon, 9 Jul 2018 13:51:08 +0000 (13:51 +0000)
share/man/man1/Makefile
share/man/man1/port-search-helper.1 [new file with mode: 0644]
share/man/man1/retrieve-index.1 [deleted file]

index 6bac28d..7ae1f75 100644 (file)
@@ -1,4 +1,4 @@
-#      $OpenBSD: Makefile,v 1.9 2018/07/09 11:36:57 espie Exp $
+#      $OpenBSD: Makefile,v 1.10 2018/07/09 13:51:08 espie Exp $
 #      $NetBSD: Makefile,v 1.4 1994/12/22 10:48:04 cgd Exp $
 
 MAN=   clang-local.1 help.1 intro.1 gcc-local.1
@@ -7,9 +7,10 @@ MAN=   clang-local.1 help.1 intro.1 gcc-local.1
 MAN+=  check-lib-depends.1 check-manpages.1 check-problems.1 \
        clean-old-distfiles.1 dpb-replay.1 dpb.1 \
        getpkgpath.1 out-of-date.1 outdated-perl-ports.1 \
-       pkg_subst.1 portbump.1 portcheck.1 portgen.1 \
+       pkg_subst.1 \
+       port-search-helper.1 portbump.1 portcheck.1 portgen.1 \
        portimport.1 portlock.1 portslogger.1 proot.1 \
-       register-plist.1 resolve-lib.1 retrieve-index.1 \
+       register-plist.1 resolve-lib.1 \
        update-patches.1 update-plist.1
 
 .include <bsd.prog.mk>
diff --git a/share/man/man1/port-search-helper.1 b/share/man/man1/port-search-helper.1
new file mode 100644 (file)
index 0000000..2601d2d
--- /dev/null
@@ -0,0 +1,48 @@
+.\"    $OpenBSD: port-search-helper.1,v 1.1 2018/07/09 13:51:08 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: July 9 2018 $
+.Dt PORT-SEARCH-HELPER 1
+.Os
+.Sh NAME
+.Nm port-search-helper
+.Nd find index entry in ports index according to selected criteria
+.Sh SYNOPSIS
+.Nm
+.Cm index Ns = Ns Ar file
+.Op Cm category Ns = Ns Ar cat
+.Op Cm maintainer Ns = Ns Ar person
+.Op Cm key Ns = Ns Ar 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 by
+.Pa ${PORTSDIR}/Makefile
+for searches.
+.Pp
+It relies on
+.Pa ${PORTSDIR}/INDEX
+being accurate.
+.Sh SEE ALSO
+.Xr perlre 1 ,
+.Xr ports 7
diff --git a/share/man/man1/retrieve-index.1 b/share/man/man1/retrieve-index.1
deleted file mode 100644 (file)
index ff7cd0e..0000000
+++ /dev/null
@@ -1,45 +0,0 @@
-.\"    $OpenBSD: retrieve-index.1,v 1.1 2018/06/26 05:38:49 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: June 26 2018 $
-.Dt RETRIEVE-INDEX 1
-.Os
-.Sh NAME
-.Nm retrieve-index
-.Nd find index entry in ports index according to selected criteria
-.Sh SYNOPSIS
-.Nm retrieve-index
-.Cm index Ns = Ns Ar file
-.Op Cm category Ns = Ns Ar cat
-.Op Cm maintainer Ns = Ns Ar person
-.Op Cm key Ns = Ns Ar 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