diff options
| author | Stefan Monnier | 2012-03-25 16:37:21 -0400 |
|---|---|---|
| committer | Stefan Monnier | 2012-03-25 16:37:21 -0400 |
| commit | 699c782b7668c44d0fa4446331b0590a6d5dac82 (patch) | |
| tree | 5dcce364741d0761920a3d274b0fc8aba4103d45 /doc/misc/url.texi | |
| parent | 98fb480ee31bf74cf554044f60f21df16566dd7f (diff) | |
| parent | e99a9b8bdccadded1f6fae88ee7a2a93dfd4eacf (diff) | |
| download | emacs-pending.tar.gz emacs-pending.zip | |
Merge from trunkpending
Diffstat (limited to 'doc/misc/url.texi')
| -rw-r--r-- | doc/misc/url.texi | 28 |
1 files changed, 20 insertions, 8 deletions
diff --git a/doc/misc/url.texi b/doc/misc/url.texi index 42594457ab1..680f1921479 100644 --- a/doc/misc/url.texi +++ b/doc/misc/url.texi | |||
| @@ -20,7 +20,7 @@ | |||
| 20 | @copying | 20 | @copying |
| 21 | This file documents the Emacs Lisp URL loading package. | 21 | This file documents the Emacs Lisp URL loading package. |
| 22 | 22 | ||
| 23 | Copyright @copyright{} 1993-1999, 2002, 2004-2011 Free Software Foundation, Inc. | 23 | Copyright @copyright{} 1993-1999, 2002, 2004-2012 Free Software Foundation, Inc. |
| 24 | 24 | ||
| 25 | @quotation | 25 | @quotation |
| 26 | Permission is granted to copy, distribute and/or modify this document | 26 | Permission is granted to copy, distribute and/or modify this document |
| @@ -96,7 +96,7 @@ where @samp{@r{[}} and @samp{@r{]}} delimit optional parts. | |||
| 96 | but you should beware of the security risks of sending cleartext | 96 | but you should beware of the security risks of sending cleartext |
| 97 | passwords. @var{hostname} may be a domain name or a dotted decimal | 97 | passwords. @var{hostname} may be a domain name or a dotted decimal |
| 98 | address. If the @samp{:@var{port}} is omitted then the library will | 98 | address. If the @samp{:@var{port}} is omitted then the library will |
| 99 | use the `well known' port for that service when accessing URLs. With | 99 | use the ``well known'' port for that service when accessing URLs. With |
| 100 | the possible exception of @code{telnet}, it is rare for ports to be | 100 | the possible exception of @code{telnet}, it is rare for ports to be |
| 101 | specified, and it is possible using a non-standard port may have | 101 | specified, and it is possible using a non-standard port may have |
| 102 | undesired consequences if a different service is listening on that | 102 | undesired consequences if a different service is listening on that |
| @@ -145,7 +145,7 @@ is the host name associated with it, or @code{nil}; | |||
| 145 | @item port | 145 | @item port |
| 146 | is the port number associated with it, or @code{nil}; | 146 | is the port number associated with it, or @code{nil}; |
| 147 | @item file | 147 | @item file |
| 148 | is the `file' part of it, or @code{nil}. This doesn't necessarily | 148 | is the ``file'' part of it, or @code{nil}. This doesn't necessarily |
| 149 | actually refer to a file; | 149 | actually refer to a file; |
| 150 | @item target | 150 | @item target |
| 151 | is the target part, or @code{nil}; | 151 | is the target part, or @code{nil}; |
| @@ -201,13 +201,25 @@ data. @var{url} is either a string or a parsed URL structure. Return | |||
| 201 | info, or mailto URLs that need no further processing). | 201 | info, or mailto URLs that need no further processing). |
| 202 | @end defun | 202 | @end defun |
| 203 | 203 | ||
| 204 | @defun url-retrieve url callback &optional cbargs | 204 | @defun url-retrieve url callback &optional cbargs silent no-cookies |
| 205 | Retrieve @var{url} asynchronously and call @var{callback} with args | 205 | Retrieve @var{url} asynchronously and call @var{callback} with args |
| 206 | @var{cbargs} when finished. The callback is called when the object | 206 | @var{cbargs} when finished. The callback is called when the object |
| 207 | has been completely retrieved, with the current buffer containing the | 207 | has been completely retrieved, with the current buffer containing the |
| 208 | object and any MIME headers associated with it. @var{url} is either a | 208 | object and any MIME headers associated with it. @var{url} is either a |
| 209 | string or a parsed URL structure. Returns the buffer @var{url} will | 209 | string or a parsed URL structure. Returns the buffer @var{url} will |
| 210 | load into, or @code{nil} if the process has already completed. | 210 | load into, or @code{nil} if the process has already completed. |
| 211 | If the optional argument @var{silent} is non-@code{nil}, suppress | ||
| 212 | progress messages. If the optional argument @var{no-cookies} is | ||
| 213 | non-@code{nil}, do not store or send cookies. | ||
| 214 | @end defun | ||
| 215 | |||
| 216 | @vindex url-queue-parallel-processes | ||
| 217 | @vindex url-queue-timeout | ||
| 218 | @defun url-queue-retrieve url callback &optional cbargs silent no-cookies | ||
| 219 | This acts like the @code{url-retrieve} function, but with limits on | ||
| 220 | the degree of parallelism. The option @code{url-queue-parallel-processes} | ||
| 221 | controls the number of concurrent processes, and the option | ||
| 222 | @code{url-queue-timeout} sets a timeout in seconds. | ||
| 211 | @end defun | 223 | @end defun |
| 212 | 224 | ||
| 213 | @node Supported URL Types | 225 | @node Supported URL Types |
| @@ -216,7 +228,7 @@ load into, or @code{nil} if the process has already completed. | |||
| 216 | @menu | 228 | @menu |
| 217 | * http/https:: Hypertext Transfer Protocol. | 229 | * http/https:: Hypertext Transfer Protocol. |
| 218 | * file/ftp:: Local files and FTP archives. | 230 | * file/ftp:: Local files and FTP archives. |
| 219 | * info:: Emacs `Info' pages. | 231 | * info:: Emacs "Info" pages. |
| 220 | * mailto:: Sending email. | 232 | * mailto:: Sending email. |
| 221 | * news/nntp/snews:: Usenet news. | 233 | * news/nntp/snews:: Usenet news. |
| 222 | * rlogin/telnet/tn3270:: Remote host connectivity. | 234 | * rlogin/telnet/tn3270:: Remote host connectivity. |
| @@ -460,7 +472,7 @@ The form of a mailto URL is | |||
| 460 | @var{header} is @samp{body}, then @var{contents} is put in the body | 472 | @var{header} is @samp{body}, then @var{contents} is put in the body |
| 461 | otherwise a @var{header} header field is created with @var{contents} | 473 | otherwise a @var{header} header field is created with @var{contents} |
| 462 | as its contents. Note that the URL library does not consider any | 474 | as its contents. Note that the URL library does not consider any |
| 463 | headers `dangerous' so you should check them before sending the | 475 | headers ``dangerous'' so you should check them before sending the |
| 464 | message. | 476 | message. |
| 465 | 477 | ||
| 466 | @c Fixme: update | 478 | @c Fixme: update |
| @@ -997,7 +1009,7 @@ This the @samp{nslookup} program. It is @code{"nslookup"} by default. | |||
| 997 | In some circumstances it is desirable to suppress making network | 1009 | In some circumstances it is desirable to suppress making network |
| 998 | connections. A typical case is when rendering HTML in a mail user | 1010 | connections. A typical case is when rendering HTML in a mail user |
| 999 | agent, when external URLs should not be activated, particularly to | 1011 | agent, when external URLs should not be activated, particularly to |
| 1000 | avoid `bugs' which `call home' by fetch single-pixel images and the | 1012 | avoid ``bugs'' which ``call home'' by fetch single-pixel images and the |
| 1001 | like. To arrange this, bind the following variable for the duration | 1013 | like. To arrange this, bind the following variable for the duration |
| 1002 | of such processing. | 1014 | of such processing. |
| 1003 | 1015 | ||
| @@ -1050,7 +1062,7 @@ automatically via @code{url-do-setup} when it is configured to be on. | |||
| 1050 | Note that the size of the history list is currently not limited. | 1062 | Note that the size of the history list is currently not limited. |
| 1051 | 1063 | ||
| 1052 | @vindex url-history-hash-table | 1064 | @vindex url-history-hash-table |
| 1053 | The history `list' is actually a hash table, | 1065 | The history ``list'' is actually a hash table, |
| 1054 | @code{url-history-hash-table}. It contains access times keyed by URL | 1066 | @code{url-history-hash-table}. It contains access times keyed by URL |
| 1055 | strings. The times are in the format returned by @code{current-time}. | 1067 | strings. The times are in the format returned by @code{current-time}. |
| 1056 | 1068 | ||