summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libwhichdb.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/lib/libwhichdb.tex')
-rw-r--r--Doc/lib/libwhichdb.tex16
1 files changed, 16 insertions, 0 deletions
diff --git a/Doc/lib/libwhichdb.tex b/Doc/lib/libwhichdb.tex
new file mode 100644
index 0000000..fbdfa8c
--- /dev/null
+++ b/Doc/lib/libwhichdb.tex
@@ -0,0 +1,16 @@
+\section{Standard Module \sectcode{whichdb}}
+\stmodindex{whichdb}
+
+The single function in this module attempts to guess which of the
+several simple database modules available--dbm, gdbm, or
+dbhash--should be used to open a given file.
+
+\renewcommand{\indexsubitem}{(in module whichdb)}
+\begin{funcdesc}{whichdb}{filename}
+Returns one of the following values: \code{None} if the file can't be
+opened because it's unreadable or doesn't exist; the empty string
+(\code{""}) if the file's format can't be guessed; or a string
+containing the required module name, such as \code{"dbm"} or
+\code{"gdbm"}.
+\end{funcdesc}
+