doc/misc/eww.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename ../../info/eww.info
   4 @settitle Emacs Web Wowser
   5 @documentencoding UTF-8
   6 @c %**end of header
   7
   8 @copying
   9 This file documents the GNU Emacs Web Wowser (EWW) package.
  10
  11 Copyright @copyright{} 2014 Free Software Foundation, Inc.
  12
  13 @quotation
  14 Permission is granted to copy, distribute and/or modify this document
  15 under the terms of the GNU Free Documentation License, Version 1.3 or
  16 any later version published by the Free Software Foundation; with no
  17 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
  18 and with the Back-Cover Texts as in (a) below.  A copy of the license
  19 is included in the section entitled ``GNU Free Documentation License.''
  20
  21 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  22 modify this GNU manual.''
  23 @end quotation
  24 @end copying
  25
  26 @dircategory Emacs misc features
  27 @direntry
  28 * EWW: (eww).      Emacs Web Wowser
  29 @end direntry
  30
  31 @finalout
  32
  33 @titlepage
  34 @title Emacs Web Wowser (EWW)
  35 @subtitle A web browser for GNU Emacs.
  36
  37 @page
  38 @vskip 0pt plus 1filll
  39 @insertcopying
  40 @end titlepage
  41
  42 @contents
  43
  44 @ifnottex
  45 @node Top
  46 @top EWW
  47
  48 @insertcopying
  49 @end ifnottex
  50
  51 @menu
  52 * Overview::
  53 * Basics::
  54 * Advanced::
  55
  56 Appendices
  57 * History and Acknowledgments::
  58 * GNU Free Documentation License::  The license for this documentation.
  59
  60 Indices
  61 * Key Index::
  62 * Variable Index::
  63 * Lisp Function Index::
  64 * Concept Index::
  65 @end menu
  66
  67 @node Overview
  68 @chapter Overview
  69 @dfn{EWW}, the Emacs Web Wowser, is a web browser for GNU Emacs.  It
  70 can load, parse, and display various web pages using @dfn{shr.el}.
  71 However a GNU Emacs with @code{libxml2} support is required.
  72
  73 @node Basics
  74 @chapter Basic Usage
  75
  76 @findex eww
  77 @findex eww-open-file
  78 @vindex eww-search-prefix
  79 @cindex eww
  80 @cindex Web Browsing
  81   You can open a URL or search the web with the command @kbd{M-x eww}.
  82 If the input doesn't look like a URL or domain name the web will be
  83 searched via @code{eww-search-prefix}.  The default search engine is
  84 @url{https://duckduckgo.com, DuckDuckGo}.  If you want to open a file
  85 either prefix the file name with @code{file://} or use the command
  86 @kbd{M-x eww-open-file}.
  87
  88 @findex eww-quit
  89 @findex eww-reload
  90 @findex eww-copy-page-url
  91 @kindex q
  92 @kindex w
  93 @kindex g
  94   If loading the URL was successful the buffer @file{*eww*} is opened
  95 and the web page is rendered in it.  You can leave EWW by pressing
  96 @kbd{q} or exit the browser by calling @kbd{eww-quit}.  To reload the
  97 web page hit @kbd{g} (@code{eww-reload}).  Pressing @kbd{w}
  98 (@code{eww-copy-page-url}) will copy the current URL to the kill ring.
  99
 100 @findex eww-readable
 101 @kindex R
 102   The @kbd{R} command (@code{eww-readable}) will attempt to determine
 103 which part of the document contains the ``readable'' text, and will
 104 only display this part.  This usually gets rid of menus and the like.
 105
 106 @findex eww-download
 107 @vindex eww-download-directory
 108 @kindex d
 109 @cindex Download
 110   A URL under the point can be downloaded with @kbd{d}
 111 (@code{eww-download}).  The file will be written to the directory
 112 specified in @code{eww-download-directory} (Default: @file{~/Downloads/}).
 113
 114 @findex eww-back-url
 115 @findex eww-forward-url
 116 @findex eww-list-histories
 117 @kindex r
 118 @kindex l
 119 @kindex H
 120 @cindex History
 121   EWW remembers the URLs you have visited to allow you to go back and
 122 forth between them.  By pressing @kbd{l} (@code{eww-back-url}) you go
 123 to the previous URL.  You can go forward again with @kbd{r}
 124 (@code{eww-forward-url}).  If you want an overview of your browsing
 125 history press @kbd{H} (@code{eww-list-histories}) to open the history
 126 buffer @file{*eww history*}.  The history is lost when EWW is quit.
 127 If you want to remember websites you can use bookmarks.
 128
 129 @vindex eww-history-limit
 130   Along with the URLs visited, EWW also remembers both the rendered
 131 page (as it appears in the buffer) and its source.  This can take a
 132 considerable amount of memory, so EWW discards the history entries to
 133 keep their number within a set limit, as specified by
 134 @code{eww-history-limit}; the default being 50.  This variable could
 135 also be set to @code{nil} to allow for the history list to grow
 136 indefinitely.
 137
 138 @findex eww-add-bookmark
 139 @findex eww-list-bookmarks
 140 @kindex b
 141 @kindex B
 142 @cindex Bookmarks
 143   EWW allows you to @dfn{bookmark} URLs.  Simply hit @kbd{b}
 144 (@code{eww-add-bookmark}) to store a bookmark for the current website.
 145 You can view stored bookmarks with @kbd{B}
 146 (@code{eww-list-bookmarks}).  This will open the bookmark buffer
 147 @file{*eww bookmarks*}.
 148
 149 @findex eww-browse-with-external-browser
 150 @vindex shr-external-browser
 151 @vindex eww-use-external-browser-for-content-type
 152 @kindex &
 153 @cindex External Browser
 154   Although EWW and shr.el do their best to render webpages in GNU
 155 Emacs some websites use features which can not be properly represented
 156 or are not implemented (E.g., JavaScript).  If you have trouble
 157 viewing a website with EWW then hit @kbd{&}
 158 (@code{eww-browse-with-external-browser}) inside the EWW buffer to
 159 open the website in the external browser specified by
 160 @code{shr-external-browser}.  Some content types, such as video or
 161 audio content, do not make sense to display in GNU Emacs at all.  You
 162 can tell EWW to open specific content automatically in an external
 163 browser by customizing
 164 @code{eww-use-external-browser-for-content-type}.
 165
 166 @node Advanced
 167 @chapter Advanced
 168
 169 @findex eww-view-source
 170 @kindex v
 171 @cindex Viewing Source
 172   You can view the source of a website with @kbd{v}
 173 (@code{eww-view-source}).  This will open a new buffer
 174 @file{*eww-source*} and insert the source.  The buffer will be set to
 175 @code{html-mode} if available.
 176
 177 @findex url-cookie-list
 178 @kindex C
 179 @cindex Cookies
 180   EWW handles cookies through the @ref{Top, url package, ,url}.
 181 You can list existing cookies with @kbd{C} (@code{url-cookie-list}).
 182 For details about the Cookie handling @xref{Cookies,,,url}.
 183
 184 @vindex eww-header-line-format
 185 @cindex Header
 186   The header line of the EWW buffer can be changed by customizing
 187 @code{eww-header-line-format}.  The format replaces @code{%t} with the
 188 title of the website and @code{%u} with the URL.
 189
 190 @c @vindex shr-bullet
 191 @c @vindex shr-hr-line
 192 @c @vindex eww-form-checkbox-selected-symbol
 193 @c @vindex eww-form-checkbox-symbol
 194 @c   EWW and the rendering engine shr.el use ASCII characters to
 195 @c represent some graphical elements, such as bullet points
 196 @c (@code{shr-bullet}), check boxes
 197 @c (@code{eww-form-checkbox-selected-symbol} and
 198 @c @code{eww-form-checkbox-symbol}), and horizontal rules
 199 @c @code{shr-hr-line}).  Depending on your fonts these characters can be
 200 @c replaced by Unicode glyphs to achieve better looking results.
 201
 202 @vindex shr-max-image-proportion
 203 @vindex shr-blocked-images
 204 @cindex Image Display
 205   Loading random images from the web can be problematic due to their
 206 size or content.  By customizing @code{shr-max-image-proportion} you
 207 can set the maximal image proportion in relation to the window they
 208 are displayed in.  E.g., 0.7 means an image is allowed to take up 70%
 209 of the width and height.  If Emacs supports image scaling (ImageMagick
 210 support required) then larger images are scaled down.  You can block
 211 specific images completely by customizing @code{shr-blocked-images}.
 212
 213 @vindex shr-color-visible-distance-min
 214 @vindex shr-color-visible-luminance-min
 215 @cindex Contrast
 216   EWW (or rather its HTML renderer @code{shr}) uses the colors declared
 217 in the HTML page, but adjusts them if needed to keep a certain minimum
 218 contrast.  If that is still too low for you, you can customize the
 219 variables @code{shr-color-visible-distance-min} and
 220 @code{shr-color-visible-luminance-min} to get a better contrast.
 221
 222 @node History and Acknowledgments
 223 @appendix History and Acknowledgments
 224
 225 EWW was originally written by Lars Ingebrigtsen, known for his work on
 226 Gnus.  He started writing an Emacs HTML rendering library,
 227 @code{shr.el}, to read blogs in Gnus.  He eventually added a web
 228 browser front end and HTML form support.  Which resulted in EWW, the
 229 Emacs Web Wowser.  EWW was announced on 16 June 2013:
 230 @url{http://lars.ingebrigtsen.no/2013/06/16/eww/}.
 231
 232 EWW was then moved from the Gnus repository to GNU Emacs and several
 233 developers started contributing to it as well.
 234
 235 @node GNU Free Documentation License
 236 @chapter GNU Free Documentation License
 237 @include doclicense.texi
 238
 239 @node Key Index
 240 @unnumbered Key Index
 241
 242 @printindex ky
 243
 244 @node Variable Index
 245 @unnumbered Variable Index
 246
 247 @vindex eww-after-render-hook
 248 After eww has rendered the data in the buffer,
 249 @code{eww-after-render-hook} is called.  It can be used to alter the
 250 contents, for instance.
 251
 252 @printindex vr
 253
 254 @node Lisp Function Index
 255 @unnumbered Function Index
 256
 257 @printindex fn
 258
 259 @node Concept Index
 260 @unnumbered Concept Index
 261
 262 @printindex cp
 263
 264
 265 @bye