\input texinfo
-@setfilename ../../info/url
+@setfilename ../../info/url.info
@settitle URL Programmer's Manual
+@documentencoding UTF-8
+
@iftex
@c @finalout
@end iftex
@copying
This is the manual for the @code{url} Emacs Lisp library.
-Copyright @copyright{} 1993-1999, 2002, 2004-2012 Free Software Foundation, Inc.
+Copyright @copyright{} 1993--1999, 2002, 2004--2014 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.3 or
any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
+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
is included in the section entitled ``GNU Free Documentation License''.
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual. Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''
@end quotation
@end copying
@cindex parsed URI
The return value of @code{url-generic-parse-url}, and the argument
expected by @code{url-recreate-url}, is a @dfn{parsed URI}: a CL
-structure whose slots hold the various components of the URI.
-@xref{top,the CL Manual,,cl,GNU Emacs Common Lisp Emulation}, for
+structure whose slots hold the various components of the URI@.
+@xref{Top,the CL Manual,,cl,GNU Emacs Common Lisp Emulation}, for
details about CL structures. Most of the other functions in the
@code{url} library act on parsed URIs.
@table @code
@item type
-The URI scheme (a string, e.g.@: @code{http}). @xref{Supported URL
+The URI scheme (a string, e.g., @code{http}). @xref{Supported URL
Types}, for a list of schemes that the @code{url} library knows how to
process. This slot can also be @code{nil}, if the URI is not fully
specified.
webpage.
@item fullness
-This is @code{t} if the URI is fully specified, i.e.@: the
+This is @code{t} if the URI is fully specified, i.e., the
hierarchical components of the URI (the hostname and/or username
and/or password) are preceded by @samp{//}.
@end table
@defun url-encode-url url-string
This function return a properly URI-encoded version of
@var{url-string}. It also performs @dfn{URI normalization},
-e.g.@: converting the scheme component to lowercase if it was
+e.g., converting the scheme component to lowercase if it was
previously uppercase.
@end defun
@chapter Retrieving URLs
The @code{url} library defines the following three functions for
-retrieving the data specified by a URL. The actual retrieval protocol
+retrieving the data specified by a URL@. The actual retrieval protocol
depends on the URL's URI scheme, and is performed by lower-level
scheme-specific functions. (Those lower-level functions are not
documented here, and generally should not be called directly.)
Its default port is 80.
The @code{https} scheme is a secure version of @code{http}, with
-transmission via SSL. It is defined in RFC 2069, and its default port
+transmission via SSL@. It is defined in RFC 2069, and its default port
is 443. When using @code{https}, the @code{url} library performs SSL
encryption via the @code{ssl} library, by forcing the @code{ssl}
gateway method to be used. @xref{Gateways in general}.
@node Cookies
@subsection Cookies
+@findex url-cookie-delete
+@defun url-cookie-list
+This command creates a @file{*url cookies*} buffer listing the current
+cookies, if there are any. You can remove a cookie using the
+@kbd{C-k} (@code{url-cookie-delete}) command.
+@end defun
+
@defopt url-cookie-file
The file in which cookies are stored, defaulting to @file{cookies} in
the directory specified by @code{url-configuration-directory}.
the URL@.
@defun url-http-options url
-Returns a property list describing options available for URL. The
+Returns a property list describing options available for URL@. The
property list members are:
@table @code
email address. For example, @samp{mailto:foo@@bar.com} specifies
sending a message to @samp{foo@@bar.com}. The ``retrieval method''
for such URLs is to open a mail composition buffer in which the
-appropriate content (e.g.@: the recipient address) has been filled in.
+appropriate content (e.g., the recipient address) has been filled in.
As defined in RFC 2368, a @code{mailto} URL has the form
@vindex NNTPSERVER
@defopt url-news-server
This variable specifies the default news server from which to fetch
-news, if no server was specified in the URL. The default value,
+news, if no server was specified in the URL@. The default value,
@code{nil}, means to use the server specified by the standard
environment variable @samp{NNTPSERVER}, or @samp{news} if that
environment variable is unset.
@end defun
@defun url-cache-expired
-This function returns non-nil if a cache entry has expired (or is absent).
+This function returns non-@code{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
@c With a large cache of documents on the local disk, it can be very handy
@c when traveling, or any other time the network connection is not active
-@c (a laptop with a dial-on-demand PPP connection, etc). Emacs/W3 can rely
+@c (a laptop with a dial-on-demand PPP connection, etc.). Emacs/W3 can rely
@c solely on its cache, and avoid checking to see if the page has changed
@c on the remote server. In the case of a dial-on-demand PPP connection,
@c this will keep the phone line free as long as possible, only bringing up
@defopt url-debug
@cindex debugging
Specifies the types of debug messages which are logged to
-the @code{*URL-DEBUG*} buffer.
+the @file{*URL-DEBUG*} buffer.
@code{t} means log all messages.
A number means log all messages and show them with @code{message}.
It may also be a list of the types of messages to be logged.
HCoop / bpt / emacs.git / blobdiff