X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/3e93bafb95608467e438ba7f725fd1f020669f8c..1dd4f26ab6c1f14628d9fcf03b0cca7e54d52302:/doc/misc/eww.texi diff --git a/doc/misc/eww.texi b/doc/misc/eww.texi index 38bec5a4c8..14f0a8d0ea 100644 --- a/doc/misc/eww.texi +++ b/doc/misc/eww.texi @@ -1,20 +1,20 @@ \input texinfo @c -*-texinfo-*- @c %**start of header -@setfilename ../../info/eww +@setfilename ../../info/eww.info @settitle Emacs Web Wowser -@documentencoding UTF-8 +@include docstyle.texi @c %**end of header @copying This file documents the GNU Emacs Web Wowser (EWW) package. -Copyright @copyright{} 2014 Free Software Foundation, Inc. +Copyright @copyright{} 2014--2016 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' +Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' @@ -91,12 +91,30 @@ either prefix the file name with @code{file://} or use the command @kindex q @kindex w @kindex g - If loading the URL was successful the buffer @code{*eww*} is opened + If loading the URL was successful the buffer @file{*eww*} is opened and the web page is rendered in it. You can leave EWW by pressing @kbd{q} or exit the browser by calling @kbd{eww-quit}. To reload the web page hit @kbd{g} (@code{eww-reload}). Pressing @kbd{w} (@code{eww-copy-page-url}) will copy the current URL to the kill ring. +@findex eww-readable +@kindex R + The @kbd{R} command (@code{eww-readable}) will attempt to determine +which part of the document contains the ``readable'' text, and will +only display this part. This usually gets rid of menus and the like. + +@findex eww-toggle-fonts +@findex shr-use-fonts +@kindex F + The @kbd{F} command (@code{eww-toggle-fonts}) toggles whether to use +variable-pitch fonts or not. This sets the @code{shr-use-fonts} variable. + +@findex eww-toggle-colors +@findex shr-use-colors +@kindex F + The @kbd{C} command (@code{eww-toggle-colors}) toggles whether to use +HTML-specified colors or not. This sets the @code{shr-use-colors} variable. + @findex eww-download @vindex eww-download-directory @kindex d @@ -114,12 +132,27 @@ specified in @code{eww-download-directory} (Default: @file{~/Downloads/}). @cindex History EWW remembers the URLs you have visited to allow you to go back and forth between them. By pressing @kbd{l} (@code{eww-back-url}) you go -to the previous URL. You can go forward again with @kbd{r} +to the previous URL@. You can go forward again with @kbd{r} (@code{eww-forward-url}). If you want an overview of your browsing history press @kbd{H} (@code{eww-list-histories}) to open the history -buffer @code{*eww history*}. The history is lost when EWW is quit. +buffer @file{*eww history*}. The history is lost when EWW is quit. If you want to remember websites you can use bookmarks. +@vindex eww-history-limit + Along with the URLs visited, EWW also remembers both the rendered +page (as it appears in the buffer) and its source. This can take a +considerable amount of memory, so EWW discards the history entries to +keep their number within a set limit, as specified by +@code{eww-history-limit}; the default being 50. This variable could +also be set to @code{nil} to allow for the history list to grow +indefinitely. + +@cindex PDF + PDFs are viewed inline, by default, with @code{doc-view-mode}, but +this can be customized by using the mailcap (@pxref{mailcap,,, +emacs-mime, Emacs MIME Manual}) +mechanism, in particular @code{mailcap-mime-data}. + @findex eww-add-bookmark @findex eww-list-bookmarks @kindex b @@ -129,7 +162,14 @@ If you want to remember websites you can use bookmarks. (@code{eww-add-bookmark}) to store a bookmark for the current website. You can view stored bookmarks with @kbd{B} (@code{eww-list-bookmarks}). This will open the bookmark buffer -@code{*eww bookmarks*}. +@file{*eww bookmarks*}. + +@findex eww-list-buffers +@kindex S +@cindex Multiple Buffers + To get summary of currently opened EWW buffers, press @kbd{S} +(@code{eww-list-buffers}). The @file{*eww buffers*} buffer allows to +quickly kill, flip through and switch to specific EWW buffer. @findex eww-browse-with-external-browser @vindex shr-external-browser @@ -156,7 +196,7 @@ browser by customizing @cindex Viewing Source You can view the source of a website with @kbd{v} (@code{eww-view-source}). This will open a new buffer -@code{*eww-source*} and insert the source. The buffer will be set to +@file{*eww-source*} and insert the source. The buffer will be set to @code{html-mode} if available. @findex url-cookie-list @@ -195,6 +235,49 @@ of the width and height. If Emacs supports image scaling (ImageMagick support required) then larger images are scaled down. You can block specific images completely by customizing @code{shr-blocked-images}. +@vindex shr-color-visible-distance-min +@vindex shr-color-visible-luminance-min +@cindex Contrast + EWW (or rather its HTML renderer @code{shr}) uses the colors declared +in the HTML page, but adjusts them if needed to keep a certain minimum +contrast. If that is still too low for you, you can customize the +variables @code{shr-color-visible-distance-min} and +@code{shr-color-visible-luminance-min} to get a better contrast. + +@cindex Desktop Support +@cindex Saving Sessions + In addition to maintaining the history at run-time, EWW will also +save the partial state of its buffers (the URIs and the titles of the +pages visited) in the desktop file if one is used. @xref{Saving Emacs +Sessions, , emacs, The GNU Emacs Manual}. + +@vindex eww-desktop-remove-duplicates + EWW history may sensibly contain multiple entries for the same page +URI@. At run-time, these entries may still have different associated +point positions or the actual Web page contents. +The latter, however, tend to be overly large to preserve in the +desktop file, so they get omitted, thus rendering the respective +entries entirely equivalent. By default, such duplicate entries are +not saved. Setting @code{eww-desktop-remove-duplicates} to nil will +force EWW to save them anyway. + +@vindex eww-restore-desktop + Restoring EWW buffers' contents may prove to take too long to +finish. When the @code{eww-restore-desktop} variable is set to +@code{nil} (the default), EWW will not try to reload the last visited +Web page when the buffer is restored from the desktop file, thus +allowing for faster Emacs start-up times. When set to @code{t}, +restoring the buffers will also initiate the reloading of such pages. + +@vindex eww-restore-reload-prompt + The EWW buffer restored from the desktop file but not yet reloaded +will contain a prompt, as specified by the +@code{eww-restore-reload-prompt} variable. The value of this variable +will be passed through @code{substitute-command-keys} upon each use, +thus allowing for the use of the usual substitutions, such as +@code{\[eww-reload]} for the current key binding of the +@code{eww-reload} command. + @node History and Acknowledgments @appendix History and Acknowledgments @@ -206,24 +289,7 @@ Emacs Web Wowser. EWW was announced on 16 June 2013: @url{http://lars.ingebrigtsen.no/2013/06/16/eww/}. EWW was then moved from the Gnus repository to GNU Emacs and several -developers started contributing to it as well. A list of contributors -at the time of writing this manual: - -@itemize @bullet -@item Daniel Hackney -@item Eli Zaretskii -@item Glenn Morris -@item Ivan Kanis -@item Juri Linkov -@item Katsumi Yamaoka -@item Kenjiro NAKAYAMA -@item Lars Magne Ingebrigtsen -@item Leo Liu -@item Paul Eggert -@item Rüdiger Sonderfeld -@item Stefan Monnier -@item Ted Zlatanov -@end itemize +developers started contributing to it as well. @node GNU Free Documentation License @chapter GNU Free Documentation License @@ -237,6 +303,11 @@ at the time of writing this manual: @node Variable Index @unnumbered Variable Index +@vindex eww-after-render-hook +After eww has rendered the data in the buffer, +@code{eww-after-render-hook} is called. It can be used to alter the +contents, for instance. + @printindex vr @node Lisp Function Index