summaryrefslogtreecommitdiff
path: root/usr.sbin/pkg_add
diff options
context:
space:
mode:
authorMarc Espie <espie@cvs.openbsd.org>2005-02-28 14:30:02 +0000
committerMarc Espie <espie@cvs.openbsd.org>2005-02-28 14:30:02 +0000
commitf8c1294e718870c35cc7c1d956b91bac851044be (patch)
tree90bfe7da973c52cae8964a1dc1a671ded3809096 /usr.sbin/pkg_add
parent97658e2f26b7cacae2b97f1736a8aa8ecf3c758e (diff)
document the public interface to PkgSpec.
Very simple actually...
Diffstat (limited to 'usr.sbin/pkg_add')
-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.