Merge from emacs-23; up to 2010-06-11T21:26:13Z!lekktu@gmail.com.
[bpt/emacs.git] / doc / misc / url.texi
index 07b6582..4259445 100644 (file)
 \overfullrule=0pt
 %\global\baselineskip 30pt      % for printing in double space
 @end tex
-@dircategory World Wide Web
-@dircategory GNU Emacs Lisp
+@dircategory Emacs lisp libraries
 @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.
+Copyright @copyright{} 1993-1999, 2002, 2004-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 +47,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.
@@ -114,7 +116,10 @@ The meaning of the @var{path} component depends on the service.
 @cindex @file{~/.url}
 @cindex configuration files
 The directory in which URL configuration files, the cache etc.,
-reside.  Default @file{~/.url}.
+reside.  The old default was @file{~/.url}, and this directory
+is still used if it exists.  The new default is a @file{url/}
+directory in @code{user-emacs-directory}, which is normally
+@file{~/.emacs.d}.
 @end defvar
 
 @node Parsed URLs
@@ -309,7 +314,7 @@ 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,
@@ -381,20 +386,7 @@ Currently this is just the raw header contents.
 HTTP URLs are retrieved into a buffer containing the HTTP headers
 followed by the body.  Since the headers are quasi-MIME, they may be
 processed using the MIME library.  @xref{Top,, Emacs MIME,
-emacs-mime, The Emacs MIME Manual}.  The URL package provides a
-function to do this in general:
-
-@defun url-decode-text-part handle &optional coding
-This function decodes charset-encoded text in the current buffer.  In
-Emacs, the buffer is expected to be unibyte initially and is set to
-multibyte after decoding.
-HANDLE is the MIME handle of the original part.  CODING is an explicit
-coding to use, overriding what the MIME headers specify.
-The coding system used for the decoding is returned.
-
-Note that this function doesn't deal with @samp{http-equiv} charset
-specifications in HTML @samp{<meta>} elements.
-@end defun
+emacs-mime, The Emacs MIME Manual}.
 
 @node file/ftp
 @section file and ftp
@@ -727,14 +719,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 +748,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 +1116,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,10 +1181,4 @@ Connect directly.
 @unnumbered Concept Index
 @printindex cp
 
-@setchapternewpage odd
-@contents
 @bye
-
-@ignore
-   arch-tag: c96be356-7e2d-4196-bcda-b13246c5c3f0
-@end ignore