summaryrefslogtreecommitdiff
path: root/usr.sbin/pkg_add/pod/OpenBSD::IdCache.pod
blob: 5a2727fc813a9a6f6e5d905bea29b94a8af063f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
$OpenBSD: OpenBSD::IdCache.pod,v 1.1 2005/02/28 13:08:41 espie Exp $

=head1 NAME

OpenBSD::IdCache - cache for uid and gid look-ups

=head1 SYNOPSIS

    use OpenBSD::IdCache;

    my $ucache = new OpenBSD::UidCache;
    my $uid = $ucache->lookup("espie");

    my $gcache = new OpenBSD::GidCache;
    my $gid = $gcache->lookup("wheel", 0);

=head1 DESCRIPTION

C<OpenBSD::IdCache> provides two classes: C<OpenBSD::UidCache>, for UIDs,
and C<OpenBSD::GidCache> for GIDs.

C<UidCache::new> creates a UID cache, which can be used to look up user
names by using the C<lookup> method.  Looking up a numeric user name
is a no-op. Non-existing IDs return a default value, which is normally
C<undef> but can be provided as an extra argument to C<lookup>.

C<GidCache::new> provides the same service for GIDs.