]> code.delx.au - gnu-emacs/commitdiff
Document EWW.
authorRüdiger Sonderfeld <ruediger@c-plusplus.de>
Thu, 9 Jan 2014 23:21:56 +0000 (00:21 +0100)
committerRüdiger Sonderfeld <ruediger@c-plusplus.de>
Thu, 9 Jan 2014 23:21:56 +0000 (00:21 +0100)
* doc/emacs/emacs.texi: Add EWW.
* doc/emacs/misc.texi (EWW): Document EWW.
* doc/misc/Makefile.in: Add eww.texi.
* doc/misc/eww.texi: New file.

doc/emacs/ChangeLog
doc/emacs/emacs.texi
doc/emacs/misc.texi
doc/misc/ChangeLog
doc/misc/Makefile.in
doc/misc/eww.texi [new file with mode: 0644]
etc/NEWS

index b91d9c3075cf9ede4827944a69ef08afa83b8a33..49dea7ba879aaee3cf90a3b1938dd0b0a00d41ef 100644 (file)
@@ -1,3 +1,9 @@
+2014-01-09  Rüdiger Sonderfeld  <ruediger@c-plusplus.de>
+
+       * emacs.texi: Add EWW.
+
+       * misc.texi (EWW): Document EWW.
+
 2014-01-09  Glenn Morris  <rgm@gnu.org>
 
        * trouble.texi (Service): Refer to online service directory
index 691c8bd8ff535e42fbb4b1e8fa55091c76aff77c..8ec4fb5880d9e440c935b6107777c649c3304893 100644 (file)
@@ -190,6 +190,7 @@ Advanced Features
 * Rmail::               Reading mail in Emacs.
 * Gnus::                A flexible mail and news reader.
 * Document View::       Viewing PDF, PS and DVI files.
+* EWW::                 A web browser in Emacs.
 * Shell::               Executing shell commands from Emacs.
 * Emacs Server::        Using Emacs as an editing server.
 * Printing::            Printing hardcopies of buffers or regions.
index 8cdeab986774f7da58772020d5c554cb99477cce..aed854e1a3f937719defa5446d646e508d6ea501 100644 (file)
@@ -439,6 +439,18 @@ associated with the current buffer, type @kbd{K}
 (@code{doc-view-kill-proc-and-buffer}) kills the converter process and
 the DocView buffer.
 
+@node EWW
+@section Web Browsing with EWW
+
+@findex eww
+@findex eww-open-file
+  @dfn{EWW}, the Emacs Web Wowser, is a web browser package for Emacs.
+It allows browsing URLs within an Emacs buffer.  The command @kbd{M-x
+eww} can be used to open a URL or search the web.  A file can be
+opened using the command @kbd{M-x eww-open-file}.  EWW can be used as
+web browser for @code{browse-url}, see @ref{Browse-URL}.  For full
+details, see @ref{Top, EWW,, eww, The Emacs Web Wowser Manual}.
+
 @node Shell
 @section Running Shell Commands from Emacs
 @cindex subshell
index 46fb672e28a45620ec5e6956a1eacc9ddf946b9b..41e7e3d768fc19f2b431b1d7500369febe641f14 100644 (file)
@@ -1,3 +1,8 @@
+2014-01-09  Rüdiger Sonderfeld  <ruediger@c-plusplus.de>
+
+       * Makefile.in: Add eww.texi.
+       * eww.texi: New file.
+
 2014-01-07  Glenn Morris  <rgm@gnu.org>
 
        * efaq.texi (Problems with very large files): Fix superscript typo.
index 8b8d8a606c97c3e45b00860098887251f637f75f..b3318ddd18376ee38b1cdaf1465c08663e4caa3d 100644 (file)
@@ -65,7 +65,7 @@ DOCMISC_W32 = @DOCMISC_W32@
 ## Info files to build and install on all platforms.
 INFO_COMMON = ada-mode auth autotype bovine calc ccmode cl \
        dbus dired-x ebrowse ede ediff edt eieio \
