Fred Drake | 7fefba5 | 1999-06-27 15:01:08 +0000 | [diff] [blame] | 1 | \section{\module{nis} --- |
Fred Drake | 0d6e6e0 | 1999-07-06 15:43:55 +0000 | [diff] [blame] | 2 | Interface to Sun's NIS (Yellow Pages)} |
Fred Drake | 7fefba5 | 1999-06-27 15:01:08 +0000 | [diff] [blame] | 3 | |
| 4 | \declaremodule{extension}{nis} |
| 5 | \platform{UNIX} |
| 6 | \moduleauthor{Fred Gansevles}{Fred.Gansevles@cs.utwente.nl} |
| 7 | \sectionauthor{Moshe Zadka}{mzadka@geocities.com} |
Fred Drake | 38e5d27 | 2000-04-03 20:13:55 +0000 | [diff] [blame] | 8 | \modulesynopsis{Interface to Sun's NIS (a.k.a. Yellow Pages) library.} |
Fred Drake | 7fefba5 | 1999-06-27 15:01:08 +0000 | [diff] [blame] | 9 | |
| 10 | The \module{nis} module gives a thin wrapper around the NIS library, useful |
| 11 | for central administration of several hosts. |
| 12 | |
| 13 | Because NIS exists only on \UNIX{} systems, this module is |
| 14 | only available for \UNIX{}. |
| 15 | |
| 16 | The \module{nis} module defines the following functions: |
| 17 | |
| 18 | \begin{funcdesc}{match}{key, mapname} |
| 19 | Return the match for \var{key} in map \var{mapname}, or raise an |
| 20 | error (\exception{nis.error}) if there is none. |
| 21 | Both should be strings, \var{key} is 8-bit clean. |
Thomas Wouters | f831663 | 2000-07-16 19:01:10 +0000 | [diff] [blame^] | 22 | Return value is an arbitrary array of bytes (i.e., may contain \code{NULL} |
Fred Drake | 7fefba5 | 1999-06-27 15:01:08 +0000 | [diff] [blame] | 23 | and other joys). |
| 24 | |
| 25 | Note that \var{mapname} is first checked if it is an alias to another name. |
Fred Drake | 7fefba5 | 1999-06-27 15:01:08 +0000 | [diff] [blame] | 26 | \end{funcdesc} |
| 27 | |
| 28 | \begin{funcdesc}{cat}{mapname} |
| 29 | Return a dictionary mapping \var{key} to \var{value} such that |
| 30 | \code{match(\var{key}, \var{mapname})==\var{value}}. |
Thomas Wouters | f831663 | 2000-07-16 19:01:10 +0000 | [diff] [blame^] | 31 | Note that both keys and values of the dictionary are arbitrary |
Fred Drake | 7fefba5 | 1999-06-27 15:01:08 +0000 | [diff] [blame] | 32 | arrays of bytes. |
| 33 | |
| 34 | Note that \var{mapname} is first checked if it is an alias to another name. |
| 35 | \end{funcdesc} |
| 36 | |
| 37 | \begin{funcdesc}{maps}{} |
| 38 | Return a list of all valid maps. |
| 39 | \end{funcdesc} |
| 40 | |
| 41 | |
| 42 | The \module{nis} module defines the following exception: |
| 43 | |
| 44 | \begin{excdesc}{error} |
| 45 | An error raised when a NIS function returns an error code. |
| 46 | \end{excdesc} |