Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libgrp.tex @ 21467:4e35fa5d5708 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents cde27318cf87
children d0acb3cb011d
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
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 Group database entries are reported as 4-tuples containing the
9002
7116cb9712bc Fix markup where C include files get named in <...> form; bug reported by
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
13 following items from the group database (see \code{<grp.h>}), in order:
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
14
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
15 \begin{tableiii}{r|l|l}{textrm}{Index}{Field}{Meaning}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
16 \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
17 \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
18 \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
19 \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
20 \end{tableiii}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
21
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 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
23 list is a list of strings.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 (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
25 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
26 databases to get complete membership information.)
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
27
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 It defines the following items:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
29
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 \begin{funcdesc}{getgrgid}{gid}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 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
32 \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
33 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
34
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 \begin{funcdesc}{getgrnam}{name}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
36 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
37 \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
38 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
39
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 \begin{funcdesc}{getgrall}{}
2527
815dfaa6a778 small changes by Soren Larsen
Guido van Rossum <guido@python.org>
parents: 1471
diff changeset
41 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
42 \end{funcdesc}
12223
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
43
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 \begin{seealso}
e82e82b3b9ad Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents: 10335
diff changeset
46 \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
47 \end{seealso}