-       emacs-mime epa erc ert eshell eudc efaq \
+       emacs-mime epa erc ert eshell eudc efaq eww \
        flymake forms gnus emacs-gnutls htmlfontify idlwave ido info.info \
        mairix-el message mh-e newsticker nxml-mode octave-mode \
        org pcl-cvs pgg rcirc remember reftex sasl \
@@ -410,6 +410,18 @@ eudc.pdf: $(eudc_deps)
 eudc.html: $(eudc_deps)
        $(MAKEINFO) $(MAKEINFO_OPTS) $(HTML_OPTS) -o $@ ${srcdir}/eudc.texi
 
+eww_deps = ${srcdir}/eww.texi $(emacsdir)/emacsver.texi ${gfdl}
+eww : $(buildinfodir)/eww$(INFO_EXT)
+$(buildinfodir)/eww$(INFO_EXT): $(eww_deps)
+       $(mkinfodir)
+       $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/eww.texi
+eww.dvi: $(eww_deps)
+       $(ENVADD) $(TEXI2DVI) ${srcdir}/eww.texi
+eww.pdf: $(eww_deps)
+       $(ENVADD) $(TEXI2PDF) ${srcdir}/eww.texi
+eww.html: $(eww_deps)
+       $(MAKEINFO) $(MAKEINFO_OPTS) $(HTML_OPTS) -o $@ ${srcdir}/eww.texi
+
 flymake_deps = ${srcdir}/flymake.texi ${gfdl}
 flymake : $(buildinfodir)/flymake$(INFO_EXT)
 $(buildinfodir)/flymake$(INFO_EXT): $(flymake_deps)
