Debian Codegraph @

upstream/opensuse-tumbleweed/man3/User::grent.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "User::grent 3pm"
61 .TH User::grent 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 User::grent \- by\-name interface to Perl\*(Aqs built\-in getgr*() functions
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 5
71 \& use User::grent;
72 \& my $gr = getgrgid(0) or die "No group zero";
73 \& if ( $gr\->name eq \*(Aqwheel\*(Aq && @{$gr\->members} > 1 ) {
74 \& print "gid zero name wheel, with other members";
75 \& }
76 \&
77 \& use User::grent qw(:FIELDS);
78 \& getgrgid(0) or die "No group zero";
79 \& if ( $gr_name eq \*(Aqwheel\*(Aq && @gr_members > 1 ) {
80 \& print "gid zero name wheel, with other members";
81 \& }
82 \&
83 \& my $gr = getgr($whoever);
84 .Ve
85 .SH DESCRIPTION
86 .IX Header "DESCRIPTION"
87 This module\*(Aqs default exports override the core \fBgetgrent()\fR, \fBgetgrgid()\fR,
88 and \fBgetgrnam()\fR functions, replacing them with versions that return
89 "User::grent" objects. This object has methods that return the similarly
90 named structure field name from the C\*(Aqs passwd structure from \fIgrp.h\fR;
91 namely name, passwd, gid, and members (not mem). The first three
92 return scalars, the last an array reference.
93 .PP
94 You may also import all the structure fields directly into your namespace
95 as regular variables using the :FIELDS import tag. (Note that this still
96 overrides your core functions.) Access these fields as variables named
97 with a preceding \f(CW\*(C`gr_\*(C'\fR. Thus, \f(CW\*(C`$group_obj\->gid()\*(C'\fR corresponds
98 to \f(CW$gr_gid\fR if you import the fields. Array references are available as
99 regular array variables, so \f(CW\*(C`@{ $group_obj\->members() }\*(C'\fR would be
100 simply \f(CW@gr_members\fR.
101 .PP
102 The \fBgetgr()\fR function is a simple front\-end that forwards a numeric
103 argument to \fBgetgrgid()\fR and the rest to \fBgetgrnam()\fR.
104 .PP
105 To access this functionality without the core overrides,
106 pass the \f(CW\*(C`use\*(C'\fR an empty import list, and then access
107 function functions with their full qualified names.
108 On the other hand, the built\-ins are still available
109 via the \f(CW\*(C`CORE::\*(C'\fR pseudo\-package.
110 .SH NOTE
111 .IX Header "NOTE"
112 While this class is currently implemented using the Class::Struct
113 module to build a struct\-like class, you shouldn\*(Aqt rely upon this.
114 .SH AUTHOR
115 .IX Header "AUTHOR"
116 Tom Christiansen