summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorespie <espie@openbsd.org>2005-02-28 14:30:01 +0000
committerespie <espie@openbsd.org>2005-02-28 14:30:01 +0000
commit555ff3ddfd9932db96408691ed83ef4d53c8398c (patch)
tree4b010f76bca0fa20c468356462e10d1f5ece51e2
parentuse the linkshar keyword when gtalking about the link sharing service (diff)
downloadwireguard-openbsd-555ff3ddfd9932db96408691ed83ef4d53c8398c.tar.xz
wireguard-openbsd-555ff3ddfd9932db96408691ed83ef4d53c8398c.zip
document the public interface to PkgSpec.
Very simple actually...
-rw-r--r--usr.sbin/pkg_add/pod/OpenBSD::PkgSpec.pod14
1 files changed, 13 insertions, 1 deletions
diff --git a/usr.sbin/pkg_add/pod/OpenBSD::PkgSpec.pod b/usr.sbin/pkg_add/pod/OpenBSD::PkgSpec.pod
index ad4e761938f..2aa21e19d84 100644
--- a/usr.sbin/pkg_add/pod/OpenBSD::PkgSpec.pod
+++ b/usr.sbin/pkg_add/pod/OpenBSD::PkgSpec.pod
@@ -1,4 +1,4 @@
-$OpenBSD: OpenBSD::PkgSpec.pod,v 1.1 2005/02/28 13:08:41 espie Exp $
+$OpenBSD: OpenBSD::PkgSpec.pod,v 1.2 2005/02/28 14:30:01 espie Exp $
=head1 NAME
@@ -6,4 +6,16 @@ OpenBSD::PkgSpec - C<packages-specs(7)> handling
=head1 SYNOPSIS
+ use OpenBSD::PkgSPec;
+ @sublist = OpenBSD::PkgSpec::match($pattern, @list);
+
=head1 DESCRIPTION
+
+C<OpenBSD::PkgSpec> is the canonical interface to C<packages-specs(7)>
+handling.
+
+A package specification C<$pattern> is a string that can be used to
+extract matching package names from a C<@list>. The resulting list
+C<@sublist> will only hold the package names that match the specification.
+
+For performance reason, the result may contain duplicates.