diff --git a/doc/misc/eww.texi b/doc/misc/eww.texi
new file mode 100644 (file)
index 0000000..b84de75
--- /dev/null
@@ -0,0 +1,254 @@
+\input texinfo @c -*-texinfo-*-
+@c %**start of header
+@setfilename ../../info/eww
+@settitle Emacs Web Wowser
+@documentencoding UTF-8
+@c @include emacsver.texi
+@c %**end of header
+
+@copying
+This file documents the GNU Emacs Web Wowser (EWW) package.
+
+Copyright @copyright{} 2014 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,''
+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.''
+
+(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
+modify this GNU manual.''
+@end quotation
+@end copying
+
+@dircategory Emacs misc features
+@direntry
+* EWW: (eww).      Emacs Web Wowser
+@end direntry
+
+@finalout
+
+@titlepage
+@title Emacs Web Wowser (EWW)
+@subtitle A web browser for GNU Emacs.
+
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@contents
+
+@ifnottex
+@node Top
+@top EWW
+
+@insertcopying
+@end ifnottex
+
+@menu
+* Overview::
+* Basics::
+* Advanced::
+
+Appendices
+* History and Acknowledgments::
+* GNU Free Documentation License::  The license for this documentation.
+
+Indices
+* Key Index::
+* Variable Index::
+* Lisp Function Index::
+* Concept Index::
+@end menu
+
+@node Overview
+@chapter Overview
+@dfn{EWW}, the Emacs Web Wowser, is a web browser for GNU Emacs.  It
+can load, parse, and display various web pages using @dfn{shr.el}.
+However a GNU Emacs with @code{libxml2} support is required.
+
+@node Basics
+@chapter Basic Usage
+
+@findex eww
+@findex eww-open-file
+@vindex eww-search-prefix
+@cindex eww
+@cindex Web Browsing
+  You can open a URL or search the web with the command @kbd{M-x eww}.
+If the input doesn't look like a URL or domain name the web will be
+searched via @code{eww-search-prefix}.  The default search engine is
+@url{https://duckduckgo.com, DuckDuckGo}.  If you want to open a file
+either prefix the path with @code{file://} or use the command @kbd{M-x
+eww-open-file}.
+
+@findex eww-quit
+@findex eww-reload
+@findex eww-copy-page-url
+@kindex q
+@kindex w
+@kindex g
+  If loading the URL was successful the buffer @code{*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-download
+@vindex eww-download-path
+@kindex d
+@cindex Download
+  A URL under the point can be downloaded with @kbd{d}
+(@code{eww-download}).  The file will be written to the directory
+specified in @code{eww-download-path} (Default: @file{~/Downloads/}).
+
+@findex eww-back-url
+@findex eww-forward-url
+@findex eww-list-histories
+@kindex r
+@kindex l
+@kindex H
+@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}
+(@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.
+If you want to remember websites you can use bookmarks.
+
+@findex eww-add-bookmark
+@findex eww-list-bookmarks
+@kindex b
+@kindex B
+@cindex Bookmarks
+  EWW allows you to @dfn{bookmark} URLs.  Simply hit @kbd{b}
+(@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*}.
+
+@findex eww-browse-with-external-browser
+@vindex shr-external-browser
+@vindex eww-use-external-browser-for-content-type
+@kindex &
+@cindex External Browser
+  Although EWW and shr.el do their best to render webpages in GNU
+Emacs some websites use features which can not be properly represented
+or are not implemented (E.g., JavaScript).  If you have trouble
+viewing a website with EWW then hit @kbd{&}
+(@code{eww-browse-with-external-browser}) inside the EWW buffer to
+open the website in the external browser specified by
+@code{shr-external-browser}.  Some content types, such as video or
+audio content, do not make sense to display in GNU Emacs at all.  You
+can tell EWW to open specific content automatically in an external
+browser by customizing
+@code{eww-use-external-browser-for-content-type}.
+
+@node Advanced
+@chapter Advanced
+
+@findex eww-view-source
+@kindex v
+@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
+@code{html-mode} if available.
+
+@findex url-cookie-list
+@kindex C
+@cindex Cookies
+  EWW handles cookies through the @ref{Top, url package, ,url}.
+You can list existing cookies with @kbd{C} (@code{url-cookie-list}).
+For details about the Cookie handling @xref{Cookies,,,url}.
+
+@vindex eww-header-line-format
+@cindex Header
+  The header line of the EWW buffer can be changed by customizing
+@code{eww-header-line-format}.  The format replaces @code{%t} with the
+title of the website and @code{%u} with the URL.
+
+@c @vindex shr-bullet
+@c @vindex shr-hr-line
+@c @vindex eww-form-checkbox-selected-symbol
+@c @vindex eww-form-checkbox-symbol
+@c   EWW and the rendering engine shr.el use ASCII characters to
+@c represent some graphical elements, such as bullet points
+@c (@code{shr-bullet}), check boxes
+@c (@code{eww-form-checkbox-selected-symbol} and
+@c @code{eww-form-checkbox-symbol}), and horizontal rules
+@c @code{shr-hr-line}).  Depending on your fonts these characters can be
+@c replaced by Unicode glyphs to achieve better looking results.
+
+@vindex shr-max-image-proportion
+@vindex shr-blocked-images
+@cindex Image Display
+  Loading random images from the web can be problematic due to their
+size or content.  By customizing @code{shr-max-image-proportion} you
+can set the maximal image proportion in relation to the window they
+are displayed in.  E.g., 0.7 means an image is allowed to take up 70%
+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}.
+
+@node History and Acknowledgments
+@appendix History and Acknowledgments
+
+EWW was originally written by Lars Ingebrigtsen, known for his work on
+Gnus.  He started writing an Emacs HTML rendering library,
+@code{shr.el}, to read blogs in Gnus.  He eventually added a web
+browser front end and HTML form support.  Which resulted in EWW, the
+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
+
+@node GNU Free Documentation License
+@chapter GNU Free Documentation License
+@include doclicense.texi
+
+@node Key Index
+@unnumbered Key Index
+
+@printindex ky
+
+@node Variable Index
+@unnumbered Variable Index
+
+@printindex vr
+
+@node Lisp Function Index
+@unnumbered Function Index
+
+@printindex fn
+
+@node Concept Index
+@unnumbered Concept Index
+
+@printindex cp
+
+
+@bye
index f93ff617347c8089dda98f8852b00b4cf0301716..159dd3846bea612ae4c32e6161d0a5ef4002cf9b 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -895,6 +895,7 @@ has not been relevant for some time.
 \f
 * New Modes and Packages in Emacs 24.4
 
++++
 ** New package `eww' is a built-in web browser.
 It is only available if Emacs is compiled with libxml2 support.