annotate doc/misc/url.texi @ 112432:27320025ed54

Merge chages made in Gnus trunk. mailcap.el (mailcap-mime-extensions): Rename text/org to text/x-org. gnus-draft.el (gnus-group-send-queue): Update the queue group in the group buffer after sending the queue. gnus-draft.el (gnus-group-send-queue): Really refresh the queue group after sending. gnus-agent.el (gnus-agent-send-mail): Ditto. gnus-group.el (gnus-group-refresh-group): New convenience function. message.el (message-bogus-addresses): Remove commented-out value. message.el (message-check-recipients): Display the encoded version of the bogus address if they differ. flow-fill.el (fill-flowed): Make `delete-space' option correspond to "DelSp" parameter in RFC3676. gnus-sum.el (gnus-summary-move-article): Protect against backends (i.e., nnimap) returning nil as the article number.
author Katsumi Yamaoka <yamaoka@jpl.org>
date Sun, 23 Jan 2011 00:34:08 +0000
parents ef719132ddfa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 \input texinfo
84329
3d431f1997d8 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84321
diff changeset
2 @setfilename ../../info/url
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @settitle URL Programmer's Manual
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @iftex
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 @c @finalout
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @end iftex
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @c @setchapternewpage odd
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @c @smallbook
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @tex
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 \overfullrule=0pt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 %\global\baselineskip 30pt % for printing in double space
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 @end tex
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 @dircategory World Wide Web
102059
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
16 @dircategory Emacs
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 @direntry
109274
a91e94388547 Minor doc/misc/*.texi direntry fixes.
Glenn Morris <rgm@gnu.org>
parents: 108366
diff changeset
18 * URL: (url). URL loading package.
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 @end direntry
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20
95935
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
21 @copying
102059
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
22 This file documents the Emacs Lisp URL loading package.
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 Copyright @copyright{} 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2002,
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 109274
diff changeset
25 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26
95935
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
27 @quotation
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 Permission is granted to copy, distribute and/or modify this document
99709
6de181810d0f Relicense all texi files under FDL 1.3 or later.
Glenn Morris <rgm@gnu.org>
parents: 96451
diff changeset
29 under the terms of the GNU Free Documentation License, Version 1.3 or
95935
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
30 any later version published by the Free Software Foundation; with no
95981
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 95935
diff changeset
31 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 95935
diff changeset
32 and with the Back-Cover Texts as in (a) below. A copy of the license
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 95935
diff changeset
33 is included in the section entitled ``GNU Free Documentation License''.
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 95935
diff changeset
34
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 95935
diff changeset
35 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 95935
diff changeset
36 modify this GNU manual. Buying copies from the FSF supports it in
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 95935
diff changeset
37 developing GNU and promoting software freedom.''
95935
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
38 @end quotation
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
39 @end copying
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 @c
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 @titlepage
95935
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
43 @title URL Programmer's Manual
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
44 @subtitle First Edition, URL Version 2.0
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
45 @author William M. Perry @email{wmperry@@gnu.org}
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
46 @author David Love @email{fx@@gnu.org}
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 @page
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 @vskip 0pt plus 1filll
95935
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
49 @insertcopying
ef5e07e42359 Use @copying, @title, @subtitle, @author.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
50 @end titlepage
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51
102059
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
52 @contents
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
53
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 @node Top
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 @top URL
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56
102059
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
57 @ifnottex
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
58 @insertcopying
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
59 @end ifnottex
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 @menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 * Getting Started:: Preparing your program to use URLs.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 * Retrieving URLs:: How to use this package to retrieve a URL.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 * Supported URL Types:: Descriptions of URL types currently supported.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 * Defining New URLs:: How to define a URL loader for a new protocol.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 * General Facilities:: URLs can be cached, accessed via a gateway
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 and tracked in a history list.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 * Customization:: Variables you can alter.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 * GNU Free Documentation License:: The license for this documentation.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 * Function Index::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 * Variable Index::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 * Concept Index::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 @end menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 @node Getting Started
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 @chapter Getting Started
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 @cindex URLs, definition
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 @cindex URIs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 @dfn{Uniform Resource Locators} (URLs) are a specific form of
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 @dfn{Uniform Resource Identifiers} (URI) described in RFC 2396 which
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 updates RFC 1738 and RFC 1808. RFC 2016 defines uniform resource
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 agents.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 URIs have the form @var{scheme}:@var{scheme-specific-part}, where the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 @var{scheme}s supported by this library are described below.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 @xref{Supported URL Types}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 FTP, NFS, HTTP, HTTPS, @code{rlogin}, @code{telnet}, tn3270,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 IRC and gopher URLs all have the form
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 @var{scheme}://@r{[}@var{userinfo}@@@r{]}@var{hostname}@r{[}:@var{port}@r{]}@r{[}/@var{path}@r{]}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 @noindent
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 where @samp{@r{[}} and @samp{@r{]}} delimit optional parts.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 @var{userinfo} sometimes takes the form @var{username}:@var{password}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 but you should beware of the security risks of sending cleartext
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 passwords. @var{hostname} may be a domain name or a dotted decimal
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 address. If the @samp{:@var{port}} is omitted then the library will
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 use the `well known' port for that service when accessing URLs. With
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 the possible exception of @code{telnet}, it is rare for ports to be
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 specified, and it is possible using a non-standard port may have
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 undesired consequences if a different service is listening on that
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 port (e.g., an HTTP URL specifying the SMTP port can cause mail to be
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 sent). @c , but @xref{Other Variables, url-bad-port-list}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 The meaning of the @var{path} component depends on the service.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 @menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 * Configuration::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 * Parsed URLs:: URLs are parsed into vector structures.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 @end menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 @node Configuration
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 @section Configuration
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 @defvar url-configuration-directory
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 @cindex @file{~/.url}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 @cindex configuration files
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 The directory in which URL configuration files, the cache etc.,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 reside. Default @file{~/.url}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 @end defvar
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 @node Parsed URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 @section Parsed URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 @cindex parsed URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 The library functions typically operate on @dfn{parsed} versions of
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 URLs. These are actually vectors of the form:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 [@var{type} @var{user} @var{password} @var{host} @var{port} @var{file} @var{target} @var{attributes} @var{full}]
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 @noindent where
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 @table @var
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 @item type
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 is the type of the URL scheme, e.g., @code{http}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 @item user
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 is the username associated with it, or @code{nil};
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 @item password
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 is the user password associated with it, or @code{nil};
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 @item host
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 is the host name associated with it, or @code{nil};
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @item port
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 is the port number associated with it, or @code{nil};
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 @item file
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 is the `file' part of it, or @code{nil}. This doesn't necessarily
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 actually refer to a file;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 @item target
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 is the target part, or @code{nil};
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @item attributes
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 is the attributes associated with it, or @code{nil};
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @item full
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 is @code{t} for a fully-specified URL, with a host part indicated by
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 @samp{//} after the scheme part.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 @end table
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 @findex url-type
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 @findex url-user
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 @findex url-password
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 @findex url-host
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 @findex url-port
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 @findex url-file
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164 @findex url-target
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 @findex url-attributes
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 @findex url-full
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 @findex url-set-type
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 @findex url-set-user
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 @findex url-set-password
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 @findex url-set-host
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 @findex url-set-port
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 @findex url-set-file
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 @findex url-set-target
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 @findex url-set-attributes
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175 @findex url-set-full
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 These attributes have accessors named @code{url-@var{part}}, where
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 @var{part} is the name of one of the elements above, e.g.,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 @code{url-host}. Similarly, there are setters of the form
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 @code{url-set-@var{part}}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 There are functions for parsing and unparsing between the string and
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 vector forms.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 @defun url-generic-parse-url url
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 Return a parsed version of the string @var{url}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 @defun url-recreate-url url
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 @cindex unparsing URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 Recreates a URL string from the parsed @var{url}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 @node Retrieving URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 @chapter Retrieving URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 @defun url-retrieve-synchronously url
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 Retrieve @var{url} synchronously and return a buffer containing the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 data. @var{url} is either a string or a parsed URL structure. Return
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 @code{nil} if there are no data associated with it (the case for dired,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 info, or mailto URLs that need no further processing).
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 @defun url-retrieve url callback &optional cbargs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 Retrieve @var{url} asynchronously and call @var{callback} with args
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 @var{cbargs} when finished. The callback is called when the object
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 has been completely retrieved, with the current buffer containing the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 object and any MIME headers associated with it. @var{url} is either a
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 string or a parsed URL structure. Returns the buffer @var{url} will
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 load into, or @code{nil} if the process has already completed.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 @node Supported URL Types
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 @chapter Supported URL Types
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 @menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 * http/https:: Hypertext Transfer Protocol.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 * file/ftp:: Local files and FTP archives.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 * info:: Emacs `Info' pages.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 * mailto:: Sending email.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 * news/nntp/snews:: Usenet news.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 * rlogin/telnet/tn3270:: Remote host connectivity.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 * irc:: Internet Relay Chat.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 * data:: Embedded data URLs.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 * nfs:: Networked File System
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 @c * finger::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 @c * gopher::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 @c * netrek::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 @c * prospero::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 * cid:: Content-ID.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 * about::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 * ldap:: Lightweight Directory Access Protocol
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 * imap:: IMAP mailboxes.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 * man:: Unix man pages.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 @end menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 @node http/https
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 @section @code{http} and @code{https}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 The scheme @code{http} is Hypertext Transfer Protocol. The library
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 supports version 1.1, specified in RFC 2616. (This supersedes 1.0,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 defined in RFC 1945) HTTP URLs have the following form, where most of
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 the parts are optional:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 http://@var{user}:@var{password}@@@var{host}:@var{port}/@var{path}?@var{searchpart}#@var{fragment}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 @c The @code{:@var{port}} part is optional, and @var{port} defaults to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 @c 80. The @code{/@var{path}} part, if present, is a slash-separated
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 @c series elements. The @code{?@var{searchpart}}, if present, is the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 @c query for a search or the content of a form submission. The
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 @c @code{#fragment} part, if present, is a location in the document.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 The scheme @code{https} is a secure version of @code{http}, with
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 transmission via SSL. It is defined in RFC 2069. Its default port is
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 443. This scheme depends on SSL support in Emacs via the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 @file{ssl.el} library and is actually implemented by forcing the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 @code{ssl} gateway method to be used. @xref{Gateways in general}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 @defopt url-honor-refresh-requests
96451
2f876106ada2 American English spelling fix.
Glenn Morris <rgm@gnu.org>
parents: 95981
diff changeset
259 This controls honoring of HTTP @samp{Refresh} headers by which
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 servers can direct clients to reload documents from the same URL or a
96451
2f876106ada2 American English spelling fix.
Glenn Morris <rgm@gnu.org>
parents: 95981
diff changeset
261 or different one. @code{nil} means they will not be honored,
2f876106ada2 American English spelling fix.
Glenn Morris <rgm@gnu.org>
parents: 95981
diff changeset
262 @code{t} (the default) means they will always be honored, and
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 otherwise the user will be asked on each request.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 @menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 * Cookies::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 * HTTP language/coding::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 * HTTP URL Options::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 * Dealing with HTTP documents::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 @end menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 @node Cookies
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 @subsection Cookies
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 @defopt url-cookie-file
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 The file in which cookies are stored, defaulting to @file{cookies} in
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 the directory specified by @code{url-configuration-directory}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 @defopt url-cookie-confirmation
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 Specifies whether confirmation is require to accept cookies.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 @defopt url-cookie-multiple-line
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 Specifies whether to put all cookies for the server on one line in the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 HTTP request to satisfy broken servers like
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 @url{http://www.hotmail.com}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @defopt url-cookie-trusted-urls
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 A list of regular expressions matching URLs from which to accept
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 cookies always.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 @defopt url-cookie-untrusted-urls
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 A list of regular expressions matching URLs from which to reject
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 cookies always.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 @defopt url-cookie-save-interval
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 The number of seconds between automatic saves of cookies to disk.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 Default is one hour.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 @node HTTP language/coding
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 @subsection Language and Encoding Preferences
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 HTTP allows clients to express preferences for the language and
96451
2f876106ada2 American English spelling fix.
Glenn Morris <rgm@gnu.org>
parents: 95981
diff changeset
312 encoding of documents which servers may honor. For each of these
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 variables, the value is a string; it can specify a single choice, or
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 it can be a comma-separated list.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315
108366
e2da1d33db95 Fix typos (Bug#6094). From tpn Nmec.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
316 Normally, this list is ordered by descending preference. However, each
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 element can be followed by @samp{;q=@var{priority}} to specify its
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 preference level, a decimal number from 0 to 1; e.g., for
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 @code{url-mime-language-string}, @w{@code{"de, en-gb;q=0.8,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 en;q=0.7"}}. An element that has no @samp{;q} specification has
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 preference level 1.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 @defopt url-mime-charset-string
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 @cindex character sets
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 @cindex coding systems
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 This variable specifies a preference for character sets when documents
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 can be served in more than one encoding.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 HTTP allows specifying a series of MIME charsets which indicate your
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 preferred character set encodings, e.g., Latin-9 or Big5, and these
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 can be weighted. The default series is generated automatically from
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 the associated MIME types of all defined coding systems, sorted by the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 coding system priority specified in Emacs. @xref{Recognize Coding, ,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 Recognizing Coding Systems, emacs, The GNU Emacs Manual}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 @defopt url-mime-language-string
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 @cindex language preferences
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 A string specifying the preferred language when servers can serve
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 files in several languages. Use RFC 1766 abbreviations, e.g.,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 @samp{en} for English, @samp{de} for German.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 The string can be @code{"*"} to get the first available language (as
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 opposed to the default).
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 @node HTTP URL Options
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 @subsection HTTP URL Options
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 HTTP supports an @samp{OPTIONS} method describing things supported by
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 the URL@.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 @defun url-http-options url
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 Returns a property list describing options available for URL. The
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 property list members are:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 @table @code
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 @item methods
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 A list of symbols specifying what HTTP methods the resource
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 supports.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 @item dav
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 @cindex DAV
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 A list of numbers specifying what DAV protocol/schema versions are
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 supported.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 @item dasl
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 @cindex DASL
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 A list of supported DASL search types supported (string form).
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 @item ranges
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 A list of the units available for use in partial document fetches.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 @item p3p
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 @cindex P3P
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 The @dfn{Platform For Privacy Protection} description for the resource.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 Currently this is just the raw header contents.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 @end table
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 @node Dealing with HTTP documents
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 @subsection Dealing with HTTP documents
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 HTTP URLs are retrieved into a buffer containing the HTTP headers
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 followed by the body. Since the headers are quasi-MIME, they may be
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 processed using the MIME library. @xref{Top,, Emacs MIME,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 emacs-mime, The Emacs MIME Manual}. The URL package provides a
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 function to do this in general:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 @defun url-decode-text-part handle &optional coding
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 This function decodes charset-encoded text in the current buffer. In
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 Emacs, the buffer is expected to be unibyte initially and is set to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 multibyte after decoding.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 HANDLE is the MIME handle of the original part. CODING is an explicit
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 coding to use, overriding what the MIME headers specify.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 The coding system used for the decoding is returned.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 Note that this function doesn't deal with @samp{http-equiv} charset
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 specifications in HTML @samp{<meta>} elements.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 @node file/ftp
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 @section file and ftp
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 @cindex files
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 @cindex FTP
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 @cindex File Transfer Protocol
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 @cindex compressed files
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 @cindex dired
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 ftp://@var{user}:@var{password}@@@var{host}:@var{port}/@var{file}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 file://@var{user}:@var{password}@@@var{host}:@var{port}/@var{file}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 These schemes are defined in RFC 1808.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 @samp{ftp:} and @samp{file:} are synonymous in this library. They
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 allow reading arbitrary files from hosts. Either @samp{ange-ftp}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 (Emacs) or @samp{efs} (XEmacs) is used to retrieve them from remote
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 hosts. Local files are accessed directly.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 Compressed files are handled, but support is hard-coded so that
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 @code{jka-compr-compression-info-list} and so on have no affect.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 Suffixes recognized are @samp{.z}, @samp{.gz}, @samp{.Z} and
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 @samp{.bz2}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 @defopt url-directory-index-file
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 The filename to look for when indexing a directory, default
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 @samp{"index.html"}. If this file exists, and is readable, then it
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 will be viewed instead of using @code{dired} to view the directory.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 @node info
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 @section info
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 @cindex Info
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 @cindex Texinfo
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 @findex Info-goto-node
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 info:@var{file}#@var{node}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 Info URLs are not officially defined. They invoke
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 @code{Info-goto-node} with argument @samp{(@var{file})@var{node}}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 @samp{#@var{node}} is optional, defaulting to @samp{Top}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 @node mailto
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 @section mailto
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 @cindex mailto
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 @cindex email
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 A mailto URL will send an email message to the address in the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 URL, for example @samp{mailto:foo@@bar.com} would compose a
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 message to @samp{foo@@bar.com}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 @defopt url-mail-command
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 @vindex mail-user-agent
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 The function called whenever url needs to send mail. This should
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 normally be left to default from @var{mail-user-agent}. @xref{Mail
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 Methods, , Mail-Composition Methods, emacs, The GNU Emacs Manual}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 An @samp{X-Url-From} header field containing the URL of the document
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 that contained the mailto URL is added if that URL is known.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 RFC 2368 extends the definition of mailto URLs in RFC 1738.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 The form of a mailto URL is
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 @samp{mailto:@var{mailbox}[?@var{header}=@var{contents}[&@var{header}=@var{contents}]]}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 @noindent where an arbitrary number of @var{header}s can be added. If the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @var{header} is @samp{body}, then @var{contents} is put in the body
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 otherwise a @var{header} header field is created with @var{contents}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 as its contents. Note that the URL library does not consider any
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 headers `dangerous' so you should check them before sending the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 message.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 @c Fixme: update
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 Email messages are defined in @sc{rfc}822.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @node news/nntp/snews
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 @section @code{news}, @code{nntp} and @code{snews}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 @cindex news
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 @cindex network news
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 @cindex usenet
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 @cindex NNTP
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 @cindex snews
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 @c draft-gilman-news-url-01
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 The network news URL scheme take the following forms following RFC
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 1738 except that for compatibility with other clients, host and port
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 fields may be included in news URLs though they are properly only
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 allowed for nntp an snews.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 @table @samp
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 @item news:@var{newsgroup}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 Retrieves a list of messages in @var{newsgroup};
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 @item news:@var{message-id}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 Retrieves the message with the given @var{message-id};
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 @item news:*
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 Retrieves a list of all available newsgroups;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 @item nntp://@var{host}:@var{port}/@var{newsgroup}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 @itemx nntp://@var{host}:@var{port}/@var{message-id}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 @itemx nntp://@var{host}:@var{port}/*
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 Similar to the @samp{news} versions.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 @end table
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 @samp{:@var{port}} is optional and defaults to :119.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @samp{snews} is the same as @samp{nntp} except that the default port
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 is :563.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 @cindex SSL
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 (It is tunneled through SSL.)
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 An @samp{nntp} URL is the same as a news URL, except that the URL may
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 specify an article by its number.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 @defopt url-news-server
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 This variable can be used to override the default news server.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 Usually this will be set by the Gnus package, which is used to fetch
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 news.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 @cindex environment variable
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 @vindex NNTPSERVER
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 It may be set from the conventional environment variable
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 @code{NNTPSERVER}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 @node rlogin/telnet/tn3270
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529 @section rlogin, telnet and tn3270
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 @cindex rlogin
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 @cindex telnet
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 @cindex tn3270
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 @cindex terminal emulation
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 @findex terminal-emulator
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 These URL schemes from RFC 1738 for logon via a terminal emulator have
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 the form
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 telnet://@var{user}:@var{password}@@@var{host}:@var{port}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 but the @code{:@var{password}} component is ignored.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 To handle rlogin, telnet and tn3270 URLs, a @code{rlogin},
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 @code{telnet} or @code{tn3270} (the program names and arguments are
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 hardcoded) session is run in a @code{terminal-emulator} buffer.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 Well-known ports are used if the URL does not specify a port.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 @node irc
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 @section irc
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 @cindex IRC
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 @cindex Internet Relay Chat
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 @cindex ZEN IRC
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 @cindex ERC
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 @cindex rcirc
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 @c Fixme: reference (was http://www.w3.org/Addressing/draft-mirashi-url-irc-01.txt)
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 @dfn{Internet Relay Chat} (IRC) is handled by handing off the @sc{irc}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 session to a function named in @code{url-irc-function}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 @defopt url-irc-function
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 A function to actually open an IRC connection.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 This function
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 must take five arguments, @var{host}, @var{port}, @var{channel},
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 @var{user} and @var{password}. The @var{channel} argument specifies the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 channel to join immediately, this can be @code{nil}. By default this is
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @code{url-irc-rcirc}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 @defun url-irc-rcirc host port channel user password
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 Processes the arguments and lets @code{rcirc} handle the session.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 @defun url-irc-erc host port channel user password
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 Processes the arguments and lets @code{ERC} handle the session.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 @defun url-irc-zenirc host port channel user password
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 Processes the arguments and lets @code{zenirc} handle the session.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 @node data
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 @section data
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 @cindex data URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 data:@r{[}@var{media-type}@r{]}@r{[};@var{base64}@r{]},@var{data}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 Data URLs contain MIME data in the URL itself. They are defined in
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 RFC 2397.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 @var{media-type} is a MIME @samp{Content-Type} string, possibly
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 including parameters. It defaults to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 @samp{text/plain;charset=US-ASCII}. The @samp{text/plain} can be
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 omitted but the charset parameter supplied. If @samp{;base64} is
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 present, the @var{data} are base64-encoded.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 @node nfs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 @section nfs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 @cindex NFS
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 @cindex Network File System
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 @cindex automounter
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 nfs://@var{user}:@var{password}@@@var{host}:@var{port}/@var{file}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 The @samp{nfs:} scheme is defined in RFC 2224. It is similar to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 @samp{ftp:} except that it points to a file on a remote host that is
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 handled by the automounter on the local host.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 @defvar url-nfs-automounter-directory-spec
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 @end defvar
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 A string saying how to invoke the NFS automounter. Certain @samp{%}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 sequences are recognized:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 @table @samp
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 @item %h
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 The hostname of the NFS server;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 @item %n
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 The port number of the NFS server;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 @item %u
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 The username to use to authenticate;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 @item %p
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 The password to use to authenticate;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 @item %f
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 The filename on the remote server;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 @item %%
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 A literal @samp{%}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 @end table
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 Each can be used any number of times.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 @node cid
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 @section cid
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 @cindex Content-ID
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 RFC 2111
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 @node about
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 @section about
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 @node ldap
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 @section ldap
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 @cindex LDAP
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 @cindex Lightweight Directory Access Protocol
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 The LDAP scheme is defined in RFC 2255.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 @node imap
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 @section imap
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 @cindex IMAP
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 RFC 2192
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 @node man
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 @section man
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 @cindex @command{man}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 @cindex Unix man pages
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 @findex man
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 @samp{man:@var{page-spec}}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 This is a non-standard scheme. @var{page-spec} is passed directly to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 the Lisp @code{man} function.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 @node Defining New URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 @chapter Defining New URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 @menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 * Naming conventions::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 * Required functions::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 * Optional functions::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 * Asynchronous fetching::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 * Supporting file-name-handlers::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 @end menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 @node Naming conventions
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 @section Naming conventions
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 @node Required functions
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 @section Required functions
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 @node Optional functions
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 @section Optional functions
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @node Asynchronous fetching
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 @section Asynchronous fetching
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 @node Supporting file-name-handlers
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 @section Supporting file-name-handlers
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 @node General Facilities
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 @chapter General Facilities
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 @menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 * Disk Caching::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 * Proxies::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 * Gateways in general::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 * History::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @end menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 @node Disk Caching
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 @section Disk Caching
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 @cindex Caching
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 @cindex Persistent Cache
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 @cindex Disk Cache
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 The disk cache stores retrieved documents locally, whence they can be
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 retrieved more quickly. When requesting a URL that is in the cache,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 the library checks to see if the page has changed since it was last
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 retrieved from the remote machine. If not, the local copy is used,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 saving the transmission over the network.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 @cindex Cleaning the cache
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 @cindex Clearing the cache
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 @cindex Cache cleaning
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 Currently the cache isn't cleared automatically.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 @c Running the @code{clean-cache} shell script
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 @c fist is recommended, to allow for future cleaning of the cache. This
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 @c shell script will remove all files that have not been accessed since it
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 @c was last run. To keep the cache pared down, it is recommended that this
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 @c script be run from @i{at} or @i{cron} (see the manual pages for
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 @c crontab(5) or at(1) for more information)
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @defopt url-automatic-caching
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 Setting this variable non-@code{nil} causes documents to be cached
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 automatically.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 @defopt url-cache-directory
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 This variable specifies the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 directory to store the cache files. It defaults to sub-directory
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 @file{cache} of @code{url-configuration-directory}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 @defopt url-cache-creation-function
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 The cache relies on a scheme for mapping URLs to files in the cache.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 This variable names a function which sets the type of cache to use.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 It takes a URL as argument and returns the absolute file name of the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 corresponding cache file. The two supplied possibilities are
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 @code{url-cache-create-filename-using-md5} and
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 @code{url-cache-create-filename-human-readable}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 @defun url-cache-create-filename-using-md5 url
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 Creates a cache file name from @var{url} using MD5 hashing.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 This is creates entries with very few cache collisions and is fast.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 @cindex MD5
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 @smallexample
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 (url-cache-create-filename-using-md5 "http://www.example.com/foo/bar")
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 @result{} "/home/fx/.url/cache/fx/http/com/example/www/b8a35774ad20db71c7c3409a5410e74f"
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 @end smallexample
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 @defun url-cache-create-filename-human-readable url
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 Creates a cache file name from @var{url} more obviously connected to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 @var{url} than for @code{url-cache-create-filename-using-md5}, but
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 more likely to conflict with other files.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 @smallexample
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 (url-cache-create-filename-human-readable "http://www.example.com/foo/bar")
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 @result{} "/home/fx/.url/cache/fx/http/com/example/www/foo/bar"
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 @end smallexample
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762
110535
eb986ca47c5a Minor url.texi update.
Glenn Morris <rgm@gnu.org>
parents: 109274
diff changeset
763 @defun url-cache-expired
110536
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
764 This function returns non-nil if a cache entry has expired (or is absent).
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
765 The arguments are a URL and optional expiration delay in seconds
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
766 (default @var{url-cache-expire-time}).
110535
eb986ca47c5a Minor url.texi update.
Glenn Morris <rgm@gnu.org>
parents: 109274
diff changeset
767 @end defun
eb986ca47c5a Minor url.texi update.
Glenn Morris <rgm@gnu.org>
parents: 109274
diff changeset
768
110536
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
769 @defopt url-cache-expire-time
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
770 This variable is the default number of seconds to use for the
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
771 expire-time argument of the function @code{url-cache-expired}.
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
772 @end defopt
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
773
110535
eb986ca47c5a Minor url.texi update.
Glenn Morris <rgm@gnu.org>
parents: 109274
diff changeset
774 @defun url-fetch-from-cache
110536
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
775 This function takes a URL as its argument and returns a buffer
4ee5521b7a45 * doc/misc/url.texi (Disk Caching): Tweak previous change.
Glenn Morris <rgm@gnu.org>
parents: 110535
diff changeset
776 containing the data cached for that URL.
110535
eb986ca47c5a Minor url.texi update.
Glenn Morris <rgm@gnu.org>
parents: 109274
diff changeset
777 @end defun
eb986ca47c5a Minor url.texi update.
Glenn Morris <rgm@gnu.org>
parents: 109274
diff changeset
778
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 @c Fixme: never actually used currently?
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @c @defopt url-standalone-mode
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 @c @cindex Relying on cache
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 @c @cindex Cache only mode
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 @c @cindex Standalone mode
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @c If this variable is non-@code{nil}, the library relies solely on the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 @c cache for fetching documents and avoids checking if they have changed
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @c on remote servers.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 @c @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 @c With a large cache of documents on the local disk, it can be very handy
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 @c when traveling, or any other time the network connection is not active
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 @c (a laptop with a dial-on-demand PPP connection, etc). Emacs/W3 can rely
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 @c solely on its cache, and avoid checking to see if the page has changed
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 @c on the remote server. In the case of a dial-on-demand PPP connection,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 @c this will keep the phone line free as long as possible, only bringing up
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 @c the PPP connection when asking for a page that is not located in the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 @c cache. This is very useful for demonstrations as well.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 @node Proxies
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 @section Proxies and Gatewaying
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 @c fixme: check/document url-ns stuff
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 @cindex proxy servers
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 @cindex proxies
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 @cindex environment variables
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 @vindex HTTP_PROXY
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 Proxy servers are commonly used to provide gateways through firewalls
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 or as caches serving some more-or-less local network. Each protocol
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 (HTTP, FTP, etc.)@: can have a different gateway server. Proxying is
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 conventionally configured commonly amongst different programs through
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 environment variables of the form @code{@var{protocol}_proxy}, where
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 @var{protocol} is one of the supported network protocols (@code{http},
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 @code{ftp} etc.). The library recognizes such variables in either
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 upper or lower case. Their values are of one of the forms:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 @itemize @bullet
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 @item @code{@var{host}:@var{port}}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 @item A full URL;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 @item Simply a host name.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 @end itemize
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 @vindex NO_PROXY
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 The @code{NO_PROXY} environment variable specifies URLs that should be
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 excluded from proxying (on servers that should be contacted directly).
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 This should be a comma-separated list of hostnames, domain names, or a
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 mixture of both. Asterisks can be used as wildcards, but other
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 clients may not support that. Domain names may be indicated by a
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 leading dot. For example:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 NO_PROXY="*.aventail.com,home.com,.seanet.com"
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 @noindent says to contact all machines in the @samp{aventail.com} and
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @samp{seanet.com} domains directly, as well as the machine named
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 @samp{home.com}. If @code{NO_PROXY} isn't defined, @code{no_PROXY}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 and @code{no_proxy} are also tried, in that order.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 Proxies may also be specified directly in Lisp.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 @defopt url-proxy-services
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 This variable is an alist of URL schemes and proxy servers that
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 gateway them. The items are of the form @w{@code{(@var{scheme}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 . @var{host}:@var{portnumber})}}, says that the URL @var{scheme} is
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 gatewayed through @var{portnumber} on the specified @var{host}. An
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 exception is the pseudo scheme @code{"no_proxy"}, which is paired with
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 a regexp matching host names not to be proxied. This variable is
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 initialized from the environment as above.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 (setq url-proxy-services
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 '(("http" . "proxy.aventail.com:80")
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 ("no_proxy" . "^.*\\(aventail\\|seanet\\)\\.com")))
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 @node Gateways in general
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 @section Gateways in General
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @cindex gateways
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 @cindex firewalls
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 The library provides a general gateway layer through which all
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 networking passes. It can both control access to the network and
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 provide access through gateways in firewalls. This may make direct
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 connections in some cases and pass through some sort of gateway in
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 others.@footnote{Proxies (which only operate over HTTP) are
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 implemented using this.} The library's basic function responsible for
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 making connections is @code{url-open-stream}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 @defun url-open-stream name buffer host service
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 @cindex opening a stream
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 @cindex stream, opening
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 Open a stream to @var{host}, possibly via a gateway. The other
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 arguments are as for @code{open-network-stream}. This will not make a
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 connection if @code{url-gateway-unplugged} is non-@code{nil}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 @defvar url-gateway-local-host-regexp
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 This is a regular expression that matches local hosts that do not
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 require the use of a gateway. If @code{nil}, all connections are made
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 through the gateway.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 @end defvar
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 @defvar url-gateway-method
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 This variable controls which gateway method is used. It may be useful
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 to bind it temporarily in some applications. It has values taken from
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 a list of symbols. Possible values are:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 @table @code
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 @item telnet
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 @cindex @command{telnet}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 Use this method if you must first telnet and log into a gateway host,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 and then run telnet from that host to connect to outside machines.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 @item rlogin
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 @cindex @command{rlogin}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 This method is identical to @code{telnet}, but uses @command{rlogin}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 to log into the remote machine without having to send the username and
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 password over the wire every time.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 @item socks
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 @cindex @sc{socks}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 Use if the firewall has a @sc{socks} gateway running on it. The
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 @sc{socks} v5 protocol is defined in RFC 1928.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 @c @item ssl
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 @c This probably shouldn't be documented
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 @c Fixme: why not? -- fx
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @item native
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 This method uses Emacs's builtin networking directly. This is the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 default. It can be used only if there is no firewall blocking access.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 @end table
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 @end defvar
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 The following variables control the gateway methods.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 @defopt url-gateway-telnet-host
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 The gateway host to telnet to. Once logged in there, you then telnet
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 out to the hosts you want to connect to.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 @defopt url-gateway-telnet-parameters
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 This should be a list of parameters to pass to the @command{telnet} program.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 @defopt url-gateway-telnet-password-prompt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 This is a regular expression that matches the password prompt when
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 logging in.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 @defopt url-gateway-telnet-login-prompt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 This is a regular expression that matches the username prompt when
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 logging in.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 @defopt url-gateway-telnet-user-name
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 The username to log in with.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 @defopt url-gateway-telnet-password
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 The password to send when logging in.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 @defopt url-gateway-prompt-pattern
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 This is a regular expression that matches the shell prompt.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 @defopt url-gateway-rlogin-host
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 Host to @samp{rlogin} to before telnetting out.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 @defopt url-gateway-rlogin-parameters
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 Parameters to pass to @samp{rsh}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 @defopt url-gateway-rlogin-user-name
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 User name to use when logging in to the gateway.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 @defopt url-gateway-prompt-pattern
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 This is a regular expression that matches the shell prompt.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 @defopt socks-server
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 This specifies the default server, it takes the form
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 @w{@code{("Default server" @var{server} @var{port} @var{version})}}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 where @var{version} can be either 4 or 5.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 @defvar socks-password
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 If this is @code{nil} then you will be asked for the password,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 otherwise it will be used as the password for authenticating you to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 the @sc{socks} server.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 @end defvar
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 @defvar socks-username
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 This is the username to use when authenticating yourself to the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 @sc{socks} server. By default this is your login name.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 @end defvar
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 @defvar socks-timeout
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 This controls how long, in seconds, to wait for responses from the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 @sc{socks} server; it is 5 by default.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 @end defvar
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @c fixme: these have been effectively commented-out in the code
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 @c @defopt socks-server-aliases
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972 @c This a list of server aliases. It is a list of aliases of the form
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 @c @var{(alias hostname port version)}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 @c @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 @c @defopt socks-network-aliases
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 @c This a list of network aliases. Each entry in the list takes the form
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 @c @var{(alias (network))} where @var{alias} is a string that names the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 @c @var{network}. The networks can contain a pair (not a dotted pair) of
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 @c @sc{ip} addresses which specify a range of @sc{ip} addresses, an @sc{ip}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @c address and a netmask, a domain name or a unique hostname or @sc{ip}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 @c address.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @c @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 @c @defopt socks-redirection-rules
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 @c This a list of redirection rules. Each rule take the form
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 @c @var{(Destination network Connection type)} where @var{Destination
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 @c network} is a network alias from @code{socks-network-aliases} and
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 @c @var{Connection type} can be @code{nil} in which case a direct
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 @c connection is used, or it can be an alias from
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 @c @code{socks-server-aliases} in which case that server is used as a
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 @c proxy.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 @c @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 @defopt socks-nslookup-program
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 @cindex @command{nslookup}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 This the @samp{nslookup} program. It is @code{"nslookup"} by default.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 @menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 * Suppressing network connections::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 @end menu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 @c * Broken hostname resolution::
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 @node Suppressing network connections
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 @subsection Suppressing Network Connections
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 @cindex network connections, suppressing
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 @cindex suppressing network connections
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 @cindex bugs, HTML
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 @cindex HTML `bugs'
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 In some circumstances it is desirable to suppress making network
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 connections. A typical case is when rendering HTML in a mail user
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 agent, when external URLs should not be activated, particularly to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 avoid `bugs' which `call home' by fetch single-pixel images and the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 like. To arrange this, bind the following variable for the duration
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 of such processing.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 @defvar url-gateway-unplugged
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 If this variable is non-@code{nil} new network connections are never
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 opened by the URL library.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 @end defvar
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @c @node Broken hostname resolution
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 @c @subsection Broken Hostname Resolution
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 @c @cindex hostname resolver
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 @c @cindex resolver, hostname
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 @c Some C libraries do not include the hostname resolver routines in
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 @c their static libraries. If Emacs was linked statically, and was not
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 @c linked with the resolver libraries, it will not be able to get to any
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 @c machines off the local network. This is characterized by being able
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 @c to reach someplace with a raw ip number, but not its hostname
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 @c (@url{http://129.79.254.191/} works, but
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 @c @url{http://www.cs.indiana.edu/} doesn't). This used to happen on
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 @c SunOS4 and Ultrix, but is now probably now rare. If Emacs can't be
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 @c rebuilt linked against the resolver library, it can use the external
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 @c @command{nslookup} program instead.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 @c @defopt url-gateway-broken-resolution
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 @c @cindex @code{nslookup} program
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 @c @cindex program, @code{nslookup}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 @c If non-@code{nil}, this variable says to use the program specified by
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 @c @code{url-gateway-nslookup-program} program to do hostname resolution.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 @c @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 @c @defopt url-gateway-nslookup-program
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 @c The name of the program to do hostname lookup if Emacs can't do it
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 @c directly. This program should expect a single argument on the command
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 @c line---the hostname to resolve---and should produce output similar to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 @c the standard Unix @command{nslookup} program:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 @c @example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 @c Name: www.cs.indiana.edu
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 @c Address: 129.79.254.191
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @c @end example
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 @c @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @node History
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 @section History
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058 @findex url-do-setup
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 The library can maintain a global history list tracking URLs accessed.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 URL completion can be done from it. The history mechanism is set up
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 automatically via @code{url-do-setup} when it is configured to be on.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 Note that the size of the history list is currently not limited.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 @vindex url-history-hash-table
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 The history `list' is actually a hash table,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 @code{url-history-hash-table}. It contains access times keyed by URL
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 strings. The times are in the format returned by @code{current-time}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 @defun url-history-update-url url time
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 This function updates the history table with an entry for @var{url}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 accessed at the given @var{time}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 @defopt url-history-track
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 If non-@code{nil}, the library will keep track of all the URLs
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 accessed. If it is @code{t}, the list is saved to disk at the end of
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 each Emacs session. The default is @code{nil}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 @defopt url-history-file
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 The file storing the history list between sessions. It defaults to
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 @file{history} in @code{url-configuration-directory}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 @defopt url-history-save-interval
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 @findex url-history-setup-save-timer
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 The number of seconds between automatic saves of the history list.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 Default is one hour. Note that if you change this variable directly,
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 rather than using Custom, after @code{url-do-setup} has been run, you
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 need to run the function @code{url-history-setup-save-timer}.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 @defun url-history-parse-history &optional fname
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 Parses the history file @var{fname} (default @code{url-history-file})
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 and sets up the history list.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 @defun url-history-save-history &optional fname
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 Saves the current history to file @var{fname} (default
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 @code{url-history-file}).
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 @defun url-completion-function string predicate function
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 You can use this function to do completion of URLs from the history.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 @end defun
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 @node Customization
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 @chapter Customization
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 @section Environment Variables
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 @cindex environment variables
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 The following environment variables affect the library's operation at
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 startup.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 @table @code
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 @item TMPDIR
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 @vindex TMPDIR
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 @vindex url-temporary-directory
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 If this is defined, @var{url-temporary-directory} is initialized from
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 it.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 @end table
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 @section General User Options
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 The following user options, settable with Customize, affect the
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 general operation of the package.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 @defopt url-debug
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 @cindex debugging
108366
e2da1d33db95 Fix typos (Bug#6094). From tpn Nmec.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
1131 Specifies the types of debug messages which are logged to
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 the @code{*URL-DEBUG*} buffer.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 @code{t} means log all messages.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 A number means log all messages and show them with @code{message}.
108366
e2da1d33db95 Fix typos (Bug#6094). From tpn Nmec.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
1135 It may also be a list of the types of messages to be logged.
84321
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 @defopt url-personal-mail-address
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 @defopt url-privacy-level
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 @defopt url-uncompressor-alist
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 @defopt url-passwd-entry-func
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 @defopt url-standalone-mode
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 @defopt url-bad-port-list
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 @defopt url-max-password-attempts
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 @defopt url-temporary-directory
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 @defopt url-show-status
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 @defopt url-confirmation-func
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 The function to use for asking yes or no functions. This is normally
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 either @code{y-or-n-p} or @code{yes-or-no-p}, but could be another
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 function taking a single argument (the prompt) and returning @code{t}
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 only if an affirmative answer is given.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 @defopt url-gateway-method
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @c fixme: describe gatewaying
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 A symbol specifying the type of gateway support to use for connections
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 from the local machine. The supported methods are:
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 @table @code
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 @item telnet
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 Run telnet in a subprocess to connect;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169 @item rlogin
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 Rlogin to another machine to connect;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 @item socks
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 Connect through a socks server;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 @item ssl
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 Connect with SSL;
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 @item native
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 Connect directly.
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 @end table
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 @end defopt
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 @node GNU Free Documentation License
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 @appendix GNU Free Documentation License
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 @include doclicense.texi
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 @node Function Index
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 @unnumbered Command and Function Index
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 @printindex fn
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 @node Variable Index
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 @unnumbered Variable Index
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 @printindex vr
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 @node Concept Index
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 @unnumbered Concept Index
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 @printindex cp
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195
46a18ad74c29 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 @bye