|
0
|
1 \input texinfo
|
|
80
|
2 @setfilename w3.info
|
|
70
|
3 @settitle Emacs-W3 User's Manual
|
|
0
|
4 @iftex
|
|
|
5 @finalout
|
|
|
6 @end iftex
|
|
|
7 @c @setchapternewpage odd
|
|
|
8 @c @smallbook
|
|
|
9 @tex
|
|
|
10 \overfullrule=0pt
|
|
|
11 %\global\baselineskip 30pt % for printing in double space
|
|
|
12 @end tex
|
|
|
13 @synindex cp fn
|
|
|
14 @synindex vr fn
|
|
|
15 @ifinfo
|
|
70
|
16 This file documents the Emacs-W3 World Wide Web browser.
|
|
0
|
17
|
|
70
|
18 Copyright (C) 1993, 1994, 1995 William M. Perry
|
|
|
19 Copyright (C) 1996 Free Software Foundation
|
|
0
|
20
|
|
|
21 Permission is granted to make and distribute verbatim copies of
|
|
|
22 this manual provided the copyright notice and this permission notice
|
|
|
23 are preserved on all copies.
|
|
|
24
|
|
|
25 @ignore
|
|
|
26 Permission is granted to process this file through Tex and print the
|
|
|
27 results, provided the printed document carries copying permission
|
|
|
28 notice identical to this one except for the removal of this paragraph
|
|
|
29 (this paragraph not being relevant to the printed manual).
|
|
|
30
|
|
|
31 @end ignore
|
|
|
32 @end ifinfo
|
|
|
33 @c
|
|
|
34 @titlepage
|
|
|
35 @sp 6
|
|
70
|
36 @center @titlefont{Emacs-W3}
|
|
0
|
37 @center @titlefont{User's Manual}
|
|
|
38 @sp 4
|
|
70
|
39 @center Third Edition, Emacs-W3 Version 3.0
|
|
0
|
40 @sp 1
|
|
80
|
41 @center December 1996
|
|
0
|
42 @sp 5
|
|
|
43 @center William M. Perry
|
|
|
44 @center @i{wmperry@@cs.indiana.edu}
|
|
|
45 @page
|
|
|
46 @vskip 0pt plus 1filll
|
|
|
47 Copyright @copyright{} 1993, 1994, 1995 William M. Perry@*
|
|
70
|
48 Copyright @copyright{} 1996 Free Software Foundation
|
|
0
|
49
|
|
|
50 Permission is granted to make and distribute verbatim copies of@*
|
|
|
51 this manual provided the copyright notice and this permission notice@*
|
|
|
52 are preserved on all copies.
|
|
|
53
|
|
|
54 @end titlepage
|
|
|
55 @page
|
|
|
56 @ifinfo
|
|
70
|
57 @node Top, Introduction,, (DIR)
|
|
|
58 This manual documents the Emacs-W3 World Wide Web browser, a Lisp program
|
|
|
59 which runs as a subsystem under Emacs. The manual is divided into the
|
|
|
60 following chapters.
|
|
0
|
61
|
|
|
62 @menu
|
|
70
|
63 * Introduction:: Overview of Emacs-W3.
|
|
80
|
64 * Getting Started:: Getting up and running with Emacs-W3
|
|
70
|
65 * Basic Usage:: Basic movement and usage of Emacs-W3.
|
|
0
|
66 * Compatibility:: Explanation of compatibility with
|
|
70
|
67 other web browsers.
|
|
|
68 * Controlling Formatting:: How to control HTML formatting
|
|
|
69 * MIME Support:: Support for MIME
|
|
|
70 * Security:: Various forms of security
|
|
|
71 * Non-Unix Operating Systems:: Special considerations necessary to get
|
|
0
|
72 up and running correctly under non-unix
|
|
|
73 OS's.
|
|
|
74 * Advanced Features:: Some of the more arcane features.
|
|
|
75 * More Help:: How to get more help---mailing lists,
|
|
|
76 newsgroups, etc.
|
|
|
77 * Future Directions:: Plans for future revisions
|
|
|
78
|
|
|
79 Appendices:
|
|
70
|
80 * Reporting Bugs:: How to report a bug in Emacs-W3
|
|
|
81 * Installing SSL:: Turning on SSL support
|
|
|
82 * Using PGP/PEM:: Turning on PGP/PEM encryption support
|
|
|
83 * Mailcap Files:: An explanation of Mailcap files
|
|
0
|
84
|
|
|
85 Indices:
|
|
70
|
86 * General Index:: General Index
|
|
|
87 * Key Index:: Menus of command keys and their references
|
|
0
|
88 @end menu
|
|
|
89 @end ifinfo
|
|
|
90
|
|
80
|
91 @node Introduction, Getting Started, Top, Top
|
|
70
|
92 @chapter Introduction
|
|
|
93 @cindex World Wide Web
|
|
|
94
|
|
80
|
95 :: WORK :: Basic info on what Emacs-W3 is, including copyrights, etc.
|
|
70
|
96
|
|
|
97 @ifinfo
|
|
80
|
98 Here is some more specific information about what languages and
|
|
|
99 protocols Emacs-W3 supports.
|
|
70
|
100 @menu
|
|
80
|
101 * Markup Languages Supported:: Markup languages supported by Emacs-W3
|
|
|
102 * Stylesheets:: Stylesheet languages supported by Emacs-W3
|
|
|
103 * Supported Protocols:: Network protocols supported by Emacs-W3
|
|
70
|
104 @end menu
|
|
|
105 @end ifinfo
|
|
80
|
106 @node Markup Languages Supported, Stylesheets, Introduction, Introduction
|
|
70
|
107 @chapter Supported Markup Languages
|
|
|
108 Several different markup languages, and various extensions to those
|
|
|
109 languages, are supported by Emacs-W3.
|
|
|
110 @ifinfo
|
|
|
111 @center ----------
|
|
|
112 @center HTML 2.0
|
|
|
113 @center ----------
|
|
|
114 @end ifinfo
|
|
|
115 @iftex
|
|
|
116 @section HTML 2.0
|
|
|
117 @end iftex
|
|
80
|
118 @cindex HTML 2.0
|
|
70
|
119
|
|
80
|
120 :: WORK :: Reference to the HTML 2.0 RFC
|
|
|
121 :: WORK :: Basic explanation of HTML, tag structure, etc.
|
|
32
|
122
|
|
70
|
123 @ifinfo
|
|
|
124 @center ----------
|
|
80
|
125 @center HTML 3.2
|
|
70
|
126 @center ----------
|
|
|
127 @end ifinfo
|
|
|
128 @iftex
|
|
|
129 @section HTML 3.2
|
|
|
130 @end iftex
|
|
|
131 @cindex HTML 3.2
|
|
|
132 The HTML 3.2 language is an extension of HTML, with a large degree of
|
|
|
133 backward compatibility with HTML 2.0. This basically documents current
|
|
|
134 practice as of January, 1996.
|
|
|
135
|
|
|
136 @ifinfo
|
|
|
137 @center ----------
|
|
|
138 @center SGML Features
|
|
|
139 @center ----------
|
|
|
140 @end ifinfo
|
|
|
141 @iftex
|
|
|
142 @section SGML Features
|
|
|
143 @end iftex
|
|
|
144 @cindex SGML Features
|
|
|
145 @cindex Entity Definitions
|
|
|
146 @cindex Marked Sections
|
|
80
|
147
|
|
70
|
148 :: WORK :: Document marked sections, SGML features
|
|
80
|
149
|
|
70
|
150 @ifinfo
|
|
|
151 @center ----------
|
|
|
152 @center Extras
|
|
|
153 @center ----------
|
|
|
154 @end ifinfo
|
|
|
155 @iftex
|
|
|
156 @section Extra Markup
|
|
|
157 @end iftex
|
|
|
158 @cindex Easter Eggs
|
|
|
159 @cindex Fluff
|
|
|
160 @cindex Pomp & Circumstance
|
|
|
161 There are several different markup elements that are not officially part
|
|
80
|
162 of HTML or HTML 3.2 that Emacs-W3 supports. These are either items that
|
|
|
163 were dropped from HTML 3.@var{x} after I had implemented them, things I
|
|
|
164 find just completely hilarious, or experimental parts of HTML that
|
|
|
165 should not be counted as "official" or long lived.
|
|
70
|
166 @itemize @bullet
|
|
|
167 @item
|
|
|
168 FLAME support. For truly interesting dynamic documents. This is
|
|
|
169 replaced with a random quote from Mr. Angry (see @kbd{M-x flame} for a
|
|
|
170 sample).
|
|
|
171 @item
|
|
|
172 The top ten tags that did not make it into netscape. These tags were
|
|
|
173 posted to the newsgroup comp.infosystems.www.misc by Laura Lemay
|
|
|
174 (@i{lemay@@netcom.com}). Much thanks to her for the humor.
|
|
|
175 @table @b
|
|
|
176 @item <wired>...</wired>
|
|
|
177 Renders the enclosed text in a suitably ugly font/color combination. If
|
|
|
178 no default has been set up by the user, this is the default font, with
|
|
|
179 red text on a yellow background.
|
|
|
180 @item <roach>...</roach>
|
|
|
181 When selected, the enclosed text runs and hides under the nearest
|
|
|
182 window. OR, giggles a lot and demands nachos, depending on the
|
|
|
183 definition of "roach." (the formal definition, of course, to be
|
|
|
184 determined by the Official Honorary Internet Standards Committee For
|
|
|
185 Moving Really Slowly.)
|
|
|
186 @item <pinhead>
|
|
|
187 Inserts "zippyisms" into the enclosed text. Perfect for those professional
|
|
|
188 documents. This is sure to be a favorite of mine!
|
|
|
189 @item <secret>...</secret>
|
|
|
190 Must use secret spy decoder glasses (available direct from Netscape for
|
|
|
191 a reasonable fee) in order to read the enclosed text. Can also be read
|
|
|
192 by holding the computer in front of a full moon during the autumn
|
|
|
193 solstice.
|
|
32
|
194
|
|
70
|
195 In Emacs-W3, this displays the text using rot13 encoding.
|
|
|
196 @item <hype>
|
|
|
197 Causes Marc Andreesen to magically appear and grant an interview (wanted
|
|
|
198 or not). Please use this tag sparingly.
|
|
|
199 @item <peek>....</peek>
|
|
|
200 @item <poke>...</poke>
|
|
|
201 Need more control over screen layout in HTML? Well, here ya go.
|
|
80
|
202 n
|
|
70
|
203 Actually, <peek> could almost be considered useful. The VARIABLE
|
|
|
204 attribute can be used to insert the value of an emacs variable into the
|
|
|
205 current document. Things like 'Welcome to my page, <peek
|
|
80
|
206 variable=user-mail-address>' can be useful in spreading fear,
|
|
|
207 uncertainty, and doubt among users.
|
|
70
|
208 @item <yogsothoth>
|
|
|
209 @cindex Gates Bill
|
|
|
210 @cindex Yogsothoth
|
|
|
211 Summons the elder gods to suck away your immortal soul. Or Bill Gates,
|
|
|
212 if the elder gods are busy. Unpredictable (but amusing) results occur
|
|
|
213 when the <YOGSOTHOTH> and <HYPE> tags are used in close proximity.
|
|
|
214
|
|
|
215 @item <blink>...</blink>
|
|
|
216 Causes the enclosed text to .... ooops that one made it in.
|
|
|
217 @end table
|
|
|
218 @end itemize
|
|
80
|
219
|
|
|
220 @node Stylesheets, Supported Protocols, Markup Languages Supported,Introduction
|
|
|
221 @chapter Stylesheets
|
|
|
222 @cindex Stylesheets
|
|
|
223 @cindex Cascading Style Sheets
|
|
|
224 @cindex CSS
|
|
|
225 @cindex DSSSL
|
|
|
226 :: WORK :: Document CSS support
|
|
|
227 :: WORK :: Document DSSSL support
|
|
|
228
|
|
|
229 @node Supported Protocols, , Stylesheets, Introduction
|
|
70
|
230 @chapter Supported Protocols
|
|
|
231 @cindex Network Protocols
|
|
|
232 @cindex Protocols Supported
|
|
|
233 @cindex Supported Protocols
|
|
|
234 Emacs-W3 supports the following protocols
|
|
|
235 @table @b
|
|
|
236 @item Usenet News
|
|
|
237 Can either display an entire newsgroup or specific articles by
|
|
80
|
238 Message-ID: header. Instead of rewriting a newsreader, this integrates
|
|
|
239 with the Gnus newsreader. It requires at least Gnus 5.0, but it is
|
|
|
240 always safest to use the latest version. Gnus supports some very
|
|
|
241 advanced features, including virtual newsgroups, mail and news
|
|
|
242 integration, and reading news from multiple servers. @inforef{Gnus,
|
|
|
243 Top,gnus}, for more info.
|
|
32
|
244
|
|
70
|
245 To be more in line with the other URL schemes, the hostname and port of
|
|
|
246 an NNTP server can be specified. URLs of the form
|
|
80
|
247 news://hostname:port/messageID work, but might not work in some other
|
|
70
|
248 browsers.
|
|
32
|
249
|
|
70
|
250 @item HTTP
|
|
80
|
251 Supports the HTTP/0.9, HTTP/1.0, and parts of the HTTP/1.1 protocols.
|
|
70
|
252 @item Gopher
|
|
|
253 Support for all gopher types, including CSO queries.
|
|
|
254 @item Gopher+
|
|
|
255 Support for Gopher+ retrievals. Support for converting ASK blocks into
|
|
|
256 HTML 3.0 FORMS and submitting them back to the server.
|
|
|
257 @item FTP
|
|
|
258 FTP is handled by either ange-ftp or efs.
|
|
80
|
259 @inforef{Ange-FTP,Top,ange-ftp}, for more information on Ange-FTP, or
|
|
|
260 @inforef{EFS, Top,efs}, for information on EFS.
|
|
70
|
261 @item Local files
|
|
80
|
262 Local files are of course handled, and MIME content-types are derived
|
|
|
263 from the file extensions.
|
|
|
264 @item Telnet, tn3270, rlogin
|
|
|
265 Telnet, tn3270, and rogin are handled by running the appropriate program
|
|
|
266 in an emacs buffer, or running an external process.
|
|
70
|
267 @item Mailto
|
|
80
|
268 Causes a mail message to be started to a specific address. Supports the
|
|
|
269 Netscape @i{extensions} to specify arbitrary headers on the message.
|
|
70
|
270 @item mailserver
|
|
|
271 A more powerful version of mailto, which allows the author to specify
|
|
|
272 the subject and body text of the mail message. This type of link is
|
|
|
273 never fully executed without user confirmation, because it is possible
|
|
|
274 to insert insulting or threatening (and possibly illegal) data into the
|
|
80
|
275 message. The mail message is displayed, and the user must confirm the
|
|
|
276 message before it is sent.
|
|
70
|
277 @item X-exec
|
|
|
278 A URL can cause a local executable to be run, and its output interpreted
|
|
|
279 as if it had come from an HTTP server. This is very useful, but is
|
|
80
|
280 still an experimental protocol, hence the X- prefix. This URL protocol
|
|
|
281 is deprecated, but might be useful in the future.
|
|
|
282 @item NFS
|
|
|
283 Retrieves information over NFS. This requires that your operating
|
|
|
284 system support auto-mounting of NFS volumes.
|
|
|
285 @item Finger
|
|
|
286 Retrieves information about a user via the 'finger' protocol, as defined
|
|
|
287 in RFC ????? :: WORK ::
|
|
|
288 @item Info
|
|
|
289 Creates a link to an GNU-style info file. @inforef{Info,Top,info}, for more
|
|
|
290 information on the Info format.
|
|
70
|
291 @item SSL
|
|
|
292 SSL requires a set of patches to the Emacs C code and SSLRef 2.0, or an
|
|
|
293 external program to run in a subprocess (similar to the @file{tcp.el}
|
|
|
294 package that comes with GNUS. @xref{Installing SSL}
|
|
32
|
295 @end table
|
|
20
|
296
|
|
80
|
297 @node Getting Started, Getting Emacs, Introduction, Top
|
|
|
298 @chapter Getting Started
|
|
|
299 @cindex Clueless in Seattle
|
|
|
300 @cindex Getting Started
|
|
70
|
301 This section of the manual deals with getting, compiling, and
|
|
|
302 configuring @i{Emacs-W3}.
|
|
80
|
303 :: WORK :: Introduction to 'Getting Started'
|
|
|
304
|
|
70
|
305 @ifinfo
|
|
20
|
306 @menu
|
|
80
|
307 * Getting Emacs:: Where to get Emacs
|
|
|
308 * Getting Emacs-W3:: Where to get Emacs-W3
|
|
|
309 * Basic Setup:: Basic setup that most people want to do
|
|
|
310 * Firewalls:: Integrating Emacs-W3 with a firewall setup.
|
|
70
|
311 * Proxy Gateways:: Using a proxy server
|
|
20
|
312 @end menu
|
|
70
|
313 @end ifinfo
|
|
|
314
|
|
80
|
315 @node Getting Emacs, Getting Emacs-W3, Getting Started, Getting Started
|
|
|
316 @section Getting Emacs
|
|
|
317 @cindex Getting Emacs
|
|
|
318 @cindex Source code availability
|
|
|
319 :: WORK :: Explanation of Emacs, XEmacs, and where to get both
|
|
|
320
|
|
|
321 @node Getting Emacs-W3, Basic Setup, Getting Emacs, Getting Started
|
|
|
322 @section Getting Emacs-W3
|
|
|
323 @cindex FTP'in the distribution
|
|
|
324 @cindex Source code availability
|
|
|
325 :: WORK :: Explanation of Emacs, XEmacs, and where to get both
|
|
|
326
|
|
|
327 @node Basic Setup, Firewalls, Getting Emacs-W3, Getting Started
|
|
70
|
328 @section Basic Setup
|
|
80
|
329 For most people, Emacs-W3 will be ready to run straight out of the box.
|
|
|
330 Once the user is more familiar with the web and how it integrates with
|
|
|
331 Emacs, there are a few basic configuration variables that most people
|
|
|
332 will want to personalize.
|
|
70
|
333
|
|
|
334 @table @code
|
|
|
335 @item w3-default-homepage
|
|
|
336 @vindex w3-default-homepage
|
|
80
|
337 The URL to open at startup. This defaults to the environment variable
|
|
70
|
338 WWW_HOME if it is not set it in the users @file{.emacs} file. If
|
|
|
339 WWW_HOME is undefined, then it defaults to the hypertext documentation
|
|
|
340 for Emacs-W3.
|
|
0
|
341
|
|
70
|
342 @item w3-delay-image-loads
|
|
|
343 @vindex w3-delay-image-loads
|
|
|
344 Controls the loading of inlined images. If non-@code{nil}, images are
|
|
|
345 not loaded. If the correct image converters are not installed or the
|
|
|
346 network connection is very slow, it is best to set this to @code{t}.
|
|
|
347 Defaults to @code{nil}.
|
|
|
348 @item url-global-history-file
|
|
|
349 @vindex url-global-history-file
|
|
|
350 The global history file used by both Mosaic/X and Emacs-W3. This file
|
|
|
351 contains a list of all the URLs that have been visited. This file is parsed
|
|
|
352 at startup and used to provide URL completion. Emacs-W3 can read and
|
|
|
353 write Mosaic/X or Netscape 1.x style history files, or use its own
|
|
|
354 internal format (faster). The file type is determined automatically, or
|
|
|
355 prompted for if the file does not exist.
|
|
|
356 @item w3-hotlist-file
|
|
|
357 @vindex w3-hotlist-file
|
|
|
358 Hotlist filename. This should be the name of a file that is stored in
|
|
|
359 NCSA's Mosaic/X or Netscape's format. It is used to keep a listing of
|
|
|
360 commonly accessed URLs.
|
|
|
361 @item w3-personal-annotation-directory
|
|
|
362 @vindex w3-personal-annotation-directory
|
|
|
363 The directory where Emacs-W3 looks for personal annotations. This is a
|
|
|
364 directory that should hold the personal annotations stored in a
|
|
|
365 Mosaic/X-compatible format.
|
|
|
366 @item url-pgp/pem-entity
|
|
|
367 @findex user-real-login-name
|
|
|
368 @findex system-name
|
|
|
369 The name by which the user is known to PGP and/or PEM entities. If this
|
|
|
370 is not set when Emacs-W3 is loaded, it defaults to
|
|
|
371 @code{user-mail-address} if it is set, otherwise @code{(user-real-login-name)}@@@code{(system-name)}.
|
|
|
372 @item url-personal-mail-address
|
|
|
373 @vindex url-personal-mail-address
|
|
|
374 @vindex url-pgp/pem-entity
|
|
|
375 User's full email address. This is what is sent to HTTP/1.0 servers as
|
|
|
376 the FROM header. If this is not set when Emacs-W3 is loaded, then it
|
|
|
377 defaults to the value of @code{url-pgp/pem-entity}.
|
|
26
|
378
|
|
70
|
379 @item w3-right-border
|
|
|
380 @vindex w3-right-border
|
|
|
381 @findex window-width
|
|
|
382 Amount of space to leave on right margin of WWW buffers. This amount is
|
|
|
383 subtracted from the width of the window for each new WWW buffer and used
|
|
|
384 as the new @code{fill-column}.
|
|
20
|
385
|
|
70
|
386 @item w3-track-mouse
|
|
|
387 @vindex w3-track-mouse
|
|
|
388 Controls whether to track the mouse and message the url under the mouse.
|
|
|
389 If this is non-@code{nil}, then a description of the hypertext area
|
|
|
390 under the mouse is shown in the minibuffer. This shows what type of
|
|
|
391 link (inlined image, form entry area, delayed image, delayed MPEG, or
|
|
|
392 hypertext reference) is under the cursor, and the destination.
|
|
|
393 @item w3-echo-link
|
|
|
394 @vindex w3-echo-link
|
|
|
395 Controls how a URL is shown when a link is reached with @key{f},
|
|
|
396 @key{b}, or the mouse moves over it. Possible values are:
|
|
|
397 @table @b
|
|
|
398 @item url
|
|
|
399 Displays the URL (ie: @samp{http://www.cs.indiana.edu/}).
|
|
|
400 @item text
|
|
|
401 Displays the text of the link (ie: @samp{A link to Indiana University}).
|
|
80
|
402 @item title
|
|
|
403 Displays the title of the link, if any, otherwise behaves the same as @code{url}.
|
|
70
|
404 @item nil
|
|
|
405 Show nothing.
|
|
|
406 @end table
|
|
|
407 @item w3-use-forms-index
|
|
|
408 @vindex w3-use-forms-index
|
|
|
409 @cindex ISINDEX handling
|
|
|
410 @cindex Forms based searching
|
|
|
411 @cindex Searching with forms
|
|
|
412 Non-@code{nil} means translate <ISINDEX> tags into a hypertext form. A
|
|
|
413 single text entry box is shown where the ISINDEX tag appears.
|
|
|
414 @item url-use-hypertext-gopher
|
|
|
415 @vindex url-use-hypertext-gopher
|
|
|
416 @cindex Gopher+
|
|
|
417 Controls how gopher documents are retrieved. If non-@code{nil}, the
|
|
|
418 gopher pages are converted into HTML and parsed just like any other
|
|
|
419 page. If @code{nil}, the requests are passed off to the
|
|
|
420 @file{gopher.el} package by Scott Snyder. Using the @file{gopher.el}
|
|
|
421 package loses the gopher+ support, and inlined searching.
|
|
|
422 @item url-xterm-command
|
|
|
423 @vindex url-xterm-command
|
|
|
424 Command used to start a windowed shell, similar to an xterm. This
|
|
|
425 string is passed through @code{format}, and should expect four strings:
|
|
|
426 the title of the window, the program name to execute, and the server and
|
|
|
427 port number. The default is for xterm, which is very UNIX and
|
|
|
428 XWindows-centric.
|
|
|
429 @end table
|
|
80
|
430 @node Firewalls, Proxy Gateways, Basic Setup, Getting Started
|
|
70
|
431 @section Firewalls
|
|
|
432 @cindex Gateways
|
|
|
433 There are several different reasons why the gateway support might be
|
|
|
434 required.
|
|
|
435 @enumerate
|
|
|
436 @cindex Firewalls
|
|
|
437 @item
|
|
|
438 Stuck behind a firewall. This is usually the case at large corporations
|
|
|
439 with paranoid system-administrators.
|
|
0
|
440
|
|
70
|
441 @cindex TERM
|
|
|
442 @item
|
|
|
443 Using TERM @footnote{TERM is a user-level protocol for emulating IP over
|
|
|
444 a serial line. More information is available at
|
|
|
445 ftp://sunsite.unc.edu/pub/Linux/apps/comm/term} for slip-like access to
|
|
|
446 the internet.
|
|
26
|
447
|
|
70
|
448 NOTE: XEmacs and Emacs 19.22 or later have patches to enable native TERM
|
|
|
449 networking. To enable it, #define TERM in the appropriate s/*.h file
|
|
|
450 for the operating system, then change the SYSTEM_LIBS define to include
|
|
|
451 the @file{termnet} library that comes with the latest versions of TERM.
|
|
|
452
|
|
|
453 @item
|
|
|
454 @cindex Faulty hostname resolvers
|
|
|
455 @cindex Broken SUN libc
|
|
|
456 @cindex Can't resolve hostnames
|
|
|
457 Emacs cannot resolve hostnames. This happens quite often on Sun
|
|
|
458 workstations and some ULTRIX machines. Some C libraries do not include
|
|
|
459 the hostname resolver routines in their static libraries. If Emacs was
|
|
|
460 linked statically, this means it won't be able to get to any machines
|
|
|
461 off the local network. This is characterized by being able to reach
|
|
|
462 someplace with a raw ip number, but not its hostname
|
|
|
463 (http://129.79.254.191/ works, but http://www.cs.indiana.edu/ doesn't).
|
|
|
464
|
|
|
465 If for some reason it is not feasible to recompile Emacs with the
|
|
|
466 @file{-lresolv} library or dynamic linking, it is just like being behind
|
|
|
467 a firewall. Another alternative is to set the variable
|
|
|
468 @code{url-broken-resolution} - this will use the support in ange-ftp or
|
|
|
469 EFS to use @file{nslookup} in a subprocess to do all hostname resolving.
|
|
|
470 See the variables @code{efs-nslookup-program},
|
|
|
471 @code{efs-nslookup-on-connect}, and @code{efs-nslookup-threshold} if are
|
|
|
472 using EFS, or @code{ange-ftp-nslookup-program} if using Ange-FTP.
|
|
|
473
|
|
|
474 @end enumerate
|
|
|
475
|
|
|
476 @vindex url-gateway-local-host-regexp
|
|
|
477 Emacs-W3 has support for using the gateway mechanism for certain
|
|
|
478 domains, and directly connecting to others. To use this, change the
|
|
|
479 value of @code{url-gateway-local-host-regexp}. This should be a regular
|
|
|
480 expression @footnote{Please see the full Emacs distribution for a
|
|
|
481 description of regular expressions} that matches local hosts that do not
|
|
|
482 require the use of a gateway. If @code{nil}, then all connections are
|
|
|
483 made through the gateway.
|
|
|
484
|
|
20
|
485
|
|
70
|
486 @vindex url-gateway-method
|
|
|
487 Emacs-W3 supports several methods of getting around gateways. The variable
|
|
|
488 @code{url-gateway-method} controls which of these methods is used. This
|
|
|
489 variable can have several values (use these as symbol names, not
|
|
|
490 strings):
|
|
|
491 @table @dfn
|
|
|
492 @item program
|
|
|
493 Run a program in a subprocess to connect to remote hosts (examples are
|
|
|
494 @i{itelnet}@footnote{Itelnet is a standard name for a telnet executable
|
|
|
495 that is capable of escaping the firewall. Check with system
|
|
|
496 administrators to see if anything similar is available}, an
|
|
|
497 @i{expect}@footnote{Expect is a scripting language that allows control
|
|
|
498 of interactive programs (like telnet) very easily. It is available from
|
|
|
499 gatekeeper.dec.com:/pub/GNU/expect-3.24.0.tar.gz} script, etc.).
|
|
|
500
|
|
|
501 @item tcp
|
|
|
502 Masanobu UMEDA (@i{umerin@@mse.kyutech.ac.jp}) has written a very nice
|
|
|
503 replacement for the standard networking in Emacs. This does basically
|
|
|
504 the same thing that a method of @code{program} does, but is slightly
|
|
|
505 more transparent to the user.
|
|
|
506 @item native
|
|
|
507 This means that Emacs-W3 should use the builtin networking code of Emacs.
|
|
|
508 This should be used only if there is no firewall, or the Emacs source
|
|
|
509 has already been hacked to get around the firewall.
|
|
|
510 @end table
|
|
80
|
511 One of these needs a bit more explanation than that:
|
|
70
|
512 @vindex url-gateway-telnet-ready-regexp
|
|
|
513 @vindex url-gateway-telnet-program
|
|
|
514 When running a program in a subprocess to emulate a network connection,
|
|
|
515 a few extra variables need to be set. The variable
|
|
|
516 @code{url-gateway-telnet-program} should point to an executable that
|
|
|
517 accepts a hostname and port # as its arguments, and passes standard
|
|
|
518 input to the remote host. This can be either the full path to the
|
|
|
519 executable or just the basename. The variable
|
|
|
520 @code{url-gateway-telnet-ready-regexp} controls how long Emacs-W3 should
|
|
|
521 wait after spawning the subprocess to start sending to its standard
|
|
|
522 input. This gets around a bug where telnet would miss the beginning of
|
|
|
523 requests becausse it did not buffer its input before opening a
|
|
|
524 connection. This should be a regular expression to watch for that
|
|
|
525 signifies the end of the setup of @code{url-gateway-telnet-program}.
|
|
|
526 The default should work fine for telnet.
|
|
|
527
|
|
|
528 Emacs-W3 should now be able to get outside the local network. If none
|
|
|
529 of this makes sense, its probably my fault. Please check with the
|
|
|
530 network administrators to see if they have a program that does most of
|
|
|
531 this already, since somebody somewhere at the company has probably been
|
|
|
532 through something similar to this before, and would be much more
|
|
|
533 helpful/knowledgeable about the local setup than I would be. But feel
|
|
|
534 free to mail me as a last resort.
|
|
20
|
535
|
|
80
|
536 @node Proxy Gateways, Basic Usage, Firewalls, Getting Started
|
|
70
|
537 @section Proxy Gateways
|
|
|
538 @vindex url-proxy-services
|
|
|
539 @cindex Proxy Servers
|
|
|
540 @cindex Proxies
|
|
|
541 @cindex Proxies, environment variables
|
|
|
542 @cindex HTTP Proxy
|
|
|
543 In late January 1993, Kevin Altis and Lou Montulli proposed and
|
|
|
544 implemented a new proxy service. This service requires the use of
|
|
|
545 environment variables to specify a gateway server/port # to send
|
|
|
546 protocol requests to. Each protocol (HTTP, WAIS, gopher, FTP, etc.@:)
|
|
|
547 can have a different gateway server. The environment variables are
|
|
|
548 @var{PROTOCOL}_proxy, where @var{PROTOCOL} is one of the supported
|
|
|
549 network protocols (gopher, file, HTTP, FTP, etc.)
|
|
|
550
|
|
|
551 @cindex No Proxy
|
|
|
552 @cindex Proxies, exclusion lists
|
|
|
553 @vindex NO_PROXY
|
|
|
554 For companies with internal intranets, it will usually be helpful to
|
|
|
555 define a list of hosts that should be contacted directly, @b{not} sent
|
|
|
556 through the proxy. The @var{NO_PROXY} environment variable controls
|
|
|
557 what hosts are able to be contacted directly. This should be a comma
|
|
|
558 separated list of hostnames, domain names, or a mixture of both.
|
|
|
559 Asterisks can be used as a wildcard. For example:
|
|
|
560
|
|
|
561 @example
|
|
|
562 NO_PROXY=*.aventail.com,home.com,*.seanet.com
|
|
|
563 @end example
|
|
|
564
|
|
|
565 tells Emacs-W3 to contact all machines in the @b{aventail.com} and
|
|
|
566 @b{seanet.com} domains directly, as well as the machine named
|
|
|
567 @b{home.com}.
|
|
|
568
|
|
|
569 @vindex url-proxy-services
|
|
|
570 @cindex Proxies, setting from lisp
|
|
|
571 For those adventurous souls who enjoy writing regular expressions, all
|
|
|
572 the proxy settings can be manipulated from Emacs-Lisp. The variable
|
|
|
573 @code{url-proxy-services} controls this. This is an assoc list, keyed
|
|
|
574 on the protocol type (http, gopher, etc) in all lowercase. The
|
|
|
575 @code{cdr} of each entry should be the fully-specified URL of the proxy
|
|
|
576 server to contact, or, in the case of the special "no_proxy" entry, a
|
|
|
577 regular expression that matches any hostnames that should be contacted
|
|
|
578 directly.
|
|
|
579
|
|
|
580 @example
|
|
|
581 (setq url-proxy-services '(("http" . "http://proxy.aventail.com/")
|
|
|
582 ("no_proxy" . "^.*\\(aventail\\|seanet\\)\.com")))
|
|
|
583 @end example
|
|
|
584
|
|
|
585 @node Basic Usage, , Proxy Gateways, Top
|
|
0
|
586 @chapter Basic Usage
|
|
70
|
587 Emacs-W3 is similar to the Info package all Emacs users hold near and dear to
|
|
|
588 their hearts (@xref{Top,,Info,info, The Info Manual}, for a description
|
|
|
589 of Info). Basically, @kbd{space} and @kbd{backspace} control scrolling,
|
|
|
590 and @kbd{return} or @kbd{mouse2} follows a hypertext link. The @kbd{f}
|
|
|
591 and @kbd{b} keys maneuver around the various links on the page.
|
|
|
592
|
|
|
593 @b{NOTE:} To enter data into a form entry area, select it using
|
|
|
594 @kbd{return} or the middle mouse button, just like a hypertext link.
|
|
0
|
595
|
|
80
|
596 By default, hypertext links are surrounded by '[[' and ']]' on
|
|
|
597 non-graphic terminals (VT100, DOS window, etc.). On a graphics
|
|
|
598 terminal, the links are in shown in different colors. @xref{Controlling
|
|
|
599 Formatting} for information on how to change this, or for help on
|
|
|
600 getting the highlighting to work on graphics terminals.
|
|
0
|
601
|
|
70
|
602 There are approximately 50 keys bound to special Emacs-W3 functions.
|
|
|
603 The basic rule of thumb regarding keybindings in Emacs-W3 is that a
|
|
0
|
604 lowercase key takes an action on the @b{current document}, and an
|
|
|
605 uppercase key takes an action on the document pointed to by the
|
|
|
606 hypertext link @b{under the cursor}.
|
|
|
607
|
|
|
608 There are several areas that the keybindings fall into: movement,
|
|
|
609 information, action, and miscellaneous.
|
|
|
610
|
|
70
|
611 @ifinfo
|
|
0
|
612 @menu
|
|
70
|
613 * Movement:: Moving around in a Emacs-W3 buffer
|
|
|
614 * Information:: Getting information about the Emacs-W3 document being
|
|
|
615 viewed, and/or links within that document.
|
|
|
616 * Action:: Taking actions in a Emacs-W3 buffer (following links,
|
|
|
617 printing, etc.)
|
|
|
618 * Miscellaneous:: Miscellaneous keybindings
|
|
0
|
619 @end menu
|
|
70
|
620 @end ifinfo
|
|
0
|
621 @node Movement, Information, Basic Usage, Basic Usage
|
|
|
622 @section Movement
|
|
70
|
623 :: WORK :: Document the 'h' and 'a' keymaps
|
|
0
|
624 @table @kbd
|
|
70
|
625 @findex scroll-up
|
|
|
626 @kindex SPC
|
|
|
627 @item SPC
|
|
0
|
628 Scroll downward in the buffer. With prefix arg, scroll down that many
|
|
|
629 screenfuls.
|
|
70
|
630 @kindex DEL
|
|
0
|
631 @findex scroll-down
|
|
70
|
632 @item DEL
|
|
0
|
633 Scroll upward in the buffer. With prefix arg, scroll up that many
|
|
|
634 screenfuls.
|
|
|
635 @kindex <
|
|
|
636 @findex w3-start-of-document
|
|
|
637 @item <
|
|
|
638 Goes to the start of document
|
|
|
639 @kindex >
|
|
|
640 @findex w3-end-of-document
|
|
|
641 @item >
|
|
|
642 Goes to the end of document
|
|
|
643 @kindex b
|
|
70
|
644 @kindex Shift-TAB
|
|
|
645 @findex w3-back-link
|
|
|
646 @item Shift-TAB, b
|
|
0
|
647 Attempts to move backward one link area in the current document.
|
|
|
648 Signals an error if no previous links are found.
|
|
70
|
649 @kindex hl
|
|
|
650 @findex w3-show-hotlist
|
|
|
651 @item hl
|
|
|
652 Displays a complete listing of the items in the hotlist.
|
|
|
653 @kindex hu
|
|
|
654 @findex w3-use-hotlist
|
|
|
655 @item hu
|
|
|
656 Go to a link in the hotlist.
|
|
0
|
657 @kindex m
|
|
|
658 @findex w3-complete-link
|
|
|
659 @item m
|
|
|
660 Choose a link from the current buffer and follow it. A completing-read
|
|
|
661 is done on all the links, so @kbd{space} and @kbd{TAB} can be used for
|
|
|
662 completion.
|
|
70
|
663 @kindex f
|
|
|
664 @kindex TAB
|
|
|
665 @kindex n
|
|
|
666 @findex w3-forward-link
|
|
|
667 @item TAB, f, n
|
|
|
668 Attempts to move forward one link area in the current document. Signals
|
|
|
669 an error if no more links are found.
|
|
|
670 @end table
|
|
|
671 @node Information, Action, Movement, Basic Usage
|
|
|
672 @section Information
|
|
|
673 These functions relate information about one or more links on the
|
|
|
674 current document.
|
|
|
675 @table @kbd
|
|
|
676 @kindex v
|
|
|
677 @findex url-view-url
|
|
|
678 @item v
|
|
|
679 This shows the URL of the current document in the minibuffer.
|
|
|
680 @kindex V
|
|
|
681 @findex w3-view-this-url
|
|
|
682 @item V
|
|
|
683 This shows the URL of the hypertext link under point in the minibuffer.
|
|
|
684 If there is not a hypertext link under point, then it shows the type of
|
|
|
685 form entry area under point. If there is no form entry area under
|
|
|
686 point, then it shows the inlined image's URL that is under point, if
|
|
|
687 any.
|
|
|
688 @kindex i
|
|
|
689 @findex w3-document-information
|
|
|
690 @item i
|
|
|
691 Shows miscellaneous information about the currently displayed document.
|
|
|
692 This includes the URL, the last modified date, MIME headers, the HTTP
|
|
|
693 response code, and any relationships to other documents. Any security
|
|
|
694 information is also displayed.
|
|
|
695 @kindex I
|
|
|
696 @findex w3-document-information-this-url
|
|
|
697 @item I
|
|
|
698 Shows information about the URL at point.
|
|
|
699 @kindex s
|
|
|
700 @findex w3-source-document
|
|
|
701 @item s
|
|
|
702 This shows the HTML source of the current document in a separate buffer.
|
|
|
703 The buffer's name is based on the document's URL.
|
|
|
704 @kindex S
|
|
|
705 @findex w3-source-document-at-point
|
|
|
706 @item S
|
|
|
707 Shows the HTML source of the hypertext link under point in a separate
|
|
|
708 buffer. The buffer's name is based on the document's URL.
|
|
|
709 @kindex k
|
|
|
710 @findex w3-save-url
|
|
|
711 @item k
|
|
|
712 This stores the current document's URL in the kill ring, and also in the
|
|
|
713 current window-system's clipboard, if possible.
|
|
|
714 @kindex K
|
|
|
715 @findex w3-save-this-url
|
|
|
716 @item K
|
|
|
717 Stores the URL of the document under point in the kill ring, and also in
|
|
|
718 the current window-system's clipboard, if possible.
|
|
|
719 @end table
|
|
|
720 @node Action, Miscellaneous, Information, Basic Usage
|
|
|
721 @section Action
|
|
|
722 First, here are the keys and functions that bring up a new hypertext
|
|
|
723 page, usually creating a new buffer.
|
|
|
724 @table @kbd
|
|
0
|
725 @kindex return
|
|
|
726 @findex w3-follow-link
|
|
|
727 @item return
|
|
|
728 Pressing return when over a hyperlink attempts to follow the link
|
|
|
729 under the cursor. With a prefix argument (@kbd{C-u}), this forces the
|
|
|
730 file to be saved to disk instead of being passed off to other viewers
|
|
70
|
731 or being parsed as HTML.
|
|
0
|
732
|
|
70
|
733 Pressing return when over a form input field will prompt in the
|
|
0
|
734 minibuffer for the data to insert into the input field. Type checking
|
|
|
735 is done, and the data is only entered into the form when data of the
|
|
|
736 correct type is entered (ie: cannot enter 44 for 'date' field, etc).
|
|
|
737
|
|
|
738 @kindex Middle Mouse Button
|
|
|
739 @findex w3-follow-mouse
|
|
|
740 @item Middle Mouse Button
|
|
|
741 Attempt to follow a hypertext link under the mouse cursor. Clicking on
|
|
|
742 a form input field will prompt in the minibuffer for the data to insert
|
|
|
743 into the input field. Type checking is done, and the data is only
|
|
|
744 entered into the form when data of the correct type is entered (ie:
|
|
|
745 cannot enter 44 for 'date' field, etc).
|
|
|
746
|
|
|
747 @kindex Control Middle Mouse Button
|
|
|
748 @kindex Meta return
|
|
|
749 @findex w3-follow-inlined-image
|
|
|
750 @item Control Middle Mouse Button, Meta return
|
|
|
751 Tries to retrieve the inlined image that is under point. It ignores any
|
|
|
752 form entry areas or hyperlinks, and blindly follows any inlined image.
|
|
|
753 Useful for seeing images that are meant to be used as hyperlinks when
|
|
|
754 not on a terminal capable of displaying graphics.
|
|
|
755
|
|
|
756 @kindex p
|
|
|
757 @findex w3-print-this-url
|
|
|
758 @item p
|
|
|
759 Prints out the current buffer in a variety of formats, including
|
|
70
|
760 PostScript, HTML source, or formatted text.
|
|
0
|
761 @kindex P
|
|
|
762 @findex w3-print-url-under-point
|
|
|
763 @item P
|
|
70
|
764 Prints out the URL under point in a variety of formats, including
|
|
|
765 PostScript, HTML source, or formatted text.
|
|
0
|
766 @kindex m
|
|
|
767 @findex w3-complete-link
|
|
|
768 @item m
|
|
|
769 Selects a destination from a list of all the hyperlinks in the current
|
|
|
770 buffer. Use @kbd{space} and @kbd{tab} to complete on the links.
|
|
|
771
|
|
|
772 @kindex r
|
|
|
773 @kindex g
|
|
|
774 @findex w3-reload-document
|
|
|
775 @item r, g
|
|
|
776 Reloads the current document. The position within the buffer remains
|
|
|
777 the same (unless the document has changed since it was last retrieved,
|
|
|
778 in which case it should be relatively close). This causes an
|
|
|
779 unconditional reload from the remote server - the locally cached copy is
|
|
|
780 not consulted.
|
|
|
781 @kindex C-o
|
|
|
782 @findex w3-fetch
|
|
|
783 @item C-o
|
|
70
|
784 Prompts for a URL in the minibuffer, and attempts to fetch
|
|
|
785 it. If there are any errors, or Emacs-W3 cannot understand the type of link
|
|
0
|
786 requested, the errors are displayed in a hypertext buffer.
|
|
|
787 @kindex o
|
|
|
788 @findex w3-open-local
|
|
|
789 @vindex url-use-hypertext-dired
|
|
|
790 @item o
|
|
|
791 Opens a local file, interactively. This prompts for a local file name
|
|
|
792 to open. The file must exist, and may be a directory. If the requested
|
|
|
793 file is a directory and @code{url-use-hypertext-dired} is @code{nil},
|
|
70
|
794 then a dired-mode buffer is displayed. If non@code{nil}, then Emacs-W3
|
|
0
|
795 automatically generates a hypertext listing of the directory. The
|
|
|
796 hypertext mode is the default, so that all the keys and functions remain
|
|
|
797 the same.
|
|
|
798
|
|
|
799 @kindex M-s
|
|
70
|
800 @findex w3-search
|
|
0
|
801 @item M-s
|
|
70
|
802 Perform a search, if this is a searchable index. Searching requires a
|
|
|
803 server - Emacs-W3 can not do local file searching, as there are too many
|
|
|
804 possible types of searches people could want to do. Generally, the only
|
|
|
805 URL types that allow searching are HTTP, gopher, and X-EXEC.
|
|
0
|
806 @kindex Hv
|
|
|
807 @findex w3-show-history-list
|
|
|
808 @vindex w3-keep-history
|
|
|
809 @item Hv
|
|
70
|
810 If @code{url-keep-history} is non-@code{nil}, then Emacs-W3 keeps track
|
|
|
811 of all the URLs visited in an Emacs session. This function takes all
|
|
0
|
812 the links that are in that internal list, and formats them as hypertext
|
|
|
813 links in a list.
|
|
|
814 @end table
|
|
|
815
|
|
|
816 @cindex Buffer movement
|
|
70
|
817 And here are the commands to move around between Emacs-W3 buffers:
|
|
0
|
818
|
|
|
819 @table @kbd
|
|
|
820 @kindex l
|
|
|
821 @findex w3-goto-last-buffer
|
|
|
822 @item l
|
|
|
823 Goes to the last WWW buffer seen.
|
|
|
824 @kindex q
|
|
|
825 @findex w3-quit
|
|
|
826 @item q
|
|
|
827 Quits WWW mode. This kills the current buffer and goes to the most
|
|
|
828 recently visited buffer.
|
|
|
829 @kindex Q
|
|
|
830 @findex w3-leave-buffer
|
|
|
831 @item u
|
|
|
832 This is similar to w3-quit, but the buffer is not killed, it is moved to
|
|
|
833 the bottom of the buffer list (so it is the least likely to show up as
|
|
|
834 the default with switch-to-buffer). This is different from
|
|
|
835 @code{w3-goto-last-buffer} in that it does not return to the last WWW
|
|
|
836 page visited - it is the same as using @code{switch-to-buffer} - the
|
|
|
837 buffer left in the window is fairly random.
|
|
|
838 @kindex HB
|
|
|
839 @kindex B
|
|
|
840 @findex w3-backward-in-history
|
|
|
841 @item HB, B
|
|
|
842 Takes one step back along the path in the current history. Has no
|
|
|
843 effect if at the beginning of the session history.
|
|
|
844 @kindex HF
|
|
|
845 @kindex F
|
|
|
846 @findex w3-forward-in-history
|
|
|
847 @item HF, F
|
|
|
848 Takes one step forward along the path in the current history. Has no
|
|
|
849 effect if at the end of the session history.
|
|
|
850 @end table
|
|
|
851
|
|
70
|
852 @node Miscellaneous, , Action, Basic Usage
|
|
0
|
853 @section Miscellaneous
|
|
|
854 @table @kbd
|
|
|
855 @kindex M-m
|
|
|
856 @findex w3-mail-current-document
|
|
|
857 @item M-m
|
|
|
858 Mails the current document to someone. Choose from several different
|
|
70
|
859 formats to mail: formatted text, HTML source, PostScript, or LaTeX source.
|
|
|
860 When the HTML source is mailed, then an appropriate <base> tag is inserted
|
|
0
|
861 at the beginning of the document so that relative links may be followed
|
|
|
862 correctly by whoever receives the mail.
|
|
|
863 @kindex M-M
|
|
|
864 @findex w3-mail-document-under-point
|
|
|
865 @item M-M
|
|
|
866 Mails the document pointed to by the hypertext link under point to someone.
|
|
70
|
867 Choose from several different formats to mail: formatted text, HTML source,
|
|
|
868 PostScript, or LaTeX source. When the HTML source is mailed, then an
|
|
0
|
869 appropriate <base> tag is inserted at the beginning of the document so that
|
|
|
870 relative links may be followed correctly by whoever receives the
|
|
|
871 mail.
|
|
|
872 @kindex p
|
|
|
873 @findex w3-print-this-url
|
|
|
874 @item p
|
|
|
875 Prints the current document. Choose from several different formats to
|
|
70
|
876 print: formatted text, HTML source, PostScript (with ps-print), or by using
|
|
0
|
877 LaTeX and dvips).
|
|
|
878
|
|
|
879 @findex lpr-buffer
|
|
|
880 @vindex lpr-command
|
|
|
881 @vindex lpr-switches
|
|
|
882 When the formatted text is printed, the normal @code{lpr-buffer} function
|
|
|
883 is called, and the variables @code{lpr-command} and @code{lpr-switches}
|
|
|
884 control how the document is printed.
|
|
|
885
|
|
70
|
886 When the HTML source is printed, then an appropriate <base> tag is
|
|
0
|
887 inserted at the beginning of the document.
|
|
|
888 @vindex w3-print-commnad
|
|
|
889 @vindex w3-latex-docstyle
|
|
70
|
890 When postscript is printed, then the HTML source of the document is
|
|
80
|
891 converted into LaTeX source. There are several variables controlling
|
|
|
892 what the final LaTeX document looks like.
|
|
|
893
|
|
|
894 :: WORK :: Document the new LaTeX backend
|
|
|
895
|
|
|
896 @table @code
|
|
|
897 @item w3-latex-use-latex2e
|
|
|
898 @vindex w3-latex-use-latex2e
|
|
|
899 If non-@code{nil}, configures the LaTeX engine to use the LaTeX2e
|
|
|
900 syntax. A @code{nil} value indicates that LaTeX 2.0.9 compabibility
|
|
|
901 will be used instead.
|
|
|
902 @item w3-latex-docstyle
|
|
|
903 @vindex w3-latex-docstyle
|
|
|
904 The document style to use when printing or mailing converted HTML files
|
|
|
905 in LaTeX. Good defaults are: @{article@}, [psfig,twocolumn]@{article@},
|
|
|
906 etc.
|
|
|
907 @item w3-latex-packages
|
|
|
908 @vindex w3-latex-packages
|
|
|
909 List of LaTeX packages to include. Currently this is only used if
|
|
|
910 @code{w3-latex-use-latex2e} is non-@code{nil}.
|
|
|
911 @item w3-latex-use-maketitle
|
|
|
912 @vindex w3-latex-use-maketitle
|
|
|
913 If non-@code{nil}, the LaTeX engine will use real LaTeX title pages for
|
|
|
914 document titles.
|
|
|
915 @item w3-latex-print-links
|
|
|
916 @vindex w3-latex-print-links
|
|
|
917 If non-@code{nil}, prints the URLs of hypertext links as endnotes at the
|
|
|
918 end of the document. If set to @code{footnote}, prints the URL's as
|
|
|
919 footnotes on each page.
|
|
|
920 @end table
|
|
|
921
|
|
0
|
922 @kindex P
|
|
|
923 @findex w3-print-url-under-point
|
|
|
924 @item P
|
|
|
925 Prints the document pointed to by the hypertext link under point.
|
|
|
926 Please see the previous item for more information.
|
|
|
927 @kindex M-x w3-insert-formatted-url
|
|
|
928 @findex w3-insert-formatted-url
|
|
|
929 @item M-x w3-insert-formatted-url
|
|
70
|
930 Insert a fully formatted HTML link into another buffer. This gets the
|
|
|
931 name and URL of either the current buffer, or, with a prefix arg, of the
|
|
0
|
932 link under point, and construct the appropriate <a...>...</a> markup and
|
|
|
933 insert it into the desired buffer.
|
|
|
934 @kindex M-tab
|
|
|
935 @findex w3-insert-this-url
|
|
|
936 @item M-tab
|
|
70
|
937 Inserts the URL of the current document into another buffer. Buffer is
|
|
|
938 prompted for in the minibuffer. With prefix arg, uses the URL of the
|
|
0
|
939 link under point.
|
|
|
940 @kindex U
|
|
|
941 @findex w3-use-links
|
|
|
942 @item U
|
|
|
943 Selects one of the <LINK> tags from this document and fetch it. Links
|
|
|
944 are attributes of a specific document, and can tell such things as who
|
|
|
945 made the document, where a table of contents is located, etc.
|
|
|
946
|
|
|
947 Link tags specify relationships between documents in two ways. Normal
|
|
|
948 (forward) relationships (where the link has a REL="xxx" attribute), and
|
|
|
949 reverse relationships (where the link has a REV="xxx" attribute). This
|
|
|
950 first asks what type of link to follow (Normal or Reverse), then does
|
|
|
951 a @code{completing-read} on only the links that have that type of
|
|
|
952 relationship.
|
|
|
953 @end table
|
|
|
954
|
|
70
|
955 @node Compatibility, , , Top
|
|
0
|
956 @chapter Compatibility with other Browsers
|
|
70
|
957 Due to the popularity of several other browsers, Emacs-W3 offers an easy
|
|
0
|
958 transition to its much better way of life. This ranges from being able
|
|
|
959 to share the same preferences files and disk cache to actually emulating
|
|
|
960 the keybindings used in other browsers.
|
|
|
961
|
|
70
|
962 @ifinfo
|
|
0
|
963 @menu
|
|
70
|
964 * Emulation:: Emacs-W3 can emulate the keybindings and
|
|
0
|
965 other behaviours of other browsers.
|
|
|
966 * Hotlist Handling:: A hotlist is an easy way to keep track of
|
|
|
967 interesting Web pages without having to
|
|
|
968 remember the exact path to get there.
|
|
|
969 * Session History:: Keeping a history of documents visited
|
|
|
970 in one Emacs sessions allows the use of
|
|
|
971 'forward' and 'back' buttons easily.
|
|
70
|
972 * Global History:: Keeping a history of all the places ever
|
|
0
|
973 visited on the web.
|
|
70
|
974 * Annotations:: Annotations allow comments on other
|
|
|
975 people's Web documents without needing
|
|
|
976 to change the document.
|
|
0
|
977 @end menu
|
|
70
|
978 @end ifinfo
|
|
0
|
979 @node Emulation, Hotlist Handling, Compatibility, Compatibility
|
|
|
980 @section Emulation
|
|
|
981 @cindex Browser emulation
|
|
|
982 @cindex Emulation of other browsers
|
|
|
983 @cindex Netscape emulation
|
|
|
984 @cindex Lynx emulation
|
|
|
985 @findex turn-on-netscape-emulation
|
|
|
986 @findex turn-on-lynx-emulation
|
|
|
987 @findex w3-netscape-emulation-minor-mode
|
|
|
988 @findex w3-lynx-emulation-minor-mode
|
|
|
989 @vindex w3-mode-hook
|
|
80
|
990 :: WORK :: Document lynx emulation
|
|
|
991 :: WORK :: Document netscape emulation
|
|
26
|
992
|
|
0
|
993 @node Hotlist Handling, Session History, Emulation, Compatibility
|
|
|
994 @section Hotlist Handling
|
|
|
995 :: WORK :: Document that it supports different types of hotlist formats
|
|
|
996 :: WORK :: Make sure everything hotlist related can be accessed via 'h'
|
|
|
997 In order to avoid having to traverse many documents to get to the same
|
|
70
|
998 document over and over, Emacs-W3 supports a ``hotlist'' like Mosaic. This is
|
|
|
999 a file that contains URLs and aliases. Hotlists allow quick access to any
|
|
0
|
1000 document in the Web, providing it has been visited and added to the hotlist.
|
|
|
1001 The variable @code{w3-hotlist-file} determines where this information
|
|
|
1002 is saved. The structure of the file is compatible with Mosaic's
|
|
|
1003 hotlist file, so this defaults to @file{~/.mosaic-hotlist-default}.
|
|
|
1004
|
|
|
1005 Hotlist commands are:
|
|
|
1006 @table @kbd
|
|
|
1007 @kindex hi
|
|
|
1008 @findex w3-hotlist-add-document
|
|
|
1009 @vindex w3-hotlist-file
|
|
|
1010 @item a
|
|
|
1011 Adds the current document to the hotlist, with the buffer name as its
|
|
|
1012 identifier. Modifies the file specified by @code{w3-hotlist-file}. If
|
|
70
|
1013 this is given a @var{prefix-argument} (via @kbd{C-u}), the title is
|
|
|
1014 prompted for instead of automatically defaulting to the
|
|
|
1015 document title.
|
|
0
|
1016
|
|
|
1017 @findex w3-hotlist-refresh
|
|
|
1018 @vindex w3-hotlist-file
|
|
|
1019 @kindex hR
|
|
|
1020 @item hR
|
|
|
1021 This rereads the default hostlist file specified by
|
|
|
1022 @code{w3-hotlist-file}.
|
|
|
1023 @findex w3-hotlist-delete
|
|
|
1024 @vindex w3-hotlist-file
|
|
|
1025 @kindex hd
|
|
|
1026 @item d
|
|
|
1027 Prompts for the alias of the entry to kill. Pressing the spacebar or
|
|
|
1028 tab will list out partial completions. The internal representation of
|
|
|
1029 the hotlist and the file specified by @code{w3-hotlist-file} are
|
|
|
1030 updated.
|
|
|
1031 @item hr
|
|
|
1032 @kindex hr
|
|
|
1033 @findex w3-hotlist-rename-entry
|
|
|
1034 @vindex w3-hotlist-file
|
|
|
1035 Some hotlist item names can be very unwieldy (`Mosaic for X level 2 fill
|
|
|
1036 out form support'), or uninformative (`Index of /'). Prompts for the
|
|
|
1037 item to rename in the minibuffer---use the spacebar or tab key for
|
|
|
1038 completion. After having chosen an item to rename, prompts for a new
|
|
|
1039 title until a unique title is entered. Modifies the file specified by
|
|
|
1040 @code{w3-hotlist-file}.
|
|
|
1041
|
|
|
1042 @item hu
|
|
|
1043 @kindex hu
|
|
|
1044 @findex w3-use-hotlist
|
|
|
1045 Prompts for the alias to jump to. Pressing the @key{spacebar} or
|
|
|
1046 @key{tab} key shows partial completions.
|
|
|
1047
|
|
|
1048 @item hv
|
|
|
1049 @kindex hv
|
|
|
1050 @findex w3-show-hotlist
|
|
70
|
1051 Converts the hotlist into HTML and displays it.
|
|
0
|
1052 @item ha
|
|
|
1053 @kindex ha
|
|
|
1054 @findex w3-hotlist-apropos
|
|
|
1055 Shows the hotlist entries matching a regular expression.
|
|
|
1056 @item hA
|
|
|
1057 @kindex hA
|
|
|
1058 @findex w3-hotlist-append
|
|
|
1059 Appends another hotlist file to the one currently in memory.
|
|
|
1060 @end table
|
|
|
1061 @node Session History, Global History, Hotlist Handling, Compatibility
|
|
|
1062 @section History
|
|
|
1063 @cindex History Lists
|
|
70
|
1064 Almost all web browsers keep track of the URLs followed from a page, so
|
|
0
|
1065 that it can provide @b{forward} and @b{back} buttons to keep a @i{path}
|
|
70
|
1066 of URLs that can be traversed easily.
|
|
0
|
1067 @vindex url-keep-history
|
|
70
|
1068 If the variable @code{url-keep-history} is @code{t}, then Emacs-W3
|
|
|
1069 keeps a list of all the URLs visited in a session.
|
|
0
|
1070 @findex w3-show-history
|
|
70
|
1071 To view a listing of the history for this session of Emacs-W3, use
|
|
|
1072 @code{M-x w3-show-history} from any buffer, and Emacs-W3 generates an
|
|
|
1073 HTML document showing every URL visited since Emacs started (or
|
|
0
|
1074 cleared the history list), and then format it. Any of the links can
|
|
|
1075 be chosen and followed to the original document. To clear the history
|
|
|
1076 list, choose 'Clear History' from the 'Options' menu.
|
|
|
1077
|
|
|
1078 @findex w3-forward-in-history
|
|
|
1079 @findex w3-backward-in-history
|
|
|
1080 @findex w3-fetch
|
|
|
1081 Another twist on the history list mechanism is the fact that all
|
|
70
|
1082 Emacs-W3 buffers remember what URL, buffer, and buffer position of the
|
|
0
|
1083 last document, and also keeps track of the next location jumped @b{to}
|
|
|
1084 from that buffer. This means that the user can go forwards and
|
|
|
1085 backwards very easily along the path taken to reach a particular
|
|
|
1086 document. To go forward, use the function @code{w3-forward-in-history},
|
|
|
1087 to go backward, use the function @code{w3-backward-in-history}.
|
|
|
1088
|
|
70
|
1089 @node Global History, Annotations, Session History, Compatibility
|
|
0
|
1090 @section Global History
|
|
|
1091 :: WORK :: Document that the global history can have diff. formats
|
|
70
|
1092 Most web browsers also support the idea of a ``history'' of URLs the
|
|
0
|
1093 user has visited, and it displays them in a different style than normal
|
|
70
|
1094 URLs.
|
|
0
|
1095
|
|
|
1096 @vindex url-keep-history
|
|
|
1097 @vindex url-global-history-file
|
|
70
|
1098 If the variable @code{url-keep-history} is @code{t}, then Emacs-W3
|
|
|
1099 keeps a list of all the URLs visited in a session. The file is
|
|
0
|
1100 automatically written to disk when exiting emacs. The list is added to
|
|
|
1101 those already in the file specified by @code{url-global-history-file},
|
|
|
1102 which defaults to @file{~/.mosaic-global-history}.
|
|
|
1103
|
|
70
|
1104 If any URL in the list is found in the file, it is not saved, but new
|
|
0
|
1105 ones are added at the end of the file.
|
|
|
1106
|
|
|
1107 The function that saves the global history list is smart enough to
|
|
70
|
1108 notice what style of history list is being used (Netscape, Emacs-W3, or
|
|
0
|
1109 XMosaic), and writes out the new additions appropriately.
|
|
|
1110
|
|
|
1111 @cindex Completion of URLs
|
|
|
1112 @cindex Usefulness of global history
|
|
70
|
1113 One of the nice things about keeping a global history files is that Emacs-W3
|
|
0
|
1114 can use it as a completion table. When doing @kbd{M-x w3-fetch}, pressing
|
|
|
1115 the @kbd{tab} or @kbd{space} key will show all completions for a
|
|
70
|
1116 partial URL. This is very useful, especially for very long URLs that
|
|
0
|
1117 are not in a hotlist, or for seeing all the pages from a particular web
|
|
|
1118 site before choosing which to retrieve.
|
|
|
1119
|
|
70
|
1120 @node Annotations, Group Annotations, Global History, Compatibility
|
|
|
1121 @section Annotations
|
|
|
1122 @cindex Annotations
|
|
|
1123 Mosaic can @i{annotate} documents. Annotations are comments about the
|
|
|
1124 current document, and these annotations appear as a link to the comments
|
|
|
1125 at the end of the document. The original file is not changed.
|
|
|
1126
|
|
|
1127 @ifinfo
|
|
|
1128 @menu
|
|
|
1129 * Group Annotations:: Annotations accessible by everyone
|
|
|
1130 * Personal Annotations:: Private annotations only accessible
|
|
|
1131 to the user who created them
|
|
|
1132 @end menu
|
|
|
1133 @end ifinfo
|
|
|
1134 @node Group Annotations, Personal Annotations, Annotations, Annotations
|
|
|
1135 @subsection Group Annotations
|
|
|
1136 @cindex Group Annotations
|
|
|
1137 @b{@i{NOTE}}: The group annotation experiment has been terminated. It
|
|
|
1138 will be replaced with support on the server side for adding <LINK> tags
|
|
|
1139 to documents.
|
|
0
|
1140
|
|
70
|
1141 @node Personal Annotations, , Group Annotations, Annotations
|
|
|
1142 @subsection Personal Annotations
|
|
|
1143 @cindex Personal Annotations
|
|
|
1144 @vindex w3-personal-annotation-directory
|
|
|
1145 Emacs-W3 looks in the directory specified by
|
|
|
1146 @code{w3-personal-annotation-directory} (defaults to
|
|
|
1147 @file{~/.mosaic-personal-annotations}). Any personal annotations for a
|
|
|
1148 document are automatically appended when it is retrieved.
|
|
22
|
1149
|
|
70
|
1150 :: WORK :: Document the new 'a' prefix keymap
|
|
|
1151 :: WORK :: Tell where the annotations are stored
|
|
|
1152
|
|
|
1153 @findex w3-add-personal-annotation
|
|
|
1154 @vindex w3-annotation-mode
|
|
|
1155 To add a new personal annotation, type @kbd{M-x
|
|
|
1156 w3-add-personal-annotation}. This creates a new buffer, in the mode
|
|
|
1157 specified by @code{w3-annotation-mode}. This defaults to
|
|
|
1158 @code{html-mode}. If this variable is @code{nil}, or it points to an
|
|
|
1159 undefined function, then @code{default-major-mode} is consulted.
|
|
|
1160
|
|
|
1161 A minor mode redefines @kbd{C-c C-c} to complete the annotation and
|
|
|
1162 store it on the local disk.
|
|
0
|
1163
|
|
70
|
1164 @findex w3-delete-personal-annotation
|
|
|
1165 To delete a personal annotation, it must be the current page. Once
|
|
|
1166 reading the annotation, @kbd{M-x w3-delete-personal-annotation} will
|
|
|
1167 remove it. This deletes the file containing the annotation, and any
|
|
|
1168 references to it in the annotation log file.
|
|
|
1169
|
|
|
1170 Editing personal annotations is not yet supported.
|
|
22
|
1171
|
|
70
|
1172 @node Controlling Formatting, General Formatting, Top, Top
|
|
|
1173 @chapter Controlling Formatting
|
|
|
1174 @cindex Customizing formatting
|
|
|
1175 @cindex Specifying Fonts
|
|
|
1176 @cindex Fonts
|
|
|
1177 @cindex Colors
|
|
80
|
1178 How Emacs-W3 formats a document is very customizable. All control over
|
|
|
1179 formatting is now controlled by a default stylesheet set by the user
|
|
|
1180 with the @code{w3-default-sheet} variable.
|
|
0
|
1181
|
|
70
|
1182 The following sections describe in more detail how to change the
|
|
|
1183 formatting of a document.
|
|
0
|
1184
|
|
70
|
1185 @ifinfo
|
|
|
1186 @menu
|
|
|
1187 * General Formatting:: Changing general things about a
|
|
|
1188 document.
|
|
|
1189 * Character based terminals:: Changing how a document is
|
|
|
1190 displayed on a non-graphics
|
|
|
1191 terminal (vt100, etc.@:) or if
|
|
|
1192 @code{w3-delimit-emphasis} is @code{t}.
|
|
|
1193 * Graphics workstations:: Changing how a document is
|
|
|
1194 displayed on a graphics terminal
|
|
|
1195 (Xwindows, Windows, NeXTstep,
|
|
|
1196 OS/2, etc.)
|
|
|
1197 * Inlined images:: How to specify how Emacs-W3
|
|
|
1198 handles inlined images/mpegs.
|
|
|
1199 @end menu
|
|
|
1200 @end ifinfo
|
|
|
1201 @node General Formatting, Character based terminals, Controlling Formatting, Controlling Formatting
|
|
|
1202 @section General formatting conventions
|
|
|
1203 @iftex
|
|
|
1204 @heading Setting the fill column
|
|
|
1205 @end iftex
|
|
|
1206 @ifinfo
|
|
|
1207 @center --------------------
|
|
80
|
1208 @center Setting the right margin
|
|
70
|
1209 @center --------------------
|
|
|
1210 @end ifinfo
|
|
80
|
1211 @cindex Margins
|
|
70
|
1212 @vindex fill-column
|
|
|
1213 @vindex w3-right-border
|
|
80
|
1214 Each time a document is parsed, the right margin is recalculated
|
|
|
1215 using the width of the current window and @code{w3-right-border}.
|
|
70
|
1216 @code{w3-right-border} is an integer specifying how much room at the
|
|
|
1217 right edge of the screen to leave blank. The @code{fill-column} is set
|
|
|
1218 to @code{(- (window-width) @code{w3-right-border})}.
|
|
|
1219 @iftex
|
|
|
1220 @heading Formatting of directory listings
|
|
|
1221 @end iftex
|
|
|
1222 @ifinfo
|
|
|
1223 @center --------------------
|
|
|
1224 @center Formatting of directory listings
|
|
|
1225 @center --------------------
|
|
|
1226 @end ifinfo
|
|
|
1227 @vindex url-use-hypertext-dired
|
|
|
1228 When Emacs-W3 encounters a link to a directory (whether by local file access
|
|
|
1229 or via FTP), it can either create an HTML document on the fly, or use
|
|
|
1230 @code{dired-mode} to peruse the listing. The variable
|
|
|
1231 @code{url-use-hypertext-dired} controls this behavior.
|
|
0
|
1232
|
|
70
|
1233 If the value is @code{t}, Emacs-W3 uses @code{directory-files} to list them
|
|
|
1234 out and transform the directory into a hypertext document, then pass it
|
|
|
1235 through the parser like any other document.
|
|
22
|
1236
|
|
70
|
1237 If the value is @code{nil}, just pass the directory off to dired using
|
|
|
1238 @code{find-file}. Using this option loses all the hypertext abilities
|
|
|
1239 of Emacs-W3, and the users is unable to load documents in the directory
|
|
|
1240 directly into Emacs-W3 by clicking with the mouse, etc.
|
|
22
|
1241
|
|
70
|
1242 @iftex
|
|
|
1243 @heading Formatting of gopher directories
|
|
|
1244 @end iftex
|
|
|
1245 @ifinfo
|
|
|
1246 @center --------------------
|
|
|
1247 @center Formatting of gopher directories
|
|
|
1248 @center --------------------
|
|
|
1249 @end ifinfo
|
|
|
1250 @vindex w3-use-hypertext-gopher
|
|
|
1251 @cindex Gopher+
|
|
|
1252 @cindex ASK blocks
|
|
|
1253 There are two different ways of viewing gopher links. The built-in
|
|
|
1254 support that converts gopher directories into HTML, or the
|
|
|
1255 @file{gopher.el} package by Scott Snyder (@i{snyder@@fnald0.fnal.gov}).
|
|
|
1256 The variable that controls this is @code{w3-use-hypertext-gopher}. If
|
|
|
1257 set to @code{nil}, then @file{gopher.el} is used. Any other value
|
|
|
1258 causes Emacs-W3 to use its internal gopher support. If using
|
|
|
1259 @file{gopher.el}, all the hypertext capabilities of Emacs-W3 are lost.
|
|
|
1260 All the functionality of @file{gopher.el} is now available in the
|
|
|
1261 hypertext version, and the hypertext version supports Gopher+ and ASK
|
|
|
1262 blocks.
|
|
22
|
1263
|
|
70
|
1264 @vindex w3-gopher-labels
|
|
|
1265 The main way to control the display of gopher directories is by the
|
|
|
1266 variable @code{w3-gopher-labels}. This variable controls the text that
|
|
|
1267 is inserted at the front of each item. This is an assoc list of gopher
|
|
|
1268 types (as one character strings), and a string to insert just after the
|
|
|
1269 list item. All the normal gopher types are defined. Entries should be
|
|
|
1270 similar to: @samp{("0" . "(TXT)")}. I have tried to keep all the tags
|
|
|
1271 to three characters plus two parentheses.
|
|
|
1272 @iftex
|
|
|
1273 @heading Creating a horizontal rule
|
|
|
1274 @end iftex
|
|
|
1275 @ifinfo
|
|
|
1276 @center --------------------
|
|
|
1277 @center Creating a horizontal rule
|
|
|
1278 @center --------------------
|
|
|
1279 @end ifinfo
|
|
|
1280 @vindex w3-horizontal-rule-char
|
|
|
1281 Horizontal rules (@b{<HR>} tags in HTML[+]) are used to separate chunks
|
|
|
1282 of a document, and is meant to be rendered as a solid line across the
|
|
|
1283 page. Some terminals display characters differently, so the variable
|
|
80
|
1284 @code{w3-horizontal-rule-char} controls which character is used to draw
|
|
|
1285 a horizontal bar. This variable must be the ASCII value of the
|
|
|
1286 character, @b{not a string}. The variable is passed through
|
|
|
1287 @code{make-string} whenever a horizontal rule of a certain width is
|
|
|
1288 necessary.
|
|
22
|
1289
|
|
70
|
1290 @node Character based terminals, Graphics workstations, General Formatting, Controlling Formatting
|
|
|
1291 @section On character based terminals
|
|
|
1292 @vindex w3-delimit-emphasis
|
|
|
1293 On character based terminals, there is no easy way to show that a
|
|
|
1294 certain range of text is in bold or italics. If the variable
|
|
|
1295 @code{w3-delimit-emphasis} is non-@code{nil}, then Emacs-W3 can insert
|
|
|
1296 characters before and after character formatting commands in HTML
|
|
|
1297 documents. The defaul value of @code{w3-delimit-emphasis} is
|
|
|
1298 automatically set based on the type of window system and version of
|
|
|
1299 Emacs being used.
|
|
0
|
1300
|
|
70
|
1301 @vindex w3-header-chars-assoc
|
|
|
1302 :: WORK ::
|
|
|
1303
|
|
|
1304 @findex w3-upcase-region
|
|
|
1305 @code{w3-header-chars-assoc} is an assoc list of header tags and a list
|
|
|
1306 of formatting instructions. The @code{car} of the list is the level of
|
|
|
1307 the header (1--6). The rest of the list should contain three items.
|
|
|
1308 The first item is text to insert before the header. The second item is
|
|
|
1309 text to insert after the header. Both should have reserved characters
|
|
|
1310 converted to their HTML[+] entity definitions. The third item is a
|
|
|
1311 function to call on the area the header is in. This function is called
|
|
|
1312 with arguments specifying the start and ending character positions of
|
|
|
1313 the header. The starting point is always first. To convert a region to
|
|
|
1314 upper case, please use @code{w3-upcase-region} instead of
|
|
|
1315 @code{upcase-region}, so that entities are converted properly.
|
|
22
|
1316
|
|
70
|
1317 @node Graphics workstations, Inlined images, Character based terminals, Controlling Formatting
|
|
|
1318 @section With graphics workstations
|
|
|
1319 Starting with the first public release of version 2.3.0, all formatting
|
|
|
1320 is controlled by the use of stylesheets.
|
|
|
1321
|
|
|
1322 :: WORK :: Graphic workstation stuff - redo for stylesheets
|
|
0
|
1323
|
|
70
|
1324 @node Inlined images, , Graphics workstations, Controlling Formatting
|
|
|
1325 @cindex Inlined images
|
|
|
1326 @cindex Images
|
|
|
1327 @cindex Movies
|
|
|
1328 @cindex Inlined MPEGs
|
|
|
1329 @cindex MPEGs
|
|
|
1330 When running in Lucid Emacs 19.10 or XEmacs 19.11 and higher, Emacs-W3 can
|
|
|
1331 display inlined images and MPEG movies. There are several variables that
|
|
|
1332 control how and when the images are displayed.
|
|
22
|
1333
|
|
70
|
1334 @cindex Netpbm
|
|
|
1335 @cindex Pbmplus
|
|
|
1336 @vindex w3-graphic-converter-alist
|
|
|
1337 Since Lucid/XEmacs only natively understands XPixmaps and XBitmaps, GIFs
|
|
|
1338 and other image types must first be converted to one of these formats.
|
|
|
1339 To do this, the @b{netpbm utilities}@footnote{Available via anonymous
|
|
|
1340 ftp from ftp.x.org:/R5contrib/netpbm-1mar1994.tar.gz, and most large ftp
|
|
|
1341 sites.} programs are normally used. This is a suite of freeware image
|
|
|
1342 conversion tools. The variable @code{w3-graphic-converter-alist}
|
|
|
1343 controls how each image type is converted. This is an assoc list, keyed
|
|
|
1344 on the MIME content-type. The @code{car} is the content-type, and the
|
|
|
1345 @code{cdr} is a string suitable to pass to @code{format}. A %s in this
|
|
|
1346 string will be replaced with a converter from the ppm image format to an
|
|
|
1347 XPixmap (or XBitmap, if being run on a monochrome display). By default,
|
|
|
1348 the Emacs-W3 browser has converters for:
|
|
0
|
1349
|
|
|
1350 @enumerate
|
|
|
1351 @item
|
|
70
|
1352 image/x-xbitmap
|
|
|
1353 @item
|
|
|
1354 image/xbitmap
|
|
|
1355 @item
|
|
|
1356 image/xbm
|
|
|
1357 @item
|
|
|
1358 image/gif
|
|
0
|
1359 @item
|
|
70
|
1360 image/jpeg
|
|
|
1361 @item
|
|
|
1362 image/x-fax
|
|
|
1363 @item
|
|
|
1364 image/x-raster
|
|
|
1365 @item
|
|
|
1366 image/windowdump
|
|
0
|
1367 @item
|
|
70
|
1368 image/x-icon
|
|
|
1369 @item
|
|
|
1370 image/portable-graymap
|
|
|
1371 @item
|
|
|
1372 image/portable-pixmap
|
|
|
1373 @item
|
|
|
1374 image/x-pixmap
|
|
0
|
1375 @item
|
|
70
|
1376 image/x-xpixmap
|
|
|
1377 @item
|
|
|
1378 image/pict
|
|
|
1379 @item
|
|
|
1380 image/x-macpaint
|
|
|
1381 @item
|
|
|
1382 image/x-targa
|
|
|
1383 @item
|
|
|
1384 image/tiff
|
|
0
|
1385 @end enumerate
|
|
|
1386
|
|
70
|
1387 @vindex w3-color-max-blue
|
|
|
1388 @vindex w3-color-max-green
|
|
|
1389 @vindex w3-color-max-red
|
|
|
1390 @vindex w3-color-use-reducing
|
|
|
1391 @vindex w3-color-filter
|
|
|
1392 Since most displays are (sadly) not 24-bit, Emacs-W3 can automatically
|
|
|
1393 dither an image, so that it does not fill up the application' colormap too
|
|
|
1394 quickly. If @code{w3-color-use-reducing} is non-@code{nil}, then the
|
|
|
1395 images will use reduced colors. If @code{w3-color-filter} is @code{eq} to
|
|
|
1396 @code{'ppmquant}, then the ppmquant program will be used. If @code{eq} to
|
|
|
1397 @code{'ppmdither}, then the ppmdither program will be used. The ppmdither
|
|
|
1398 program tends to give better results. The values of
|
|
|
1399 @code{w3-color-max-red}, @code{w3-color-max-blue}, and
|
|
|
1400 @code{w3-color-max-green} control how many colors the inlined images can
|
|
|
1401 use. If using ppmquant, then the product of these three variables is used
|
|
|
1402 as the maximum number of colors per image. If using ppmdither, then only
|
|
|
1403 the set number of color cells can be allocated per image. See the man
|
|
|
1404 pages for ppmdither and ppmquant for more information on how the dithering
|
|
|
1405 is actually done. @code{w3-color-filter} may also be a string, specifying
|
|
|
1406 exactly what external filter to use. An example is: @samp{ppmquant -fs
|
|
|
1407 -map ~/pixmaps/colormap.ppm}.
|
|
22
|
1408
|
|
70
|
1409 @cindex MPEGs
|
|
|
1410 @cindex Inlined animations
|
|
|
1411 When running in XEmacs 19.11 or XEmacs 19.12, Emacs-W3 can insert an
|
|
|
1412 MPEG movie in the middle of a buffer.
|
|
22
|
1413
|
|
70
|
1414 :: WORK :: Need a pointer to the new EMBED Internet Draft ::
|
|
26
|
1415
|
|
70
|
1416 The basic syntax is:
|
|
24
|
1417 @example
|
|
70
|
1418 <embed href="somevideo.mpg" type="video/mpeg">
|
|
24
|
1419 @end example
|
|
|
1420
|
|
70
|
1421 @vindex w3-mpeg-args
|
|
|
1422 @vindex w3-mpeg-program
|
|
|
1423 This requires a special version of the standard @file{mpeg_play} mpeg
|
|
|
1424 player. Patches against the 2.0 version are available at
|
|
|
1425 ftp://ftp.cs.indiana.edu/pub/elisp/w3/mpeg_patch. The variable
|
|
|
1426 @code{w3-mpeg-program} should point to this executable, and
|
|
|
1427 @code{w3-mpeg-args} should be a list of any additional arguments to be
|
|
|
1428 passed to the player. By default, this includes @var{-loop}, so the
|
|
|
1429 mpeg plays continuously.
|
|
24
|
1430
|
|
70
|
1431 @cindex Delaying inlined images
|
|
|
1432 @cindex Delaying inlined animations
|
|
|
1433 @vindex w3-delay-image-loads
|
|
|
1434 @vindex w3-delay-mpeg-loads
|
|
|
1435 Because images and movies can take up an incredible amount of bandwidth,
|
|
|
1436 it is useful to be able to control whether they are loaded or not. By
|
|
|
1437 default, images and movies are loaded automatically, but the variables
|
|
|
1438 @code{w3-delay-image-loads} and @code{w3-delay-mpeg-loads} control this.
|
|
|
1439 If set to non-@code{nil}, then the images or movies are not
|
|
|
1440 loaded until explicitly requested by the user.
|
|
26
|
1441
|
|
70
|
1442 @cindex Loading delayed images
|
|
|
1443 @cindex Loading delayed movies
|
|
|
1444 @findex w3-load-delayed-images
|
|
|
1445 @findex w3-load-delayed-mpegs
|
|
|
1446 To load any delayed images, use the function
|
|
|
1447 @code{w3-load-delayed-images}. Its counterpart for delayed movies is
|
|
|
1448 @code{w3-load-delayed-mpegs}
|
|
22
|
1449
|
|
70
|
1450 @node MIME Support, Adding MIME types based on file extensions, , Top
|
|
0
|
1451 @chapter MIME Support
|
|
70
|
1452 MIME is an emerging standard for multimedia mail. It offers a very
|
|
0
|
1453 flexible typing mechanism. The type of a file or message is specified
|
|
|
1454 in two parts, separated by a '/'. The first part is the general
|
|
|
1455 category of the data (text, application, image, etc.). The second part
|
|
70
|
1456 is the specific type of data (postscript, gif, jpeg, etc.). So
|
|
|
1457 @samp{text/html} specifies an HTML document, whereas
|
|
0
|
1458 @samp{image/x-xwindowdump} specifies an image of an Xwindow taken with
|
|
|
1459 the @file{xwd} program.
|
|
|
1460
|
|
|
1461
|
|
70
|
1462 This typing allows much more flexibility in naming files. HTTP/1.0
|
|
0
|
1463 servers can now send back content-type headers in response to a request,
|
|
70
|
1464 and not have the client second-guess it based on file extensions. HTML
|
|
|
1465 files can now be named @file{something.gif} (not a great idea, but
|
|
0
|
1466 possible).
|
|
|
1467
|
|
70
|
1468 @ifinfo
|
|
0
|
1469 @menu
|
|
|
1470 * Adding MIME types based on file extensions:: How to map file
|
|
|
1471 extensions onto MIME
|
|
70
|
1472 types (e.g., @samp{.gif ->
|
|
|
1473 image/gif)}.
|
|
|
1474 * Specifying Viewers:: How to specify external and internal viewers
|
|
|
1475 for files that Emacs-W3 cannot handle natively.
|
|
0
|
1476 @end menu
|
|
70
|
1477 @end ifinfo
|
|
0
|
1478
|
|
|
1479 @node Adding MIME types based on file extensions, Specifying Viewers, MIME Support, MIME Support
|
|
|
1480 @section Adding MIME types based on file extensions
|
|
|
1481 @vindex mm-mime-extensions
|
|
|
1482 For some protocols however, it is still necessary to guess the content
|
|
|
1483 of a file based on the file extension. This type of guess-work should
|
|
70
|
1484 only be needed when accessing files via FTP, local file access, or old
|
|
|
1485 HTTP/0.9 servers.
|
|
0
|
1486
|
|
|
1487 Instead of specifying how to view things twice, once based on
|
|
|
1488 content-type and once based on the file extension, it is easier to map
|
|
|
1489 file extensions to MIME content-types. The variable that controls this
|
|
|
1490 is @code{mm-mime-extensions}.
|
|
|
1491
|
|
|
1492 This variable is an assoc list of file extensions and the corresponding
|
|
|
1493 MIME content-type. A sample entry looks like: @samp{(".movie"
|
|
|
1494 . "video/x-sgi-movie")} This makes all files that end in @file{.movie}
|
|
|
1495 (@file{foo.movie} and @file{bar.movie}) be interpreted as SGI animation
|
|
|
1496 files. If a content-type is defined for the document, then this is
|
|
|
1497 over-ridden. Regular expressions can @b{NOT} be used.
|
|
|
1498
|
|
|
1499 @cindex mime-types file
|
|
|
1500 @findex mm-parse-mimetypes
|
|
70
|
1501 Both Mosaic and the NCSA HTTP daemon rely on a separate file for mapping
|
|
|
1502 file extensions to MIME types. Instead of having the users of Emacs-W3
|
|
0
|
1503 duplicate this in lisp, this file can be parsed using the
|
|
|
1504 @code{url-parse-mimetypes} function. This function is called each time
|
|
|
1505 w3 is loaded. It tries to locate mimetype files in several places. If
|
|
|
1506 the environment variable @code{MIMETYPES} is nonempty, then this is
|
|
|
1507 assumed to specify a UNIX-like path of mimetype files (this is a colon
|
|
|
1508 separated string of pathnames). If the @code{MIMETYPES} environment
|
|
70
|
1509 variable is empty, then Emacs-W3 looks for these files:
|
|
0
|
1510
|
|
|
1511 @enumerate
|
|
|
1512 @item
|
|
|
1513 @file{~/.mime-types}
|
|
|
1514 @item
|
|
|
1515 @file{/etc/mime-types}
|
|
|
1516 @item
|
|
|
1517 @file{/usr/etc/mime-types}
|
|
|
1518 @item
|
|
|
1519 @file{/usr/local/etc/mime-types}
|
|
|
1520 @item
|
|
|
1521 @file{/usr/local/www/conf/mime-types}
|
|
|
1522 @end enumerate
|
|
|
1523
|
|
70
|
1524 Each line contains information for one http type. These types resemble
|
|
0
|
1525 MIME types. To add new ones, use subtypes beginning with x-, such as
|
|
|
1526 application/x-myprogram. Lines beginning with # are comment lines, and
|
|
|
1527 suitably ignored. Each line consists of:
|
|
|
1528
|
|
|
1529 type/subtype ext1 ext2 ... ext@var{n}
|
|
|
1530
|
|
|
1531 type/subtype is the MIME-like type of the document. ext* is any number
|
|
|
1532 of space-separated filename extensions which correspond to the MIME
|
|
|
1533 type.
|
|
|
1534
|
|
70
|
1535 @node Specifying Viewers, ,Adding MIME types based on file extensions, MIME Support
|
|
0
|
1536 @section Specifying Viewers
|
|
70
|
1537 Not all files look as they should when parsed as an HTML document
|
|
0
|
1538 (whitespace is stripped, paragraphs are reformatted, and lots of little
|
|
|
1539 changes that make the document look unrecognizable). Files may be
|
|
|
1540 passed to external programs or Emacs Lisp functions to be viewed.
|
|
|
1541
|
|
70
|
1542 Not all files can be viewed accurately from within an Emacs session (GIF
|
|
0
|
1543 files for example, or audio files). For this reason, the user can
|
|
|
1544 specify file "viewers" based on MIME content-types. This is done with
|
|
|
1545 a standard mailcap file. @xref{Mailcap Files}
|
|
|
1546
|
|
|
1547 @findex mm-add-mailcap-entry
|
|
|
1548 As an alternative, the function @code{mm-add-mailcap-entry} can also be
|
|
|
1549 used from an appropriate hook.@xref{Hooks} This functions takes three
|
|
70
|
1550 arguments, the major type ("@i{image}"), the minor type ("@i{gif}"), and
|
|
|
1551 an assoc list of information about the viewer. Please see the URL
|
|
0
|
1552 documentation for more specific information on what this assoc list
|
|
|
1553 should look like.
|
|
|
1554
|
|
70
|
1555 @node Security, Non-Unix Operating Systems, , Top
|
|
0
|
1556 @chapter Security
|
|
|
1557 @cindex Security
|
|
|
1558 @cindex Paranoia
|
|
|
1559 There are an increasing number of ways to authenticate a user to a web
|
|
70
|
1560 service. Emacs-W3 tries to support as many as possible. Emacs-W3
|
|
0
|
1561 currently supports:
|
|
|
1562
|
|
|
1563 @table @b
|
|
|
1564 @item Basic Authentication
|
|
|
1565 @cindex Security, Basic
|
|
|
1566 @cindex HTTP/1.0 Authentication
|
|
|
1567 @cindex Authentication, Basic
|
|
|
1568 The weakest authentication available, not recommended if serious
|
|
|
1569 security is necessary. This is simply a string that looks like
|
|
|
1570 @samp{user:password} that has been Base64 encoded, as defined in RFC
|
|
|
1571 1421.
|
|
|
1572 @item Digest Authentication
|
|
|
1573 @cindex Security, Digest
|
|
|
1574 @cindex HTTP/1.0 Authentication
|
|
|
1575 @cindex Authentication, Digest
|
|
|
1576 Jeffery L. Hostetler, John Franks, Philip Hallam-Baker, Ari Luotonen,
|
|
|
1577 Eric W. Sink, and Lawrence C. Stewart have an internet draft for a new
|
|
|
1578 authentication mechanism. For the complete specification, please see
|
|
|
1579 draft-ietf-http-digest-aa-01.txt in the nearest internet drafts
|
|
|
1580 archive@footnote{One is ftp://ds.internic.net/internet-drafts}.
|
|
|
1581 @item SSL Encryption
|
|
|
1582 @cindex HTTP/1.0 Authentication
|
|
|
1583 @cindex Secure Sockets Layer
|
|
|
1584 @cindex SSL
|
|
|
1585 @cindex Gag Puke Retch
|
|
|
1586 @cindex Exportability
|
|
|
1587 @cindex Export Restrictions
|
|
|
1588 SSL is the @code{Secure Sockets Layer} interface developed by Netscape
|
|
70
|
1589 Communications @footnote{http://www.netscape.com/}. Emacs-W3 supports
|
|
|
1590 HTTP transfers over an SSL encrypted channel, if the appropriate files
|
|
0
|
1591 have been installed.@xref{Installing SSL}
|
|
70
|
1592 @item PGP/PEM
|
|
|
1593 @cindex HTTP/1.0 Authentication
|
|
|
1594 @cindex Public Key Cryptography
|
|
|
1595 @cindex Authentication, PGP
|
|
|
1596 @cindex Authentication, PEM
|
|
|
1597 @cindex RIPEM
|
|
|
1598 @cindex Public Key Cryptography
|
|
|
1599 @cindex PGP
|
|
|
1600 @cindex Pretty Good Privacy
|
|
|
1601 @cindex Encryption
|
|
|
1602 @cindex Security
|
|
|
1603 @cindex ITAR must die
|
|
|
1604 @cindex Stupid export restrictions
|
|
|
1605 @cindex Support your local crypto-anarchist
|
|
|
1606 @cindex NSA freaks
|
|
|
1607 A few servers still support this method of authentication, but it has
|
|
|
1608 been superseded by SSL and Secure-HTTP.@xref{Using PGP/PEM}
|
|
0
|
1609 @end table
|
|
|
1610
|
|
70
|
1611 @node Non-Unix Operating Systems, VMS, Security, Top
|
|
0
|
1612 @chapter Non-Unix Operating Systems
|
|
|
1613 @cindex Non-Unix Operating Systems
|
|
70
|
1614 @ifinfo
|
|
0
|
1615 @menu
|
|
70
|
1616 * VMS:: The wonderful world of VAX|AXP-VMS!
|
|
|
1617 * OS/2:: The next-best thing to Unix.
|
|
|
1618 * MS-DOS:: The wonderful world of MS-DOG!
|
|
|
1619 * 32-Bit Windows:: Windows NT, Chicago/Windows 95.
|
|
|
1620 * Amiga:: The Amiga, for those who still love them.
|
|
0
|
1621 @end menu
|
|
70
|
1622 @end ifinfo
|
|
0
|
1623
|
|
|
1624 @node VMS, OS/2, Non-Unix Operating Systems, Non-Unix Operating Systems
|
|
|
1625 @section VMS
|
|
|
1626 @cindex VAX-VMS
|
|
|
1627 @cindex AXP-VMS
|
|
|
1628 @cindex Digital VMS
|
|
|
1629 @cindex VMS
|
|
|
1630 :: WORK :: VMS Specific instriuctions
|
|
|
1631
|
|
|
1632 @node OS/2, MS-DOS, VMS, Non-Unix Operating Systems
|
|
|
1633 @section OS/2
|
|
|
1634 @cindex OS/2
|
|
|
1635 @cindex Warp
|
|
|
1636 :: WORK :: OS/2 Specific instructions
|
|
|
1637
|
|
70
|
1638 @node MS-DOS, 32-Bit Windows, OS/2, Non-Unix Operating Systems
|
|
0
|
1639 @section MS-DOS
|
|
|
1640 @cindex MS-DOS
|
|
|
1641 @cindex Microsloth
|
|
|
1642 @cindex DOS
|
|
|
1643 @cindex MS-DOG
|
|
|
1644 :: WORK :: DOS Specific instructions
|
|
|
1645
|
|
70
|
1646 @node 32-Bit Windows, Amiga, MS-DOS, Non-Unix Operating Systems
|
|
|
1647 @section 32-Bit Windows
|
|
0
|
1648 @cindex Windows (32-Bit)
|
|
|
1649 @cindex 32-Bit Windows
|
|
|
1650 @cindex Microsloth
|
|
|
1651 @cindex Windows '95
|
|
|
1652 :: WORK :: 32bit Windows Specific instructions
|
|
|
1653
|
|
70
|
1654 @node Amiga, Advanced Features, 32-Bit Windows, Non-Unix Operating Systems
|
|
|
1655 @section Amiga
|
|
|
1656 @cindex Amiga
|
|
|
1657 @cindex Commodore
|
|
|
1658 :: WORK :: Amiga specific instructions
|
|
26
|
1659
|
|
70
|
1660 @node Advanced Features, Style Sheets, Amiga, Top
|
|
0
|
1661 @chapter Advanced Features
|
|
|
1662
|
|
70
|
1663 @ifinfo
|
|
0
|
1664 @menu
|
|
70
|
1665 * Style Sheets:: Formatting control, the right way
|
|
|
1666 * Disk Caching:: Improving performance by using a local disk cache
|
|
|
1667 * Interfacing to Mail/News:: How to make VM understand hypertext links
|
|
|
1668 * Debugging HTML:: How to make Emacs-W3 display warnings about invalid
|
|
|
1669 HTML/HTML+ constructs.
|
|
|
1670 * Native WAIS Support:: How to make Emacs-W3 understand WAIS links without
|
|
|
1671 using a gateway.
|
|
|
1672 * Rating Links:: How to make Emacs-W3 put an 'interestingness' value
|
|
|
1673 next to each link.
|
|
|
1674 * Gopher Plus Support:: How Emacs-W3 makes use of the Gopher+ protocol.
|
|
|
1675 * Hooks:: Various hooks to use throughout Emacs-W3
|
|
|
1676 * Other Variables:: Miscellaneous variables that control the real
|
|
|
1677 guts of Emacs-W3.
|
|
0
|
1678 @end menu
|
|
70
|
1679 @end ifinfo
|
|
26
|
1680
|
|
70
|
1681 @node Style Sheets, Disk Caching, Advanced Features, Advanced Features
|
|
|
1682 @section Style Sheets
|
|
|
1683 @cindex Formatting control
|
|
|
1684 @cindex Style sheets
|
|
|
1685 @cindex Look and Feel
|
|
|
1686 @cindex Layout control
|
|
|
1687 @cindex Experimental style sheet mechanism
|
|
|
1688 Emacs-W3 currently supports the experimental style sheet mechanism
|
|
|
1689 proposed by H&kon W. Lie of the W3 Consortium. This allows for the
|
|
|
1690 author to specify what a document should look like, and yet allow the
|
|
|
1691 end user to override any of the stylistic changes. This allows for
|
|
|
1692 people with special needs (most notably the visually impaired) to
|
|
|
1693 override style bindings that could make a document totally
|
|
|
1694 unreadable.
|
|
|
1695
|
|
|
1696 @example
|
|
|
1697 <style notation="css">
|
|
|
1698 /* This is a comment
|
|
|
1699 ** These will be ignored, up to the terminating */
|
|
|
1700
|
|
|
1701 h1 @{ align: center,
|
|
|
1702 color: yellow,
|
|
|
1703 background: red,
|
|
|
1704 font-size: 24pt
|
|
|
1705 @}
|
|
|
1706 h2 @{ align: right,
|
|
|
1707 font-family: palatino,
|
|
|
1708 font-size: 18pt
|
|
|
1709 @}
|
|
|
1710 </style>
|
|
|
1711 @end example
|
|
|
1712
|
|
|
1713 :: WORK :: Much more information on stylesheets
|
|
|
1714
|
|
|
1715 @cindex <style>
|
|
|
1716 To include a stylesheet into a document, simply use the <style> tag.
|
|
|
1717 Use the @b{notation} attribute to specify what language the stylesheet
|
|
|
1718 is specified in. The default is @b{css}. The data between the <style>
|
|
|
1719 and </style> tags is the stylsheet proper - no HTML parsing is done to
|
|
|
1720 this data - it is treated similar to an <XMP> section of text. To
|
|
|
1721 reference an external stylesheet, use the <link> tag.
|
|
|
1722 @example
|
|
|
1723 <link rel="stylesheet" href="/bill.style">
|
|
|
1724 @end example
|
|
|
1725 If these two mechanisms are mixed, then the URL is resolved first, and
|
|
|
1726 the contents of the <style> tag take precedence if there are any
|
|
|
1727 conflicting directives.
|
|
|
1728
|
|
|
1729 @cindex DSSSL
|
|
|
1730 @cindex DSSSL-lite
|
|
|
1731 In the future, DSSSL and DSSSL-lite will be supported as valid
|
|
|
1732 stylesheet languages, but not in this release. For more information on
|
|
|
1733 DSSSL-lite see http://www.falch.no/~pepper/DSSSL-Lite/ - for more
|
|
|
1734 information on full DSSSL, see
|
|
|
1735 ftp://ftp.jclark.com/pub/dsssl/dsssl.ps.gz
|
|
|
1736
|
|
|
1737 @node Disk Caching, Interfacing to Mail/News, Style Sheets, Advanced Features
|
|
0
|
1738 @section Disk Caching
|
|
|
1739 @cindex Caching
|
|
|
1740 @cindex Persistent Cache
|
|
|
1741 @cindex Disk Cache
|
|
|
1742 A cache stores the information on a page on the local machine. When
|
|
70
|
1743 requesting a page that is in the cache, Emacs-W3 can retrieve the page
|
|
0
|
1744 from the cache more quickly than retrieving the page again from its
|
|
|
1745 location out on the network. With a well-populated cache, browsing the
|
|
|
1746 web is dramatically faster.
|
|
|
1747
|
|
70
|
1748 The first time a page is requested, Emacs-W3 retrieves the page from the
|
|
|
1749 network. When requesting a page that is in the cache, Emacs-W3 checks
|
|
0
|
1750 to see if the page has changed since it was last retrieved from the
|
|
|
1751 remote machine. If it has not changed, the local copy is used, saving
|
|
|
1752 the transmission of the file over the network.
|
|
|
1753
|
|
|
1754 @vindex url-automatic-caching
|
|
|
1755 @cindex Turning on caching
|
|
|
1756 @cindex Cleaning the cache
|
|
|
1757 @cindex Clearing the cache
|
|
|
1758 @cindex Cache cleaning
|
|
|
1759 @cindex Limiting the size of the cache
|
|
|
1760 To turn on disk caching, set the variable @code{url-automatic-caching}
|
|
|
1761 to non-@code{nil}, or choose the 'Caching' menu item (under `Options').
|
|
|
1762 That is all there is to it. Running the @code{clean-cache} shell script
|
|
|
1763 fist is recommended, to allow for future cleaning of the cache. This
|
|
|
1764 shell script will remove all files that have not been accessed since it
|
|
|
1765 was last run. To keep the cache pared down, it is recommended that this
|
|
|
1766 script be run from @i{at} or @i{cron} (see the manual pages for
|
|
|
1767 crontab(5) or at(1) for more information)
|
|
|
1768
|
|
|
1769
|
|
|
1770 @cindex Relying on cache
|
|
|
1771 @cindex Cache only mode
|
|
|
1772 @cindex Standalone mode
|
|
|
1773 @cindex Browsing with no network connection
|
|
|
1774 @cindex Netless browsing
|
|
|
1775 @vindex url-standalone-mode
|
|
|
1776 With a large cache of documents on the local disk, it can be very handy
|
|
|
1777 when traveling, or any other time the network connection is not active
|
|
70
|
1778 (a laptop with a dial-on-demand PPP connection, etc). Emacs-W3 can rely
|
|
0
|
1779 solely on its cache, and avoid checking to see if the page has changed
|
|
|
1780 on the remote server. In the case of a dial-on-demand PPP connection,
|
|
|
1781 this will keep the phone line free as long as possible, only bringing up
|
|
|
1782 the PPP connection when asking for a page that is not located in the
|
|
|
1783 cache. This is very useful for demonstrations as well. To turn this
|
|
|
1784 feature on, set the variable @code{url-standalone-mode} to
|
|
|
1785 non-@code{nil}, or choose the `Use Cache Only' menu item (under
|
|
|
1786 `Options')
|
|
|
1787
|
|
70
|
1788 @cindex Caching options
|
|
|
1789 @cindex Alternate caching method
|
|
|
1790 Emacs-W3 caches files under the temporary directory specified by
|
|
|
1791 @code{url-temporary-directory}, in a user-specific subdirectory
|
|
|
1792 (determined by the @code{user-real-login-name} function). The cache
|
|
|
1793 files are stored under their original names, so a URL like:
|
|
|
1794 http://www.aventail.com/foo/bar/baz.html would be stored in a cache file
|
|
|
1795 named: /tmp/wmperry/com/aventail/www/foo/bar/baz.html. Sometimes,
|
|
|
1796 espcially with gopher links, there will be name conflicts, and an error
|
|
|
1797 will be signalled. This cannot be avoided, and still have reasonable
|
|
|
1798 performance at startup time (reading in an index file of all the cached
|
|
|
1799 pages can take a long time on slow machines, or even fast machines with
|
|
|
1800 large caches). When running XEmacs 19.12 or later, a different naming
|
|
|
1801 scheme can be used. This avoids name conflicts, but loses the human
|
|
|
1802 readability of the cache file names. The cache files will look like:
|
|
|
1803 /tmp/wmperry/acbd18db4cc2f85cedef654fccc4a4d8, which is certainly
|
|
|
1804 unique, but not very user-friendly. To turn this on, add this to the
|
|
|
1805 @file{.emacs} file:
|
|
|
1806
|
|
|
1807
|
|
|
1808 @example
|
|
|
1809 (add-hook 'w3-load-hooks '(lambda ()
|
|
|
1810 (fset 'url-create-cached-filename
|
|
|
1811 'url-create-cached-filename-using-md5)))
|
|
|
1812 @end example
|
|
|
1813
|
|
|
1814 If other versions of emacs will not be sharing the cache, I highly
|
|
|
1815 recommend this method of creating the cache filename.
|
|
|
1816
|
|
|
1817
|
|
0
|
1818 @node Interfacing to Mail/News, Debugging HTML, Disk Caching, Advanced Features
|
|
|
1819 @section Interfacing to Mail/News
|
|
|
1820 @cindex Interfacing to Mail/News
|
|
|
1821 @cindex VM
|
|
70
|
1822 @cindex Using Emacs-W3 with VM
|
|
0
|
1823 @cindex GNUS
|
|
70
|
1824 @cindex Using Emacs-W3 with Gnus
|
|
0
|
1825 @cindex RMAIL
|
|
70
|
1826 @cindex Using Emacs-W3 with RMAIL
|
|
|
1827 More and more people are including URLs in their signatures, and within
|
|
0
|
1828 the body of mail messages. It can get quite tedious to type these into
|
|
|
1829 the minibuffer to follow one.
|
|
|
1830
|
|
2
|
1831 @vindex browse-url-browser-function
|
|
|
1832 With the latest versions of VM (the 5.9x series of betas) and Gnus
|
|
70
|
1833 (5.x), URLs are automatically highlighted, and can be followed with the
|
|
|
1834 mouse or the return key. How the URLs are viewed is determined by the
|
|
2
|
1835 variable @code{browse-url-browser-function}, and it should be set to the
|
|
|
1836 symbol @code{browse-url-w3}.
|
|
0
|
1837
|
|
70
|
1838 To access URLs from within RMAIL, the following hook should do the
|
|
0
|
1839 trick.
|
|
|
1840 @example
|
|
|
1841 (add-hook 'rmail-mode-hook
|
|
|
1842 (function
|
|
|
1843 (lambda ()
|
|
|
1844 (define-key rmail-mode-map [mouse-2] 'w3-maybe-follow-link-mouse)
|
|
|
1845 (define-key rmail-mode-map "\r" 'w3-maybe-follow-link))))
|
|
|
1846 @end example
|
|
|
1847
|
|
70
|
1848 @node Debugging HTML, Native WAIS Support, Interfacing to Mail/News, Advanced Features
|
|
0
|
1849 @section Debugging HTML
|
|
|
1850 @cindex Debugging
|
|
|
1851 @cindex Invalid HTML
|
|
|
1852 @cindex Bad HTML
|
|
|
1853 @vindex w3-debug-buffer
|
|
|
1854 @vindex w3-debug-html
|
|
|
1855 For those people that are adventurous, or are just as anal as I am about
|
|
70
|
1856 people writing valid HTML, set the variable @code{w3-debug-html} to
|
|
0
|
1857 @code{t} and see what happens.
|
|
|
1858
|
|
|
1859
|
|
70
|
1860 If a Emacs-W3 thinks it has encountered invalid HTML, then a debugging
|
|
0
|
1861 message is displayed.
|
|
|
1862
|
|
|
1863 :: WORK :: Need to list the different values w3-debug-html can have, and
|
|
|
1864 :: WORK :: what they do ::
|
|
|
1865
|
|
70
|
1866 @node Native WAIS Support, Rating Links, Debugging HTML, Advanced Features
|
|
|
1867 @section Native WAIS Support
|
|
|
1868 This version of Emacs-W3 supports native WAIS querying (earlier
|
|
|
1869 versions required the use of a gateway program). In order to use the
|
|
|
1870 native WAIS support, a working @dfn{waisq} binary is required. I
|
|
|
1871 recommend the distribution from think.com -
|
|
|
1872 ftp://think.com/wais/wais-8-b6.1.tar.Z is a good place to start.
|
|
|
1873
|
|
|
1874 @vindex url-waisq-prog
|
|
|
1875 @vindex url-wais-gateway-server
|
|
|
1876 @vindex url-wais-gateway-port
|
|
|
1877 The variable @code{url-waisq-prog} must point to this executable, and
|
|
|
1878 one of @code{url-wais-gateway-server} or @code{url-wais-gateway-port}
|
|
|
1879 should be @code{nil}.
|
|
|
1880
|
|
|
1881 When a WAIS URL is encountered, a form will be automatically generated
|
|
|
1882 and displayed. After typing in the search term, the query will be sent
|
|
|
1883 to the server by running the @code{url-waisq-prog} in a subprocess. The
|
|
|
1884 results will be converted into HTML and displayed.
|
|
|
1885
|
|
|
1886 @node Rating Links, Gopher Plus Support, Native WAIS Support, Advanced Features
|
|
|
1887 @section Rating Links
|
|
|
1888 The @code{w3-link-info-display-function} variable can be used to 'rate' a URL
|
|
|
1889 when it shows up in an HTML page. If non-@code{nil}, then this should
|
|
|
1890 be a list specifying (or a symbol specifying the name) of a function.
|
|
|
1891 This function should expect one argument, a fully specified URL, and
|
|
|
1892 should return a string. This string is inserted after the link
|
|
|
1893 text.
|
|
|
1894
|
|
|
1895 If a user has decided that all links served from blort.com are too laden
|
|
|
1896 with images, and wants to be warned that a link points at this host,
|
|
|
1897 they could do something like this:
|
|
|
1898
|
|
|
1899 @example
|
|
|
1900 (defun check-url (url)
|
|
|
1901 (if (string-match "://[^/]blort.com" url)
|
|
|
1902 "[SLOW!]" ""))
|
|
|
1903
|
|
|
1904 (setq w3-link-info-display-function 'check-url)
|
|
|
1905 @end example
|
|
|
1906
|
|
|
1907 So that all links pointing to any site at blort.com shows up as "Some
|
|
|
1908 link[SLOW!]" instead of just "Some link".
|
|
|
1909
|
|
|
1910 @node Gopher Plus Support, Hooks, Rating Links, Advanced Features
|
|
|
1911 @section Gopher+ Support
|
|
|
1912 @cindex Gopher+
|
|
|
1913 The gopher+ support in Emacs-W3 is limited to the conversion of ASK
|
|
|
1914 blocks into HTML 3.0 forms, and the usage of the content-length given by
|
|
|
1915 the gopher+ server to give a nice status bar on the bottom of the
|
|
|
1916 screen.
|
|
|
1917
|
|
|
1918 This will hopefully be extended to include the Gopher+ method of
|
|
|
1919 content-type negotiation, but this may be a while.
|
|
|
1920
|
|
|
1921 @node Hooks, Other Variables, Gopher Plus Support, Advanced Features
|
|
0
|
1922 @section Hooks
|
|
|
1923 @cindex Hooks
|
|
|
1924 These are the various hooks that can be used to customize some of
|
|
70
|
1925 Emacs-W3's behavior. They are arranged in the order in which they would
|
|
|
1926 happen when retrieving a document. All of these are functions (or lists
|
|
|
1927 of functions) that are called consecutively.
|
|
0
|
1928
|
|
|
1929 @table @code
|
|
70
|
1930 @vindex w3-load-hooks
|
|
|
1931 @item w3-load-hooks
|
|
|
1932 These hooks are run by @code{w3-do-setup} the first time a URL is
|
|
|
1933 fetched. All the w3 variables are initialized before this hook is
|
|
|
1934 run.
|
|
|
1935 @item w3-file-done-hooks
|
|
|
1936 These hooks are run by @code{w3-prepare-buffer} after all parsing on a
|
|
|
1937 document has been done. All @code{url-current-}@var{*} and
|
|
|
1938 @code{w3-current-}@var{*} variables are initialized when this hook is run.
|
|
|
1939 This is run before the buffer is shown, and before any inlined images
|
|
|
1940 are downloaded and converted.
|
|
|
1941 @item w3-file-prepare-hooks
|
|
|
1942 These hooks are run by @code{w3-prepare-buffer} before any parsing is
|
|
|
1943 done on the HTML file. The HTTP/1.0 headers specified by
|
|
|
1944 @code{w3-show-headers} have been inserted, the syntax table has been set
|
|
|
1945 to @code{w3-parse-args-syntax-table}, and any personal annotations have
|
|
|
1946 been inserted by the time this hook is run.
|
|
|
1947 @item w3-mode-hooks
|
|
0
|
1948 These hooks are run after a buffer has been parsed and displayed, but
|
|
|
1949 before any inlined images are downloaded and converted.
|
|
70
|
1950 @item w3-source-file-hooks
|
|
|
1951 These hooks are run after displaying a document's source
|
|
0
|
1952 @end table
|
|
|
1953
|
|
70
|
1954 @node Other Variables, , Hooks, Advanced Features
|
|
0
|
1955 @section Miscellaneous variables
|
|
70
|
1956 There are lots of variables that control the real nitty-gritty of Emacs-W3
|
|
0
|
1957 that the beginning user probably shouldn't mess with. Here they are.
|
|
|
1958
|
|
|
1959 @table @code
|
|
|
1960 @item url-bad-port-list
|
|
|
1961 @vindex url-bad-port-list
|
|
|
1962 List of ports to warn the user about connecting to. Defaults to just
|
|
70
|
1963 the mail and NNTP ports so a malicious HTML author cannot spoof mail or
|
|
0
|
1964 news to other people.
|
|
|
1965 @item url-confirmation-func
|
|
|
1966 @vindex url-confirmation-func
|
|
|
1967 What function to use for asking yes or no functions. Possible values
|
|
|
1968 are @code{'yes-or-no-p} or @code{'y-or-n-p}, or any function that takes
|
|
|
1969 a single argument (the prompt), and returns @code{t} only if a positive
|
|
|
1970 answer is gotten. Defaults to @code{'yes-or-no-p}.
|
|
|
1971 @item w3-default-action
|
|
|
1972 @vindex w3-default-action
|
|
|
1973 A lisp symbol specifying what action to take for files with extensions
|
|
|
1974 that are not in the @code{mm-mime-extensions} assoc list. This is
|
|
70
|
1975 useful in case Emacs-W3 ever run across files with weird extensions
|
|
0
|
1976 (.foo, .README, .READMEFIRST, etc.). In most circumstances, this should
|
|
|
1977 not be required anymore.
|
|
|
1978
|
|
|
1979 Possible values: any lisp symbol. Should be a function that takes no
|
|
|
1980 arguments. The return value does not matter, it is ignored. Some examples
|
|
|
1981 are @code{'w3-prepare-buffer} or @code{'indented-text-mode}.
|
|
|
1982 @ignore
|
|
|
1983 @item w3-icon-directory-list
|
|
|
1984 @vindex w3-icon-directory-list
|
|
|
1985 A list of directorys to look in for the w3 standard icons... must end
|
|
|
1986 in a /! If the directory @code{data-directory}/w3 exists, then this is
|
|
|
1987 automatically added to the default value of
|
|
|
1988 http://cs.indiana.edu/elisp/w3/icons/.
|
|
|
1989 @end ignore
|
|
|
1990 @item w3-keep-old-buffers
|
|
|
1991 @vindex w3-keep-old-buffers
|
|
|
1992 Whether to keep old buffers around when following links. To avoid lots
|
|
|
1993 of buffers in one Emacs session, set this variable to @code{nil}. I
|
|
|
1994 recommend setting it to @code{t}, so that backtracking from one link to
|
|
|
1995 another is faster.
|
|
|
1996
|
|
|
1997 @item url-passwd-entry-func
|
|
|
1998 @vindex url-passwd-entry-func
|
|
|
1999 This is a symbol indicating which function to call to read in a
|
|
|
2000 password. If this variable is @code{nil} at startup, it is initialized
|
|
|
2001 depending on whether @dfn{EFS} or @dfn{ange-ftp} is being used. This
|
|
|
2002 function should accept the prompt string as its first argument, and the
|
|
|
2003 default value as its second argument.
|
|
|
2004
|
|
|
2005 @item w3-reuse-buffers
|
|
|
2006 @vindex w3-reuse-buffers
|
|
|
2007 Determines what happens when @code{w3-fetch} is called on a document
|
|
|
2008 that has already been loaded into another buffer. Possible values are:
|
|
|
2009 @code{nil}, @code{yes}, and @code{no}. @code{nil} will ask the user if
|
|
70
|
2010 Emacs-W3 should reuse the buffer (this is the default value). A value of
|
|
0
|
2011 @code{yes} means assume the user wants to always reuse the buffer. A
|
|
|
2012 value of @code{no} means assume the user always wants to re-fetch the
|
|
|
2013 document.
|
|
|
2014 @item w3-show-headers
|
|
|
2015 @vindex w3-show-headers
|
|
70
|
2016 This is a list of HTTP/1.0 headers to show at the end of a buffer. All
|
|
0
|
2017 the headers should be in lowercase. They are inserted at the end of the
|
|
|
2018 buffer in a <UL> list. Alternatively, if this is simply @code{t}, then
|
|
70
|
2019 all the HTTP/1.0 headers are shown. The default value is
|
|
0
|
2020 @code{nil}.
|
|
|
2021 @item w3-show-status, url-show-status
|
|
|
2022 @vindex url-show-status
|
|
|
2023 @vindex w3-show-status
|
|
|
2024 Whether to show progress messages in the minibuffer.
|
|
|
2025 @code{w3-show-status} controls if messages about the parsing are
|
|
|
2026 displayed, and @code{url-show-status} controls if a running total of the
|
|
|
2027 number of bytes transferred is displayed. These Can cause a large
|
|
|
2028 performance hit if using a remote X display over a slow link, or a
|
|
|
2029 terminal with a slow modem.
|
|
|
2030 @item mm-content-transfer-encodings
|
|
|
2031 @vindex mm-content-transfer-encodings
|
|
|
2032 An assoc list of @var{Content-Transfer-Encodings} or
|
|
|
2033 @var{Content-Encodings} and the appropriate decoding algorithms for each.
|
|
|
2034 If the @code{cdr} of a node is a list, then this specifies the decoder is
|
|
|
2035 an external program, with the program as the first item in the list, and
|
|
|
2036 the rest of the list specifying arguments to be passed on the command line.
|
|
|
2037 If using an external decoder, it must accept its input from @code{stdin}
|
|
|
2038 and send its output to @code{stdout}.
|
|
|
2039
|
|
|
2040 If the @code{cdr} of a node is a symbol whose function definition is
|
|
|
2041 non-@code{nil}, then that encoding can be handled internally. The function
|
|
|
2042 is called with 2 arguments, buffer positions bounding the region to be
|
|
|
2043 decoded. The function should completely replace that region with the
|
|
|
2044 unencoded information.
|
|
|
2045
|
|
|
2046 Currently supported transfer encodings are: base64, x-gzip, 7bit, 8bit,
|
|
|
2047 binary, x-compress, x-hqx, and quoted-printable.
|
|
|
2048 @item url-uncompressor-alist
|
|
|
2049 @vindex url-uncompressor-alist
|
|
|
2050 An assoc list of file extensions and the appropriate uncompression
|
|
|
2051 programs for each. This is used to build the Accept-encoding header for
|
|
70
|
2052 HTTP/1.0 requests.
|
|
|
2053 @item url-waisq-prog
|
|
|
2054 @vindex url-waisq-prog
|
|
|
2055 Name of the waisq executable on this system. This should be the
|
|
|
2056 @file{waisq} program from think.com's wais8-b5.1 distribution.
|
|
0
|
2057 @end table
|
|
|
2058
|
|
70
|
2059 @node More Help, Future Directions, , Top
|
|
0
|
2060 @chapter More Help
|
|
|
2061 @cindex Relevant Newsgroups
|
|
|
2062 @cindex Newsgroups
|
|
|
2063 @cindex Support
|
|
70
|
2064 For more help on Emacs-W3, please send me mail
|
|
0
|
2065 (@i{wmperry@@cs.indiana.edu}). Several discussion lists have also been
|
|
70
|
2066 created for Emacs-W3. To subscribe, send mail to
|
|
0
|
2067 @i{majordomo@@indiana.edu}, with the body of the message 'subscribe
|
|
|
2068 @var{listname} @var{<email addres>}'. All other mail should go to
|
|
|
2069 @i{<listname>@@indiana.edu}.
|
|
|
2070
|
|
|
2071
|
|
|
2072 @itemize @bullet
|
|
|
2073 @item
|
|
70
|
2074 w3-announce -- this list is for anyone interested in Emacs-W3, and
|
|
0
|
2075 should in general only be used by me. The gnu.emacs.sources newsgroup
|
|
|
2076 and a few other mailing lists are included on this. Please only use
|
|
70
|
2077 this list for major package releases related to Emacs-W3.
|
|
0
|
2078 (@i{www-announce@@w3.org} is included on this list).
|
|
|
2079 @item
|
|
70
|
2080 w3-beta -- this list is for beta testers of Emacs-W3. These brave souls test
|
|
0
|
2081 out not-quite stable code.
|
|
|
2082 @item
|
|
|
2083 w3-dev -- a list consisting of myself and a few other people who are
|
|
70
|
2084 interested in the internals of Emacs-W3, and doing active development work.
|
|
0
|
2085 Pretty dead right now, but I hope it will grow.
|
|
|
2086 @end itemize
|
|
|
2087
|
|
|
2088 For more help on the World Wide Web in general, please refer to the
|
|
|
2089 comp.infosystems.www.* newsgroups. There are also several discussion
|
|
|
2090 lists concerning the Web. Send mail to @i{<listname>-request@@w3.org}
|
|
|
2091 with a subject line of 'subscribe <listname>'. All mail should go to
|
|
|
2092 @i{<listname>@@w3.org}. Administrative mail should go to
|
|
|
2093 @i{www-admin@@w3.org}. The lists are:
|
|
|
2094
|
|
|
2095
|
|
|
2096 @itemize @bullet
|
|
|
2097 @item
|
|
|
2098 www-talk -- for general discussion of the World Wide Web, where its
|
|
|
2099 going, new features, etc. All the major developers are subscribed to
|
|
|
2100 this list.
|
|
|
2101 @item
|
|
|
2102 www-announce -- for announcements concerning the World Wide Web. Server
|
|
|
2103 changes, new servers, new software, etc.
|
|
|
2104 @end itemize
|
|
|
2105
|
|
|
2106 As a last resort, mail me. I'll try to answer as quickly as I can.
|
|
|
2107
|
|
2
|
2108 @node Future Directions, Reporting Bugs, More Help, Top
|
|
0
|
2109 @chapter Future Directions
|
|
|
2110 Changes are constantly being made to the Emacs browser (hopefully all
|
|
|
2111 for the better). This is a list of the things that are being worked on
|
|
|
2112 right now.
|
|
|
2113
|
|
|
2114 :: WORK :: Revamp the todo list
|
|
|
2115
|
|
70
|
2116 @node Reporting Bugs, Installing SSL, Future Directions, Top
|
|
0
|
2117 @appendix Reporting Bugs
|
|
|
2118 @cindex Reporting Bugs
|
|
|
2119 @cindex Bugs
|
|
|
2120 @cindex Contacting the author
|
|
|
2121
|
|
70
|
2122 :: WORK :: Reporting bugs needs work.
|
|
22
|
2123
|
|
70
|
2124 @node Installing SSL, Using PGP/PEM, Reporting Bugs, Top
|
|
0
|
2125 @appendix Installing SSL
|
|
|
2126 @cindex HTTP/1.0 Authentication
|
|
|
2127 @cindex Secure Sockets Layer
|
|
|
2128 @cindex SSL
|
|
|
2129 @cindex Gag Puke Retch
|
|
|
2130 @cindex Exportability
|
|
|
2131 @cindex Export Restrictions
|
|
70
|
2132 In order to use SSL in Emacs-W3, an implementation of SSL is necessary.
|
|
|
2133 These are the implementations that I am aware of:
|
|
32
|
2134
|
|
|
2135 @table @code
|
|
70
|
2136 @item SSLRef 2.0
|
|
|
2137 Available from Netscape Communications @footnote{http://www.netscape.com/newsref/std/sslref.html}. This requires the
|
|
|
2138 RSARef library, which is not exportable. The RSARef library is
|
|
|
2139 available from ftp://ftp.rsa.com/rsaref/
|
|
|
2140 @item SSLeay 0.4
|
|
|
2141 An implementation by Eric Young (eay@@mincom.oz.au) that is free for
|
|
|
2142 commerial or noncommercial use, and was developed completely outside the
|
|
|
2143 US by a non-US citizen. More information can be found at
|
|
|
2144 ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL/
|
|
|
2145 @end table
|
|
|
2146
|
|
0
|
2147 @vindex ssl-program-name
|
|
70
|
2148 Whichever reference implementation is used (I recommend the SSLeay
|
|
|
2149 distribution, just to thumb a nose at the NSA :), there is a program
|
|
|
2150 that can be run in a subprocess that takes a hostname and port number on
|
|
|
2151 the command line, and reads/writes to standard input/output (the
|
|
|
2152 Netscape implementation comes with one of these by default). Set the
|
|
|
2153 variable @code{ssl-program-name} to point to this program.
|
|
|
2154
|
|
|
2155
|
|
|
2156 This should be all the configuration necessary. In the future, I will
|
|
|
2157 be distributing a set of patches to Emacs 19.xx and XEmacs 19.xx to
|
|
|
2158 SSL-enable them, for the sake of speed.
|
|
|
2159
|
|
|
2160 @node Using PGP/PEM, Mailcap Files, Installing SSL, Top
|
|
|
2161 @appendix Using PGP/PEM
|
|
|
2162 @cindex HTTP/1.0 Authentication
|
|
|
2163 @cindex Public Key Cryptography
|
|
|
2164 @cindex Authentication, PGP
|
|
|
2165 @cindex Authentication, PEM
|
|
|
2166 @cindex RIPEM
|
|
|
2167 @cindex Public Key Cryptography
|
|
|
2168 @cindex PGP
|
|
|
2169 @cindex Pretty Good Privacy
|
|
|
2170 @cindex Encryption
|
|
|
2171 @cindex Security
|
|
|
2172 @cindex ITAR must die
|
|
|
2173 @cindex Stupid export restrictions
|
|
|
2174 @cindex Support your local crypto-anarchist
|
|
|
2175 @cindex NSA freaks
|
|
|
2176 Most of this chapter has been reproduced from the original documentation
|
|
|
2177 written by Rob McCool (@i{robm@@netscape.com})@footnote{See
|
|
|
2178 http://hoohoo.ncsa.uiuc.edu/docs/PEMPGP.html for the original}.
|
|
|
2179
|
|
|
2180 RIPEM is 'Riordan's Internet Privacy Enhanced Mail', and is currently on
|
|
|
2181 version 1.2b3. US citizens can ftp it from
|
|
|
2182 ftp://ripem.msu.edu/pub/crypt/ripem.
|
|
|
2183
|
|
|
2184 PGP is 'Pretty Good Privacy', and is currently on version 2.6. The
|
|
|
2185 legal controversies that plagued earlier versions have been resolved, so
|
|
|
2186 this is a competely legal program now. There is also a legal version
|
|
|
2187 for european users, called 2.6ui (the Unofficial International
|
|
|
2188 version).
|
|
|
2189
|
|
|
2190 PGP and PEM are programs that allow two parties to communicate in a way
|
|
|
2191 which does not allow third parties to read them, and which certify that
|
|
|
2192 the person who sent the message is really who they claim they are.
|
|
|
2193
|
|
|
2194
|
|
|
2195 PGP and PEM both use RSA encryption. The U.S. government has strict
|
|
|
2196 export controls over foreign use of this technology, so people outside
|
|
|
2197 the U.S. may have a difficult time finding programs which perform the
|
|
|
2198 encryption.
|
|
|
2199
|
|
|
2200 A working copy of either Pretty Good Privacy or RIPEM is required. You
|
|
|
2201 should be familiar with the program and have generated a public/private
|
|
|
2202 key pair.
|
|
|
2203
|
|
|
2204
|
|
|
2205 Currently, the protocol has been implemented with PEM and PGP using
|
|
|
2206 local key files on the server side, and on the client side with PEM
|
|
|
2207 using finger to retrieve the server's public key.
|
|
|
2208
|
|
|
2209 Parties who wish to use Emacs-W3 with PEM or PGP encryption will need to
|
|
|
2210 communicate beforehand and find a tamper-proof way to exchange their
|
|
|
2211 public keys.
|
|
|
2212
|
|
|
2213 Pioneers get shot full of arrows. This work is currently in the
|
|
|
2214 experimental stages and thus may have some problems that I have
|
|
|
2215 overlooked. The only known problem that I know about is that the
|
|
|
2216 messages are currently not timestamped. This means that a malicious
|
|
|
2217 user could record the encrypted message with a packet sniffer and repeat
|
|
|
2218 it back to the server ad nauseum. Although they would not be able to
|
|
|
2219 read the reply, if the request was for something being charged for, this
|
|
|
2220 could be very inconvenient.
|
|
|
2221
|
|
|
2222 This protocol is almost word-for-word a copy of Tony Sander's RIPEM
|
|
|
2223 based scheme, generalized a little. Below, wherever PEM is used,
|
|
|
2224 replace it with PGP, and the behaviour should remain the same.
|
|
32
|
2225
|
|
|
2226 @example
|
|
70
|
2227 *Client:*
|
|
|
2228
|
|
|
2229 GET /docs/protected.html HTTP/1.0
|
|
|
2230 UserAgent: Emacs-W3/2.1.x
|
|
|
2231
|
|
|
2232 *Server:*
|
|
|
2233
|
|
|
2234 HTTP/1.0 401 Unauthorized
|
|
|
2235 WWW-Authenticate: PEM entity="webmaster@@hoohoo.ncsa.uiuc.edu"
|
|
|
2236 Server: NCSA/1.1
|
|
|
2237
|
|
|
2238 *Client:*
|
|
|
2239
|
|
|
2240 GET / HTTP/1.0
|
|
|
2241 Authorization: PEM entity="robm@@ncsa.uiuc.edu"
|
|
|
2242 Content-type: application/x-www-pem-request
|
|
|
2243
|
|
|
2244 --- BEGIN PRIVACY-ENHANCED MESSAGE ---
|
|
|
2245 this is the real request, encrypted
|
|
|
2246 --- END PRIVACY-ENHANCED MESSAGE ---
|
|
|
2247
|
|
|
2248 *Server:*
|
|
|
2249
|
|
|
2250 HTTP/1.0 200 OK
|
|
|
2251 Content-type: application/x-www-pem-reply
|
|
|
2252
|
|
|
2253 --- BEGIN PRIVACY-ENHANCED MESSAGE ---
|
|
|
2254 this is the real reply, encrypted
|
|
|
2255 --- END PRIVACY-ENHANCED MESSAGE ---
|
|
|
2256 That's it.
|
|
32
|
2257 @end example
|
|
|
2258
|
|
70
|
2259 @cindex Mailcrypt
|
|
|
2260 Emacs-W3 uses the excellent @i{mailcrypt}@footnote{Available from
|
|
|
2261 http://www.cs.indiana.edu/LCD/cover.html?mailcrypt} package written by
|
|
|
2262 Jin S Choi (@i{jsc@@mit.edu}). This package takes care of calling ripem
|
|
|
2263 and/or pgp with the correct arguments. Please see the documentation at
|
|
|
2264 the top of mailcrypt.el for instructions on using mailcrypt. All bug
|
|
|
2265 reports about mailcrypt should go to Jin S Choi, but bugs about how I
|
|
|
2266 use it in Emacs-W3 should of course be directed to me.
|
|
32
|
2267
|
|
70
|
2268 @node Mailcap Files, General Index, Using PGP/PEM, Top
|
|
0
|
2269 @appendix Mailcap Files
|
|
|
2270 NCSA Mosaic and almost all other WWW browsers rely on a separate file
|
|
|
2271 for mapping MIME types to external viewing programs. This takes some of
|
|
|
2272 the burden off of browser developers, so each browser does not have to
|
|
|
2273 support all image formats, or postscript, etc. Instead of having the
|
|
70
|
2274 users of Emacs-W3 duplicate this in lisp, this file can be parsed using
|
|
0
|
2275 the @code{mm-parse-mailcaps} function. This function is called each
|
|
70
|
2276 time Emacs-W3 is loaded. It tries to locate mimetype files in several
|
|
0
|
2277 places. If the environment variable @code{MAILCAPS} is nonempty, then
|
|
|
2278 this is assumed to specify a UNIX-like path of mimetype files (this is a
|
|
|
2279 colon separated string of pathnames). If the @code{MAILCAPS}
|
|
70
|
2280 environment variable is empty, then Emacs-W3 looks for these
|
|
0
|
2281 files:
|
|
|
2282
|
|
|
2283 @enumerate
|
|
|
2284 @item
|
|
|
2285 @file{~/.mailcap}
|
|
|
2286 @item
|
|
|
2287 @file{/etc/mailcap}
|
|
|
2288 @item
|
|
|
2289 @file{/usr/etc/mailcap}
|
|
|
2290 @item
|
|
|
2291 @file{/usr/local/etc/mailcap}
|
|
|
2292 @end enumerate
|
|
|
2293
|
|
|
2294 This format of this file is specified in RFC 1343, but a brief synopsis
|
|
|
2295 follows (this is taken verbatim from sections of RFC 1343).
|
|
|
2296
|
|
|
2297 Each mailcap file consists of a set of entries that describe the proper
|
|
|
2298 handling of one media type at the local site. For example, one line
|
|
|
2299 might tell how to display a message in Group III fax format. A mailcap
|
|
|
2300 file consists of a sequence of such individual entries, separated by
|
|
|
2301 newlines (according to the operating system's newline
|
|
|
2302 conventions). Blank lines and lines that start with the "#" character
|
|
|
2303 (ASCII 35) are considered comments, and are ignored. Long entries may
|
|
|
2304 be continued on multiple lines if each non-terminal line ends with a
|
|
|
2305 backslash character ('\', ASCII 92), in which case the multiple lines
|
|
|
2306 are to be treated as a single mailcap entry. Note that for such
|
|
|
2307 "continued" lines, the backslash must be the last character on the line
|
|
|
2308 to be continued.
|
|
|
2309
|
|
|
2310 Each mailcap entry consists of a number of fields, separated by
|
|
|
2311 semi-colons. The first two fields are required, and must occur in the
|
|
|
2312 specified order. The remaining fields are optional, and may appear in
|
|
|
2313 any order.
|
|
|
2314
|
|
|
2315 The first field is the content-type, which indicates the type of data
|
|
|
2316 this mailcap entry describes how to handle. It is to be matched against
|
|
|
2317 the type/subtype specification in the "Content-Type" header field of an
|
|
|
2318 Internet mail message. If the subtype is specified as "*", it is
|
|
|
2319 intended to match all subtypes of the named content-type.
|
|
|
2320
|
|
|
2321 The second field, view-command, is a specification of how the message or
|
|
|
2322 body part can be viewed at the local site. Although the syntax of this
|
|
|
2323 field is fully specified, the semantics of program execution are
|
|
|
2324 necessarily somewhat operating system dependent.
|
|
|
2325
|
|
|
2326 The optional fields, which may be given in any order, are as follows:
|
|
|
2327 @itemize @bullet
|
|
|
2328 @item
|
|
|
2329 The "compose" field may be used to specify a program that can be used to
|
|
|
2330 compose a new body or body part in the given format. Its intended use
|
|
|
2331 is to support mail composing agents that support the composition of
|
|
|
2332 multiple types of mail using external composing agents. As with the
|
|
|
2333 view- command, the semantics of program execution are operating system
|
|
|
2334 dependent. The result of the composing program may be data that is not
|
|
|
2335 yet suitable for mail transport---that is, a Content-Transfer-Encoding
|
|
|
2336 may need to be applied to the data.
|
|
|
2337 @item
|
|
|
2338 The "composetyped" field is similar to the "compose" field, but is to be
|
|
|
2339 used when the composing program needs to specify the Content-type header
|
|
|
2340 field to be applied to the composed data. The "compose" field is
|
|
|
2341 simpler, and is preferred for use with existing (non-mail-oriented)
|
|
|
2342 programs for composing data in a given format. The "composetyped" field
|
|
|
2343 is necessary when the Content-type information must include auxilliary
|
|
|
2344 parameters, and the composition program must then know enough about mail
|
|
|
2345 formats to produce output that includes the mail type
|
|
|
2346 information.
|
|
|
2347 @item
|
|
|
2348 The "edit" field may be used to specify a program that can be used to
|
|
|
2349 edit a body or body part in the given format. In many cases, it may be
|
|
|
2350 identical in content to the "compose" field, and shares the
|
|
|
2351 operating-system dependent semantics for program execution.
|
|
|
2352 @item
|
|
|
2353 The "print" field may be used to specify a program that can be used to
|
|
|
2354 print a message or body part in the given format. As with the
|
|
|
2355 view-command, the semantics of program execution are operating system
|
|
|
2356 dependent.
|
|
|
2357 @item
|
|
|
2358 The "test" field may be used to test some external condition (e.g. the
|
|
|
2359 machine architecture, or the window system in use) to determine whether
|
|
|
2360 or not the mailcap line applies. It specifies a program to be run to
|
|
|
2361 test some condition. The semantics of execution and of the value
|
|
|
2362 returned by the test program are operating system dependent. If the
|
|
|
2363 test fails, a subsequent mailcap entry should be sought. Multiple test
|
|
|
2364 fields are not permitted---since a test can call a program, it can
|
|
|
2365 already be arbitrarily complex.
|
|
|
2366 @item
|
|
|
2367 The "needsterminal" field indicates that the view-command must be run on
|
|
|
2368 an interactive terminal. This is needed to inform window-oriented user
|
|
|
2369 agents that an interactive terminal is needed. (The decision is not
|
|
|
2370 left exclusively to the view-command because in some circumstances it
|
|
|
2371 may not be possible for such programs to tell whether or not they are on
|
|
|
2372 interactive terminals.) The needsterminal command should be assumed to
|
|
|
2373 apply to the compose and edit commands, too, if they exist. Note that
|
|
|
2374 this is NOT a test---it is a requirement for the environment in which
|
|
|
2375 the program will be executed, and should typically cause the creation of
|
|
|
2376 a terminal window when not executed on either a real terminal or a
|
|
|
2377 terminal window.
|
|
|
2378 @item
|
|
|
2379 The "copiousoutput" field indicates that the output from the
|
|
|
2380 view-command will be an extended stream of output, and is to be
|
|
|
2381 interpreted as advice to the UA (User Agent mail- reading program) that
|
|
|
2382 the output should be either paged or made scrollable. Note that it is
|
|
|
2383 probably a mistake if needsterminal and copiousoutput are both
|
|
|
2384 specified.
|
|
|
2385 @item
|
|
|
2386 The "description" field simply provides a textual description,
|
|
|
2387 optionally quoted, that describes the type of data, to be used
|
|
|
2388 optionally by mail readers that wish to describe the data before
|
|
|
2389 offering to display it.
|
|
|
2390 @item
|
|
|
2391 The "x11-bitmap" field names a file, in X11 bitmap (xbm) format, which
|
|
|
2392 points to an appropriate icon to be used to visually denote the presence
|
|
|
2393 of this kind of data.
|
|
|
2394 @item
|
|
|
2395 Any other fields beginning with "x-" may be included for local or
|
|
|
2396 mailer-specific extensions of this format. Implementations should
|
|
|
2397 simply ignore all such unrecognized fields to permit such extensions,
|
|
|
2398 some of which might be standardized in a future version of this
|
|
|
2399 document.
|
|
|
2400 @end itemize
|
|
|
2401
|
|
70
|
2402 @node General Index, Key Index, Mailcap Files, Top
|
|
0
|
2403 @appendix General Index
|
|
|
2404 @printindex fn
|
|
70
|
2405 @node Key Index, , General Index, Top
|
|
0
|
2406 @appendix Key Index
|
|
|
2407 @printindex ky
|
|
|
2408 @contents
|
|
|
2409 @bye
|
