summaryrefslogtreecommitdiff
path: root/sys/src/cmd/python/Doc/lib/libgrp.tex
diff options
context:
space:
mode:
authorcinap_lenrek <cinap_lenrek@localhost>2011-05-03 11:25:13 +0000
committercinap_lenrek <cinap_lenrek@localhost>2011-05-03 11:25:13 +0000
commit458120dd40db6b4df55a4e96b650e16798ef06a0 (patch)
tree8f82685be24fef97e715c6f5ca4c68d34d5074ee /sys/src/cmd/python/Doc/lib/libgrp.tex
parent3a742c699f6806c1145aea5149bf15de15a0afd7 (diff)
add hg and python
Diffstat (limited to 'sys/src/cmd/python/Doc/lib/libgrp.tex')
-rw-r--r--sys/src/cmd/python/Doc/lib/libgrp.tex49
1 files changed, 49 insertions, 0 deletions
diff --git a/sys/src/cmd/python/Doc/lib/libgrp.tex b/sys/src/cmd/python/Doc/lib/libgrp.tex
new file mode 100644
index 000000000..3eed7d086
--- /dev/null
+++ b/sys/src/cmd/python/Doc/lib/libgrp.tex
@@ -0,0 +1,49 @@
+\section{\module{grp} ---
+ The group database}
+
+\declaremodule{builtin}{grp}
+ \platform{Unix}
+\modulesynopsis{The group database (\function{getgrnam()} and friends).}
+
+
+This module provides access to the \UNIX{} group database.
+It is available on all \UNIX{} versions.
+
+Group database entries are reported as a tuple-like object, whose
+attributes correspond to the members of the \code{group} structure
+(Attribute field below, see \code{<pwd.h>}):
+
+\begin{tableiii}{r|l|l}{textrm}{Index}{Attribute}{Meaning}
+ \lineiii{0}{gr_name}{the name of the group}
+ \lineiii{1}{gr_passwd}{the (encrypted) group password; often empty}
+ \lineiii{2}{gr_gid}{the numerical group ID}
+ \lineiii{3}{gr_mem}{all the group member's user names}
+\end{tableiii}
+
+The gid is an integer, name and password are strings, and the member
+list is a list of strings.
+(Note that most users are not explicitly listed as members of the
+group they are in according to the password database. Check both
+databases to get complete membership information.)
+
+It defines the following items:
+
+\begin{funcdesc}{getgrgid}{gid}
+Return the group database entry for the given numeric group ID.
+\exception{KeyError} is raised if the entry asked for cannot be found.
+\end{funcdesc}
+
+\begin{funcdesc}{getgrnam}{name}
+Return the group database entry for the given group name.
+\exception{KeyError} is raised if the entry asked for cannot be found.
+\end{funcdesc}
+
+\begin{funcdesc}{getgrall}{}
+Return a list of all available group entries, in arbitrary order.
+\end{funcdesc}
+
+
+\begin{seealso}
+ \seemodule{pwd}{An interface to the user database, similar to this.}
+ \seemodule{spwd}{An interface to the shadow password database, similar to this.}
+\end{seealso}