Debian Codegraph @

upstream/debian-unstable/man3/User::grent.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "User::grent 3perl"
58 .TH User::grent 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 User::grent \- by\-name interface to Perl's built\-in getgr*() functions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 5
68 \& use User::grent;
69 \& my $gr = getgrgid(0) or die "No group zero";
70 \& if ( $gr\->name eq \*(Aqwheel\*(Aq && @{$gr\->members} > 1 ) {
71 \& print "gid zero name wheel, with other members";
72 \& }
73 \&
74 \& use User::grent qw(:FIELDS);
75 \& getgrgid(0) or die "No group zero";
76 \& if ( $gr_name eq \*(Aqwheel\*(Aq && @gr_members > 1 ) {
77 \& print "gid zero name wheel, with other members";
78 \& }
79 \&
80 \& my $gr = getgr($whoever);
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 This module's default exports override the core \fBgetgrent()\fR, \fBgetgrgid()\fR,
85 and \fBgetgrnam()\fR functions, replacing them with versions that return
86 "User::grent" objects. This object has methods that return the similarly
87 named structure field name from the C's passwd structure from \fIgrp.h\fR;
88 namely name, passwd, gid, and members (not mem). The first three
89 return scalars, the last an array reference.
90 .PP
91 You may also import all the structure fields directly into your namespace
92 as regular variables using the :FIELDS import tag. (Note that this still
93 overrides your core functions.) Access these fields as variables named
94 with a preceding \f(CW\*(C`gr_\*(C'\fR. Thus, \f(CW\*(C`$group_obj\->gid()\*(C'\fR corresponds
95 to \f(CW$gr_gid\fR if you import the fields. Array references are available as
96 regular array variables, so \f(CW\*(C`@{ $group_obj\->members() }\*(C'\fR would be
97 simply \f(CW@gr_members\fR.
98 .PP
99 The \fBgetgr()\fR function is a simple front-end that forwards a numeric
100 argument to \fBgetgrgid()\fR and the rest to \fBgetgrnam()\fR.
101 .PP
102 To access this functionality without the core overrides,
103 pass the \f(CW\*(C`use\*(C'\fR an empty import list, and then access
104 function functions with their full qualified names.
105 On the other hand, the built-ins are still available
106 via the \f(CW\*(C`CORE::\*(C'\fR pseudo-package.
107 .SH NOTE
108 .IX Header "NOTE"
109 While this class is currently implemented using the Class::Struct
110 module to build a struct-like class, you shouldn't rely upon this.
111 .SH AUTHOR
112 .IX Header "AUTHOR"
113 Tom Christiansen