Merge from emacs-23

[bpt/emacs.git] / doc / misc / url.texi

diff --git a/doc/misc/url.texi b/doc/misc/url.texi
index 56c3048..62ed9d8 100644 (file)
--- a/doc/misc/url.texi
+++ b/doc/misc/url.texi
@@ -13,20 +13,20 @@
 %\global\baselineskip 30pt      % for printing in double space
 @end tex
 @dircategory World Wide Web
-@dircategory GNU Emacs Lisp
+@dircategory Emacs
 @direntry
-* URL: (url).                 URL loading package.
+* URL: (url).                   URL loading package.
 @end direntry
 
 @copying
-This file documents the URL loading package.
+This file documents the Emacs Lisp URL loading package.
 
 Copyright @copyright{} 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2002,
-2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 or
+under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
 and with the Back-Cover Texts as in (a) below.  A copy of the license
@@ -49,10 +49,14 @@ developing GNU and promoting software freedom.''
 @insertcopying
 @end titlepage
 
-@page
+@contents
+
 @node Top
 @top URL
 
+@ifnottex
+@insertcopying
+@end ifnottex
 
 @menu
 * Getting Started::             Preparing your program to use URLs.
@@ -252,10 +256,10 @@ transmission via SSL.  It is defined in RFC 2069.  Its default port is
 @code{ssl} gateway method to be used.  @xref{Gateways in general}.
 
 @defopt url-honor-refresh-requests
-This controls honouring of HTTP @samp{Refresh} headers by which
+This controls honoring of HTTP @samp{Refresh} headers by which
 servers can direct clients to reload documents from the same URL or a
-or different one.  @code{nil} means they will not be honoured,
-@code{t} (the default) means they will always be honoured, and
+or different one.  @code{nil} means they will not be honored,
+@code{t} (the default) means they will always be honored, and
 otherwise the user will be asked on each request.
 @end defopt
 
@@ -305,11 +309,11 @@ Default is one hour.
 @subsection Language and Encoding Preferences
 
 HTTP allows clients to express preferences for the language and
-encoding of documents which servers may honour.  For each of these
+encoding of documents which servers may honor.  For each of these
 variables, the value is a string; it can specify a single choice, or
 it can be a comma-separated list.
 
-Normally this list ordered by descending preference.  However, each
+Normally, this list is ordered by descending preference.  However, each
 element can be followed by @samp{;q=@var{priority}} to specify its
 preference level, a decimal number from 0 to 1; e.g., for
 @code{url-mime-language-string}, @w{@code{"de, en-gb;q=0.8,
@@ -727,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.
@@ -764,6 +760,22 @@ more likely to conflict with other files.
 @end smallexample
 @end defun
 
+@defun url-cache-expired
+This function returns non-nil if a cache entry has expired (or is absent).
+The arguments are a URL and optional expiration delay in seconds
+(default @var{url-cache-expire-time}).
+@end defun
+
+@defopt url-cache-expire-time
+This variable is the default number of seconds to use for the
+expire-time argument of the function @code{url-cache-expired}.
+@end defopt
+
+@defun url-fetch-from-cache
+This function takes a URL as its argument and returns a buffer
+containing the data cached for that URL.
+@end defun
+
 @c Fixme: never actually used currently?
 @c @defopt url-standalone-mode
 @c @cindex Relying on cache
@@ -1116,11 +1128,11 @@ general operation of the package.
 
 @defopt url-debug
 @cindex debugging
-Specifies the types of debug messages the library which are logged to
+Specifies the types of debug messages which are logged to
 the @code{*URL-DEBUG*} buffer.
 @code{t} means log all messages.
 A number means log all messages and show them with @code{message}.
-If may also be a list of the types of messages to be logged.
+It may also be a list of the types of messages to be logged.
 @end defopt
 @defopt url-personal-mail-address
 @end defopt
@@ -1181,8 +1193,6 @@ Connect directly.
 @unnumbered Concept Index
 @printindex cp
 
-@setchapternewpage odd
-@contents
 @bye
 
 @ignore