Document the eww Desktop stuff

Fixes: debbugs:18010

* eww.texi (Advanced): Mention the Desktop stuff (bug#18010).
This commit is contained in:
Ivan Shmakov 2014-11-23 16:44:22 +01:00 committed by Lars Magne Ingebrigtsen
parent 0445aff691
commit e791d4dfb2
3 changed files with 41 additions and 0 deletions

View file

@ -1,3 +1,7 @@
2014-11-23 Ivan Shmakov <ivan@siamics.net>
* eww.texi (Advanced): Mention the Desktop stuff (bug#18010).
2014-11-23 Michael Albinus <michael.albinus@gmx.de>
* tramp.texi (Remote processes): Let-bind environment variables to

View file

@ -219,6 +219,40 @@ 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

View file

@ -177,6 +177,9 @@ the like off the page.
*** You can now use several eww buffers in parallel by renaming eww
buffers you want to keep separate.
*** Partial state of the eww buffers (the URIs and the titles of the
pages visited) is now preserved in the desktop file.
*** `eww-after-render-hook' is now called after eww has rendered
the data in the buffer.