From: espie <espie@openbsd.org>
Date: Mon, 1 Mar 2021 10:35:49 +0000 (+0000)
Subject: document pkg_check-version
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=2f0ead4c1d0e5648c8e51b8076849aee84fe4aed;p=openbsd

document pkg_check-version
---

diff --git a/share/man/man1/Makefile b/share/man/man1/Makefile
index f54494417a9..7d3c103376e 100644
--- a/share/man/man1/Makefile
+++ b/share/man/man1/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.17 2019/11/12 16:39:10 espie Exp $
+#	$OpenBSD: Makefile,v 1.18 2021/03/01 10:35:49 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,8 +7,8 @@ MAN=	clang-local.1 help.1 intro.1 gcc-local.1
 MAN+=	build-debug-info.1 check-lib-depends.1 clean-old-distfiles.1 \
 	dpb-replay.1 dpb.1 \
 	outdated-perl-ports.1 \
-	pkg_check-problems.1 pkg_check-manpages.1 pkg_outdated.1 \
-	pkg_subst.1 \
+	pkg_check-problems.1 pkg_check-manpages.1 pkg_check-version.1 \
+	pkg_outdated.1 pkg_subst.1 \
 	port-getpkgpath-helper.1 port-resolve-lib-helper.1 \
 	port-search-helper.1 \
 	portbump.1 portcheck.1 portgen.1 \
diff --git a/share/man/man1/pkg_check-version.1 b/share/man/man1/pkg_check-version.1
new file mode 100644
index 00000000000..b8167136aaf
--- /dev/null
+++ b/share/man/man1/pkg_check-version.1
@@ -0,0 +1,55 @@
+.\"	$OpenBSD: pkg_check-version.1,v 1.1 2021/03/01 10:35:49 espie Exp $
+.\"
+.\" Copyright (c) 2021 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: March 1 2021 $
+.Dt PKG_CHECK-VERSION 1
+.Os
+.Sh NAME
+.Nm pkg_check-version
+.Nd verify parsing and ordering of package names.
+.Sh SYNOPSIS
+.Nm
+.Op Fl Hv
+.Ar pkgname ...
+.Sh DESCRIPTION
+.Nm
+takes a list of
+.Ar pkgname
+and processes them.
+.Bl -bullet -compact
+.It 
+each name is parsed and checked for issues.
+.It
+in addition, comparable names (same stem and same flavor) are sorted
+from older to newer version.
+.El
+.Pp
+Options are as follows:
+.Bl -tag -width Hv
+.It Fl H
+displays a human-readable version of each
+.Ar pkgname
+(full version parsing, including known suffixes, dewey numbers parsing,
+REVISION, EPOCH, flavor markers).
+.It Fl v
+verbose mode, which will explicitly state
+.Ar pkgname
+with no issues and sort one element lists.
+.El
+.Sh SEE ALSO
+.Xr packages-specs 7 
+.Sh AUTHORS
+.An Marc Espie Aq Mt espie@openbsd.org