summaryrefslogtreecommitdiff
path: root/docs/docbook
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2003-04-14 09:18:36 +0000
committerJelmer Vernooij <jelmer@samba.org>2003-04-14 09:18:36 +0000
commitde7094af68ef0d6b83dd19100afc62a4ed5ab27e (patch)
tree8f1ced650ea12dc378b3c38f8106d92ddcded1ff /docs/docbook
parent3aaee9fea9a2a5f3d28f56d0041d466046eb7fe2 (diff)
downloadsamba-de7094af68ef0d6b83dd19100afc62a4ed5ab27e.tar.gz
samba-de7094af68ef0d6b83dd19100afc62a4ed5ab27e.tar.bz2
samba-de7094af68ef0d6b83dd19100afc62a4ed5ab27e.zip
Document NET CACHE
(This used to be commit d1cd95e6b7d2c0e73595d8f19b994da43ca4217d)
Diffstat (limited to 'docs/docbook')
-rw-r--r--docs/docbook/manpages/net.8.sgml60
1 files changed, 57 insertions, 3 deletions
diff --git a/docs/docbook/manpages/net.8.sgml b/docs/docbook/manpages/net.8.sgml
index f4f75d0c88..45bb3bcbcd 100644
--- a/docs/docbook/manpages/net.8.sgml
+++ b/docs/docbook/manpages/net.8.sgml
@@ -527,10 +527,64 @@ or workgroup. Defaults to local domain.</para>
<refsect2>
<title>CACHE</title>
-<para>Interface to samba's internal gencache functions. For debugging
-purposes only.</para>
+<para>Samba uses a general caching interface called 'gencache'. It
+can be controlled using 'NET CACHE'.</para>
-<!--FIXME-->
+<para>All the timeout parameters support the suffixes:
+
+<simplelist>
+<member>s - Seconds</member>
+<member>m - Minutes</member>
+<member>h - Hours</member>
+<member>d - Days</member>
+<member>w - Weeks</member>
+</simplelist>
+
+</para>
+
+<refsect3>
+<title>CACHE ADD <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title>
+
+<para>Add specified key+data to the cache with the given timeout.</para>
+
+</refsect3>
+
+<refsect3>
+<title>CACHE DEL <replaceable>key</replaceable></title>
+
+<para>Delete key from the cache.</para>
+
+</refsect3>
+
+<refsect3>
+<title>CACHE SET <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title>
+
+<para>Update data of existing cache entry.</para>
+
+</refsect3>
+
+<refsect3>
+<title>CACHE SEARCH <replaceable>PATTERN</replaceable></title>
+
+<para>Search for the specified pattern in the cache data.</para>
+
+</refsect3>
+
+<refsect3>
+<title>CACHE LIST</title>
+
+<para>
+List all current items in the cache.
+</para>
+
+</refsect3>
+
+<refsect3>
+<title>CACHE FLUSH</title>
+
+<para>Remove all the current items from the cache.</para>
+
+</refsect3>
</refsect2>