ACCT-GROUP.ECLASS

Section: eclass-manpages (5)
Updated: Oct 2024
Index Return to Main Contents

NAME

acct-group.eclass - Eclass used to create and maintain a single group entry

DESCRIPTION

This eclass represents and creates a single group entry. The name of the group is derived from ${PN}, while (preferred) GID needs to be specified via ACCT_GROUP_ID. Packages (and users) needing the group in question should depend on the package providing it.

Example: If your package needs group 'foo', you create 'acct-group/foo' package and add an ebuild with the following contents:

EAPI=8
inherit acct-group
ACCT_GROUP_ID=200

Then you add appropriate dependencies to your package. Note that the build system might need to resolve names, too. The dependency type(s) should be: BDEPEND if the group must be resolvable at build time (e.g. 'fowners' uses it in src_install), IDEPEND if it must be resolvable at install time (e.g. 'fowners' uses it in pkg_preinst), and RDEPEND in every case.

SUPPORTED EAPIS

7 8

FUNCTIONS

acct-group_pkg_pretend: Performs sanity checks for correct eclass usage, and early-checks whether requested GID can be enforced.
acct-group_src_install: Installs sysusers.d file for the group.
acct-group_pkg_preinst: Creates the group if it does not exist yet.

ECLASS VARIABLES

ACCT_GROUP_NAME = ${PN}: The name of the group. This is forced to ${PN} and the policy prohibits it from being changed. The variable is left writable for use in overlays; package naming restrictions would prohibit some otherwise-valid group names.
ACCT_GROUP_ID (REQUIRED): Preferred GID for the new group. This variable is obligatory, and its value must be unique across all group packages. This can be overridden in make.conf through ACCT_GROUP_<UPPERCASE_USERNAME>_ID variable.
Overlays should set this to -1 to dynamically allocate GID. Using -1 in ::gentoo is prohibited by policy.
ACCT_GROUP_ENFORCE_ID: If set to a non-null value, the eclass will require the group to have specified GID. If the group already exists with another GID, or the GID is taken by another group, the install will fail.

AUTHORS

Michael Orlitzky <mjo@gentoo.org>
Michał Górny <mgorny@gentoo.org>

MAINTAINERS

Michał Górny <mgorny@gentoo.org>
Mike Gilbert <floppym@gentoo.org>

REPORTING BUGS

Please report bugs via https://bugs.gentoo.org/

FILES

acct-group.eclass

This document was created by man2html, using the manual pages.
Time: 03:27:01 GMT, October 07, 2024