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