Minor url.texi update.

* doc/misc/url.texi (Disk Caching): Mention url-cache-expire-time,
url-cache-expired, and url-fetch-from-cache.

diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 3e723cd..e330849 100644 (file)
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,8 @@
+2010-09-24  Julien Danjou  <julien@danjou.info>
+
+       * url.texi (Disk Caching): Mention url-cache-expire-time,
+       url-cache-expired, and url-fetch-from-cache.
+
 2010-09-21  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
        * gnus.texi (Expunging mailboxes): Update name of the expunging

diff --git a/doc/misc/url.texi b/doc/misc/url.texi
index a6bbf0b..dcb8f5c 100644 (file)
--- a/doc/misc/url.texi
+++ b/doc/misc/url.texi
@@ -731,14 +731,6 @@ directory to store the cache files.  It defaults to sub-directory
 @file{cache} of @code{url-configuration-directory}.
 @end defopt
 
-@c Fixme: function v. option, but neither used.
-@c @findex url-cache-expired
-@c @defopt url-cache-expired
-@c This is a function to decide whether or not a cache entry has expired.
-@c It takes two times as it parameters and returns non-@code{nil} if the
-@c second time is ``too old'' when compared with the first time.
-@c @end defopt
-
 @defopt url-cache-creation-function
 The cache relies on a scheme for mapping URLs to files in the cache.
 This variable names a function which sets the type of cache to use.
@@ -748,6 +740,11 @@ corresponding cache file.  The two supplied possibilities are
 @code{url-cache-create-filename-human-readable}.
 @end defopt
 
+@defopt url-cache-expire-time
+This variable defines a default time value to use as expire delay when
+checking if an URL has expired with @code{url-cache-expired}.
+@end defopt
+
 @defun url-cache-create-filename-using-md5 url
 Creates a cache file name from @var{url} using MD5 hashing.
 This is creates entries with very few cache collisions and is fast.
@@ -768,6 +765,19 @@ more likely to conflict with other files.
 @end smallexample
 @end defun
 
+@defun url-cache-expired
+This is a function to decide whether or not a cache entry has expired.
+It takes a an URL as it first parameters and a expiration delay in
+second paramater. It returns non-@code{nil} if URL is not cached or is
+cached for more than the give expiration delay. If the delay is not
+used, @var{url-cache-expire-time} is used instead.
+@end defun
+
+@defun url-fetch-from-cache
+This function takes an URL as its first argument and then returns a
+buffer containing the data cached for the given URL.
+@end defun
+
 @c Fixme: never actually used currently?
 @c @defopt url-standalone-mode
 @c @cindex Relying on cache