comparison man/w3.texi @ 30:ec9a17fef872 r19-15b98

Import from CVS: tag r19-15b98
author cvs
date Mon, 13 Aug 2007 08:52:29 +0200
parents 441bb1e64a06
children e04119814345
comparison
equal deleted inserted replaced
29:7976500f47f9 30:ec9a17fef872
1 \input texinfo 1 \input texinfo
2 @c 2 @c
3 @c Please note that this file uses some constructs not supported by earlier 3 @c Please note that this file uses some constructs not supported by earlier
4 @c versions of TeXinfo. You must be running one of the newer TeXinfo 4 @c versions of TeX-info. You must be running one of the newer TeX-info
5 @c releases (I currently use version 3.9 from ftp://prep.ai.mit.edu/pub/gnu/) 5 @c releases (I currently use version 3.9 from ftp://prep.ai.mit.edu/pub/gnu/)
6 @c 6 @c
7 @c Please do not send in bug reports about not being able to format the 7 @c Please do not send in bug reports about not being able to format the
8 @c document with 'makeinfo' or 'tex', just upgrade your installation. 8 @c document with 'makeinfo' or 'tex', just upgrade your installation.
9 @c 9 @c
10 @c Info formatted files are provided in the distribution, and you can 10 @c Info formatted files are provided in the distribution, and you can
11 @c retrieve dvi, postscript, and PDF versions from the web site or ftp 11 @c retrieve dvi, postscript, and PDF versions from the web site or FTP
12 @c site: http://www.cs.indiana.edu/elisp/w3/docs.html 12 @c site: http://www.cs.indiana.edu/elisp/w3/docs.html
13 @c 13 @c
14 @setfilename w3.info 14 @setfilename w3.info
15 @settitle Emacs-W3 User's Manual 15 @settitle Emacs-W3 User's Manual
16 @iftex 16 @iftex
244 @item > 244 @item >
245 Goes to the end of document 245 Goes to the end of document
246 @kindex b 246 @kindex b
247 @kindex Meta-tab 247 @kindex Meta-tab
248 @findex w3-widget-backward 248 @findex w3-widget-backward
249 @item Meta-tab, b 249 @item Meta-tab, Shift-tab, b
250 Attempts to move backward one link area in the current document. 250 Attempts to move backward one link area in the current document.
251 Signals an error if no previous links are found. 251 Signals an error if no previous links are found.
252 @kindex f 252 @kindex f
253 @kindex tab 253 @kindex tab
254 @kindex n 254 @kindex n
272 @findex w3-quit 272 @findex w3-quit
273 @item q 273 @item q
274 Kill this buffer. 274 Kill this buffer.
275 @kindex Q, u 275 @kindex Q, u
276 @findex w3-leave-buffer 276 @findex w3-leave-buffer
277 @item Q, u
277 Bury this buffer, but don't kill it 278 Bury this buffer, but don't kill it
278 @end table 279 @end table
279 280
280 @node Information, Action, Movement, Basic Usage 281 @node Information, Action, Movement, Basic Usage
281 @section Information 282 @section Information
414 automatically generates a hypertext listing of the directory. The 415 automatically generates a hypertext listing of the directory. The
415 hypertext mode is the default, so that all the keys and functions remain 416 hypertext mode is the default, so that all the keys and functions remain
416 the same. 417 the same.
417 418
418 @kindex M-s 419 @kindex M-s
419 @findex w3-search 420 @findex w3-save-as
420 @item M-s 421 @item M-s
421 Perform a search, if this is a searchable index. Searching requires a 422 Save a document to the local disk as HTML Source, Formatted Text, LaTeX
422 server - Emacs-W3 can not do local file searching, as there are too many 423 Source, or Binary.
423 possible types of searches people could want to do. Generally, the only 424
424 @sc{url} types that allow searching are @sc{http}, gopher, and X-EXEC.
425 @kindex Hv 425 @kindex Hv
426 @findex w3-show-history-list 426 @findex w3-show-history-list
427 @vindex w3-keep-history 427 @vindex w3-keep-history
428 @item Hv 428 @item Hv
429 If @code{url-keep-history} is non-@code{nil}, then Emacs-W3 keeps track 429 If @code{url-keep-history} is non-@code{nil}, then Emacs-W3 keeps track
603 @findex w3-netscape-emulation-minor-mode 603 @findex w3-netscape-emulation-minor-mode
604 @findex w3-lynx-emulation-minor-mode 604 @findex w3-lynx-emulation-minor-mode
605 @vindex w3-mode-hook 605 @vindex w3-mode-hook
606 606
607 :: WORK :: Document lynx emulation 607 :: WORK :: Document lynx emulation
608 @table @bullet 608 @table @kbd
609 @item Down arrow 609 @item Down arrow
610 Highlight next topic 610 Highlight next topic
611 @item Up arrow 611 @item Up arrow
612 Highlight previous topic 612 Highlight previous topic
613 @item Right arrow, Return, Enter 613 @item Right arrow, Return, Enter
974 @item @sc{sgml} 974 @item @sc{sgml}
975 Standard Generalized Markup Language, of which @sc{html} is an 975 Standard Generalized Markup Language, of which @sc{html} is an
976 application. 976 application.
977 @item simple selector 977 @item simple selector
978 A selector that matches elements based on the element type and/or 978 A selector that matches elements based on the element type and/or
979 attributes, and not he element's position in the document 979 attributes, and not the element's position in the document
980 structure. E.g., 'H1.initial' is a simple selector. 980 structure. E.g., 'H1.initial' is a simple selector.
981 @item style sheet 981 @item style sheet
982 A collection of rules. 982 A collection of rules.
983 @item @sc{ua} 983 @item @sc{ua}
984 User Agent, often a web browser or web client. 984 User Agent, often a web browser or web client.
2888 cache. This is very useful for demonstrations as well. To turn this 2888 cache. This is very useful for demonstrations as well. To turn this
2889 feature on, set the variable @code{url-standalone-mode} to 2889 feature on, set the variable @code{url-standalone-mode} to
2890 non-@code{nil}, or choose the `Use Cache Only' menu item (under 2890 non-@code{nil}, or choose the `Use Cache Only' menu item (under
2891 `Options') 2891 `Options')
2892 2892
2893 @cindex Caching options
2894 @cindex Alternate caching method
2895 Emacs-W3 caches files under the temporary directory specified by
2896 @code{url-temporary-directory}, in a user-specific subdirectory
2897 (determined by the @code{user-real-login-name} function). The cache
2898 files are stored under their original names, so a @sc{url} like:
2899 http://www.aventail.com/foo/bar/baz.html would be stored in a cache file
2900 named: /tmp/wmperry/com/aventail/www/foo/bar/baz.html. Sometimes,
2901 espcially with gopher links, there will be name conflicts, and an error
2902 will be signalled. This cannot be avoided, and still have reasonable
2903 performance at startup time (reading in an index file of all the cached
2904 pages can take a long time on slow machines, or even fast machines with
2905 large caches). When running XEmacs 19.12 or later, a different naming
2906 scheme can be used. This avoids name conflicts, but loses the human
2907 readability of the cache file names. The cache files will look like:
2908 /tmp/wmperry/acbd18db4cc2f85cedef654fccc4a4d8, which is certainly
2909 unique, but not very user-friendly. To turn this on, add this to the
2910 @file{.emacs} file:
2911
2912
2913 @example
2914 (add-hook 'w3-load-hooks '(lambda ()
2915 (fset 'url-create-cached-filename
2916 'url-create-cached-filename-using-md5)))
2917 @end example
2918
2919 If other versions of emacs will not be sharing the cache, I highly
2920 recommend this method of creating the cache filename.
2921
2922
2923 @node Interfacing to Mail/News, Debugging HTML, Disk Caching, Advanced Features 2893 @node Interfacing to Mail/News, Debugging HTML, Disk Caching, Advanced Features
2924 @section Interfacing to Mail/News 2894 @section Interfacing to Mail/News
2925 @cindex Interfacing to Mail/News 2895 @cindex Interfacing to Mail/News
2926 @cindex VM 2896 @cindex VM
2927 @cindex Using Emacs-W3 with VM 2897 @cindex Using Emacs-W3 with VM
2974 @section Hooks 2944 @section Hooks
2975 @cindex Hooks 2945 @cindex Hooks
2976 2946
2977 These are the various hooks that can be used to customize some of 2947 These are the various hooks that can be used to customize some of
2978 Emacs-W3's behavior. They are arranged in the order in which they would 2948 Emacs-W3's behavior. They are arranged in the order in which they would
2979 happen when retrieving a document. All of these are functions (or lists 2949 happen when retrieving a document. These are all 'normal hooks' in
2980 of functions) that are called consecutively. 2950 standard Emacs-terminology, meaning they are functions (or lists of
2951 functions) that are called consecutively.
2981 2952
2982 @table @code 2953 @table @code
2983 @vindex w3-load-hooks 2954 @vindex w3-load-hook
2984 @item w3-load-hooks 2955 @item w3-load-hook
2985 These hooks are run by @code{w3-do-setup} the first time a @sc{url} is 2956 These hooks are run the first time a @sc{url} is fetched. All the
2986 fetched. All the w3 variables are initialized before this hook is 2957 Emacs-W3 variables are initialized before this hook is run.
2987 run. 2958 @item w3-mode-hook
2988 @item w3-file-done-hooks
2989 These hooks are run by @code{w3-prepare-buffer} after all parsing on a
2990 document has been done. All @code{url-current-}@var{*} and
2991 @code{w3-current-}@var{*} variables are initialized when this hook is run.
2992 This is run before the buffer is shown, and before any inlined images
2993 are downloaded and converted.
2994 @item w3-file-prepare-hooks
2995 These hooks are run by @code{w3-prepare-buffer} before any parsing is
2996 done on the @sc{html} file. The @sc{http}/1.0 headers specified by
2997 @code{w3-show-headers} have been inserted, and the syntax table has been
2998 set to @code{w3-parse-args-syntax-table} by the time this hook is run.
2999 @item w3-mode-hooks
3000 These hooks are run after a buffer has been parsed and displayed, but 2959 These hooks are run after a buffer has been parsed and displayed, but
3001 before any inlined images are downloaded and converted. 2960 before any inlined images are downloaded and converted.
3002 @item w3-source-file-hooks 2961 @item w3-source-file-hook
3003 These hooks are run after displaying a document's source 2962 These hooks are run after displaying a document's source.
3004 @end table 2963 @end table
3005 2964
3006 @node Other Variables, , Hooks, Advanced Features 2965 @node Other Variables, , Hooks, Advanced Features
3007 @section Miscellaneous variables 2966 @section Miscellaneous variables
3008 2967