Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libgrp.tex @ 27998:e27f58a50737 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
SF bug #690377: Dud footnote reference in distutils docs
author Raymond Hettinger <python@rcn.com>
date Fri, 21 Feb 2003 02:47:09 +0000
parents d0acb3cb011d
children aaa3646f4567
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8716
diff changeset
1 \section{\module{grp} ---
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 9002
diff changeset
2 The group database}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 9002
diff changeset
3
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
4 \declaremodule{builtin}{grp}
10335
093fc298afd6 "\platform{UNIX}" should really be spelled "\platform{Unix}".
Fred Drake <fdrake@acm.org>
parents: 10334
diff changeset
5 \platform{Unix}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 9002
diff changeset
6 \modulesynopsis{The group database (\function{getgrnam()} and friends).}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
8
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 This module provides access to the \UNIX{} group database.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 It is available on all \UNIX{} versions.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
11
22099
d0acb3cb011d Patch #523268, #522027: return enhanced tuples.
Martin v. Löwis <martin@v.loewis.de>
parents: 13434
diff changeset
12 Group database entries are reported as a tuple-like object, whose
d0acb3cb011d Patch #523268, #522027: return enhanced tuples.
Martin v. Löwis <martin@v.loewis.de>
parents: 13434
diff changeset
13 attributes correspond to the members of the \code{group} structure
d0acb3cb011d Patch #523268, #522027: return enhanced tuples.
Martin v. Löwis <martin@v.loewis.de>
parents: 13434
diff changeset
14 (Attribute field below, see \code{<pwd.h>}):
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
15
22099
d0acb3cb011d Patch #523268, #522027: return enhanced tuples.
Martin v. Löwis <martin@v.loewis.de>
parents: 13434
diff changeset
16 \begin{tableiii}{r|l|l}{textrm}{Index}{Attribute}{Meaning}
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
17 \lineiii{0}{gr_name}{the name of the group}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
18 \lineiii{1}{gr_passwd}{the (encrypted) group password; often empty}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
19 \lineiii{2}{gr_gid}{the numerical group ID}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
20 \lineiii{3}{gr_mem}{all the group member's user names}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
21 \end{tableiii}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
22
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 The gid is an integer, name and password are strings, and the member
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 list is a list of strings.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 (Note that most users are not explicitly listed as members of the
13434
cde27318cf87 Minor revisions similar to some information in the new docstrings.
Fred Drake <fdrake@acm.org>
parents: 12223
diff changeset
26 group they are in according to the password database. Check both
cde27318cf87 Minor revisions similar to some information in the new docstrings.
Fred Drake <fdrake@acm.org>
parents: 12223
diff changeset
27 databases to get complete membership information.)
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
28
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 It defines the following items:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
30
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 \begin{funcdesc}{getgrgid}{gid}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
32 Return the group database entry for the given numeric group ID.
13434
cde27318cf87 Minor revisions similar to some information in the new docstrings.
Fred Drake <fdrake@acm.org>
parents: 12223
diff changeset
33 \exception{KeyError} is raised if the entry asked for cannot be found.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
35
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
36 \begin{funcdesc}{getgrnam}{name}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 Return the group database entry for the given group name.
13434
cde27318cf87 Minor revisions similar to some information in the new docstrings.
Fred Drake <fdrake@acm.org>
parents: 12223
diff changeset
38 \exception{KeyError} is raised if the entry asked for cannot be found.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
39 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
40
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
41 \begin{funcdesc}{getgrall}{}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
42 Return a list of all available group entries, in arbitrary order.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
43 \end{funcdesc}
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
44
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
45
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
46 \begin{seealso}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
47 \seemodule{pwd}{An interface to the user database, similar to this.}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
48 \end{seealso}