points people to more current ways to find package information.
authorespie <espie@openbsd.org>
Mon, 29 Nov 2021 14:06:03 +0000 (14:06 +0000)
committerespie <espie@openbsd.org>
Mon, 29 Nov 2021 14:06:03 +0000 (14:06 +0000)
with inputs from danj@ and kn@, thx guys

share/man/man7/packages.7
share/man/man7/ports.7

index 6eed9ed..6461347 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: packages.7,v 1.45 2019/12/04 11:07:58 espie Exp $
+.\" $OpenBSD: packages.7,v 1.46 2021/11/29 14:06:03 espie Exp $
 .\"
 .\" Copyright (c) 2000 Marc Espie
 .\"
@@ -24,7 +24,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: December 4 2019 $
+.Dd $Mdocdate: November 29 2021 $
 .Dt PACKAGES 7
 .Os
 .Sh NAME
@@ -56,6 +56,25 @@ distribution
 .Pa compXX.tgz ...
 .Pc
 is not composed of such packages, but of plain tarballs.
+.Sh FINDING PACKAGES
+The official builds feature packages that will help with finding a given piece
+of software:
+.Bl -tag -width ports-readmes-dancer
+.It pkglocatedb
+a
+.Xr locate 1
+database of all files in the ports tree,
+.It sqlports
+an sqlite database of all meta-info of each port, along with an index,
+and a tool to trace dependencies chains,
+.It ports-readmes-dancer
+a simple local webserver that interfaces with that database to
+display information.
+.Po
+There is a running instance of that server hosted on
+.Lk https://openports.pl/
+.Pc .
+.El
 .Sh SECURITY CAVEAT
 The packages are not as thoroughly audited as the main
 .Ox
index 8b83449..1b1b26e 100644 (file)
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $OpenBSD: ports.7,v 1.128 2020/04/28 13:11:32 espie Exp $
+.\" $OpenBSD: ports.7,v 1.129 2021/11/29 14:06:03 espie Exp $
 .\" $FreeBSD: ports.7,v 1.7 1998/06/23 04:38:50 hoek Exp $
 .\"
-.Dd $Mdocdate: April 28 2020 $
+.Dd $Mdocdate: November 29 2021 $
 .Dt PORTS 7
 .Os
 .Sh NAME
@@ -72,10 +72,12 @@ The ports master Makefile, normally located in
 (but see
 .Ev PORTSDIR
 below)
-offers a few useful targets.
-.Bl -tag -width configure
+offers a few deprecated targets for the time being.
+.Bl -tag -width print-index
 .It Cm print-index
-display the contents of the index in a user-friendly way,
+display the contents of the index in a
+.Sq user-friendly
+way,
 .It Cm search
 invoked with a key, e.g.,
 .Ic make search key=foo ,
@@ -85,7 +87,7 @@ retrieve information relevant to a given port (obsolescent).
 Starting in
 .Ox 4.0 ,
 there is a port,
-.Pa databases/sqlports
+.Pa databases/sqlports ,
 that builds an sqlite database containing most information relevant to
 every port in the ports tree.
 This database can be searched using any tool able to manipulate such
@@ -98,7 +100,13 @@ All static index generating information has now been superseded by the
 or
 .Pa pkglocatedb
 packages, which contain
-similar information to the old INDEX file, but are more frequently updated.
+similar information to the old INDEX file, but are frequently updated.
+See
+.Pa databases/sqlports
+.Pa databases/pkglocatedb
+and
+.Xr pkg_mklocatedb 1
+for details.
 .Sh SELECTING A SET OF PORTS
 One can define
 .Ev SUBDIRLIST