Release v0.10.0

Fixes #2347

.appveyor.yml

@@ -0,0 +1,17 @@
+shallow_clone: true
+version: '{branch}-{build}'
+cache:
+  - C:\projects\qutebrowser\.cache
+build: off
+environment:
+    PYTHONUNBUFFERED: 1
+    matrix:
+    - TESTENV: py34
+    - TESTENV: unittests-frozen
+    - TESTENV: pylint
+
+install:
+  - C:\Python27\python -u scripts\dev\ci\appveyor_install.py
+
+test_script:
+  - C:\Python34\Scripts\tox -e %TESTENV%

.coveragerc

@@ -1,8 +1,10 @@
 [run]
+source = qutebrowser
 branch = true
 omit =
     qutebrowser/__main__.py
     */__init__.py
+    qutebrowser/resources.py
 
 [report]
 exclude_lines =
@@ -11,3 +13,6 @@ exclude_lines =
     raise AssertionError
     raise NotImplementedError
     if __name__ == ["']__main__["']:
+
+[xml]
+output=coverage.xml

.editorconfig

@@ -0,0 +1,17 @@
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+max_line_length = 79
+
+indent_style = space
+indent_size = 4
+
+[*.yml]
+indent_size = 2
+
+[*.feature]
+max_line_length = 9999
+

.flake8

@@ -1,13 +1,47 @@
-# vim: ft=dosini fileencoding=utf-8:
-
 [flake8]
+exclude = .*,__pycache__,resources.py
+# E128: continuation line under-indented for visual indent
+# E226: missing whitespace around arithmetic operator
 # E265: Block comment should start with '#'
 # E501: Line too long
-# F841: unused variable
-# F401: Unused import
 # E402: module level import not at top of file
 # E266: too many leading '#' for block comment
-# W503: line break before binary operator
-ignore=E265,E501,F841,F401,E402,E266,W503
-max_complexity = 12
-exclude=resources.py
+# E722: do not use bare except
+# E731: do not assign a lambda expression, use a def
+#       (for pytest's __tracebackhide__)
+# F401: Unused import
+# N802: function name should be lowercase
+# P101: format string does contain unindexed parameters
+# P102: docstring does contain unindexed parameters
+# P103: other string does contain unindexed parameters
+# D102: Missing docstring in public method (will be handled by others)
+# D103: Missing docstring in public function (will be handled by others)
+# D104: Missing docstring in public package (will be handled by others)
+# D105: Missing docstring in magic method (will be handled by others)
+# D209: Blank line before closing """ (removed from PEP257)
+# D211: No blank lines allowed before class docstring
+#       (PEP257 got changed, but let's stick to the old standard)
+# D402: First line should not be function's signature (false-positives)
+# D403: First word of the first line should be properly capitalized
+#       (false-positives)
+ignore =
+    E128,E226,E265,E501,E402,E266,E722,E731,
+    F401,
+    N802,
+    P101,P102,P103,
+    D102,D103,D104,D105,D209,D211,D402,D403
+min-version = 3.4.0
+max-complexity = 12
+putty-auto-ignore = True
+putty-ignore =
+    /# pylint: disable=invalid-name/ : +N801,N806
+    /# pylint: disable=wildcard-import/ : +F403
+    /# pragma: no mccabe/ : +C901
+    tests/*/test_*.py : +D100,D101,D401
+    tests/unit/browser/webkit/test_history.py : +N806
+    tests/helpers/fixtures.py : +N806
+    tests/unit/browser/webkit/http/test_content_disposition.py : +D400
+    scripts/dev/ci/appveyor_install.py : +FI53
+copyright-check = True
+copyright-regexp = # Copyright [\d-]+ .*
+copyright-min-file-size = 110

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,2 @@
+<!-- If this is a bug report, please remember to mention your version info from
+the `qute:version` page or `qutebrowser --version` -->

.gitignore

@@ -1,5 +1,7 @@
 __pycache__
+*.py~
 *.pyc
+*.swp
 /build
 /dist
 /qutebrowser.egg-info
@@ -10,6 +12,7 @@ __pycache__
 /setuptools-*.egg
 /setuptools-*.zip
 /qutebrowser/git-commit-id
+/qutebrowser/3rdparty
 /doc/*.html
 /README.html
 /CHANGELOG.html
@@ -17,7 +20,25 @@ __pycache__
 /FAQ.html
 /INSTALL.html
 /qutebrowser/html/doc/
-/.venv
+/.venv*
 /.coverage
 /htmlcov
+/coverage.xml
+/.coverage.*
 /.tox
+/testresults.html
+/.cache
+/.testmondata
+/.hypothesis
+/prof
+/venv
+TODO
+/scripts/testbrowser_cpp/webkit/Makefile
+/scripts/testbrowser_cpp/webkit/main.o
+/scripts/testbrowser_cpp/webkit/testbrowser
+/scripts/testbrowser_cpp/webkit/.qmake.stash
+/scripts/testbrowser_cpp/webengine/Makefile
+/scripts/testbrowser_cpp/webengine/main.o
+/scripts/testbrowser_cpp/webengine/testbrowser
+/scripts/testbrowser_cpp/webengine/.qmake.stash
+/scripts/dev/pylint_checkers/qute_pylint.egg-info

.pydocstylerc

@@ -0,0 +1,13 @@
+[pydocstyle]
+# Disabled checks:
+# D102: Missing docstring in public method (will be handled by others)
+# D103: Missing docstring in public function (will be handled by others)
+# D104: Missing docstring in public package (will be handled by others)
+# D105: Missing docstring in magic method (will be handled by others)
+# D209: Blank line before closing """ (removed from PEP257)
+# D211: No blank lines allowed before class docstring
+#       (PEP257 got changed, but let's stick to the old standard)
+# D402: First line should not be function's signature (false-positives)
+ignore = D102,D103,D104,D105,D209,D211,D402
+match = (?!resources|test_*).*\.py
+inherit = false

.pylintrc

@@ -3,18 +3,21 @@
 [MASTER]
 ignore=resources.py
 extension-pkg-whitelist=PyQt5,sip
-load-plugins=pylint_checkers.config,
-             pylint_checkers.crlf,
-             pylint_checkers.modeline,
-             pylint_checkers.openencoding,
-             pylint_checkers.settrace
+load-plugins=qute_pylint.config,
+             qute_pylint.modeline,
+             qute_pylint.openencoding,
+             qute_pylint.settrace,
+             pylint.extensions.bad_builtin,
+             pylint.extensions.docstyle
+persistent=n
 
 [MESSAGES CONTROL]
+enable=all
 disable=no-self-use,
-        bad-builtin,
         fixme,
         global-statement,
         locally-disabled,
+        locally-enabled,
         too-many-ancestors,
         too-few-public-methods,
         too-many-public-methods,
@@ -24,27 +27,33 @@ disable=no-self-use,
         blacklisted-name,
         too-many-lines,
         logging-format-interpolation,
-        interface-not-implemented,
         broad-except,
         bare-except,
         eval-used,
-        exec-used
+        exec-used,
+        file-ignored,
+        wrong-import-order,
+        ungrouped-imports,
+        redefined-variable-type,
+        suppressed-message,
+        too-many-return-statements,
+        duplicate-code,
+        wrong-import-position
 
 [BASIC]
-module-rgx=(__)?[a-z][a-z0-9_]*(__)?$
-function-rgx=([a-z_][a-z0-9_]{2,30}|setUpModule|tearDownModule)$
+function-rgx=[a-z_][a-z0-9_]{2,50}$
 const-rgx=[A-Za-z_][A-Za-z0-9_]{0,30}$
-method-rgx=[a-z_][A-Za-z0-9_]{2,40}$
+method-rgx=[a-z_][A-Za-z0-9_]{1,50}$
 attr-rgx=[a-z_][a-z0-9_]{0,30}$
 argument-rgx=[a-z_][a-z0-9_]{0,30}$
 variable-rgx=[a-z_][a-z0-9_]{0,30}$
-class-attribute-rgx=[A-Za-z_][A-Za-z0-9_]{1,30}$
-inlinevar-rgx=[a-z_][a-z0-9_]*$
-docstring-min-length=2
+docstring-min-length=3
+no-docstring-rgx=(^_|^main$)
 
 [FORMAT]
 max-line-length=79
-ignore-long-lines=<?https?://
+ignore-long-lines=(<?https?://|^# Copyright 201\d|# (pylint|flake8): disable=)
+expected-line-ending-format=LF
 
 [SIMILARITIES]
 min-similarity-lines=8
@@ -52,11 +61,19 @@ min-similarity-lines=8
 [VARIABLES]
 dummy-variables-rgx=_.*
 
-[CLASSES]
-defining-attr-methods=__init__,__new__,setUp
-
 [DESIGN]
 max-args=10
 
+[CLASSES]
+valid-metaclass-classmethod-first-arg=cls
+
 [TYPECHECK]
-ignored-classes=WebElementWrapper,AnsiCodes,UnsetObject
+# WORKAROUND for https://github.com/PyCQA/astroid/pull/357
+ignored-modules=pytest
+# MsgType added as WORKAROUND for
+# https://bitbucket.org/logilab/pylint/issues/690/
+# UnsetObject because pylint infers any objreg.get(...) as UnsetObject.
+ignored-classes=qutebrowser.utils.objreg.UnsetObject,
+                qutebrowser.browser.webkit.webelem.WebElementWrapper,
+                scripts.dev.check_coverage.MsgType,
+                qutebrowser.browser.downloads.UnsupportedAttribute

.travis.yml

@@ -0,0 +1,94 @@
+sudo: required
+dist: trusty
+language: generic
+
+matrix:
+  include:
+    - os: linux
+      env: TESTENV=py34-cov
+    - os: linux
+      env: DOCKER=debian-jessie
+      services: docker
+    - os: linux
+      env: DOCKER=archlinux
+      services: docker
+    - os: linux
+      env: DOCKER=archlinux-webengine QUTE_BDD_WEBENGINE=true
+      services: docker
+    - os: linux
+      env: DOCKER=archlinux-ng
+      services: docker
+    - os: linux
+      env: DOCKER=ubuntu-xenial
+      services: docker
+    - os: linux
+      language: python
+      python: 3.6
+      env: TESTENV=py36-pyqt571
+    - os: linux
+      language: python
+      python: 3.5
+      env: TESTENV=py35-pyqt58
+    - os: linux
+      language: python
+      python: 3.6
+      env: TESTENV=py36-pyqt58
+    - os: osx
+      env: TESTENV=py36 OSX=elcapitan
+      osx_image: xcode7.3
+    # https://github.com/qutebrowser/qutebrowser/issues/2013
+    # - os: osx
+    #   env: TESTENV=py35 OSX=yosemite
+    #   osx_image: xcode6.4
+    - os: linux
+      env: TESTENV=pylint
+    - os: linux
+      env: TESTENV=flake8
+    - os: linux
+      env: TESTENV=docs
+    - os: linux
+      env: TESTENV=vulture
+    - os: linux
+      env: TESTENV=misc
+    - os: linux
+      env: TESTENV=pyroma
+    - os: linux
+      env: TESTENV=check-manifest
+    - os: linux
+      env: TESTENV=eslint
+  allow_failures:
+    - os: osx
+      env: TESTENV=py36 OSX=elcapitan
+      osx_image: xcode7.3
+  fast_finish: true
+
+cache:
+  directories:
+    - $HOME/.cache/pip
+    - $HOME/build/qutebrowser/qutebrowser/.cache
+
+before_install:
+  # We need to do this so we pick up the system-wide python properly
+  - 'export PATH="/usr/bin:$PATH"'
+
+install:
+  - bash scripts/dev/ci/travis_install.sh
+
+script:
+  - bash scripts/dev/ci/travis_run.sh
+
+after_success:
+  - '[[ $TESTENV == *-cov ]] && codecov -e TESTENV -X gcov'
+
+notifications:
+  webhooks:
+    - https://buildtimetrend.herokuapp.com/travis
+  irc:
+    channels:
+      - "chat.freenode.net#qutebrowser-dev"
+    on_success: always
+    on_failure: always
+    skip_join: true
+    template:
+      - "%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}"
+      - "%{compare_url} - %{build_url}"

CHANGELOG.asciidoc

@@ -14,7 +14,882 @@ This project adheres to http://semver.org/[Semantic Versioning].
 // `Fixed` for any bug fixes.
 // `Security` to invite users to upgrade in case of vulnerabilities.
 
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.2.0[v0.2.0]
+v0.10.0
+-------
+
+Added
+~~~~~
+
+- Userscripts now have a new `$QUTE_COMMANDLINE_TEXT` environment variable, containing the current commandline contents
+- New `ripbang` userscript to create a searchengine from a duckduckgo bang
+- link:https://github.com/annulen/webkit/wiki[QtWebKit Reloaded] (also called QtWebKit-NG) is now fully supported
+- Various new functionality with the QtWebEngine backend:
+    * Printing support with Qt >= 5.8
+    * Proxy support with Qt >= 5.8
+    * Tor the `general -> print-element-backgrounds` option with Qt >= 5.8
+    * The `content -> cookies-store` option
+    * The `storage -> cache-size` option
+    * The `colors -> webpage.bg` option
+    * The HTML5 fullscreen API (e.g. youtube videos) with QtWebEngine
+    * `:download --mhtml`
+- New `qute:history` URL and `:history` command to show the browsing history
+- Open tabs are now auto-saved on each successful load and restored in case of a crash
+- `:jseval` now has a `--file` flag so you can pass a javascript file
+- `:session-save` now has a `--only-active-window` flag to only save the active window
+- OS X builds are back, and built with QtWebEngine
+
+Changed
+~~~~~~~
+
+- PyQt 5.7/Qt 5.7.1 is now required for the QtWebEngine backend
+- Scrolling with the scrollwheel while holding shift now scrolls sideways
+- New way of clicking hints with which solves various small issues
+- When yanking a mailto: link via hints, the mailto: prefix is now stripped
+- Zoom level messages are now not stacked on top of each other anymore
+- qutebrowser now automatically uses QtWebEngine if QtWebKit is unavailable
+- :history-clear now asks for a confirmation, unless it's run with --force.
+- `input -> mouse-zoom-divider` can now be 0 to disable zooming by mouse wheel
+- `network -> proxy` can also be set to `pac+file://...` now to
+  use a local proxy autoconfig file (on QtWebKit)
+
+Fixed
+~~~~~
+
+- Various bugs with Qt 5.8 and QtWebEngine:
+    * Segfault when closing a window
+    * Segfault with when closing a tab with a search active
+    * Fixed various mouse actions (like automatically entering insert mode) not working
+    * Fixed hints sometimes not working
+    * Segfault when opening a URL after a QtWebEngine renderer process crash
+- Other QtWebEngine fixes:
+    * Insert mode now gets entered correctly with a non-100% zoom
+    * Crash reports are now re-enabled when using QtWebEngine
+    * Fixed crashes when closing tabs while hinting
+    * Using :undo or :tab-clone with a view-source:// or chrome:// tab is now prevented, as it segfaults
+- `:enter-mode` now refuses to enter modes which can't be entered manually (which caused crashes)
+- `:record-macro` (`q`) now doesn't try to record macros for special keys without a text
+- Fixed PAC (proxy autoconfig) not working with QtWebKit
+- `:download --mhtml` now uses the new file dialog
+- Word hints are now upper-cased correctly when hints -> uppercase is true
+- Font validation is now more permissive in the config, allowing e.g. "Terminus
+  (TTF)" as font name
+- Fixed starting on newer PyQt/sip versions with LibreSSL
+- When downloading files with QtWebKit, a User-Agent header is set when possible
+- Fixed showing of keybindings in the :help completion
+- `:navigate prev/next` now detects `rel` attributes on `<a>` elements, and
+  handles multiple `rel` attributes correctly
+- Fixed a crash when hinting with target `userscript` and spawning a non-existing script
+- Lines in Jupyter notebook now trigger insert mode
+
+v0.9.1
+------
+
+Fixed
+~~~~~
+
+- Prevent websites from downloading files to a location outside of the download
+  folder with QtWebEngine.
+
+v0.9.0
+------
+
+Added
+~~~~~
+
+- *New dependency:* qutebrowser now depends on the Qt QML module, which is
+   packaged separately in some distributions (as Qt Declarative/QML/Quick).
+- New `:rl-backward-kill-word` command which does what `:rl-unix-word-rubout`
+  did before v0.8.0.
+- New `:rl-unix-filename-rubout` command which is similar to readline's
+  `unix-filename-rubout`.
+- New `fonts -> completion.category` setting to customize the font used for
+  completion category headers.
+- New `:debug-log-capacity` command to adjust how many lines are logged into RAM
+  (to report bugs which are difficult to reproduce).
+- New `hide-unmatched-rapid-hints` option to not hide hint unmatched hint labels
+  in rapid mode.
+- New `{clipboard}` and `{primary}` replacements for the commandline which
+  replace the `:paste` command.
+- New `:insert-text` command to insert a given text into a field on the page,
+  which replaces `:paste-primary` together with the `{primary}` replacement.
+- New `:window-only` command to close all other windows.
+- New `prev-category` and `next-category` arguments to `:completion-item-focus`
+  to focus the previous/next category in the completion (bound to `<Ctrl-Tab>`
+  and `<Ctrl-Shift-Tab>` by default).
+- New `:click-element` command to fake a click on a element.
+- New `:debug-log-filter` command to change console log filtering on-the-fly.
+- New `:debug-log-level` command to change the console loglevel on-the-fly.
+- New `general -> yank-ignored-url-parameters` option to configure which URL
+  parameters (like `utm_source` etc.) to strip off when yanking an URL.
+- Support for the
+  https://developer.mozilla.org/en-US/docs/Web/API/Page_Visibility_API[HTML5 page visibility API]
+- New `readability` userscript which shows a readable version of a page (using
+  the `readability-lxml` python package)
+- New `cast` userscript to show a video on a Google Chromecast
+- New `:run-with-count` command which replaces the (undocumented) `:count:command` syntax.
+- New `:record-macro` (`q`) and `:run-macro` (`@`) commands for keyboard macros.
+- New `ui -> hide-scrollbar` setting to hide the scrollbar independently of the
+  `user-stylesheet` setting.
+- New `general -> default-open-dispatcher` setting to configure what to open
+  downloads with (instead of e.g. `xdg-open` on Linux).
+- Support for PAC (proxy autoconfig) with QtWebKit
+
+Changed
+~~~~~~~
+
+- Hints are now drawn natively in Qt instead of using web elements. This has a
+  few implications for users:
+    * The `hints -> opacity` setting does not exist anymore, but you can use
+      `rgba(r, g, b, alpha)` colors instead for `colors -> hints.bg`.
+    * The `hints -> font` setting is not affected by
+      `fonts -> web-family-fixed` anymore. Thus, a transformer got added to
+      change `Monospace` to `${_monospace}`.
+    * Gradients in hint colors can now be configured by using `qlineargradient`
+      and friends instead of `-webkit-gradient`. The most common cases get
+      migrated automatically, but if you drastically changed the defaults,
+      you'll need to manually adjust your config.
+    * Styling hints by styling `qutehint` elements in `user-stylesheet` was
+      never officially supported and does not work anymore.
+    * Hints are now not affected by the page's stylesheet or zoom anymore.
+- `:bookmark-add` now has a `--toggle` flag which deletes the bookmark if it
+  already exists.
+- `:bookmark-load` now has a `--delete` flag which deletes the bookmark after
+  loading it.
+- `:open` now also accepts quickmark names instead of URLs
+- `:tab-move` now optionally takes an index for absolute moving.
+- Commands taking either an argument or a count (like `:zoom` or `:tab-focus`)
+  now prefer the count instead of showing an error message.
+- `:open` now has an `--implicit` argument to treat the opened tab as implicit
+  (i.e. to open it at the position it would be opened if it was a clicked link)
+- `:download-open` and `:prompt-open-download` now have an optional `cmdline`
+  argument to pass a commandline to open the download with.
+- `:yank` now has a position argument to select what to yank instead of using
+  flags.
+- Replacements like `{url}` can now also be used in the middle of an argument.
+  Consequently, commands taking another command (`:later`, `:repeat` and
+  `:bind`) now don't immediately evaluate variables.
+- Tab titles in the `:buffer` completion now update correctly when a page's
+  title is changed via javascript.
+- `:hint` now has a `--mode <mode>` flag to override the hint mode configured
+  using the `hints -> mode` setting.
+- With `new-instance-open-target` set to a tab option, the tab is now opened in
+  the most recently focused (instead of the last opened) window. This can be
+  configured with the new `new-instance-open-target.window` setting.
+  It can also be set to `last-visible` to show the pages in the most recently
+  visible window, or `first-opened` to use the first (oldest) available window.
+- Word hints now are more clever about getting the element text from some elements.
+- Completions for `:help` and `:bind` now also show hidden commands
+- The `:buffer` completion now also filters using the first column (id).
+- `:undo` has been improved to reopen tabs at the position they were closed.
+- `:navigate` now takes a count for `up`/`increment`/`decrement`.
+- The `hints -> auto-follow` setting now can be set to
+  `always`/`full-match`/`unique-match`/`never` to more precisely control when
+  hints should be followed automatically.
+- Counts can now be used with special keybindings (e.g. with modifiers).
+  This was already implemented for v0.7.0 originally, but got reverted because
+  it caused some issues and then never re-applied.
+- Sending a command to an existing instance (via "qutebrowser :reload") now
+  doesn't mark it as urgent anymore.
+- `tabs -> title-format` now treats an empty string as valid.
+- Bindings for `:`, `/` and `?` are now configured explicitly and not hardcoded
+  anymore.
+- The `completion -> show` setting can now be set to `always`, `auto` or
+  `never`.
+- `:open-editor` can now be used in any mode.
+- Lots of improvements to and bugfixes for the QtWebEngine backend, such as
+  working hints. However, using qutebrowser directly from git is still advised
+  when using `--backend webengine`.
+- `content -> javascript-can-open-windows` got renamed to
+  `javascript-can-open-windows-automatically`.
+- `:prompt-accept` now optionally accepts a value which overrides the one
+  entered in the input box. `yes` and `no` can be used as values for yes/no
+  questions.
+- The new `--qt-arg` and `--qt-flag` arguments can be used to pass
+  arguments/flags to Qt's commandline.
+- Error/warning/info messages are now shown stacked above the statusbar.
+  This also added various new settings:
+    * `colors -> messages.fg.error` (renamed from `statusbar.fg.error`)
+    * `colors -> messages.bg.error` (renamed from `statusbar.bg.error`)
+    * `colors -> messages.border.error`
+    * `colors -> messages.fg.warning` (renamed from `statusbar.fg.warning`)
+    * `colors -> messages.bg.warning` (renamed from `statusbar.bg.warning`)
+    * `colors -> messages.border.warning`
+    * `colors -> messages.fg.info`
+    * `colors -> messages.bg.info`
+    * `colors -> messages.border.info`
+    * `fonts -> messages.error`
+    * `fonts -> messages.warning`
+    * `fonts -> messages.info`
+- The `qute:settings` page now also shows option descriptions.
+- `qute:version` and `qutebrowser --version` now show various important paths
+- `:spawn`/userscripts now show a nicer error when a script wasn't found
+- Various functionality now works when javascript is disabled with QtWebKit
+- Various commands/settings taking `left`/`right`/`previous` arguments now take
+  `prev`/`next`/`last-used` to remove ambiguity.
+- The `ui -> user-stylesheet` setting now only takes filenames, not CSS snippets
+- `ui -> window-title-format` now has a new `{backend} ` replacement
+- `:hint` has a new `--add-history` argument to add the URL to the history for
+  yank/spawn targets.
+- `:set` now cycles through values if more than one argument is given.
+- `:open` now opens `default-page` without an URL even without `-t`/`-b`/`-w` given.
+
+Deprecated
+~~~~~~~~~~
+
+- The `:paste` command got deprecated as `:open` with `{clipboard}` and
+  `{primary}` can be used instead.
+- The `:paste-primary` command got deprecated as `:insert-text {primary}` can
+  be used instead.
+- The `:prompt-yes` and `:prompt-no` commands got deprecated as
+  `:prompt-accept yes` and `:prompt-accept no` can be used instead.
+
+Removed
+~~~~~~~
+
+- The `:yank-selected` command got merged into `:yank` as `:yank selection`
+  and thus removed.
+- The `:completion-item-prev` and `:completion-item-next` commands got merged
+  into a new `:completion-focus {prev,next}` command and thus removed.
+- The `ui -> hide-mouse-cursor` setting since it was completely broken and
+  nobody seemed to care.
+- The `hints -> opacity` setting - see the "Changed" section for details.
+- The `completion -> auto-open` setting got merged into `completion -> show` and
+  thus removed.
+- All `--qt-*` arguments got replaced by `--qt-arg` and `--qt-flag` and thus
+  removed.
+- The `-c`/`--confdir`, `--datadir` and `--cachedir` arguments got removed, as
+  `--basedir` should be sufficient.
+
+Fixed
+~~~~~
+
+- `:undo` now doesn't undo tabs "closed" by `:tab-detach` anymore.
+- Fixed an issue with hint chars not being cleared correctly when leaving hint
+  mode.
+- `:tab-detach` now fails correctly when there's only one tab open.
+- Various small issues with the command completion
+- Fixed hang when using multiple spaces in a row with the URL completion
+- qutebrowser now still starts with an incorrectly configured
+  `$XDG_RUNTIME_DIR`.
+- Fixed crash when a userscript writes invalid unicode data to the FIFO
+- Fixed crash when a included HTML was not found
+
+v0.8.3
+------
+
+Fixed
+~~~~~
+
+- Fixed crash when doing `:<space><enter>`, another corner-case introduced in v0.8.0
+- Fixed `:open-editor` (`<Ctrl-e>`) on Windows
+- Fixed crash when setting `general -> auto-save-interval` to a too big value.
+- Fixed crash when using hints on Void Linux.
+- Fixed compatibility with Python 3.5.2+ on Debian unstable
+- Compatibility with pdfjs v1.6.210
+- `:bind` can now be used to bind to an alias (binding by editing `keys.conf`
+  already worked before)
+- The command completion now updates correctly when changing aliases
+- The tabbar now displays correctly with the Adwaita Qt theme
+- The default `sk` keybinding now sets the commandline to `:bind` correctly
+- Fixed crash when closing a window without focusing it
+- Userscripts now can access QUTE_FIFO correctly on Windows
+
+v0.8.2
+------
+
+Fixed
+~~~~~
+
+- Fixed `general -> private-browsing` not being set correctly until a restart
+  (which caused e.g. local storage to be enabled).
+- When hinting input fields (`:t`), also consider input elements without a type.
+- Fixed crash when opening an invalid URL with a percent-encoded and a real @ in it
+- Fixed default `;o` and `;O` bindings
+- Fixed local storage not working (and possible other bugs) when using a
+  relative path with `--basedir`.
+- Fixed crash when deleting a quickmark with Ctrl-D
+- Fixed HTML5 video playback on Windows
+- Fixed crash when using `:prompt-open-download` with a file with chars not
+  encodable with the OS' filesystem encoding (e.g. with `LC_ALL=C`)
+- Fixed `:prompt-open-download` with a too long filename (> 255 bytes)
+- Fixed crash when cancelling a download after doing `:prompt-open-download`
+- Fixed crash when writing a download to disk fails with
+  `:prompt-open-download`.
+- Fixed `:restart` deleting the basedir when it was given with `--basedir`.
+
+v0.8.1
+------
+
+Fixed
+~~~~~
+
+- Fix crash when pressing enter without a command
+- Adjust error message to point out QtWebEngine is unsupported with the OS
+  X .app currently.
+- Hide Harfbuzz warning with the OS X .app
+
+v0.8.0
+------
+
+Added
+~~~~~
+
+- New `:repeat-command` command (mapped to `.`) to repeat the last command.
+  Note that two former default bundings conflict with that binding, unbinding
+  them via `:unbind .i` and `:unbind .o` is recommended.
+- New `qute:bookmarks` page which displays all bookmarks and quickmarks.
+- New `:prompt-open-download` (bound to `Ctrl-X`) which can be used to open a
+  download directly when getting the filename prompt.
+- New `{host}` replacement for tab- and window titles which evaluates
+  to the current host.
+- New default binding `;t` for `:hint input`.
+- New variables `$QUTE_CONFIG_DIR`, `$QUTE_DATA_DIR` and
+  `$QUTE_DOWNLOAD_DIR` available for userscripts.
+- New option `ui` -> `status-position` to configure the position of the
+  status bar (top/bottom).
+- New `--pdf <filename>` argument for `:print` WHICH can be used to generate a
+  PDF without a dialog.
+
+Changed
+~~~~~~~
+
+- `:scroll-perc` now prefers a count over the argument given to it, which means
+  `gg` can be used with a count.
+- Aliases can now use `;;` to have an alias which executed multiple commands.
+- `:edit-url` now does nothing if the URL isn't changed in the spawned editor.
+- `:bookmark-add` can now be passed a URL and title to add that as a bookmark
+  rather than the current page.
+- New `taskadd` userscript to add a taskwarrior task annotated with the
+  current URL.
+- `:bookmark-del` and `:quickmark-del` now delete the current page's URL if none
+  is given.
+
+Fixed
+-----
+
+- Compatibility with PyQt 5.7
+- Fixed some configuration values being lost when a config option gets removed
+  from qutebrowser's code.
+- Fix crash when downloading with a full disk
+- Using `:jump-mark` (e.g. `''`) when the current URL is invalid doesn't crash
+  anymore.
+
+Removed
+-------
+
+- The ability to display status messages from webpages, as well as the related
+  `ui ->  display-statusbar-messages` setting.
+- The `general -> wrap-search` setting as searches now always wrap.
+  According to a quick straw poll and prior crash logs, almost nobody is using
+  `wrap-search = false`, and turning off wrapping is not possible with
+  QtWebEngine.
+- `:edit-url` now doesn't accept a count anymore as its behavior was confusing
+  and it doesn't make much sense to add a count.
+
+v0.7.0
+------
+
+Added
+~~~~~
+
+- New `:edit-url` command to edit the URL in an external editor.
+- New `network -> custom-headers` setting to send custom headers with every request.
+- New `{url:pretty}` commandline replacement which gets replaced by the decoded URL.
+- New marks to remember a scroll position:
+    - New `:jump-mark` command to jump to a mark, bound to `'`
+    - New `:set-mark` command to set a mark, bound to ```(backtick)
+    - The `'` mark gets set when moving away (hinting link with anchor, searching, etc.) so you can move back with `''`
+- New `--force-color` argument to force colored logging even if stdout is not a
+  terminal
+- New `:messages` command to show error messages
+- New pop-up showing possible keybinding when the first key of a keychain is
+  pressed. This can be turned off using `:set ui keyhint-blacklist *`.
+- New `hints -> auto-follow-timeout` setting to ignore keypresses after
+  following a hint when filtering in number mode.
+- New `:history-clear` command to clear the entire history
+- New `hints -> find-implementation` to select which implementation (JS/Python)
+  should be used to find hints on a page. The `javascript` implementation is
+  better, but slower.
+- New `inputs` group for `:hint` to hint text input fields.
+
+Changed
+~~~~~~~
+
+- qutebrowser got a new (slightly updated) logo
+- `:tab-focus` can now take a negative index to focus the nth tab counted from
+  the right.
+- `:yank` can now yank the pretty/decoded URL by adding `--pretty`
+- `:navigate` now clears the URL fragment
+- `:completion-item-del` (`Ctrl-D`) can now be used in `:buffer` completion to
+  close a tab
+- Various SSL ciphers are now disabled by default. With recent Qt/OpenSSL
+  versions those already all are disabled, but with older versions they might
+  not be.
+- Show favicons as window icon with `tabs-are-windows` set.
+- `:bind <key>` without a command now shows the existing binding
+- The optional `colorlog` dependency got removed, as qutebrowser now displays
+  colored logs without it.
+- URLs are now shown decoded when hovering.
+- Keybindings are now shown in the command completion
+- Improved behavior when pasting multiple lines
+- Rapid hints can now also be used for the `normal` hint target, which can be
+  useful with javascript click handlers or checkboxes which don't actually open
+  a new page.
+- `:zoom-in` or `:zoom-out` (`+`/`-`) with a too large count now zooms to the
+  smallest/largest zoom instead of doing nothing.
+- The commandline now accepts partially typed commands if they're unique.
+- Number hints are now kept filtered after following a hint in rapid mode.
+- Number hints are now renumbered after filtering
+- Number hints can now be filtered with multiple space-separated search terms
+- `hints -> scatter` is now ignored for number hints
+- Better history implementation which also stores titles.
+  As a consequence, URLs which redirect to another URL are now added to the
+  history too, marked with a `-r` suffix to the timestamp field.
+
+Fixed
+-----
+
+- Fixed using `:hint links spawn` with flags - you can now use things like the
+  `-v` argument for `:spawn` or pass flags to the spawned commands.
+- Various fixes for hinting corner-cases where following a link didn't work or
+  the hint was drawn at the wrong position.
+- Fixed crash when downloading from a URL with SSL errors
+- Close file handles correctly when a download failed
+- Fixed crash when using `;Y` (`:hint links yank-primary`) on a system without
+  primary selection
+- Don't display quit confirmation with finished downloads
+- Fixed updating the tab index in the statusbar when opening a background tab
+- Fixed a crash when entering `:-- ` in the commandline
+- Fixed `:debug-console` with PyQt 5.6
+- Fixed qutebrowser not starting when `sys.stderr` is `None`
+- Fixed crash when cancelling a download which belongs to an MHTML download
+- Fixed rebinding of keybindings being case-sensitive
+- Fix for tab indicators getting lost when moving tabs
+- Fixed handling of backspace in number hinting mode
+- Fixed `FileNotFoundError` when starting in some cases on old Qt versions
+- Fixed sharing of cookies between tabs when `private-browsing` is enabled
+- Toggling values with `:set` now uses lower-case values
+- Hints now work with (non-standard) links with spaces around the URL
+- Strip off trailing spaces for history entries with no title
+
+v0.6.2
+------
+
+Fixed
+~~~~~
+
+- Fixed crash when using `:tab-{prev,next,focus}` right after closing the last
+  tab with `last-close` set to `close`.
+- Fixed crash when doing `:undo` in a new instance with `tabs -> last-close` set
+  to `default-page`.
+- Fixed crash when starting with --cachedir=""
+- Fixed crash in some circumstances when using dictionary hints
+- Fixed various crashes related to PyQt 5.6
+
+v0.6.1
+-----
+
+Fixed
+~~~~~~
+
+- Fixed broken cheatsheet image which was missing from package
+- Fixed occasional crash when switching/disconnecting monitors
+- Fixed crash when downloading non-ascii files with a broken locale (`LC_ALL=C`)
+- Added workaround for a Qt/PyQt bug which is too weird to describe here
+
+v0.6.0
+------
+
+Added
+~~~~~
+
+- New `:buffer` command to easily switch tabs by name. This is not bound to a
+  key by default for existing users due to a conflict with the `gt`/`gT`
+  bindings (which are now removed from the default bindings).
+  You can bind it by hand by running `:bind -f gt set-cmd-text -s :buffer`.
+- New `--quiet` argument for the `:debug-pyeval` command to not open a tab with
+  the results. Note `:debug-pyeval` is still only intended for debugging.
+- The completion now matches each entered word separately.
+- A new command `:paste-primary` got added to paste the primary selection, and
+  `<Shift-Insert>` got added as a binding so it pastes primary rather than
+  clipboard.
+- New mode `word` for `hints -> mode` which uses a dictionary and link-texts
+  for hints instead of single characters.
+- New `--all` argument for `:download-cancel` to cancel all running downloads.
+- New `password_fill` userscript to fill passwords using the `pass` executable.
+- New `current` hinting mode which forces opening hints in the current tab
+  (even with `target="_blank"`)
+
+Changed
+~~~~~~~
+
+- Pasting multiple lines via `:paste` now opens each line in a new tab.
+- `:navigate increment/decrement` now preserves leading zeroes in URLs.
+- `general -> editor` can now also handle `{}` inside another argument (e.g. to open `vim` via `termite`)
+- Improved performance when scrolling with many tabs open.
+- Shift-Insert now also pastes primary selection for prompts.
+- `:download-remove --all` got un-deprecated to provide symmetry with
+  `:download-cancel --all`. It does the same as `:download-clear`.
+- Improved detection of URLs/search terms when pasting multiple lines.
+- Don't remove `qutebrowser-editor-*` temporary file if editor subprocess crashed
+- Userscripts are also searched in `/usr/share/qutebrowser/userscripts`.
+- Blocked hosts are now also read from a `blocked-hosts` file in the config dir
+  (e.g. `~/.config/qutebrowser/blocked-hosts`).
+
+Fixed
+~~~~~
+
+- Fixed starting with -c "".
+- Fixed crash when a tab is closed twice via javascript (e.g. Dropbox
+  authentication dialogs)
+- Fixed crash when a notification/geolocation prompt is answered after closing
+  the tab it belongs to.
+- Fixed crash when downloading a file without any path information (e.g a
+  magnet link).
+- Fixed crashes when opening an empty URL (e.g. via pasting).
+- Fixed validation of duplicate values in `hints -> chars`.
+- Fixed crash when PDF.js was partially installed.
+- Fixed crash when XDG_DOWNLOAD_DIR was not an absolute path.
+- Fixed very long filenames when downloading `data://`-URLs.
+- Fixed ugly UI fonts on Windows when Liberation Mono is installed
+- Fixed crash when unbinding key from a section which doesn't exist in the config
+- Fixed report window after a segfault
+- Fixed some directory browser issues on Windows
+- Fixed crash when closing a window with a finished download and delayed
+  `remove-finished-downloads` setting.
+- Fixed crash when hitting `<Tab>` then `<Ctrl-C>` on pages without keyboard
+  focus.
+- Fixed "Frame load interrupted by policy change" error showing up when
+  downloading files with Qt 5.6.
+
+Removed
+~~~~~~~
+
+- The `gt`/`gT` bindings (luakit-like alternatives to `J`/`K`) were removed
+  (except for existing configs) to make room for the `gt` binding to show
+  buffers.
+
+v0.5.1
+------
+
+Fixed
+~~~~~
+
+- Fixed completion for various config values when using `:set`.
+- Fixed config validation for various config values.
+- Prevented an error being logged when a website with HTTP authentication was
+  opened on Windows.
+
+v0.5.0
+------
+
+Added
+~~~~~
+
+- Ability to preview PDFs using pdf.js in the browser if it's installed. This
+  is disabled by default and can be enabled using the
+  `content -> pdfjs-enabled` setting.
+- New setting `ui -> hide-wayland-decoration` to hide the window decoration
+  when using wayland.
+- New userscripts in `misc/userscripts`:
+    - `open_download` to easily open a file in your downloads folder.
+    - `view_in_mpv` to open a video in mpv and remove it from the page.
+    - `qutedmenu` and `dmenu_qutebrowser` to select URLs via dmenu
+- New setting `content -> host-blocking-whitelist` to whitelist certain domains
+  from the adblocker.
+- `{scroll_pos}` can now be used in `ui -> window-title-format` and
+  `tabs -> title-format`.
+- New setting `general -> url-incdec-segments` to configure which segments of
+  the URL should be affected by `:navigate increment/decrement`.
+- New `--target` argument to specify how URLs should be opened in an existing
+  instance.
+- New setting `statusbar.url.fg.success.https` to set the foreground color for
+  the URL when a page was loaded via HTTPS.
+- The scrollbar in the completion is now styled, and the following new options
+  got added:
+    * `completion -> scrollbar-width`
+    * `completion -> scrollbar-padding`
+    * `colors -> completion.scrollbar.fg`
+    * `colors -> completion.scrollbar.bg`
+- New value `none` for options taking a color system so they don't display a
+  gradient:
+    * `colors -> tabs.indicator.system`
+    * `colors -> downloads.fg.system`
+    * `colors -> downloads.bg.system`
+- New command `:download-retry` to retry a failed download.
+- New command `:download-clear` which replaces `:download-remove --all`.
+- `:set-cmd-text` has a new `--append` argument to append to the current
+  statusbar text.
+- qutebrowser now uses `~/.netrc` if available to authenticate via HTTP.
+- New `:fake-key` command to send a fake keypress to a website or to
+  qutebrowser.
+- New `--mhtml` argument for `:download` to download a page including all
+  ressources as MHTML file.
+- New option `tabs -> title-alignment` to change the alignment of tab titles.
+
+Changed
+~~~~~~~
+
+- The `colors -> tabs.bg/fg.selected` option got split into
+  `tabs.bg/fg.selected.odd/even`.
+- `:spawn --userscript` and `:hint` with the `userscript` target now look up
+  relative paths in `~/.local/share/qutebrowser/userscripts` or
+  `$XDG_DATA_DIR`. Using a binary in `$PATH` won't work anymore with
+  `--userscript`.
+- New design for error pages
+- Link filtering for hints now checks if the text is contained anywhere in
+  the link, and matches case-insensitively.
+- The `ui -> remove-finished-downloads` option got changed to an integer and
+  now takes a time (in milliseconds) to keep the download around after it's
+  finished. When set to `-1`, downloads are never removed.
+- The `:follow-hint` command now optionally takes the keystring of a hint to
+  follow.
+- `:scroll-px` now doesn't take floats anymore, which made little sense.
+- Updated the user agent list for the `:set network user-agent` completion.
+- Starting with `--debug` doesn't log `VDEBUG` messages anymore (add
+  `--loglevel VDEBUG` to get them).
+- `:debug-console` now hides the console if it's already shown.
+- `:yank-selected` now doesn't log the selected text anymore.
+- `general -> log-javascript-console` got changed from a boolean to an option
+  taking a loglevel (`none`, `info`, `debug`).
+- `:tab-move +/-` now wraps around if `tabs -> wrap` is `true`.
+- When a subprocess (like launched by `:spawn`) fails, its stdout/stderr is now
+  logged to the console.
+- A search engine name can now contain any non-space character, like dashes.
+
+Deprecated
+~~~~~~~~~~
+
+- `:download-remove --all` is now deprecated and `:download-clear` should be
+  used instead.
+- `:download <url> <destination>` is now deprecated and
+  `:download --dest <destination> <url>` should be used instead.
+
+Removed
+~~~~~~~
+
+- `:scroll` with two pixel-arguments (deprecated in v0.3.0)
+- The `:run-userscript` command (deprecated in v0.2.0)
+- The `rapid` and `rapid-win` targets for `:hint` (deprecated in v0.2.0)
+- The `:cancel-download` command (deprecated in v0.2.0)
+- The `:download-page` command (deprecated in v0.2.0)
+
+Fixed
+~~~~~
+
+- Fixed retrying of downloads which were started in a now closed tab.
+- Fixed displaying of web history if `web-history-max-items` is set to -1.
+- Cloned tabs now don't display favicons anymore if show-favicons is False.
+- Fixed a crash when clicking a bookmark name and pressing `Ctrl-D`.
+- Fixed a crash when a website presents a very small favicon.
+- Fixed prompting for download directory when
+  `storage -> prompt-download-directory` was unset.
+- Fixed crash when using `:follow-hint` outside of hint mode.
+- Fixed crash when using `:set foo bar?` with invalid section/option.
+- Fixed scrolling to the very left/right with `:scroll-perc`.
+- Using an external editor should now work correctly with some funny chars
+  (U+2028/U+2029/BOM).
+- Movements in caret mode now should work correctly on OS X and Windows.
+- Fixed upgrade from earlier config versions.
+- Fixed crash when killing a running userscript.
+- Fixed characters being passed through when shifted with
+  `forward-unbound-keys` set to `auto`.
+- Fixed restarting after a crash is reported.
+- Removed `.pyc` files accidentally contained in source releases.
+
+v0.4.1
+------
+
+Fixed
+~~~~~
+
+- Adjusted AppArmor config for the IPC changes in v0.4.0.
+- Fixed atime update frequency for IPC file.
+- Worked around a Qt issue where middle-clicking caused scrolling with a
+  touchpad to restart at the beginning of the page.
+- The `completion -> web-history-max-items` setting is now also respected for
+  items added after starting qutebrowser.
+- Search terms are now shared between different tabs again
+- Tests (a reduced subset of them) now run correctly again when DISPLAY is not
+  set.
+- Fixed an issue causing qutebrowser to crash with Python 3.5 as soon as an ad
+  was blocked.
+- Fixed an issue causing qutebrowser to not start with more recent Python 3.4
+  versions (e.g. on Debian experimental).
+- Fixed various `PendingDeprecationWarnings` shown with Python 3.5.
+
+v0.4.0
+------
+
+Added
+~~~~~
+
+- New bookmark functionality (similar to quickmarks without a name).
+    * New command `:bookmark-add` to bookmark the current page (bound to `M`).
+    * New command `:bookmark-load` to load a bookmark (bound to `gb`/`gB`/`wB`).
+- New (hidden) command `:completion-item-del` (bound to `<Ctrl-D>`) to delete
+  the current item in the completion (for quickmarks/bookmarks).
+- New settings `tabs -> padding` and `tabs -> indicator-tabbing` to control the
+  size/padding of the tabbar.
+- New setting `ui -> statusbar-padding` to control the size/padding of the
+  status bar.
+- New setting `network -> referer-header` to configure when the referer should
+  be sent (by default it's only sent while on the same domain).
+- New setting `tabs -> show` which supersedes the old `tabs -> hide-*` options
+  and has an additional `switching` option which shows tab while switching
+  them. There's also a new `show-switching` option to configure the timeout.
+- New setting `storage -> remember-download-directory` to remember the last
+  used download directory.
+- New setting `storage -> prompt-download-directory` to download all downloads
+  without asking.
+- Rapid hinting is now also possible for downloads.
+- Directory browsing via `file://` is now supported.
+
+Changed
+~~~~~~~
+
+- Some developer scripts got moved to `scripts/dev/`
+- When downloading to a FIFO or special file, a confirmation is displayed as
+  this might cause qutebrowser to hang.
+- The `:yank-selected` command now works in all modes instead of just caret
+  mode and is not hidden anymore.
+- `minimal_webkit_testbrowser.py` now has a `--webengine` switch to test
+  QtWebEngine if it's installed.
+- The column width percentages for the completion view now depend on the
+  completion model.
+- The values for `tabs -> position` and `ui -> downloads-position` got changed
+  from `north`/`south`/`west/`east` to `top`/`bottom`/`left`/`right`. Existing
+  configs should be adjusted automatically.
+- `:tab-focus`/`gt` now behaves like `:tab-next` if no count/index is given.
+- The completion widget doesn't show a border anymore.
+- The tabbar doesn't display ugly arrows anymore if there isn't enough space
+  for all tabs.
+- Some insignificant Qt warnings which were printed on OS X are now hidden.
+- Better support for Qt 5.5 and Python 3.5.
+
+Fixed
+~~~~~
+
+- Fixed a bug where cookies were saved despite qutebrowser being started in
+  private browsing mode.
+- The local socket used for inter-process communication (opening new instances)
+  is now ensured to only be accessible by the user on all operating systems.
+- Various corner cases for inter-process communication issues got fixed.
+- `link_pyqt.py` now should work better on untested distributions.
+- Fixed various corner-cases with crashes when reading invalid config values
+  and the history file.
+- Fixed various corner-cases when setting text via an external editor.
+- Fixed potential crash when hinting a text field.
+- Fixed entering of insert mode when certain disabled text fields were clicked.
+- Fixed a crash when using `:set` with `-p` and `!` (invert value)
+- Downloads with unknown size are now handled correctly.
+- `:navigate increment/decrement` (`<Ctrl-A>`/`<Ctrl-X>`) now handles some
+  corner-cases better.
+- Fixed a bug where the completion got affected by another window's completion
+  if it was open in both windows.
+- Fixed a performance issue with large histories when opening previously
+  unvisited websites.
+- The progress bar now doesn't cause the statusbar to change it's height
+  anymore.
+- `~` is now always expanded when spawning a script.
+- Fixed various corner cases when opening links in an existing instance.
+- Fixed a race-condition causing an exception when starting qutebrowser.
+
+Removed
+~~~~~~~
+
+- The `tabs -> indicator-space` setting got removed as the new padding settings
+  should be used instead.
+- The `tabs -> hide-always` and `tabs -> hide-auto` settings got merged into
+  the new `tabs -> show` setting.
+
+v0.3.0
+------
+
+Added
+~~~~~
+
+- New commands `:message-info`, `:message-error` and `:message-warning` to show messages in the statusbar, e.g. from a userscript.
+- New command `:scroll-px` which replaces `:scroll` for pixel-exact scrolling.
+- New command `:jseval` to run a javascript snippet on the current page.
+- New (hidden) command `:follow-selected` (bound to `Enter`/`Ctrl-Enter` by default) to follow the link which is currently selected (e.g. after searching via `/`).
+- New (hidden) command `:clear-keychain` to clear a partially entered keychain (bound to `<Escape>` by default, in addition to clearing search).
+- New setting `ui -> smooth-scrolling`.
+- New setting `content -> webgl` to enable/disable https://www.khronos.org/webgl/[WebGL].
+- New setting `content -> css-regions` to enable/disable support for http://dev.w3.org/csswg/css-regions/[CSS Regions].
+- New setting `content -> hyperlink-auditing` to enable/disable support for https://html.spec.whatwg.org/multipage/semantics.html#hyperlink-auditing[hyperlink auditing].
+- New setting `tabs -> mousewheel-tab-switching` to control mousewheel behavior on the tab bar.
+- New arguments `--datadir` and `--cachedir` to set the data/cache location.
+- New arguments `--basedir` and `--temp-basedir` (intended for debugging) to set a different base directory for all data, which allows multiple invocations.
+- New argument `--no-err-windows` to suppress all error windows.
+- New arguments `--top-navigate` and `--bottom-navigate` (`-t`/`-b`) for `:scroll-page` to specify a navigation action (e.g. automatically go to the next page when arriving at the bottom).
+- New flag `-d`/`--detach` for `:spawn` to detach the spawned process so it's not closed when qutebrowser is.
+- New flag `-v`/`--verbose` for `:spawn` to print informations when the process started/exited successfully.
+- Many new color settings (foreground setting for every background setting).
+- New setting `ui -> modal-js-dialog` to use the standard modal dialogs for javascript questions instead of using the statusbar.
+- New setting `colors -> webpage.bg` to set the background color to use for websites which don't set one.
+- New setting `completion -> auto-open` to only open the completion when tab is pressed (if set to false).
+- New visual/caret mode (bound to `v`) to select text by keyboard.
+- There are now some example userscripts in `misc/userscripts`.
+- Support for Qt 5.5 and tox 2.0
+
+Changed
+~~~~~~~
+
+- *Breaking change for userscripts:* `QUTE_HTML` and `QUTE_TEXT` for userscripts now don't store the contents directly, and instead contain a filename.
+- The `content -> geolocation` and `notifications` settings now support a `true` value to always allow those. However, this is *not recommended*.
+- New bindings `<Ctrl-R>` (rapid), `<Ctrl-F>` (foreground) and `<Ctrl-B>` (background) to switch hint modes while hinting.
+- `<Ctrl-M>` and numpad-enter are now bound by default for bindings where `<Return>` was bound.
+- `:hint tab` and `F` now respect the `background-tabs` setting. To enforce a foreground tab (what `F` did before), use `:hint tab-fg` or `;f`.
+- `:scroll` now takes a direction argument (`up`/`down`/`left`/`right`/`top`/`bottom`/`page-up`/`page-down`) instead of two pixel arguments (`dx`/`dy`). The old form still works but is deprecated.
+- The `ui -> user-stylesheet` setting now also takes file paths relative to the config directory.
+- The `content -> cookies-accept` setting now has new `no-3rdparty` (default) and `no-unknown-3rdparty` values to block third-party cookies. The `default` value got renamed to `all`.
+- Improved startup time by reading the webpage history while qutebrowser is open.
+- The way `:spawn` splits its commandline has been changed slightly to allow commands with flags.
+- The default for the `new-instance-open-target` setting has been changed to `tab`.
+- Sessions now store zoom/scroll-position separately for each entry.
+
+Deprecated
+~~~~~~~~~~
+
+- `:scroll` with two pixel-arguments is now deprecated - `:scroll-px` should be used instead.
+
+Removed
+~~~~~~~
+
+- The `--no-crash-dialog` argument which was intended for debugging only was removed as it's replaced by `--no-err-windows` which suppresses all error windows.
+- Support for Qt installations without SSL support was dropped.
+
+Fixed
+~~~~~
+
+- Scrolling should now work more reliably on some pages where arrow keys worked but `hjkl` didn't.
+- Small improvements when checking if an input is a URL or not.
+- Fixed wrong cursor position when completing the first item in the completion.
+- Fixed exception when using search engines with {foo} in their name.
+- Fixed a bug where the same title was shown for all tabs on some systems.
+- Don't install the scripts package when installing qutebrowser.
+- Fixed searching for terms starting with a hyphen (e.g. `/-foo`)
+- Proxy authentication credentials are now remembered between different tabs.
+- Fixed updating of the tab title on pages without title.
+- Fixed AssertionError when closing many windows quickly.
+- Various fixes for deprecated key bindings and auto-migrations.
+- Workaround for qutebrowser not starting when there are NUL-bytes in the history (because of a currently unknown bug).
+- Fixed handling of keybindings containing Ctrl/Meta on OS X.
+- Fixed crash when downloading a URL without filename (e.g. magnet links) via "Save as...".
+- Fixed exception when starting qutebrowser with `:set` as argument.
+- Fixed horrible completion performance when the `shrink` option was set.
+- Sessions now store zoom/scroll-position correctly.
+
+https://github.com/qutebrowser/qutebrowser/releases/tag/v0.2.1[v0.2.1]
+-----------------------------------------------------------------------
+
+Fixed
+~~~~~
+
+- Added missing manpage (doc/qutebrowser.1.asciidoc) to archive.
+
+https://github.com/qutebrowser/qutebrowser/releases/tag/v0.2.0[v0.2.0]
 -----------------------------------------------------------------------
 
 Added
@@ -152,12 +1027,12 @@ Fixed
 - Scroll completion to top when showing it.
 - Handle unencodable file paths in config types correctly.
 - Fix for crash when executing a delayed command (because of a shadowed keybinding) and then unfocusing the window.
-- Fix for crash when hinting on a page which doesn't have an URL yet.
+- Fix for crash when hinting on a page which doesn't have a URL yet.
 - Fix exception when using `:set-cmd-text` with an empty argument.
 - Add a timeout to pastebin HTTP replies.
 - Various other fixes for small/rare bugs.
 
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.4[v0.1.4]
+https://github.com/qutebrowser/qutebrowser/releases/tag/v0.1.4[v0.1.4]
 -----------------------------------------------------------------------
 
 Changed
@@ -201,7 +1076,7 @@ Security
 * Stop the icon database from being created when private-browsing is set to true.
 * Disable insecure SSL ciphers.
 
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.3[v0.1.3]
+https://github.com/qutebrowser/qutebrowser/releases/tag/v0.1.3[v0.1.3]
 -----------------------------------------------------------------------
 
 Changed
@@ -235,7 +1110,7 @@ Security
 
 * Fix for HTTP passwords accidentally being written to debug log.
 
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.2[v0.1.2]
+https://github.com/qutebrowser/qutebrowser/releases/tag/v0.1.2[v0.1.2]
 -----------------------------------------------------------------------
 
 Changed
@@ -252,7 +1127,7 @@ Removed
 Fixed
 ~~~~~
 
-* Fix rare exception when a key is pressed shorly after opening a window
+* Fix rare exception when a key is pressed shortly after opening a window
 * Fix exception with certain invalid URLs like `http:foo:0`
 * Work around Qt bug which renders checkboxes on OS X unusable
 * Fix exception when a local files can't be read in `:adblock-update`
@@ -267,7 +1142,7 @@ Fixed
 * Fix user-stylesheet setting with an empty value.
 
 
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.1[v0.1.1]
+https://github.com/qutebrowser/qutebrowser/releases/tag/v0.1.1[v0.1.1]
 -----------------------------------------------------------------------
 
 Added
@@ -325,7 +1200,7 @@ Fixed
 * Ensure the docs get included in `freeze.py`.
 * Fix crash with `:zoom`.
 
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1[v0.1]
+https://github.com/qutebrowser/qutebrowser/releases/tag/v0.1[v0.1]
 -------------------------------------------------------------------
 
 Initial release.

CONTRIBUTING.asciidoc

@@ -11,9 +11,9 @@ This document contains guidelines for contributing to qutebrowser, as well as
 useful hints when doing so.
 
 If anything mentioned here would prevent you from contributing, please let me
-know, and contribute anyways! The guidelines are only meant to make life easier
-for me, but if you don't follow anything in here, I won't be mad at you. I will
-probably change it for you then, though.
+know, and contribute anyways! The guidelines are meant to make life easier for
+me, but if you don't follow everything in here, I won't be mad at you. In
+fact, I will probably change it for you.
 
 If you have any problems, I'm more than happy to help! You can get help in
 several ways:
@@ -34,17 +34,17 @@ this. It might be a good idea to ask on the mailing list or IRC channel to make
 sure nobody else started working on the same thing already.
 
 If you want to find something useful to do, check the
-https://github.com/The-Compiler/qutebrowser/issues[issue tracker]. Some
+https://github.com/qutebrowser/qutebrowser/issues[issue tracker]. Some
 pointers:
 
-* https://github.com/The-Compiler/qutebrowser/labels/easy[Issues which should
+* https://github.com/qutebrowser/qutebrowser/labels/easy[Issues which should
 be easy to solve]
-* https://github.com/The-Compiler/qutebrowser/labels/not%20code[Issues which
+* https://github.com/qutebrowser/qutebrowser/labels/not%20code[Issues which
 require little/no coding]
 
 There are also some things to do if you don't want to write code:
 
-* Help the community, e.g. on the mailinglist and the IRC channel.
+* Help the community, e.g., on the mailinglist and the IRC channel.
 * Improve the documentation.
 * Help on the website and graphics (logo, etc.).
 
@@ -55,12 +55,12 @@ qutebrowser uses http://git-scm.com/[git] for its development. You can clone
 the repo like this:
 
 ----
-git clone https://github.com/The-Compiler/qutebrowser.git
+git clone https://github.com/qutebrowser/qutebrowser.git
 ----
 
 If you don't know git, a http://git-scm.com/[git cheatsheet] might come in
 handy. Of course, if using git is the issue which prevents you from
-contributing, feel free to send normal patches instead, e.g. generated via
+contributing, feel free to send normal patches instead, e.g., generated via
 `diff -Nur`.
 
 Getting patches
@@ -77,7 +77,7 @@ based on your changes like this:
 ----
 git format-patch origin/master <1>
 ----
-<1> Replace `master` by the branch your work was based on, e.g.
+<1> Replace `master` by the branch your work was based on, e.g.,
 `origin/develop`.
 
 Useful utilities
@@ -86,30 +86,49 @@ Useful utilities
 Checkers
 ~~~~~~~~
 
-qutbebrowser uses http://tox.readthedocs.org/en/latest/[tox] to run its
+qutebrowser uses http://tox.readthedocs.org/en/latest/[tox] to run its
 unittests and several linters/checkers.
 
-Currently, the following tools will be invoked when you run `tox`:
+Currently, the following tox environments are available:
 
-* Unit tests using the Python
-https://docs.python.org/3.4/library/unittest.html[unittest] framework
-* https://pypi.python.org/pypi/flake8/[flake8]
-* https://github.com/GreenSteam/pep257/[pep257]
-* http://pylint.org/[pylint]
-* https://pypi.python.org/pypi/pyroma/[pyroma]
-* https://github.com/mgedmin/check-manifest[check-manifest]
-* `scripts/misc_checks.py` which checks for the following things:
+* Tests using https://www.pytest.org[pytest]:
+  - `py34`: Run pytest for python-3.4.
+  - `py35`: Run pytest for python-3.5.
+  - `py34-cov`: Run pytest for python-3.4 with code coverage report.
+  - `py35-cov`: Run pytest for python-3.5 with code coverage report.
+* `flake8`: Run https://pypi.python.org/pypi/flake8[flake8] checks:
+                https://pypi.python.org/pypi/pyflakes[pyflakes],
+                https://pypi.python.org/pypi/pep8[pep8],
+                https://pypi.python.org/pypi/mccabe[mccabe]
+* `vulture`: Run https://pypi.python.org/pypi/vulture[vulture] to find
+  unused code portions.
+* `pylint`: Run http://pylint.org/[pylint] static code analysis.
+* `pydocstyle`: Check
+  https://www.python.org/dev/peps/pep-0257/[PEP257] compliance with
+  https://github.com/PyCQA/pydocstyle[pydocstyle]
+* `pyroma`: Check packaging practices with
+  https://pypi.python.org/pypi/pyroma/[pyroma]
+* `eslint`: Run http://eslint.org/[ESLint] javascript checker.
+* `check-manifest`: Check MANIFEST.in completeness with
+  https://github.com/mgedmin/check-manifest[check-manifest]
+* `mkvenv`: Bootstrap a virtualenv for testing.
+* `misc`: Run `scripts/misc_checks.py` to check for:
     - untracked git files
     - VCS conflict markers
+    - common spelling mistakes
+
+The default test suite is run with `tox`; the list of default
+environments is obtained with `tox -l`.
 
 Please make sure the checks run without any warnings on your new contributions.
-There's of course the possibility of false-positives, and the following
+
+There's always the possibility of false positives; the following
 techniques are useful to handle these:
 
 * Use `_foo` for unused parameters, with `foo` being a descriptive name. Using
 `_` is discouraged.
-* If you think you have a good reason to suppress a message, add the following
-comment:
+* If you think you have a good reason to suppress a message, then add the 
+following comment:
 +
 ----
 # pylint: disable=message-name
@@ -121,24 +140,56 @@ smallest scope which makes sense. Most of the time, this will be line scope.
 * If you really think a check shouldn't be done globally as it yields a lot of
 false-positives, let me know! I'm still tweaking the parameters.
 
+
+Running Specific Tests
+~~~~~~~~~~~~~~~~~~~~~~
+
+While you are developing you often don't want to run the full test
+suite each time.
+
+Specific test environments can be run with `tox -e <envlist>`.
+
+Additional parameters can be passed to the test scripts by separating
+them from `tox` arguments with `--`.
+
+Examples:
+
+----
+# run only pytest tests which failed in last run:
+tox -e py35 -- --lf
+
+# run only the end2end feature tests:
+tox -e py35 -- tests/end2end/features
+
+# run everything with undo in the generated name, based on the scenario text
+tox -e py35 -- tests/end2end/features/test_tabs_bdd.py -k undo
+
+# run coverage test for specific file (updates htmlcov/index.html)
+tox -e py35-cov -- tests/unit/browser/test_webelem.py
+----
+
 Profiling
 ~~~~~~~~~
 
 In the _scripts/_ subfolder there's a `run_profile.py` which profiles the code
 and shows a graphical representation of what takes how much time.
 
-It needs https://pypi.python.org/pypi/pyprof2calltree/[pyprof2calltree] and
-http://kcachegrind.sourceforge.net/html/Home.html[KCacheGrind]. It uses the
-built-in Python https://docs.python.org/3.4/library/profile.html[cProfile]
-module.
+It uses the built-in Python
+https://docs.python.org/3.4/library/profile.html[cProfile] module and can show
+the output in four different ways:
+
+* Raw profile file (`--profile-tool=none`)
+* https://pypi.python.org/pypi/pyprof2calltree/[pyprof2calltree] and http://kcachegrind.sourceforge.net/html/Home.html[KCacheGrind] (`--profile-tool=kcachegrind`)
+* https://jiffyclub.github.io/snakeviz/[SnakeViz] (`--profile-tool=snakeviz`)
+* https://github.com/jrfonseca/gprof2dot[gprof2dot] (needs `dot` from http://graphviz.org/[Graphviz] and http://feh.finalrewind.org/[feh])
 
 Debugging
 ~~~~~~~~~
 
-In the `qutebrowser.utils.debug` module there are some useful functions for
-debugging.
+There are some useful functions for debugging in the `qutebrowser.utils.debug`
+module.
 
-When starting qutebrowser with the `--debug` flag you also get useful debug
+When starting qutebrowser with the `--debug` flag, you also get useful debug
 logs. You can add +--logfilter _category[,category,...]_+ to restrict logging
 to the given categories.
 
@@ -152,7 +203,7 @@ Useful websites
 
 Some resources which might be handy:
 
-* http://qt-project.org/doc/qt-5/classes.html[The Qt5 reference]
+* http://doc.qt.io/qt-5/classes.html[The Qt5 reference]
 * https://docs.python.org/3/library/index.html[The Python reference]
 * http://httpbin.org/[httpbin, a test service for HTTP requests/responses]
 * http://requestb.in/[RequestBin, a service to inspect HTTP requests]
@@ -165,7 +216,6 @@ Documentation of used Python libraries:
 * http://pythonhosted.org/setuptools/[setuptools]
 * http://cx-freeze.readthedocs.org/en/latest/overview.html[cx_Freeze]
 * https://pypi.python.org/pypi/colorama[colorama]
-* https://pypi.python.org/pypi/colorlog[colorlog]
 
 Related RFCs and standards:
 
@@ -210,8 +260,7 @@ Other
 Languages] (http://www.rfc-editor.org/errata_search.php?rfc=5646[Errata])
 * http://www.w3.org/TR/CSS2/[Cascading Style Sheets Level 2 Revision 1 (CSS
 2.1) Specification]
-* http://qt-project.org/doc/qt-4.8/stylesheet-reference.html[Qt Style Sheets
-Reference]
+* http://doc.qt.io/qt-5/stylesheet-reference.html[Qt Style Sheets Reference]
 * http://mimesniff.spec.whatwg.org/[MIME Sniffing Standard]
 * http://spec.whatwg.org/[WHATWG specifications]
 * http://www.w3.org/html/wg/drafts/html/master/Overview.html[HTML 5.1 Nightly]
@@ -227,43 +276,40 @@ Hints
 Python and Qt objects
 ~~~~~~~~~~~~~~~~~~~~~
 
-For many tasks, there are solutions in both Qt and the Python standard libary
-available.
+For many tasks, there are solutions available in both Qt and the Python
+standard library.
 
-In qutebrowser, the policy is usually using the Python libraries, as they
+In qutebrowser, the policy is usually to use the Python libraries, as they
 provide exceptions and other benefits.
 
 There are some exceptions to that:
 
 * `QThread` is used instead of Python threads because it provides signals and
 slots.
-* `QProcess` is used instead of Python's `subprocess` if certain actions (e.g.
-cleanup) when the process finished are desired, as it provides signals for
-that.
+* `QProcess` is used instead of Python's `subprocess`
 * `QUrl` is used instead of storing URLs as string, see the
 <<handling-urls,handling URLs>> section for details.
 
 When using Qt objects, two issues must be taken care of:
 
-* Methods of Qt objects report their status by using their return values,
+* Methods of Qt objects report their status with their return values,
 instead of using exceptions.
 +
-If a function gets or returns a Qt object which
-has an `.isValid()` method such as `QUrl` or `QModelIndex`, there's a helper
-function `ensure_valid` in `qutebrowser.utils.qt` which should get called on
-all such objects. It will raise `qutebrowser.utils.qt.QtValueError` if the
-value is not valid.
+If a function gets or returns a Qt object which has an `.isValid()`
+method such as `QUrl` or `QModelIndex`, there's a helper function
+`ensure_valid` in `qutebrowser.utils.qtutils` which should get called
+on all such objects. It will raise
+`qutebrowser.utils.qtutils.QtValueError` if the value is not valid.
 +
 If a function returns something else on error, the return value should
 carefully be checked.
 
-* Methods of Qt objects have certain maximum values, based on their underlying
-C++ types.
+* Methods of Qt objects have certain maximum values based on their
+underlying C++ types.
 +
-When passing a numeric parameter to a Qt function, all numbers should be
-range-checked using `qutebrowser.utils.check_overflow`, or passing a value
-which is too large should be avoided by other means (e.g. by setting a maximum
-value for a config object).
+To avoid passing too large of a numeric parameter to a Qt function, all 
+numbers should be range-checked using `qutebrowser.qtutils.check_overflow`,
+or by other means (e.g. by setting a maximum value for a config object).
 
 [[object-registry]]
 The object registry
@@ -292,10 +338,10 @@ window=_win-id_, tab=_tab-id_])+. The default scope is `global`.
 All objects can be printed by starting with the `--debug` flag and using the
 `:debug-all-objects` command.
 
-The registry is mainly used for <<commands,command handlers>> but also can be
-useful in places where using Qt's
-http://qt-project.org/doc/qt-5/signalsandslots.html[signals and slots]
-mechanism would be difficult.
+The registry is mainly used for <<commands,command handlers>>, but it can
+also be useful in places where using Qt's
+http://doc.qt.io/qt-5/signalsandslots.html[signals and slots] mechanism would
+be difficult.
 
 Logging
 ~~~~~~~
@@ -303,7 +349,7 @@ Logging
 Logging is used at various places throughout the qutebrowser code. If you add a
 new feature, you should also add some strategic debug logging.
 
-Unless other Python projects, qutebrowser doesn't use a logger per file,
+Unlike other Python projects, qutebrowser doesn't use a logger per file,
 instead it uses custom-named loggers.
 
 The existing loggers are defined in `qutebrowser.utils.log`. If your feature
@@ -327,7 +373,7 @@ The following logging levels are available for every logger:
 
 [width="75%",cols="25%,75%"]
 |=======================================================================
-|criticial |Critical issue, qutebrowser can't continue to run.
+|critical  |Critical issue, qutebrowser can't continue to run.
 |error     |There was an issue and some kind of operation was abandoned.
 |warning   |There was an issue but the operation can continue running.
 |info      |General informational messages.
@@ -365,44 +411,67 @@ then gets passed as the `self` parameter to the handler. The `scope` argument
 selects which object registry (global, per-tab, etc.) to use.  See the
 <<object-registry,object registry>> section for details.
 
-There are also other arguments to customize the way the command is registered,
-see the class documentation for `register` in `qutebrowser.commands.utils` for
-details.
+There are also other arguments to customize the way the command is
+registered; see the class documentation for `register` in
+`qutebrowser.commands.cmdutils` for details.
 
 The types of the function arguments are inferred based on their default values,
-e.g. an argument `foo=True` will be converted to a flag `-f`/`--foo` in
+e.g., an argument `foo=True` will be converted to a flag `-f`/`--foo` in
 qutebrowser's commandline.
 
-This behavior can be overridden using Python's
-http://legacy.python.org/dev/peps/pep-3107/[function annotations]. The
-annotation should always be a `dict`, like this:
+The type can be overridden using Python's
+http://legacy.python.org/dev/peps/pep-3107/[function annotations]:
 
 [source,python]
 ----
 @cmdutils.register(...)
-def foo(bar: {'type': int}, baz=True):
+def foo(bar: int, baz=True):
     ...
 ----
 
-The following keys are supported in the dict:
-
-* `type`: The type this value should have. The value entered by the user is
-then automatically checked. Possible values:
+Possible values:
     - A callable (`int`, `float`, etc.): Gets called to validate/convert the
       value.
-    - A string: The value must match exactly (mainly useful with tuples to get
-      a choice of values, see below).
     - A python enum type: All members of the enum are possible values.
-    - A tuple of multiple types above: Any of these types are valid values,
-      e.g. `('foo', 'bar')` or `(int, 'foo')`.
-* `flag`: The flag to be used, as 1-char string (default: First char of the
-long name).
-* `name`: The long name to be used, as string (default: Name of the parameter).
-* `special`: The string `count` or `win_id` if the parameter should be
-auto-filled (with the count given by the user and the window ID the command was
-executed in, respectively).
-* `nargs`: Gets passed to argparse, see
-https://docs.python.org/dev/library/argparse.html#nargs[its documentation].
+    - A `typing.Union` of multiple types above: Any of these types are valid
+      values, e.g., `typing.Union[str, int]`
+
+You can customize how an argument is handled using the `@cmdutils.argument`
+decorator *after* `@cmdutils.register`. This can, for example, be used to 
+customize the flag an argument should get:
+
+[source,python]
+----
+@cmdutils.register(...)
+@cmdutils.argument('bar', flag='c')
+def foo(bar):
+    ...
+----
+
+For a `str` argument, you can restrict the allowed strings using `choices`:
+
+[source,python]
+----
+@cmdutils.register(...)
+@cmdutils.argument('bar', choices=['val1', 'val2'])
+def foo(bar: str):
+    ...
+----
+
+For `typing.Union` types, the given `choices` are only checked if other types
+(like `int`) don't match.
+
+The following arguments are supported for `@cmdutils.argument`:
+
+- `flag`: Customize the short flag (`-x`) the argument will get.
+- `win_id=True`: Mark the argument as special window ID argument
+- `count=True`: Mark the argument as special count argument
+- `hide=True`: Hide the argument from the documentation
+- `completion`: A `usertypes.Completion` member to use as completion.
+- `choices`: The allowed string choices for the argument.
+
+The name of an argument will always be the parameter name, with any trailing
+underscores stripped and underscores replaced by dashes.
 
 [[handling-urls]]
 Handling URLs
@@ -412,13 +481,13 @@ qutebrowser handles two different types of URLs: URLs as a string, and URLs as
 the Qt `QUrl` type. As this can get confusing quickly, please follow the
 following guidelines:
 
-* Convert a string to a QUrl object as early as possible, i.e. directly after
+* Convert a string to a QUrl object as early as possible, i.e., directly after
 the user did enter it.
     - Use `utils.urlutils.fuzzy_url` if the URL is entered by the user
       somewhere.
     - Be sure you handle `utils.urlutils.FuzzyError` and display an error
       message to the user.
-* Convert a `QUrl` object to a string as late as possible, e.g. before
+* Convert a `QUrl` object to a string as late as possible, i.e., before
 displaying it to the user.
     - If you want to display the URL to the user, use `url.toDisplayString()`
       so password information is removed.
@@ -444,8 +513,8 @@ This is needed so valgrind handles self-modifying code correctly:
 [quote]
 ____
 This option controls Valgrind's detection of self-modifying code. If no
-checking is done, if a program executes some code, then overwrites it with new
-code, and executes the new code, Valgrind will continue to execute the
+checking is done and a program executes some code, overwrites it with new
+code, and then executes the new code, Valgrind will continue to execute the
 translations it made for the old code. This will likely lead to incorrect
 behavior and/or crashes.
 
@@ -457,6 +526,27 @@ generate code and subsequently overwrite part or all of it. Running with all
 will slow Valgrind down noticeably.
 ____
 
+Setting up a Windows Development Environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Install https://www.python.org/downloads/release/python-344/[Python 3.4]
+* Install https://sourceforge.net/projects/pyqt/files/PyQt5/PyQt-5.5.1/[PyQt 5.5]
+* Create a file at `C:\Windows\system32\python3.bat` with the following content:
+  `@C:\Python34\python %*`
+  This will make the Python 3.4 interpreter available as `python3`, which is used by various development scripts.
+* Install git from the https://git-scm.com/download/win[git-scm downloads page]
+  Try not to enable `core.autocrlf`, since that will cause `flake8` to complain a lot. Use an editor that can deal with plain line feeds instead.
+* Clone your favourite qutebrowser repository.
+* To install tox, open an elevated cmd, enter your working directory and run `pip install -rmisc/requirements/requirements-tox.txt`.
+
+Note that the `flake8` tox env might not run due to encoding errors despite having LANG/LC_* set correctly.
+
+Rebuilding the website
+~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to rebuild the website, run `./scripts/asciidoc2html.py --website <outputdir>`.
+
+
 Style conventions
 -----------------
 
@@ -525,10 +615,7 @@ Return:
 * The layout of a class should be like this:
   - docstring
   - `__magic__` methods
-  - properties
-  - _private methods
-  - public methods
-  - `on_*` methods
+  - other methods
   - overrides of Qt methods
 
 Checklists
@@ -541,37 +628,50 @@ New Qt release
 
 * Run all tests and check nothing is broken.
 * Check the
-https://bugreports.qt-project.org/issues/?jql=reporter%20%3D%20%22The%20Compiler%22%20ORDER%20BY%20fixVersion%20ASC[Qt bugtracker]
+https://bugreports.qt.io/issues/?jql=reporter%20%3D%20%22The%20Compiler%22%20ORDER%20BY%20fixVersion%20ASC[Qt bugtracker]
 and make sure all bugs marked as resolved are actually fixed.
 * Update own PKGBUILDs based on upstream Archlinux updates and rebuild.
 * Update recommended Qt version in `README`
 * Grep for `WORKAROUND` in the code and test if fixed stuff works without the
 workaround.
 * Check relevant
-https://github.com/The-Compiler/qutebrowser/issues?q=is%3Aopen+is%3Aissue+label%3Aqt[qutebrowser
+https://github.com/qutebrowser/qutebrowser/issues?q=is%3Aopen+is%3Aissue+label%3Aqt[qutebrowser
 bugs] and check if they're fixed.
 
+New PyQt release
+~~~~~~~~~~~~~~~~
+
+* See above
+* Install new PyQt in Windows VM (32- and 64-bit)
+* Download new installer and update PyQt installer path in `ci_install.py`.
+* Update `tox.ini`/`.travis.yml`/`.appveyor.yml` to test new versions
+
 qutebrowser release
 ~~~~~~~~~~~~~~~~~~~
 
-* Make sure there are no unstaged changes.
-* Run `src2asciidoc.py` and commit changes if necessary.
-* Run `asciidoc2html.py`.
+* Make sure there are no unstaged changes and the tests are green.
+* Run `x=... y=...` to set the respective shell variables
+
+* Add newest config to `tests/unit/config/old_configs` and update `test_upgrade_version`
+    - `python -m qutebrowser --basedir conf :quit`
+    - `sed '/^#/d'  conf/config/qutebrowser.conf > tests/unit/config/old_configs/qutebrowser-v0.x.y.conf`
+    - `rm -r conf`
+    - commit
 * Adjust `__version_info__` in `qutebrowser/__init__.py`.
+* Update changelog (remove *(unreleased)*)
+* Run tests again
+* Commit
 
-* Run all tests on all supported systems.
-* Test an upgrade from the previous version (no manual intervention).
-* Test an upgrade from the first version (no manual intervention).
-
-* Create annotated git tag (`git tag -s "v0.X.Y" -m "Release v0.X.Y"`)
-* If it's a new minor, create git branch `v0.X.x`
-* `git push`; `git push "v0.X.Y"`
+* Create annotated git tag (`git tag -s "v0.$x.$y" -m "Release v0.$x.$y"`)
+* `git push origin`; `git push origin v0.$x.$y`
+* If committing on minor branch, cherry-pick release commit to master.
 * Create release on github
-* Mark the milestone at https://github.com/The-Compiler/qutebrowser/milestones
+* Mark the milestone at https://github.com/qutebrowser/qutebrowser/milestones
 as closed.
 
-* Create standalone Windows package (32/64bit) in Windows VM
-* Upload to PyPI: `python setup.py register sdist upload --sign`
-* Upload to qutebrowser.org with checksum/GPG
-
-* Announce to qutebrowser mailinglist
+* Linux: Run `python3 scripts/dev/build_release.py --upload v0.$x.$y`
+* Windows: Run `C:\Python34_x32\python scripts\dev\build_release.py --asciidoc C:\Python27\python C:\asciidoc-8.6.9\asciidoc.py --upload v0.X.Y` (replace X/Y by hand)
+* OS X: Run `python3 scripts/dev/build_release.py --upload v0.X.Y` (replace X/Y by hand)
+* On server: Run `python3 scripts/dev/download_release.py v0.X.Y` (replace X/Y by hand)
+* Update `qutebrowser-git` PKGBUILD if dependencies/install changed
+* Announce to qutebrowser and qutebrowser-announce mailinglist

FAQ.asciidoc

@@ -1,11 +1,12 @@
 Frequently asked questions
 ==========================
+:title: Frequently asked questions
 The Compiler <mail@qutebrowser.org>
 
 [qanda]
 What is qutebrowser based on?::
-    qutebrowser uses http://www.python.org/[Python], http://qt-project.org/[Qt]
-    and http://www.riverbankcomputing.com/software/pyqt/intro[PyQt].
+    qutebrowser uses http://www.python.org/[Python], http://qt.io/[Qt] and
+    http://www.riverbankcomputing.com/software/pyqt/intro[PyQt].
 +
 The concept of it is largely inspired by http://portix.bitbucket.org/dwb/[dwb]
 and http://www.vimperator.org/vimperator[Vimperator]. Many actions and
@@ -15,7 +16,7 @@ Why another browser?::
     It might be hard to believe, but I didn't find any browser which I was
     happy with, so I started to write my own. Also, I needed a project to get
     into writing GUI applications with Python and
-    link:http://qt-project.org/[Qt]/link:http://www.riverbankcomputing.com/software/pyqt/intro[PyQt].
+    link:http://qt.io/[Qt]/link:http://www.riverbankcomputing.com/software/pyqt/intro[PyQt].
 +
 Read the next few questions to find out why I was unhappy with existing
 software.
@@ -32,12 +33,11 @@ API] seems to lack basic features like proxy support, and almost no projects
 seem to have started porting to WebKit2 (I only know of
 http://www.uzbl.org/[uzbl]).
 +
-qutebrowser uses http://qt-project.org/[Qt] and
-http://qt-project.org/wiki/QtWebKit[QtWebKit] instead, which suffers from far
-less such crashes. It might switch to
-http://qt-project.org/wiki/QtWebEngine[QtWebEngine] in the future, which is
-based on Google's https://en.wikipedia.org/wiki/Blink_(layout_engine)[Blink]
-rendering engine.
+qutebrowser uses http://qt.io/[Qt] and http://wiki.qt.io/QtWebKit[QtWebKit]
+instead, which suffers from far less such crashes. It might switch to
+http://wiki.qt.io/QtWebEngine[QtWebEngine] in the future, which is based on
+Google's https://en.wikipedia.org/wiki/Blink_(layout_engine)[Blink] rendering
+engine.
 
 What's wrong with https://www.mozilla.org/en-US/firefox/new/[Firefox] and link:http://5digits.org/pentadactyl/[Pentadactyl]/link:http://www.vimperator.org/vimperator[Vimperator]?::
     Firefox likes to break compatibility with addons on each upgrade, gets
@@ -54,14 +54,14 @@ What's wrong with http://www.chromium.org/Home[Chromium] and https://vimium.gith
 
 Why Python?::
     I enjoy writing Python since 2011, which made it one of the possible
-    choices. I wanted to use http://qt-project.org/[Qt] because of
-    http://qt-project.org/wiki/QtWebKit[QtWebKit] so I didn't have
-    http://qt-project.org/wiki/Category:LanguageBindings[many other choices]. I
-    don't like C++ and can't write it very well, so that wasn't an alternative.
+    choices. I wanted to use http://qt.io/[Qt] because of
+    http://wiki.qt.io/QtWebKit[QtWebKit] so I didn't have
+    http://wiki.qt.io/Category:LanguageBindings[many other choices]. I don't
+    like C++ and can't write it very well, so that wasn't an alternative.
 
 But isn't Python too slow for a browser?::
     http://www.infoworld.com/d/application-development/van-rossum-python-not-too-slow-188715[No.]
-    I believe efficency while coding is a lot more important than efficency
+    I believe efficiency while coding is a lot more important than efficiency
     while running. Also, most of the heavy lifting of qutebrowser is done by Qt
     and WebKit in C++, with the
     https://wiki.python.org/moin/GlobalInterpreterLock[GIL] released.
@@ -80,9 +80,49 @@ How do I play Youtube videos with mpv?::
     player - optionally even with hinting for links:
 +
 ----
-:bind x spawn mpv {url}
-:bind ;x hint links spawn mpv {hint-url}
+:bind m spawn mpv {url}
+:bind M hint links spawn mpv {hint-url}
 ----
++
+Note that you might need an additional package (e.g.
+https://www.archlinux.org/packages/community/any/youtube-dl/[youtube-dl] on
+Archlinux) to play web videos with mpv.
++
+There is a very useful script for mpv, which emulates "unique application"
+functionality. This way you can add links to the mpv playlist instead of
+playing them all at once.
++
+You can find the script here: https://github.com/mpv-player/mpv/blob/master/TOOLS/umpv
++
+It also works nicely with rapid hints:
++
+----
+:bind m spawn umpv {url}
+:bind M hint links spawn umpv {hint-url}
+:bind ;M hint --rapid links spawn umpv {hint-url}
+----
+
+How do I use qutebrowser with mutt?::
+    Due to a Qt limitation, local files without `.html` extensions are
+    "downloaded" instead of displayed, see
+    https://github.com/qutebrowser/qutebrowser/issues/566[#566]. You can work
+    around this by using this in your `mailcap`:
++
+----
+    text/html; mv %s %s.html && qutebrowser %s.html >/dev/null 2>/dev/null; needsterminal;
+----
+
+What is the difference between bookmarks and quickmarks?::
+    Bookmarks will always use the title of the website as their name, but with quickmarks
+    you can set your own title.
++
+For example, if you bookmark multiple food recipe websites and use `:open`, 
+you have to type the title or address of the website.
++
+When using quickmark, you can give them all names, like
+`foodrecipes1`, `foodrecipes2` and so on. When you type 
+`:open foodrecipes`, you will see a list of all the food recipe sites,
+without having to remember the exact website title or address.
 
 == Troubleshooting
 
@@ -100,8 +140,8 @@ Unable to view flash content.::
 Experiencing freezing on sites like duckduckgo and youtube.::
     This issue could be caused by stale plugin files installed by `mozplugger`
     if mozplugger was subsequently removed.
-    Try exiting qutebroser and removing `~/.mozilla/plugins/mozplugger*.so`.
-    See https://github.com/The-Compiler/qutebrowser/issues/357[Issue #357]
+    Try exiting qutebrowser and removing `~/.mozilla/plugins/mozplugger*.so`.
+    See https://github.com/qutebrowser/qutebrowser/issues/357[Issue #357]
     for more details.
 
 Experiencing segfaults (crashes) on Debian systems.::
@@ -112,10 +152,10 @@ Experiencing segfaults (crashes) on Debian systems.::
 
 Segfaults on Facebook, Medium, Amazon, ...::
     If you are on a Debian or Ubuntu based system, you might experience some crashes
-    visting these sites. This is caused by a known bug in Qt which has been
+    visiting these sites. This is caused by various bugs in Qt which have been
     fixed in Qt 5.4. However Debian and Ubuntu are slow to adopt or upgrade
-    some packages. There is currently no easy way to manually upgrade to Qt
-    5.4 on those systems.
+    some packages. On Debian Jessie, it's recommended to use the experimental
+    repos as described in https://github.com/qutebrowser/qutebrowser/blob/master/INSTALL.asciidoc#on-debian--ubuntu[INSTALL].
 +
 Since Ubuntu Trusty (using Qt 5.2.1),
 https://bugreports.qt.io/browse/QTBUG-42417?jql=component%20%3D%20WebKit%20and%20resolution%20%3D%20Done%20and%20fixVersion%20in%20(5.3.0%2C%20%225.3.0%20Alpha%22%2C%20%225.3.0%20Beta1%22%2C%20%225.3.0%20RC1%22%2C%205.3.1%2C%205.3.2%2C%205.4.0%2C%20%225.4.0%20Alpha%22%2C%20%225.4.0%20Beta%22%2C%20%225.4.0%20RC%22)%20and%20priority%20in%20(%22P2%3A%20Important%22%2C%20%22P1%3A%20Critical%22%2C%20%22P0%3A%20Blocker%22)[over
@@ -126,8 +166,8 @@ https://bugreports.qt.io/browse/QTBUG-42417?jql=component%20%3D%20WebKit%20and%2
 
 My issue is not listed.::
     If you experience any segfaults or crashes, you can report the issue in
-    https://github.com/The-Compiler/qutebrowser/issues[the issue tracker] or
+    https://github.com/qutebrowser/qutebrowser/issues[the issue tracker] or
     using the `:report` command.
     If you are reporting a segfault, make sure you read the
-    https://github.com/The-Compiler/qutebrowser/blob/master/doc/stacktrace.asciidoc[guide]
-    on how to report them with all needed information.
+    link:doc/stacktrace.asciidoc[guide] on how to report them with all needed
+    information.

INSTALL.asciidoc

@@ -8,80 +8,150 @@ qutebrowser should run on these systems:
 
 * Debian jessie or newer
 * Ubuntu Trusty (14.04 LTS) or newer
-* Any other distribution based on these (e.g. Linux Mint)
+* Any other distribution based on these (e.g. Linux Mint 17+)
+
+Unfortunately there is no Debian package in the official repos yet, but installing qutebrowser is
+still relatively easy!
+
+You can use packages that are built for every release or build it yourself from git.
+
+Using the packages
+~~~~~~~~~~~~~~~~~~
 
 Install the dependencies via apt-get:
 
 ----
-# apt-get install python3-pyqt5 python3-pyqt5.qtwebkit python-tox
+# apt-get install python3-lxml python-tox python3-pyqt5 python3-pyqt5.qtwebkit python3-pyqt5.qtquick python3-sip python3-jinja2 python3-pygments python3-yaml
+----
+
+Get the qutebrowser package from the
+https://github.com/qutebrowser/qutebrowser/releases[release page] and download
+the https://qutebrowser.org/python3-pypeg2_2.15.2-1_all.deb[PyPEG2 package].
+
+Install the packages:
+
+----
+# dpkg -i python3-pypeg2_*_all.deb
+# dpkg -i qutebrowser_*_all.deb
+----
+
+Build it from git
+~~~~~~~~~~~~~~~~~
+
+Install the dependencies via apt-get:
+
+[NOTE]
+==========================
+On Debian, it's recommended to install the Qt packages from the
+https://wiki.debian.org/DebianExperimental[experimental] repository as those
+are a much newer version of Qt which is more stable.
+
+Add the following line to your `/etc/apt/sources.list`:
+
+----
+deb http://ftp.debian.org/debian experimental main
+----
+
+Then install the packages like this:
+
+----
+# apt-get update
+# apt-get install -t experimental python3-pyqt5 python3-pyqt5.qtwebkit python3-pyqt5.qtquick python3-sip python3-dev
+# apt-get install python-tox
+----
+
+It's also recommended to pin those packages to receive updates by creating a
+file `/etc/apt/preferences.d/qutebrowser` with the following contents:
+
+----
+Package: python3-pyqt5* libqt5*
+Pin: release a=experimental
+Pin-Priority: 800
+----
+==========================
+
+For distributions other than Debian or if you prefer to not use the
+experimental repo:
+
+----
+# apt-get install python3-pyqt5 python3-pyqt5.qtwebkit python3-pyqt5.qtquick python-tox python3-sip python3-dev
 ----
 
 To generate the documentation for the `:help` command, when using the git
 repository (rather than a release):
 
 ----
-# apt-get install asciidoc
+# apt-get install asciidoc source-highlight
 $ python3 scripts/asciidoc2html.py
 ----
 
-Then run tox like this to set up a
-https://docs.python.org/3/library/venv.html[virtual environment]:
+If video or sound don't seem to work, try installing the gstreamer plugins:
 
 ----
-$ tox -e mkvenv
+# apt-get install gstreamer1.0-plugins-{bad,base,good,ugly}
 ----
 
-This installs all needed Python dependencies in a `.venv` subfolder. The
-system-wide Qt5/PyQt5 installations are symlinked into the virtual environment.
+Then <<tox,install qutebrowser via tox>>.
 
-You can then create a simple wrapper script to start qutebrowser somewhere in
-your `$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`):
+On Fedora
+---------
+
+qutebrowser is available in the official repositories for Fedora 22 and newer.
 
 ----
-#!/bin/bash
-~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
+# dnf install qutebrowser
 ----
 
-Please also read about <<updating,updating qutebrowser with tox>>.
-
 On Archlinux
 ------------
 
-There are two Archlinux packages available in the AUR:
-https://aur.archlinux.org/packages/qutebrowser/[qutebrowser] and
-https://aur.archlinux.org/packages/qutebrowser-git/[qutebrowser-git].
-
-You can install them like this:
+qutebrowser is available in the official [community] repository.
 
 ----
-$ mkdir qutebrowser
-$ cd qutebrowser
-$ wget https://aur.archlinux.org/packages/qu/qutebrowser-git/PKGBUILD
+# pacman -S qutebrowser
+----
+
+There is also a -git version available in the AUR:
+https://aur.archlinux.org/packages/qutebrowser-git/[qutebrowser-git].
+
+You can install it using `makepkg` like this:
+
+----
+$ git clone https://aur.archlinux.org/qutebrowser-git.git
+$ cd qutebrowser-git
 $ makepkg -si
+$ cd ..
+$ rm -r qutebrowser-git
 ----
 
 or you could use an AUR helper, e.g. `yaourt -S qutebrowser-git`.
 
+If video or sound don't seem to work, try installing the gstreamer plugins:
+
+----
+# pacman -S gst-plugins-{base,good,bad,ugly} gst-libav
+----
+
 On Gentoo
 ---------
 
-A dedicated overlay is available on
-https://github.com/posativ/qutebrowser-overlay[GitHub]. To install it, add the
-overlay with http://wiki.gentoo.org/wiki/Layman[layman]:
-
-----
-# layman -a qutebrowser
-----
-
-Note, that Qt5 is available in the portage tree, but masked. You may need to do
-a lot of keywording to install qutebrowser. Also make sure you have `python3_4`
-in your `PYTHON_TARGETS` (`/etc/portage/make.conf`) and rebuild your system
-(`emerge -uDNav @world`). Afterwards, you can install qutebrowser:
+qutebrowser is available in the main repository and can be installed with:
 
 ----
 # emerge -av qutebrowser
 ----
 
+Make sure you have `python3_4` in your `PYTHON_TARGETS`
+(`/etc/portage/make.conf`) and rebuild your system (`emerge -uDNav @world`) if
+necessary.
+
+If video or sound don't seem to work, try installing the gstreamer plugins:
+
+----
+# emerge -av gst-plugins-{base,good,bad,ugly,libav}
+----
+
+
 On Void Linux
 -------------
 
@@ -92,12 +162,75 @@ with:
 # xbps-install qutebrowser
 ----
 
+On NixOS
+--------
+
+Nixpkgs collection contains `pkgs.qutebrowser` since June 2015. You can install
+it with:
+
+----
+$ nix-env -i qutebrowser
+----
+
+On openSUSE
+-----------
+
+There are prebuilt RPMs available for Tumbleweed and Leap 42.1:
+
+http://software.opensuse.org/download.html?project=home%3Aarpraher&package=qutebrowser[One Click Install]
+
+Or add the repo manually:
+
+----
+# zypper addrepo http://download.opensuse.org/repositories/home:arpraher/openSUSE_Tumbleweed/home:arpraher.repo
+# zypper refresh
+# zypper install qutebrowser
+----
+
+On OpenBSD
+----------
+
+qutebrowser is in http://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/www/qutebrowser/[OpenBSD ports].
+
+Manual install:
+
+----
+# cd /usr/ports/www/qutebrowser
+# make install
+----
+
+Or alternatively if you're using `-current` (or OpenBSD 6.1 once it's been released):
+
+----
+# pkg_add qutebrowser
+----
+
 On Windows
 ----------
 
-You can either use one of the
-https://github.com/The-Compiler/qutebrowser/releases[prebuilt standalone
-packages or MSI installers], or install manually:
+There are different ways to install qutebrowser on Windows:
+
+Prebuilt binaries
+~~~~~~~~~~~~~~~~~
+
+Prebuilt standalone packages and MSI installers
+https://github.com/qutebrowser/qutebrowser/releases[are built] for every
+release.
+
+https://chocolatey.org/packages/qutebrowser[Chocolatey package]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* PackageManagement PowerShell module
+----
+PS C:\> Install-Package qutebrowser
+----
+* Chocolatey's client
+----
+C:\> choco install qutebrowser
+----
+
+Manual install
+~~~~~~~~~~~~~~
 
 * Use the installer from http://www.python.org/downloads[python.org] to get
 Python 3 (be sure to install pip).
@@ -111,41 +244,48 @@ https://pip.pypa.io/en/latest/[pip]:
 $ pip install tox
 ----
 
-Then run tox like this to set up a
-https://docs.python.org/3/library/venv.html[virtual environment]:
-
-----
-$ tox -e mkvenv
-----
-
-This installs all needed Python dependencies in a `.venv` subfolder. The
-system-wide Qt5/PyQt5 installations are used in the virtual environment.
-
-Please also read about <<updating,updating qutebrowser with tox>>.
+Then <<tox,install qutebrowser via tox>>.
 
 On OS X
 -------
 
-To install qutebrowser on OS X, you'll want a package manager, e.g.
-http://brew.sh/[Homebrew] or https://www.macports.org/[MacPorts]. Also make
-sure, you have https://itunes.apple.com/en/app/xcode/id497799835[XCode]
-installed to compile PyQt5 in a later step.
+Prebuilt binary
+~~~~~~~~~~~~~~~
+
+The easiest way to install qutebrowser on OS X is to use the prebuilt `.app`
+files from the
+https://github.com/qutebrowser/qutebrowser/releases[release page].
+
+This binary is also available through the
+https://caskroom.github.io/[Homebrew Cask] package manager:
 
 ----
-$ brew install python3 pyqt5
-$ pip3.4 install qutebrowser
+$ brew cask install qutebrowser
 ----
 
-if you are using Homebrew. For MacPorts, run:
+Manual Install
+~~~~~~~~~~~~~~
+
+Alternatively, you can install the dependencies via a package manager (like
+http://brew.sh/[Homebrew] or https://www.macports.org/[MacPorts]) and run
+qutebrowser from source.
+
+==== Homebrew
 
 ----
-$ sudo port install python34 py34-jinja2 asciidoc py34-pygments py34-pyqt5
-$ sudo pip3.4 install qutebrowser
+$ brew install qt5
+$ pip3 install qutebrowser
 ----
 
-The preferences for qutebrowser are stored in
-`~/Library/Preferences/qutebrowser`, the application data is stored in
-`~/Library/Application Support/qutebrowser`.
+Homebrew's builds of Qt and PyQt no longer include QtWebKit - if you need
+QtWebKit support, it is necessary to build from source. The build takes several
+hours on an average laptop.
+
+----
+$ brew install qt5 --with-qtwebkit
+$ brew install -s pyqt5
+$ pip3 install qutebrowser
+----
 
 Packagers
 ---------
@@ -157,9 +297,53 @@ standard location for your distro (`/usr/share/applications` and
 The normal `setup.py install` doesn't install these files, so you'll have to do
 it as part of the packaging process.
 
-[[updating]]
-Updating qutebrowser with tox
------------------------------
+[[tox]]
+Installing qutebrowser with tox
+-------------------------------
+
+First of all, clone the repository using http://git-scm.org/[git] and switch
+into the repository folder:
+
+----
+$ git clone https://github.com/qutebrowser/qutebrowser.git
+$ cd qutebrowser
+----
+
+
+Then run tox inside the qutebrowser repository to set up a
+https://docs.python.org/3/library/venv.html[virtual environment]:
+
+----
+$ tox -e mkvenv
+----
+
+On Windows, run tox with the 'mkvenv-win' option, however make sure that ONLY Python3 is in your PATH before running tox.
+
+----
+$ tox -e mkvenv-win
+----
+
+This installs all needed Python dependencies in a `.venv` subfolder. The
+system-wide Qt5/PyQt5 installations are symlinked into the virtual environment.
+
+You can then create a simple wrapper script to start qutebrowser somewhere in
+your `$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`):
+
+----
+#!/bin/bash
+~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
+----
+
+If you are developing on qutebrowser, you may want to redirect it to a local
+config:
+
+----
+#!/bin/bash
+~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@"
+----
+
+Updating
+~~~~~~~~
 
 When you updated your local copy of the code (e.g. by pulling the git repo, or
 extracting a new version), the virtualenv should automatically use the updated

MANIFEST.in

@@ -1,31 +1,49 @@
-global-exclude __pycache__ *.pyc *.pyo
-
-recursive-include qutebrowser/html *.html
-recursive-include qutebrowser/test *.py
-graft icons
-graft scripts/pylint_checkers
-graft doc/img
-graft misc
-include qutebrowser/utils/testfile
-include qutebrowser/git-commit-id
-include COPYING doc/* README.asciidoc CONTRIBUTING.asciidoc FAQ.asciidoc INSTALL.asciidoc CHANGELOG.asciidoc
-include qutebrowser.desktop
-include requirements.txt
-include tox.ini
-include qutebrowser.py
-
-exclude scripts/cleanup.py
-exclude scripts/minimal_webkit_testbrowser.py
-exclude scripts/run_profile.py
-exclude scripts/src2asciidoc.sh
-exclude scripts/gen_resources.sh
-exclude scripts/quit_segfault_test.sh
-exclude scripts/segfault_test.sh
-exclude doc/notes
-recursive-exclude doc *.asciidoc
-prune tests
-exclude qutebrowser.rcc
-exclude .coveragerc
-exclude .flake8
-exclude .pylintrc
-exclude doc/help
+recursive-include qutebrowser *.py
+recursive-include qutebrowser/img *.svg *.png
+recursive-include qutebrowser/test *.py
+recursive-include qutebrowser/javascript *.js
+graft qutebrowser/html
+graft qutebrowser/3rdparty
+graft icons
+graft doc/img
+graft misc/apparmor
+graft misc/userscripts
+recursive-include scripts *.py
+include qutebrowser/utils/testfile
+include qutebrowser/git-commit-id
+include COPYING doc/* README.asciidoc CONTRIBUTING.asciidoc FAQ.asciidoc INSTALL.asciidoc CHANGELOG.asciidoc
+include qutebrowser.desktop
+include requirements.txt
+include tox.ini
+include qutebrowser.py
+include misc/cheatsheet.svg
+
+prune www
+prune scripts/dev
+prune scripts/testbrowser_cpp
+prune .github
+exclude scripts/asciidoc2html.py
+exclude doc/notes
+recursive-exclude doc *.asciidoc
+include doc/qutebrowser.1.asciidoc
+prune tests
+prune qutebrowser/3rdparty
+prune misc/requirements
+prune misc/docker
+exclude .editorconfig
+exclude pytest.ini
+exclude qutebrowser.rcc
+exclude .coveragerc
+exclude .pylintrc
+exclude qutebrowser/javascript/.eslintrc.yaml
+exclude qutebrowser/javascript/.eslintignore
+exclude doc/help
+exclude .appveyor.yml
+exclude .travis.yml
+exclude codecov.yml
+exclude .pydocstylerc
+exclude misc/appveyor_install.py
+exclude misc/qutebrowser.spec
+exclude .flake8
+
+global-exclude __pycache__ *.pyc *.pyo

README.asciidoc

@@ -1,21 +1,26 @@
 // If you are reading this in plaintext or on PyPi:
 //
 // A rendered version is available at:
-// https://github.com/The-Compiler/qutebrowser/blob/master/README.asciidoc
+// https://github.com/qutebrowser/qutebrowser/blob/master/README.asciidoc
 
 qutebrowser
 ===========
 
-image:icons/qutebrowser-64x64.png[qutebrowser logo] *A keyboard-driven, vim-like browser based on PyQt5 and QtWebKit.*
+// QUTE_WEB_HIDE
+image:icons/qutebrowser-64x64.png[qutebrowser logo] *A keyboard-driven, vim-like browser based on PyQt5 and Qt.*
 
-image:https://img.shields.io/pypi/l/qutebrowser.svg?style=flat["license badge",link="https://github.com/The-Compiler/qutebrowser/blob/master/COPYING"]
+image:https://img.shields.io/pypi/l/qutebrowser.svg?style=flat["license badge",link="https://github.com/qutebrowser/qutebrowser/blob/master/COPYING"]
 image:https://img.shields.io/pypi/v/qutebrowser.svg?style=flat["version badge",link="https://pypi.python.org/pypi/qutebrowser/"]
-image:https://img.shields.io/github/issues/The-Compiler/qutebrowser.svg?style=flat["issues badge",link="https://github.com/The-Compiler/qutebrowser/issues"]
-image:https://requires.io/github/The-Compiler/qutebrowser/requirements.svg?branch=master["requirements badge",link="https://requires.io/github/The-Compiler/qutebrowser/requirements/?branch=master"]
-image:http://qutebrowser.org:8010/png?builder=archlinux["build badge",link="http://qutebrowser.org:8010/waterfall"]
+image:https://requires.io/github/qutebrowser/qutebrowser/requirements.svg?branch=master["requirements badge",link="https://requires.io/github/qutebrowser/qutebrowser/requirements/?branch=master"]
+image:https://travis-ci.org/qutebrowser/qutebrowser.svg?branch=master["Build Status", link="https://travis-ci.org/qutebrowser/qutebrowser"]
+image:https://ci.appveyor.com/api/projects/status/5pyauww2k68bbow2/branch/master?svg=true["AppVeyor build status", link="https://ci.appveyor.com/project/qutebrowser/qutebrowser"]
+image:https://codecov.io/github/qutebrowser/qutebrowser/coverage.svg?branch=master["coverage badge",link="https://codecov.io/github/qutebrowser/qutebrowser?branch=master"]
 
-qutebrowser is a keyboard-focused browser with with a minimal GUI. It's based
-on Python, PyQt5 and QtWebKit and free software, licensed under the GPL.
+link:https://www.qutebrowser.org[website] | link:https://blog.qutebrowser.org[blog] | link:https://github.com/qutebrowser/qutebrowser/releases[releases]
+// QUTE_WEB_HIDE_END
+
+qutebrowser is a keyboard-focused browser with a minimal GUI. It's based
+on Python and PyQt5 and free software, licensed under the GPL.
 
 It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.
 
@@ -30,7 +35,7 @@ image:doc/img/hints.png["screenshot 4",width=300,link="doc/img/hints.png"]
 Downloads
 ---------
 
-See the https://github.com/The-Compiler/qutebrowser/releases[github releases
+See the https://github.com/qutebrowser/qutebrowser/releases[github releases
 page] for available downloads (currently a source archive, and standalone
 packages as well as MSI installers for Windows).
 
@@ -43,9 +48,10 @@ Documentation
 In addition to the topics mentioned in this README, the following documents are
 available:
 
-* A http://qutebrowser.org/img/cheatsheet-big.png[key binding cheatsheet]: +
-image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser key binding cheatsheet",link="http://qutebrowser.org/img/cheatsheet-big.png"]
+* A https://qutebrowser.org/img/cheatsheet-big.png[key binding cheatsheet]: +
+image:https://qutebrowser.org/img/cheatsheet-small.png["qutebrowser key binding cheatsheet",link="https://qutebrowser.org/img/cheatsheet-big.png"]
 * link:doc/quickstart.asciidoc[Quick start guide]
+* A https://www.shortcutfoo.com/app/dojos/qutebrowser[free training course] to remember those key bindings.
 * link:FAQ.asciidoc[Frequently asked questions]
 * link:CONTRIBUTING.asciidoc[Contributing to qutebrowser]
 * link:INSTALL.asciidoc[INSTALL]
@@ -64,11 +70,14 @@ message to the
 https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at
 mailto:qutebrowser@lists.qutebrowser.org[].
 
+There's also a https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[announce-only mailinglist]
+at mailto:qutebrowser-announce@lists.qutebrowser.org[].
+
 Contributions / Bugs
 --------------------
 
 You want to contribute to qutebrowser? Awesome! Please read
-link:doc/CONTRIBUTING.asciidoc[the contribution guidelines] for details and
+link:CONTRIBUTING.asciidoc[the contribution guidelines] for details and
 useful hints.
 
 If you found a bug or have a feature request, you can report it in several
@@ -81,32 +90,33 @@ https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at
 mailto:qutebrowser@lists.qutebrowser.org[].
 
 For security bugs, please contact me directly at mail@qutebrowser.org, GPG ID
-http://www.the-compiler.org/pubkey.asc[0xFD55A072].
+https://www.the-compiler.org/pubkey.asc[0xFD55A072].
 
 Requirements
 ------------
 
 The following software and libraries are required to run qutebrowser:
 
-* http://www.python.org/[Python] 3.4
-* http://qt-project.org/[Qt] 5.2.0 or newer (5.4.1 recommended)
-* QtWebKit
+* http://www.python.org/[Python] 3.4 or newer
+* http://qt.io/[Qt] 5.2.0 or newer (5.5.1 recommended)
+* QtWebKit (old or link:https://github.com/annulen/webkit/wiki[reloaded]/NG) or QtWebEngine
 * http://www.riverbankcomputing.com/software/pyqt/intro[PyQt] 5.2.0 or newer
-(5.4.1 recommended) for Python 3
+(5.5.1 recommended) for Python 3
 * https://pypi.python.org/pypi/setuptools/[pkg_resources/setuptools]
 * http://fdik.org/pyPEG/[pyPEG2]
 * http://jinja.pocoo.org/[jinja2]
 * http://pygments.org/[pygments]
 * http://pyyaml.org/wiki/PyYAML[PyYAML]
 
+The following libraries are optional and provide a better user experience:
+
+* http://cthedot.de/cssutils/[cssutils]
+
 To generate the documentation for the `:help` command, when using the git
 repository (rather than a release), http://asciidoc.org/[asciidoc] is needed.
 
-The following libraries are optional and provide colored logging in the
-console:
-
-* https://pypi.python.org/pypi/colorlog/[colorlog]
-* On Windows: https://pypi.python.org/pypi/colorama/[colorama]
+On Windows, https://pypi.python.org/pypi/colorama/[colorama] is needed to
+display colored log output.
 
 See link:INSTALL.asciidoc[INSTALL] for directions on how to install qutebrowser
 and its dependencies.
@@ -134,44 +144,155 @@ Contributors, sorted by the number of commits in descending order:
 
 // QUTE_AUTHORS_START
 * Florian Bruhin
+* Daniel Schadt
+* Ryan Roden-Corrent
+* Jan Verbeek
+* Jakub Klinkovský
+* Antoni Boucher
+* Lamar Pavel
+* Marshall Lochbaum
 * Bruno Oliveira
-* Joel Torstensson
+* Alexander Cogneau
+* Felix Van der Jeugt
+* Daniel Karbach
+* Martin Tournoij
+* Kevin Velghe
 * Raphael Pierzina
-* Claude
-* ZDarian
-* Peter Vilim
-* John ShaggyTwoDope Jenkins
-* Jimmy
-* rikn00
+* Joel Torstensson
 * Patric Schmitz
+* Tarcisio Fedrizzi
+* Claude
+* Corentin Julé
+* meles5
+* Philipp Hansch
+* Imran Sobir
+* Panagiotis Ktistakis
+* Artur Shaik
+* Nathan Isom
+* Thorsten Wißmann
+* Austin Anderson
+* Fritz Reichwald
+* Jimmy
+* Niklas Haas
+* Maciej Wołczyk
+* Spreadyy
+* Alexey "Averrin" Nabrodov
+* nanjekyejoannah
+* avk
+* ZDarian
+* Milan Svoboda
+* John ShaggyTwoDope Jenkins
+* Clayton Craft
+* Peter Vilim
+* knaggita
+* Oliver Caldwell
+* Julian Weigt
+* Tomasz Kramkowski
+* Sebastian Frysztak
+* Nikolay Amiantov
+* Julie Engel
+* Jonas Schürmann
+* error800
+* Michael Hoang
+* Liam BEGUIN
+* Daniel Fiser
+* skinnay
+* Zach-Button
+* Samuel Walladge
+* Peter Rice
+* Ismail S
+* Halfwit
+* David Vogt
+* Claire Cavanaugh
+* rikn00
+* kanikaa1234
+* haitaka
+* Nick Ginther
+* Michał Góral
+* Michael Ilsaas
 * Martin Zimmermann
-* Error 800
+* Jussi Timperi
+* Cosmin Popescu
 * Brian Jackson
+* thuck
 * sbinix
+* rsteube
+* neeasade
+* jnphilipp
+* Tobias Patzl
+* Stefan Tatschner
+* Samuel Loury
+* Peter Michely
+* Panashe M. Fundira
+* Lucas Hoffmann
+* Link
+* Larry Hynes
+* Kirill A. Shutemov
 * Johannes Altmanninger
+* Jeremy Kaplan
+* Ismail
+* Edgar Hipp
+* Daryl Finlay
+* pkill9
+* arza
+* adam
 * Samir Benmendil
 * Regina Hug
 * Mathias Fussenegger
-* Larry Hynes
-* error800
-* Thorsten Wißmann
+* Marcelo Santos
+* Joel Bradshaw
+* Jean-Louis Fuchs
+* Franz Fellner
+* Eric Drechsel
+* zwarag
+* xd1le
+* rmortens
+* oniondreams
+* issue
+* haxwithaxe
+* evan
+* dylan araps
+* addictedtoflames
+* Xitian9
+* Tomas Orsava
+* Tom Janson
+* Tobias Werth
+* Tim Harder
 * Thiago Barroso Perrotta
+* Sorokin Alexei
+* Simon Désaulniers
+* Rok Mandeljc
+* Noah Huesser
+* Moez Bouhlel
 * Matthias Lisin
+* Marcel Schilling
+* Lazlow Carmichael
+* Kevin Wang
+* Ján Kobezda
+* Johannes Martinsson
+* Jean-Christophe Petkovich
+* Jay Kamat
 * Helen Sherwood-Taylor
 * HalosGhost
 * Gregor Pohl
-* Franz Fellner
 * Eivind Uggedal
+* Dietrich Daroch
+* Derek Sivers
+* Daniel Lu
+* Arseniy Seroka
+* Andy Balaam
 * Andreas Fischer
+* Akselmo
 // QUTE_AUTHORS_END
 
 The following people have contributed graphics:
 
-* WOFall (icon)
+* Jad/link:http://yelostudio.com[yelo] (new icon)
+* WOFall (original icon)
 * regines (key binding cheatsheet)
 
-Thanks / Similiar projects
---------------------------
+Thanks / Similar projects
+-------------------------
 
 Many projects with a similar goal as qutebrowser exist:
 
@@ -212,9 +333,10 @@ problems and helpful hints:
 
 Also, thanks to:
 
+* Everyone contributing to the link:doc/backers.asciidoc[crowdfunding].
 * Everyone who had the patience to test qutebrowser before v0.1.
 * Everyone triaging/fixing my bugs in the
-https://bugreports.qt-project.org/secure/Dashboard.jspa[Qt bugtracker]
+https://bugreports.qt.io/secure/Dashboard.jspa[Qt bugtracker]
 * Everyone answering my questions on http://stackoverflow.com/[Stack Overflow]
 and in IRC.
 * All the projects which were a great help while developing qutebrowser.
@@ -234,3 +356,14 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+pdf.js
+------
+
+qutebrowser optionally uses https://github.com/mozilla/pdf.js/[pdf.js] to
+display PDF files in the browser. Windows releases come with a bundled pdf.js.
+
+pdf.js is distributed under the terms of the Apache License. You can
+find a copy of the license in `qutebrowser/3rdparty/pdfjs/LICENSE` (in the
+Windows release or after running `scripts/dev/update_3rdparty.py`), or online
+http://www.apache.org/licenses/LICENSE-2.0.html[here].

codecov.yml

@@ -0,0 +1,9 @@
+status:
+  project:
+    enabled: no
+  patch:
+    enabled: no
+  changes:
+    enabled: no
+
+comment: off

doc/backers.asciidoc

@@ -0,0 +1,172 @@
+Crowdfunding backers
+====================
+
+Mid-2016, qutebrowser did run a http://igg.me/at/qutebrowser[crowdfunding] for
+QtWebEngine support in qutebrowser.
+
+Thanks a lot to the following people who contributed to it:
+
+Gold sponsors
+-------------
+
+- Chris Salzberg
+- Clayton Craft
+- Jean-Louis Fuchs
+- Matthias Lisin
+- 1 Anonymous
+
+Day sponsors
+------------
+
+- Agent 42
+- Iggy Jackson
+- James B
+- Rudi Seitz
+- Tim „Das MooL“ Wegener
+- amd1212
+- gavtroy
+- 4 Anonymous
+
+Other sponsors
+--------------
+
+- AP M
+- Alessandro Balzano
+- Allan Nordhøy
+- Andor Uhlar
+- Andreas Leppert
+- Andreas Saga Romsdal
+- Andrew Rogers / tuxlovesyou
+- André Glüpker
+- Arian Sanusi
+- Arin Lares
+- Assaf Lavie
+- Baptiste Wicht
+- Benjamin Richter
+- Benjamin Schnitzler
+- Bernardo Kuri
+- Boris Kourtoukov
+- Brian Buccola
+- Bruno Oliveira
+- Bryan Gilbert
+- Cassandra Rebecca Ruppen
+- Charles Saternos
+- Chris H
+- Christian Karl
+- Christian Lange
+- Christian Strasser
+- Colin O'Brien
+- Corsin Pfister
+- Cosmin Popescu
+- Daniel Andersson
+- David Wilson
+- Demure Demeanor
+- Doug Stone-Weaver
+- Eero Kari
+- Enric Morales
+- Eric Krohn
+- Eskild Hustvedt
+- Federico Panico
+- Felix Van der Jeugt
+- Francis Tseng
+- Geir Isene
+- George Voronin
+- German Correa
+- Grady Martin
+- Gregor Böhl
+- Guilherme Stein
+- Hannes Doyle
+- Hasan Soydabas
+- Ian Scott
+- Jacob Boldman
+- Jacob Wikmark
+- Jan Verbeek
+- Jarrod Seccombe
+- Joel Bradshaw
+- Johannes Martinsson
+- Jonas Schürmann
+- Josh Medeiros
+- José Alberto Orejuela García
+- Julie Engel
+- Jörg Behrmann
+- Jørgen Skancke
+- Kevin Velghe
+- Konstantin Shmelkov
+- Kyle Frazer
+- Lukas Gierth
+- Mar v Leeuwaarde
+- Marek Roszman
+- Marius Betz
+- Marius Krämer
+- Markus Schmidinger
+- Martin Gabelmann
+- Martin Zimmermann
+- Mathias Fußenegger
+- Maxime Wack
+- Michał Góral
+- Nathan Isom
+- Nathanael Philipp
+- Nils Stål
+- Oliver Hope
+- Oskar Nyberg
+- Pablo Navarro
+- Panashe M. Fundira
+- Patric Schmitz
+- Pete M
+- Peter Smith
+- Phil Collins
+- Philipp Hansch
+- Philipp Kuhnz
+- Raphael Khaiat
+- Raphael Pierzina
+- Renan Guilherme
+- Rick Losie
+- Robert Cross
+- Roy Van Ginneken
+- Rupus Reinefjord
+- Ryan Roden-Corrent
+- Samir Benmendil
+- Simon Giotta
+- Stephen England
+- Sverrir H Steindorsson
+- Tarcisio Fedrizzi
+- Thorsten Wißmann
+- Timon Stampfli
+- Tjelvar Olsson
+- Tomasz Kramkowski
+- Tsukiko Tsutsukakushi
+- Vasilij Schneidermann
+- Vinney Cavallo
+- Wesly Grefrath
+- Will Ware
+- Yousaf Khurshid
+- Zach Schultz
+- averrin
+- ben hengst
+- colin
+- craigtski47
+- dag.robole
+- daniel.m.kao
+- diepfann3
+- eamonn oneil
+- esakaforever
+- francois47
+- glspisso
+- gmccoy4242
+- gtcee3
+- jonathf
+- lapinski.maciej
+- lauri.hakko
+- ljanzen
+- mutilx9
+- nussgipfel
+- oed
+- p p
+- r.c.bruno.andre
+- robert.perce
+- sghctoma
+- targy
+- freelancer
+- pupu
+- regines
+- 37 Anonymous

doc/help/index.asciidoc

@@ -6,12 +6,13 @@ Documentation
 
 The following help pages are currently available:
 
-* link:quickstart.html[Quick start guide]
-* link:FAQ.html[Frequently asked questions]
-* link:CHANGELOG.html[Change Log]
+* link:../quickstart.html[Quick start guide]
+* link:../../FAQ.html[Frequently asked questions]
+* link:../../CHANGELOG.html[Change Log]
 * link:commands.html[Documentation of commands]
 * link:settings.html[Documentation of settings]
-* link:userscripts.html[How to write userscripts]
+* link:../userscripts.html[How to write userscripts]
+* link:../../CONTRIBUTING.html[Contributing to qutebrowser]
 
 Getting help
 ------------

doc/quickstart.asciidoc

@@ -5,18 +5,36 @@ The Compiler <mail@qutebrowser.org>
 NOTE: This page will only appear on the first start. To view it at a later
 time, use the `:help` command.
 
+Basic keybindings to get you started
+------------------------------------
+
+* Use the arrow keys or `hjkl` to move around a webpage (vim-like syntax is used in quite a few places)
+* To go to a new webpage, press `o`, then type a url, then press Enter (Use `O` to open the url in a new tab, `go` to edit the current URL)
+* If what you've typed isn't a url, then a search engine will be used instead (DuckDuckGo, by default)
+* To switch between tabs, use `J` (next tab) and `K` (previous tab), or press `<Alt-num>`, where `num` is the position of the tab to switch to
+* To close the current tab, press `d` (and press `u` to undo closing a tab)
+* Use `H` and `L` to go back and forth in the history
+* To click on something without using the mouse, press `f` to show the hints, then type the keys next to what you want to click on (if that sounds weird, then just try pressing `f` and see what happens)
+* Press `:` to show the commandline
+* To search in a page, press `/`, type the phrase to search for, then press Enter. Use `n` and `N` to go back and forth through the matches, and press Esc to stop doing the search.
+* To close qutebrowser, press `Alt-F4`, or `:q`, or `:wq` to save the currently open tabs and quit (note that in the settings you can make qutebrowser always save the currently open tabs)
+
 What to do now
 --------------
 
-* View the http://qutebrowser.org/img/cheatsheet-big.png[key binding cheatsheet]
+* View the link:http://qutebrowser.org/img/cheatsheet-big.png[key binding cheatsheet]
 to make yourself familiar with the key bindings: +
 image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser key binding cheatsheet",link="http://qutebrowser.org/img/cheatsheet-big.png"]
+* There's also a https://www.shortcutfoo.com/app/dojos/qutebrowser[free training
+  course] on shortcutfoo for the keybindings - note that you need to be in
+  insert mode (i) for it to work.
+* Run `:adblock-update` to download adblock lists and activate adblocking.
 * If you just cloned the repository, you'll need to run
 `scripts/asciidoc2html.py` to generate the documentation.
 * Go to the link:qute://settings[settings page] to set up qutebrowser the way you want it.
 * Subscribe to
-https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[the mailinglist]
-where there are weekly "what's new in qutebrowser" posts.
+https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[the mailinglist] or
+https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[the announce-only mailinglist].
 * Let me know what features you are missing or things that need (even small!)
 improvements.
 

doc/qutebrowser.1.asciidoc

@@ -7,16 +7,16 @@
 :man source: qutebrowser
 :man manual: qutebrowser manpage
 :toc:
-:homepage: http://www.qutebrowser.org/
+:homepage: https://www.qutebrowser.org/
 
 == NAME
-qutebrowser - a keyboard-driven, vim-like browser based on PyQt5 and QtWebKit.
+qutebrowser - a keyboard-driven, vim-like browser based on PyQt5.
 
 == SYNOPSIS
 *qutebrowser* ['-OPTION' ['...']] [':COMMAND' ['...']] ['URL' ['...']]
 
 == DESCRIPTION
-qutebrowser is a keyboard-focused browser with with a minimal GUI. It's based
+qutebrowser is a keyboard-focused browser with a minimal GUI. It's based
 on Python, PyQt5 and QtWebKit and free software, licensed under the GPL.
 
 It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.
@@ -38,8 +38,8 @@ show it.
 *-h*, *--help*::
     show this help message and exit
 
-*-c* 'CONFDIR', *--confdir* 'CONFDIR'::
-    Set config directory (empty for no config storage).
+*--basedir* 'BASEDIR'::
+    Base directory for all storage.
 
 *-V*, *--version*::
     Show version and quit.
@@ -53,8 +53,17 @@ show it.
 *-R*, *--override-restore*::
     Don't restore a session even if one would be restored.
 
+*--target* '{auto,tab,tab-bg,tab-silent,tab-bg-silent,window}'::
+    How URLs should be opened if there is already a qutebrowser instance running.
+
+*--backend* '{webkit,webengine}'::
+    Which backend to use (webengine backend is EXPERIMENTAL!).
+
+*--enable-webengine-inspector*::
+    Enable the web inspector for QtWebEngine. Note that this is a SECURITY RISK and you should not visit untrusted websites with the inspector turned on. See https://bugreports.qt.io/browse/QTBUG-50725 for more details.
+
 === debug arguments
-*-l* 'LOGLEVEL', *--loglevel* 'LOGLEVEL'::
+*-l* '{critical,error,warning,info,debug,vdebug}', *--loglevel* '{critical,error,warning,info,debug,vdebug}'::
     Set loglevel
 
 *--logfilter* 'LOGFILTER'::
@@ -66,9 +75,15 @@ show it.
 *--debug*::
     Turn on debugging options.
 
+*--json-logging*::
+    Output log lines in JSON format (one object per line).
+
 *--nocolor*::
     Turn off colored logging.
 
+*--force-color*::
+    Force colored logging
+
 *--harfbuzz* '{old,new,system,auto}'::
     HarfBuzz engine version to use. Default: auto.
 
@@ -81,29 +96,20 @@ show it.
 *--debug-exit*::
     Turn on debugging of late exit.
 
-*--no-crash-dialog*::
-    Don't show a crash dialog.
-
 *--pdb-postmortem*::
     Drop into pdb on exceptions.
 
-*--qt-name* 'NAME'::
-    Set the window name.
+*--temp-basedir*::
+    Use a temporary basedir.
 
-*--qt-style* 'STYLE'::
-    Set the Qt GUI style to use.
+*--no-err-windows*::
+    Don't show any error windows (used for tests/smoke.py).
 
-*--qt-stylesheet* 'STYLESHEET'::
-    Override the Qt application stylesheet.
+*--qt-arg* 'NAME' 'VALUE'::
+    Pass an argument with a value to Qt. For example, you can do `--qt-arg geometry 650x555+200+300` to set the window geometry.
 
-*--qt-widgetcount*::
-    Print debug message at the end about number of widgets left undestroyed and maximum number of widgets existed at the same time.
-
-*--qt-reverse*::
-    Set the application's layout direction to right-to-left.
-
-*--qt-qmljsdebugger* 'port:PORT[,block]'::
-    Activate the QML/JS debugger with a specified port. 'block' is optional and will make the application wait until a debugger connects to it.
+*--qt-flag* 'QT_FLAG'::
+    Pass an argument to Qt as flag.
 // QUTE_OPTIONS_END
 
 == FILES
@@ -121,7 +127,7 @@ defaults.
 
 == BUGS
 Bugs are tracked in the Github issue tracker at 
-https://github.com/The-Compiler/qutebrowser/issues.
+https://github.com/qutebrowser/qutebrowser/issues.
 
 If you found a bug, use the built-in ':report' command to create a bug report
 with all information needed.
@@ -131,7 +137,7 @@ https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at
 mailto:qutebrowser@lists.qutebrowser.org[] instead.
 
 For security bugs, please contact me directly at me@the-compiler.org, GPG ID
-http://www.the-compiler.org/pubkey.asc[0xFD55A072].
+https://www.the-compiler.org/pubkey.asc[0xFD55A072].
 
 == COPYRIGHT
 This program is free software: you can redistribute it and/or modify it under
@@ -147,12 +153,14 @@ You should have received a copy of the GNU General Public License along with
 this program.  If not, see <http://www.gnu.org/licenses/>.
 
 == RESOURCES
-* Website: http://www.qutebrowser.org/
+* Website: https://www.qutebrowser.org/
 * Mailinglist: mailto:qutebrowser@lists.qutebrowser.org[] /
 https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser
+* Announce-only mailinglist: mailto:qutebrowser-announce@lists.qutebrowser.org[] /
+https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce
 * IRC: irc://irc.freenode.org/#qutebrowser[`#qutebrowser`] on
 http://freenode.net/[Freenode]
-* Github: https://github.com/The-Compiler/qutebrowser
+* Github: https://github.com/qutebrowser/qutebrowser
 
 == AUTHOR
 *qutebrowser* was written by Florian Bruhin. All contributors can be found in

doc/stacktrace.asciidoc

@@ -41,21 +41,8 @@ For Archlinux, no debug informations are provided. You can either compile Qt
 yourself (which will take a few hours even on a modern machine) or use
 debugging symbols compiled/packaged by me (x86_64 only).
 
-.To compile by yourself
-
-----
-$ git clone https://github.com/The-Compiler/qt-debug-pkgbuild.git
-$ cd qt-debug-pkgbuild
-$ git checkout symbols
-$ export DEBUG_CFLAGS='-ggdb3 -fvar-tracking-assignments -Og'
-$ export DEBUG_CXXFLAGS='-ggdb3 -fvar-tracking-assignments -Og'
-$ cd qt5
-$ makepkg -si --pkg qt5-base-debug,qt5-webkit-debug
-$ cd ../pyqt5
-$ makepkg -si --pkg pyqt5-common-debug,python-pyqt5-debug
-----
-
-.To install my pre-built packages
+To install my pre-built packages
+++++++++++++++++++++++++++++++++
 
 First download and sign the key:
 
@@ -76,12 +63,30 @@ Server = http://qutebrowser.org/qt-debug/$arch
 Then install the packages:
 
 ----
-# pacman -Sy pyqt5-common-debug python-pyqt5-debug qt5-base-debug qt5-webkit-debug
+# pacman -Suy pyqt5-common-debug python-pyqt5-debug qt5-base-debug qt5-webkit-debug qt5-webengine-debug
 ----
 
 The `-debug` packages conflict with the non-debug variants - it's safe to
 remove them.
 
+To compile by yourself
+++++++++++++++++++++++
+
+Note that building Qt will likely take multiple hours, even on a recent system.
+I'd also expect it to take around 6 GB of RAM and 30 GB of disk space for a
+successful compile run.
+
+----
+$ git clone https://github.com/qutebrowser/qt-debug-pkgbuild.git
+$ cd qt-debug-pkgbuild
+$ export DEBUG_CFLAGS='-ggdb3 -fvar-tracking-assignments -Og'
+$ export DEBUG_CXXFLAGS='-ggdb3 -fvar-tracking-assignments -Og'
+$ cd qt5
+$ makepkg -si --pkg qt5-base-debug,qt5-webkit-debug,qt5-webengine-debug
+$ cd ../pyqt5
+$ makepkg -si --pkg pyqt5-common-debug,python-pyqt5-debug
+----
+
 Getting the stack trace
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -169,7 +174,7 @@ When you see the _qutebrowser.exe has stopped working_ window, do not click
 file displayed there.
 
 Now install
-http://www.microsoft.com/en-us/download/details.aspx?id=42933[DebugDiag] from
+https://www.microsoft.com/en-us/download/details.aspx?id=49924[DebugDiag] from
 Microsoft, then run the *DebugDiag 2 Analysis* tool. There, check
 *CrashHangAnalysis* and add your crash dump via *Add Data files*. Then click
 *Start analysis*.

doc/userscripts.asciidoc

@@ -5,9 +5,12 @@ The Compiler <mail@qutebrowser.org>
 qutebrowser is extensible by writing userscripts which can be called via the
 `:spawn --userscript` command, or via a key binding.
 
-These userscripts are similiar to the (non-javascript) dwb userscripts. They
-can be written in any language which can read environment variables and write
-to a FIFO. Note they are *not* related to Greasemonkey userscripts.
+You can also call a userscript via hints so they get the selected hint URL by
+calling `:hint links userscript ...`.
+
+These userscripts are similar to the (non-javascript) dwb userscripts. They can
+be written in any language which can read environment variables and write to a
+FIFO. Note they are *not* related to Greasemonkey userscripts.
 
 Note for simple things such as opening the current page with another browser or
 mpv, a simple key binding to something like `:spawn mpv {url}` should suffice.
@@ -15,24 +18,35 @@ mpv, a simple key binding to something like `:spawn mpv {url}` should suffice.
 Also note userscripts need to have the executable bit set (`chmod +x`) for
 qutebrowser to run them.
 
+To call a userscript, it needs to be stored in your data directory under
+`userscripts` (for example: `~/.local/share/qutebrowser/userscripts/myscript`), 
+or just use an absolute path.
+
+NOTE: On Windows, only userscripts with `com`, `bat`, or `exe` extensions will be launched.
+
 Getting information
 -------------------
 
-The following environment variables will be set when an userscript is launched:
+The following environment variables will be set when a userscript is launched:
 
 - `QUTE_MODE`: Either `hints` (started via hints) or `command` (started via
   command or key binding).
 - `QUTE_USER_AGENT`: The currently set user agent.
 - `QUTE_FIFO`: The FIFO or file to write commands to.
-- `QUTE_HTML`: The HTML source of the current page.
-- `QUTE_TEXT`: The plaintext of the current page.
+- `QUTE_HTML`: Path of a file containing the HTML source of the current page.
+- `QUTE_TEXT`: Path of a file containing the plaintext of the current page.
+- `QUTE_CONFIG_DIR`: Path of the directory containing qutebrowser's configuration.
+- `QUTE_DATA_DIR`: Path of the directory containing qutebrowser's data.
+- `QUTE_DOWNLOAD_DIR`: Path of the downloads directory.
+- `QUTE_COMMANDLINE_TEXT`: Text currently in qutebrowser's command line.
 
 In `command` mode:
 
 - `QUTE_URL`: The current URL.
 - `QUTE_TITLE`: The title of the current page.
 - `QUTE_SELECTED_TEXT`: The text currently selected on the page.
-- `QUTE_SELECTED_HTML` The HTML currently selected on the page.
+- `QUTE_SELECTED_HTML` The HTML currently selected on the page (not supported
+  with QtWebEngine).
 
 In `hints` mode:
 

icons/qutebrowser.xpm

@@ -0,0 +1,207 @@
+/* XPM */
+static char *qutebrowser[] = {
+/* columns rows colors chars-per-pixel */
+"32 32 169 2 ",
+"   c #0A396E",
+".  c #0B3C72",
+"X  c #0B4077",
+"o  c #0C437B",
+"O  c #134175",
+"+  c #15467C",
+"@  c #18477B",
+"#  c #1A497D",
+"$  c #0D4B86",
+"%  c #0F4E8D",
+"&  c #124A80",
+"*  c #1F4F83",
+"=  c #0E518C",
+"-  c #1F5084",
+";  c #11508C",
+":  c #0F5193",
+">  c #115799",
+",  c #115B9C",
+"<  c #204F83",
+"1  c #245287",
+"2  c #2A598C",
+"3  c #325E8F",
+"4  c #11609F",
+"5  c #346496",
+"6  c #3B6898",
+"7  c #115CA1",
+"8  c #115EAC",
+"9  c #1263A3",
+"0  c #1260AD",
+"q  c #136BAC",
+"w  c #136BB2",
+"e  c #1366BA",
+"r  c #196BB2",
+"t  c #157ABB",
+"y  c #1577BB",
+"u  c #2E6DB0",
+"i  c #387FB1",
+"p  c #456E9A",
+"a  c #4873A1",
+"s  c #4375AA",
+"d  c #507AA6",
+"f  c #597EA4",
+"g  c #4D7EB3",
+"h  c #156FCB",
+"j  c #167AC5",
+"k  c #1675CA",
+"l  c #177BCE",
+"z  c #1777D8",
+"x  c #1476E4",
+"c  c #167BE6",
+"v  c #167DE8",
+"b  c #197EEF",
+"n  c #1A7FF0",
+"m  c #1A80BE",
+"M  c #5F87AF",
+"N  c #5D8BBA",
+"B  c #5A84B1",
+"V  c #6C8FB3",
+"C  c #6F96BE",
+"Z  c #1886CC",
+"A  c #1883D7",
+"S  c #198DD5",
+"D  c #1987D9",
+"F  c #198ADC",
+"G  c #1A96DC",
+"H  c #3090D9",
+"J  c #1682E9",
+"K  c #1983ED",
+"L  c #1689E9",
+"P  c #1A8DEE",
+"I  c #1B95ED",
+"U  c #1C9EEA",
+"Y  c #1B97E4",
+"T  c #1A84F2",
+"R  c #1A8BF2",
+"E  c #1C94F4",
+"W  c #1D9CF5",
+"Q  c #3388E6",
+"!  c #3D90E9",
+"~  c #228EF3",
+"^  c #229FF6",
+"/  c #3294F4",
+"(  c #3D9FF6",
+")  c #339CF4",
+"_  c #1CA2E5",
+"`  c #1DABEE",
+"'  c #1DA4F6",
+"]  c #1EA9F7",
+"[  c #1EADF8",
+"{  c #1FB4F9",
+"}  c #1FB9FA",
+"|  c #20ACF8",
+" . c #27A4F6",
+".. c #3DA9F6",
+"X. c #20B9FA",
+"o. c #2EB6F9",
+"O. c #458DC9",
+"+. c #5C8DC1",
+"@. c #5795C6",
+"#. c #709DCB",
+"$. c #74A8DD",
+"%. c #4A97EA",
+"&. c #4896EA",
+"*. c #559EEA",
+"=. c #439AF5",
+"-. c #46A3F6",
+";. c #5FA9F6",
+":. c #5EA6F3",
+">. c #47BCF9",
+",. c #51B5F8",
+"<. c #58BDF8",
+"1. c #68ABEF",
+"2. c #7DB9E7",
+"3. c #63AEF7",
+"4. c #6FB1F7",
+"5. c #66B9F8",
+"6. c #61B2F6",
+"7. c #71B4F7",
+"8. c #78B7F4",
+"9. c #72BFF9",
+"0. c #3BC0FA",
+"q. c #6FCEFB",
+"w. c #6CC5FA",
+"e. c #7BCAF9",
+"r. c #89A7C3",
+"t. c #83A2C1",
+"y. c #98B6D3",
+"u. c #9DB9D3",
+"i. c #89B6E4",
+"p. c #83B6E9",
+"a. c #81BDF7",
+"s. c #83BFF8",
+"d. c #9EC4E9",
+"f. c #8CC2F9",
+"g. c #85CDFB",
+"h. c #87C4F9",
+"j. c #92C6F9",
+"k. c #95CAFA",
+"l. c #9CCBFA",
+"z. c #89D7FC",
+"x. c #91D9FC",
+"c. c #9CDEFD",
+"v. c #9ED2FB",
+"b. c #A7CAEC",
+"n. c #B5CEE3",
+"m. c #A1CEFA",
+"M. c #AED0F0",
+"N. c #ACD6FA",
+"B. c #A0DFFC",
+"V. c #AFD8FC",
+"C. c #B5D9FB",
+"Z. c #BCDDFC",
+"A. c #BFDCF5",
+"S. c #ACE3FD",
+"D. c #B5E5FE",
+"F. c #BBE2FC",
+"G. c #CFE5F5",
+"H. c #C3E1FC",
+"J. c #CAE6FD",
+"K. c #CCEBFD",
+"L. c #C4EBFE",
+"P. c #D6EDFE",
+"I. c #DAEEFD",
+"U. c #DEF1FE",
+"Y. c #D6F2FE",
+"T. c #E4F4FE",
+"R. c #E9F6FE",
+"E. c #EBF8FF",
+"W. c None",
+/* pixels */
+"W.W.W.W.W.W.W.W.W.W.W.c.S.L.Y.E.E.S.X.} W.W.W.W.W.W.W.W.W.W.W.W.",
+"W.W.W.W.W.W.W.W.W.D.T.E.E.T.L.D.c.z.} } X.} } W.W.W.W.W.W.W.W.W.",
+"W.W.W.W.W.W.W.B.T.T.R.T.R.U.0.X.z.S.} } } } { { X.W.W.W.W.W.W.W.",
+"W.W.W.W.W.W.x.x.K.T.T.T.L.P.q.o.{ } } ` _ { { { { { W.W.W.W.W.W.",
+"W.W.W.W.W.c.P.D.G.u.r.i 9 Z _ { { G 4 X t { { { { { { W.W.W.W.W.",
+"W.W.W.W.K.U.n.f O             { =       t { { { { [ { { W.W.W.W.",
+"W.W.W.F.I.t..                 '         t { { [ [ [ [ [ >.W.W.W.",
+"W.W.x.P.V                     ' X       t ` [ [ [ [ [ [ o.e.W.W.",
+"W.W.J.y.        X t S Y Z $   ' .       y [ [ [ ] [ [ | Z.J.W.W.",
+"W.<.e.&       , _ ] ] [ ] U . ' .       y [ ' [ ] ] ] w.K.J.g.W.",
+"W.' S       o ' ' [ ' [ ' ] o ' .       y Y 9 = = 9 @.J.J.J.F.W.",
+"W.| ,       j ' ' ' ' ' ' ' o ' .       $             p A.J.J.g.",
+"'  ..       G ' ' ' ' ' ' ' o ' .                       M H.H.h.",
+",.2.      . W ' W ' ' ' ' W . '                         . M.A.x.",
+"N.M..     . W W W ' W W W W  .w           9 I U 0         #.Z.m.",
+" .9.O       D W W W W ' W j $         % F W W W  .5       d Z.C.",
+"W W ;       9 9.h.5...Q %         o j W W W W W W O.      3 C.N.",
+"E W 7         B b.d.a         . w E E W W W E W E A       @ C.l.",
+"I E l                         u W E W E W E E E E A .     - k.6.",
+"P E E 7                       m.o E E E E E E E E l .     = E P ",
+"L E E E >           . O       s.o E E E E E E E E 7       , E L ",
+"W.R E R ) #.5 1 6 N i.2       s.+ E E E E E E R L .       k R W.",
+"W.L R E -.m.m.m.m.m.m.2       m.@ N m.m.s.( R R %       X E J W.",
+"W.W.K R ~ a.m.l.l.l.l.2       s.+ < i.l.m.j.h %         e K W.W.",
+"W.W.J R R / l.l.l.l.k.2       s.+     * 5 +           8 R J W.W.",
+"W.W.W.v T R 3.k.k.j.k.2     2 j.&                 . 8 R v W.W.W.",
+"W.W.W.W.J T ~ 7.j.j.j.g +.p.j.s.+.  .         . : z T v W.W.W.W.",
+"W.W.W.W.W.c T T =.f.j.j.s.j.j.j.j.$.g s u e h b T T v W.W.W.W.W.",
+"W.W.W.W.W.W.c b n 4.f.f.s.m.s.s.s.j.s.j./ T n T b c W.W.W.W.W.W.",
+"W.W.W.W.W.W.W.c x 1.s.s.s.s.s.s.s.s.4.=.n T n c c W.W.W.W.W.W.W.",
+"W.W.W.W.W.W.W.W.W.&.*.1.a.s.s.s.s.3.n n v x x W.W.W.W.W.W.W.W.W.",
+"W.W.W.W.W.W.W.W.W.W.W.%.%.%.%.*.*.Q x x x W.W.W.W.W.W.W.W.W.W.W."
+};

misc/apparmor/usr.bin.qutebrowser

@@ -29,6 +29,8 @@ profile qutebrowser /usr/{local/,}bin/qutebrowser {
 
     /proc/*/mounts r,
     owner /tmp/** rwkl,
+    owner /run/user/*/ rw,
+    owner /run/user/*/** krw,
 
     @{HOME}/.config/qutebrowser/** krw,
     @{HOME}/.local/share/qutebrowser/** krw,

misc/qt_menu.nib/README

@@ -1,7 +0,0 @@
-These files are copied from Qt's source tree in
-src/plugins/platforms/cocoa/qt_menu.nib at revision
-b8246f08e49eb672974fd3d3d972a5ff13c1524d.
-
-http://code.qt.io/cgit/qt/qtbase.git/tree/src/plugins/platforms/cocoa/qt_menu.nib
-
-They are needed for cx_Freeze and don't seem to be bundled with Qt anymore.

misc/qt_menu.nib/classes.nib

@@ -1,59 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>IBClasses</key>
-	<array>
-		<dict>
-			<key>ACTIONS</key>
-			<dict>
-				<key>hide</key>
-				<string>id</string>
-				<key>hideOtherApplications</key>
-				<string>id</string>
-				<key>orderFrontStandardAboutPanel</key>
-				<string>id</string>
-                <key>qtDispatcherToQPAMenuItem</key>
-				<string>id</string>
-				<key>terminate</key>
-				<string>id</string>
-				<key>unhideAllApplications</key>
-				<string>id</string>
-			</dict>
-			<key>CLASS</key>
-			<string>QCocoaMenuLoader</string>
-			<key>LANGUAGE</key>
-			<string>ObjC</string>
-			<key>OUTLETS</key>
-			<dict>
-				<key>aboutItem</key>
-				<string>NSMenuItem</string>
-				<key>aboutQtItem</key>
-				<string>NSMenuItem</string>
-				<key>appMenu</key>
-				<string>NSMenu</string>
-				<key>hideItem</key>
-				<string>NSMenuItem</string>
-				<key>preferencesItem</key>
-				<string>NSMenuItem</string>
-				<key>quitItem</key>
-				<string>NSMenuItem</string>
-				<key>theMenu</key>
-				<string>NSMenu</string>
-			</dict>
-			<key>SUPERCLASS</key>
-			<string>NSResponder</string>
-		</dict>
-		<dict>
-			<key>CLASS</key>
-			<string>FirstResponder</string>
-			<key>LANGUAGE</key>
-			<string>ObjC</string>
-			<key>SUPERCLASS</key>
-			<string>NSObject</string>
-		</dict>
-	</array>
-	<key>IBVersion</key>
-	<string>1</string>
-</dict>
-</plist>

misc/qt_menu.nib/info.nib

@@ -1,18 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>IBFramework Version</key>
-	<string>672</string>
-	<key>IBOldestOS</key>
-	<integer>5</integer>
-	<key>IBOpenObjects</key>
-	<array>
-		<integer>57</integer>
-	</array>
-	<key>IBSystem Version</key>
-	<string>9L31a</string>
-	<key>targetFramework</key>
-	<string>IBCocoaFramework</string>
-</dict>
-</plist>

misc/qutebrowser.spec

@@ -0,0 +1,78 @@
+# -*- mode: python -*-
+
+import sys
+import os
+
+sys.path.insert(0, os.getcwd())
+from scripts import setupcommon
+
+block_cipher = None
+
+
+def get_data_files():
+    data_files = [
+        ('../qutebrowser/html', 'html'),
+        ('../qutebrowser/img', 'img'),
+        ('../qutebrowser/javascript', 'javascript'),
+        ('../qutebrowser/html/doc', 'html/doc'),
+        ('../qutebrowser/git-commit-id', '')
+    ]
+
+    if os.path.exists(os.path.join('qutebrowser', '3rdparty', 'pdfjs')):
+        data_files.append(('../qutebrowser/3rdparty/pdfjs', '3rdparty/pdfjs'))
+    else:
+        print("Warning: excluding pdfjs as it's not present!")
+
+    return data_files
+
+
+setupcommon.write_git_file()
+
+
+if os.name == 'nt':
+    icon = 'icons/qutebrowser.ico'
+elif sys.platform == 'darwin':
+    icon = 'icons/qutebrowser.icns'
+else:
+    icon = None
+
+
+a = Analysis(['../qutebrowser/__main__.py'],
+             pathex=['misc'],
+             binaries=None,
+             datas=get_data_files(),
+             hiddenimports=[],
+             hookspath=[],
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher)
+pyz = PYZ(a.pure, a.zipped_data,
+             cipher=block_cipher)
+exe = EXE(pyz,
+          a.scripts,
+          exclude_binaries=True,
+          name='qutebrowser',
+          icon=icon,
+          debug=False,
+          strip=False,
+          upx=True,
+          console=False )
+coll = COLLECT(exe,
+               a.binaries,
+               a.zipfiles,
+               a.datas,
+               strip=False,
+               upx=True,
+               name='qutebrowser')
+
+app = BUNDLE(coll,
+             name='qutebrowser.app',
+             icon=icon,
+             info_plist={
+                 'NSHighResolutionCapable': 'True',
+                 'NSSupportsAutomaticGraphicsSwitching': 'True',
+             },
+             # https://github.com/pyinstaller/pyinstaller/blob/b78bfe530cdc2904f65ce098bdf2de08c9037abb/PyInstaller/hooks/hook-PyQt5.QtWebEngineWidgets.py#L24
+             bundle_identifier='org.qt-project.Qt.QtWebEngineCore')

misc/requirements/README.md

@@ -0,0 +1,20 @@
+This directory contains various `requirements` files which are used by `tox` to
+have reproducable tests with pinned versions.
+
+The files are generated based on unpinned requirements in `*.txt-raw` files.
+
+Those files can also contain some special commands:
+
+- Add an additional comment to a line: `#@ comment: <package> <comment here>`
+- Filter a line for requirements.io: `#@ filter: <package> <filter>`
+- Don't include a package in the output: `#@ ignore: <package>` (or multiple packages)
+- Replace a part of a frozen package specification with another: `#@ replace <regex> <replacement>`
+
+Some examples:
+
+```
+#@ comment: mypkg blah blub
+#@ filter: mypkg != 1.0.0
+#@ ignore: mypkg, otherpkg
+#@ replace: foo bar
+```

misc/requirements/requirements-check-manifest.txt

@@ -0,0 +1,3 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+check-manifest==0.35

misc/requirements/requirements-check-manifest.txt-raw

@@ -0,0 +1 @@
+check-manifest

misc/requirements/requirements-codecov.txt

@@ -0,0 +1,5 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+codecov==2.0.5
+coverage==4.3.4
+requests==2.13.0

misc/requirements/requirements-codecov.txt-raw

@@ -0,0 +1 @@
+codecov

misc/requirements/requirements-cxfreeze.txt

@@ -0,0 +1,3 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+cx-Freeze==4.3.4  # rq.filter: < 5.0.0

misc/requirements/requirements-cxfreeze.txt-raw

@@ -0,0 +1,5 @@
+cx-Freeze < 5.0.0
+
+# We'll probably switch to PyInstaller soon, and 5.x doesn't install without a
+# compiler?
+#@ filter: cx-Freeze < 5.0.0

misc/requirements/requirements-flake8.txt

@@ -0,0 +1,20 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+flake8==2.6.2  # rq.filter: < 3.0.0
+flake8-copyright==0.2.0
+flake8-debugger==1.4.0  # rq.filter: != 2.0.0
+flake8-deprecated==1.1
+flake8-docstrings==1.0.3
+flake8-future-import==0.4.3
+flake8-mock==0.3
+flake8-pep3101==1.0
+flake8-polyfill==1.0.1
+flake8-putty==0.4.0
+flake8-string-format==0.2.3
+flake8-tidy-imports==1.0.5
+flake8-tuple==0.2.12
+mccabe==0.6.1
+pep8-naming==0.4.1
+pycodestyle==2.3.1
+pydocstyle==1.1.1
+pyflakes==1.5.0

misc/requirements/requirements-flake8.txt-raw

@@ -0,0 +1,26 @@
+flake8<3.0.0
+flake8-copyright
+flake8-debugger!=2.0.0
+flake8-deprecated
+flake8-docstrings
+flake8-future-import
+flake8-mock
+flake8-pep3101
+flake8-putty
+flake8-string-format
+flake8-tidy-imports
+flake8-tuple
+pep8-naming
+pydocstyle
+pyflakes
+
+# Pinned to 2.0.0 otherwise
+pycodestyle==2.3.1
+# Pinned to 0.5.3 otherwise
+mccabe==0.6.1
+
+# Waiting until flake8-putty updated
+#@ filter: flake8 < 3.0.0
+
+# https://github.com/JBKahn/flake8-debugger/issues/5
+#@ filter: flake8-debugger != 2.0.0

misc/requirements/requirements-pip.txt

@@ -0,0 +1,8 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+appdirs==1.4.2
+packaging==16.8
+pyparsing==2.1.10
+setuptools==34.3.0
+six==1.10.0
+wheel==0.29.0

misc/requirements/requirements-pyinstaller.txt

@@ -0,0 +1,5 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+-e git+https://github.com/pyinstaller/pyinstaller.git@develop#egg=PyInstaller
+PyQt5==5.8
+sip==4.19.1

misc/requirements/requirements-pyinstaller.txt-raw

@@ -0,0 +1,5 @@
+-e git+https://github.com/pyinstaller/pyinstaller.git@develop#egg=PyInstaller
+PyQt5
+
+# remove @commit-id for scm installs
+#@ replace: @.*# @develop#

misc/requirements/requirements-pylint-master.txt

@@ -0,0 +1,11 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+-e git+https://github.com/PyCQA/astroid.git#egg=astroid
+editdistance==0.3.1
+isort==4.2.5
+lazy-object-proxy==1.2.2
+mccabe==0.6.1
+-e git+https://github.com/PyCQA/pylint.git#egg=pylint
+./scripts/dev/pylint_checkers
+requests==2.13.0
+wrapt==1.10.8

misc/requirements/requirements-pylint-master.txt-raw

@@ -0,0 +1,10 @@
+-e git+https://github.com/PyCQA/astroid.git#egg=astroid
+-e git+https://github.com/PyCQA/pylint.git#egg=pylint
+./scripts/dev/pylint_checkers
+requests
+
+# remove @commit-id for scm installs
+#@ replace: @.*# #
+
+# fix qute-pylint location
+#@ replace: qute-pylint==.* ./scripts/dev/pylint_checkers

misc/requirements/requirements-pylint.txt

@@ -0,0 +1,13 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+astroid==1.4.9
+github3.py==0.9.6
+isort==4.2.5
+lazy-object-proxy==1.2.2
+mccabe==0.6.1
+pylint==1.6.5
+./scripts/dev/pylint_checkers
+requests==2.13.0
+uritemplate==3.0.0
+uritemplate.py==3.0.2
+wrapt==1.10.8

misc/requirements/requirements-pylint.txt-raw

@@ -0,0 +1,7 @@
+pylint
+./scripts/dev/pylint_checkers
+requests
+github3.py
+
+# fix qute-pylint location
+#@ replace: qute-pylint==.* ./scripts/dev/pylint_checkers

misc/requirements/requirements-pyroma.txt

@@ -0,0 +1,4 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+docutils==0.13.1
+pyroma==2.2

misc/requirements/requirements-pyroma.txt-raw

@@ -0,0 +1 @@
+pyroma

misc/requirements/requirements-qutebrowser.txt-raw

@@ -0,0 +1,6 @@
+Jinja2
+Pygments
+pyPEG2
+PyYAML
+colorama
+cssutils

misc/requirements/requirements-tests-git.txt

@@ -0,0 +1,49 @@
+bzr+lp:beautifulsoup
+git+https://github.com/cherrypy/cheroot.git
+hg+https://bitbucket.org/ned/coveragepy
+git+https://github.com/micheles/decorator.git
+git+https://github.com/pallets/flask.git
+git+https://github.com/miracle2k/python-glob2.git
+git+https://github.com/Runscope/httpbin.git
+git+https://github.com/HypothesisWorks/hypothesis-python.git
+git+https://github.com/pallets/itsdangerous.git
+git+https://bitbucket.org/zzzeek/mako.git
+git+https://github.com/r1chardj0n3s/parse.git
+git+https://github.com/jenisys/parse_type.git
+hg+https://bitbucket.org/pytest-dev/py
+git+https://github.com/pytest-dev/pytest.git@features
+git+https://github.com/pytest-dev/pytest-bdd.git
+
+# This is broken at the moment because logfail tries to access
+# LogCaptureHandler
+# git+https://github.com/eisensheng/pytest-catchlog.git
+pytest-catchlog==1.2.2
+
+git+https://github.com/pytest-dev/pytest-cov.git
+git+https://github.com/pytest-dev/pytest-faulthandler.git
+git+https://github.com/pytest-dev/pytest-instafail.git
+git+https://github.com/pytest-dev/pytest-mock.git
+git+https://github.com/pytest-dev/pytest-qt.git
+git+https://github.com/pytest-dev/pytest-repeat.git
+git+https://github.com/pytest-dev/pytest-rerunfailures.git
+git+https://github.com/abusalimov/pytest-travis-fold.git
+git+https://github.com/fschulze/pytest-warnings.git
+git+https://github.com/The-Compiler/pytest-xvfb.git
+hg+https://bitbucket.org/gutworth/six
+hg+https://bitbucket.org/jendrikseipp/vulture
+git+https://github.com/pallets/werkzeug.git
+
+
+## qutebrowser dependencies
+
+git+https://github.com/tartley/colorama.git
+hg+https://bitbucket.org/cthedot/cssutils
+git+https://github.com/pallets/jinja.git
+git+https://github.com/pallets/markupsafe.git
+hg+http://bitbucket.org/birkenfeld/pygments-main
+hg+https://bitbucket.org/fdik/pypeg
+
+# Fails to build:
+# gcc: error: ext/_yaml.c: No such file or directory
+# hg+https://bitbucket.org/xi/pyyaml
+PyYAML==3.12

misc/requirements/requirements-tests.txt

@@ -0,0 +1,36 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+beautifulsoup4==4.5.3
+cheroot==5.1.0
+click==6.7
+coverage==4.3.4
+decorator==4.0.11
+EasyProcess==0.2.3
+Flask==0.12
+glob2==0.5
+httpbin==0.5.0
+hypothesis==3.6.1
+itsdangerous==0.24
+# Jinja2==2.9.5
+Mako==1.0.6
+# MarkupSafe==0.23
+parse==1.6.6
+parse-type==0.3.4
+py==1.4.32
+pytest==3.0.6
+pytest-bdd==2.18.1
+pytest-benchmark==3.0.0
+pytest-catchlog==1.2.2
+pytest-cov==2.4.0
+pytest-faulthandler==1.3.1
+pytest-instafail==0.3.0
+pytest-mock==1.5.0
+pytest-qt==2.1.0
+pytest-repeat==0.4.1
+pytest-rerunfailures==2.1.0
+pytest-travis-fold==1.2.0
+pytest-warnings==0.2.0
+pytest-xvfb==1.0.0
+PyVirtualDisplay==0.2.1
+vulture==0.12
+Werkzeug==0.11.15

misc/requirements/requirements-tests.txt-raw

@@ -0,0 +1,23 @@
+beautifulsoup4
+cheroot
+coverage
+Flask
+httpbin
+hypothesis
+pytest
+pytest-bdd
+pytest-benchmark
+pytest-catchlog
+pytest-cov
+pytest-faulthandler
+pytest-instafail
+pytest-mock
+pytest-qt
+pytest-repeat
+pytest-rerunfailures
+pytest-travis-fold
+pytest-warnings
+pytest-xvfb
+vulture
+
+#@ ignore: Jinja2, MarkupSafe

misc/requirements/requirements-tox.txt

@@ -0,0 +1,6 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+pluggy==0.4.0
+py==1.4.32
+tox==2.6.0
+virtualenv==15.1.0

misc/requirements/requirements-tox.txt-raw

@@ -0,0 +1,4 @@
+tox
+
+# The latest tox release still depends on pluggy < 0.4...
+pluggy==0.4.0

misc/requirements/requirements-vulture.txt

@@ -0,0 +1,3 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+vulture==0.12

misc/requirements/requirements-vulture.txt-raw

@@ -0,0 +1 @@
+vulture

misc/userscripts/cast

@@ -0,0 +1,150 @@
+#!/usr/bin/env bash
+#
+# Behaviour
+#   Userscript for qutebrowser which casts the url passed in $1 to the default
+#   ChromeCast device in the network using the program `castnow`
+#
+# Usage
+#   You can launch the script from qutebrowser as follows:
+#       spawn --userscript ${PATH_TO_FILE} {url}
+#
+#   Then, you can control the chromecast by launching the simple command
+#   `castnow` in a shell which will connect to the running castnow instance.
+#
+#   For stopping the script, issue the command `pkill -f castnow` which would
+#   then let the rest of the userscript execute for cleaning temporary file.
+#
+# Thanks
+#   This userscript borrows Thorsten Wißmann's javascript code from his `mpv`
+#   userscript.
+#
+# Dependencies
+#   - castnow, https://github.com/xat/castnow
+#
+# Author
+#   Simon Désaulniers <sim.desaulniers@gmail.com>
+
+if [ -z "$QUTE_FIFO" ] ; then
+    cat 1>&2 <<EOF
+Error: $0 can not be run as a standalone script.
+
+It is a qutebrowser userscript. In order to use it, call it using
+'spawn --userscript' as described in qute://help/userscripts.html
+EOF
+    exit 1
+fi
+
+msg() {
+    local cmd="$1"
+    shift
+    local msg="$*"
+    if [ -z "$QUTE_FIFO" ] ; then
+        echo "$cmd: $msg" >&2
+    else
+        echo "message-$cmd '${msg//\'/\\\'}'" >> "$QUTE_FIFO"
+    fi
+}
+
+js() {
+cat <<EOF
+
+    function descendantOfTagName(child, ancestorTagName) {
+        // tells whether child has some (proper) ancestor
+        // with the tag name ancestorTagName
+        while (child.parentNode != null) {
+            child = child.parentNode;
+            if (typeof child.tagName === 'undefined') break;
+            if (child.tagName.toUpperCase() == ancestorTagName.toUpperCase()) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    var App = {};
+
+    var all_videos = [];
+    all_videos.push.apply(all_videos, document.getElementsByTagName("video"));
+    all_videos.push.apply(all_videos, document.getElementsByTagName("object"));
+    all_videos.push.apply(all_videos, document.getElementsByTagName("embed"));
+    App.backup_videos = Array();
+    App.all_replacements = Array();
+    for (i = 0; i < all_videos.length; i++) {
+        var video = all_videos[i];
+        if (descendantOfTagName(video, "object")) {
+            // skip tags that are contained in an object, because we hide
+            // the object anyway.
+            continue;
+        }
+        var replacement = document.createElement("div");
+        replacement.innerHTML = "
+            <p style=\\"margin-bottom: 0.5em\\">
+            The video is being cast on your ChromeCast device.
+            </p>
+            <p>
+            In order to restore this particular video
+            <a style=\\"font-weight: bold;
+                        color: white;
+                        background: transparent;
+                     \\"
+               onClick=\\"restore_video(this, " + i + ");\\"
+               href=\\"javascript: restore_video(this, " + i + ")\\"
+              >click here</a>.
+            </p>
+        ";
+        replacement.style.position = "relative";
+        replacement.style.zIndex = "100003000000";
+        replacement.style.fontSize = "1rem";
+        replacement.style.textAlign = "center";
+        replacement.style.verticalAlign = "middle";
+        replacement.style.height = "100%";
+        replacement.style.background = "#101010";
+        replacement.style.color = "white";
+        replacement.style.border = "4px dashed #545454";
+        replacement.style.padding = "2em";
+        replacement.style.margin = "auto";
+        App.all_replacements[i] = replacement;
+        App.backup_videos[i] = video;
+        video.parentNode.replaceChild(replacement, video);
+    }
+
+    function restore_video(obj, index) {
+        obj = App.all_replacements[index];
+        video = App.backup_videos[index];
+        console.log(video);
+        obj.parentNode.replaceChild(video, obj);
+    }
+
+    /** force repainting the video, thanks to:
+     * http://martinwolf.org/2014/06/10/force-repaint-of-an-element-with-javascript/
+     */
+    var siteHeader = document.getElementById('header');
+    siteHeader.style.display='none';
+    siteHeader.offsetHeight; // no need to store this anywhere, the reference is enough
+    siteHeader.style.display='block';
+
+EOF
+}
+
+printjs() {
+    js | sed 's,//.*$,,' | tr '\n' ' '
+}
+echo "jseval -q $(printjs)" >> "$QUTE_FIFO"
+
+tmpdir=$(mktemp -d)
+file_to_cast=${tmpdir}/qutecast
+
+# kill any running instance of castnow
+pkill -f /usr/bin/castnow
+
+# start youtube download in stream mode (-o -) into temporary file
+youtube-dl -qo - "$1" > ${file_to_cast} &
+ytdl_pid=$!
+
+msg info "Casting $1" >> "$QUTE_FIFO"
+# start castnow in stream mode to cast on ChromeCast
+tail -F "${file_to_cast}" | castnow -
+
+# cleanup remaining background process and file on disk
+kill ${ytdl_pid}
+rm -rf ${tmpdir}

misc/userscripts/dmenu_qutebrowser

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+# Copyright 2015 Zach-Button <zachrey.button@gmail.com>
+#
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+# Pipes history, quickmarks, and URL into dmenu.
+#
+# If run from qutebrowser as a userscript, it runs :open on the URL
+# If not, it opens a new qutebrowser window at the URL
+#
+# Ideal for use with tabs-are-windows. Set a hotkey to launch this script, then:
+#	:bind o spawn --userscript dmenu_qutebrowser
+#
+# Use the hotkey to open in new tab/window, press 'o' to open URL in current tab/window
+# You can simulate "go" by pressing "o<tab>", as the current URL is always first in the list
+#
+# I personally use "<Mod4>o" to launch this script. For me, my workflow is:
+#	Default	keys		Keys with this script
+#	O			<Mod4>o
+#	o			o
+#	go			o<Tab>
+#	gO			gC, then o<Tab>
+#				(This is unnecessarily long. I use this rarely, feel free to make this script accept parameters.)
+#
+
+[ -z "$QUTE_URL" ] && QUTE_URL='http://google.com'
+
+url=$(echo "$QUTE_URL" | cat - "$QUTE_CONFIG_DIR/quickmarks" "$QUTE_DATA_DIR/history" | dmenu -l 15 -p qutebrowser)
+url=$(echo "$url" | sed -E 's/[^ ]+ +//g' | egrep "https?:" || echo "$url")
+
+[ -z "${url// }" ] && exit
+
+echo "open $url" >> "$QUTE_FIFO" || qutebrowser "$url"

misc/userscripts/open_download

@@ -0,0 +1,114 @@
+#!/usr/bin/env bash
+# Both standalone script and qutebrowser userscript that opens a rofi menu with
+# all files from the download director and opens the selected file. It works
+# both as a userscript and a standalone script that is called from outside of
+# qutebrowser.
+#
+# Suggested keybinding (for "show downloads"):
+# spawn --userscript ~/.config/qutebrowser/open_download
+#     sd
+#
+# Requirements:
+#  - rofi (in a recent version)
+#  - xdg-open and xdg-mime
+#  - You should configure qutebrowser to download files to a single directory
+#  - It comes in handy if you enable remove-finished-downloads. If you want to
+#    see the recent downloads, just press "sd".
+#
+# Thorsten Wißmann, 2015 (thorsten` on freenode)
+# Any feedback is welcome!
+
+set -e
+
+# open a file from the download directory using rofi
+DOWNLOAD_DIR=${DOWNLOAD_DIR:-$QUTE_DOWNLOAD_DIR}
+DOWNLOAD_DIR=${DOWNLOAD_DIR:-$HOME/Downloads}
+# the name of the rofi command
+ROFI_CMD=${ROFI_CMD:-rofi}
+ROFI_ARGS=${ROFI_ARGS:-}
+
+msg() {
+    local cmd="$1"
+    shift
+    local msg="$*"
+    if [ -z "$QUTE_FIFO" ] ; then
+        echo "$cmd: $msg" >&2
+    else
+        echo "message-$cmd '${msg//\'/\\\'}'" >> "$QUTE_FIFO"
+    fi
+}
+die() {
+    msg error "$*"
+    if [ -n "$QUTE_FIFO" ] ; then
+        # when run as a userscript, the above error message already informs the
+        # user about the failure, and no additional "userscript exited with status
+        # 1" is needed.
+        exit 0;
+    else
+        exit 1;
+    fi
+}
+
+if ! [ -d "$DOWNLOAD_DIR" ] ; then
+    die "Download directory »$DOWNLOAD_DIR« not found!"
+fi
+if ! which "${ROFI_CMD}" > /dev/null ; then
+    die "Rofi command »${ROFI_CMD}« not found in PATH!"
+fi
+
+rofi_default_args=(
+        -monitor -2 # place above window
+        -location 6 # aligned at the bottom
+        -width 100  # use full window width
+        -i
+        -no-custom
+        -format i   # make rofi return the index
+        -l 10
+        -p 'Open download:' -dmenu
+    )
+
+crop-first-column() {
+    local maxlength=${1:-40}
+    local expression='s|^\([^\t]\{0,'"$maxlength"'\}\)[^\t]*\t|\1\t|'
+    sed "$expression"
+}
+
+ls-files() {
+    # add the slash at the end of the download dir enforces to follow the
+    # symlink, if the DOWNLOAD_DIR itself is a symlink
+    ls -Q --quoting-style escape    -h  -o -1 -A -t "${DOWNLOAD_DIR}/" \
+        | grep '^[-]' \
+        | cut -d' ' -f3- \
+        | sed 's,^\(.*[^\]\) \(.*\)$,\2\t\1,' \
+        | sed 's,\\\(.\),\1,g'
+}
+
+mapfile -t entries < <(ls-files)
+
+# we need to manually check that there are items, because rofi doesn't show up
+# if there are no items and -no-custom is passed to rofi.
+if [ "${#entries[@]}" -eq 0 ] ; then
+    die "Download directory »${DOWNLOAD_DIR}« empty"
+fi
+
+line=$(printf "%s\n" "${entries[@]}"  \
+       | crop-first-column 55 \
+       | column -s $'\t' -t \
+       | $ROFI_CMD "${rofi_default_args[@]}" $ROFI_ARGS) || true
+if [ -z "$line" ];  then
+    exit 0
+fi
+
+file="${entries[$line]}"
+file="${file%%$'\t'*}"
+path="$DOWNLOAD_DIR/$file"
+filetype=$(xdg-mime query filetype "$path")
+application=$(xdg-mime query default "$filetype")
+
+if [ -z "$application" ] ; then
+    die "Do not know how to open »$file« of type $filetype"
+fi
+
+msg info "Opening »$file« (of type $filetype) with ${application%.desktop}"
+
+xdg-open "$path" &

misc/userscripts/openfeeds

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2015 jnphilipp <me@jnphilipp.org>
+#
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+# Opens all links to feeds defined in the head of a site
+#
+# Ideal for use with tabs-are-windows. Set a hotkey to launch this script, then:
+#   :bind gF spawn --userscript openfeeds
+#
+# Use the hotkey to open the feeds in new tab/window, press 'gF' to open
+#
+
+import os
+import re
+
+from bs4 import BeautifulSoup
+from urllib.parse import urljoin
+
+with open(os.environ['QUTE_HTML'], 'r') as f:
+    soup = BeautifulSoup(f)
+with open(os.environ['QUTE_FIFO'], 'w') as f:
+    for link in soup.find_all('link', rel='alternate', type=re.compile(r'application/((rss|rdf|atom)\+)?xml|text/xml')):
+        f.write('open -t %s\n' % urljoin(os.environ['QUTE_URL'], link.get('href')))

misc/userscripts/password_fill

@@ -0,0 +1,369 @@
+#!/usr/bin/env bash
+help() {
+    blink=$'\e[1;31m' reset=$'\e[0m'
+cat <<EOF
+This script can only be used as a userscript for qutebrowser
+2015, Thorsten Wißmann <edu _at_ thorsten-wissmann _dot_ de>
+In case of questions or suggestions, do not hesitate to send me an E-Mail or to
+directly ask me via IRC (nickname thorsten\`) in #qutebrowser on freenode.
+
+  $blink!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!$reset
+  WARNING: the passwords are stored in qutebrowser's
+           debug log reachable via the url qute:log
+  $blink!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!$reset
+
+Usage: run as a userscript form qutebrowser, e.g.:
+  spawn --userscript ~/.config/qutebrowser/password_fill
+
+Pass backend: (see also passwordstore.org)
+  This script expects pass to store the credentials of each page in an extra
+  file, where the filename (or filepath) contains the domain of the respective
+  page. The first line of the file must contain the password, the login name
+  must be contained in a later line beginning with "user:", "login:", or
+  "username:" (configurable by the user_pattern variable).
+
+Behavior:
+  It will try to find a username/password entry in the configured backend
+  (currently only pass) for the current website and will load that pair of
+  username and password to any form on the current page that has some password
+  entry field. If multiple entries are found, a zenity menu is offered.
+
+  If no entry is found, then it crops subdomains from the url if at least one
+  entry is found in the backend. (In that case, it always shows a menu)
+
+Configuration:
+  This script loads the bash script ~/.config/qutebrowser/password_fill_rc (if
+  it exists), so you can change any configuration variable and overwrite any
+  function you like.
+
+EOF
+}
+
+set -o errexit
+set -o pipefail
+shopt -s nocasematch # make regexp matching in bash case insensitive
+
+if [ -z "$QUTE_FIFO" ] ; then
+    help
+    exit
+fi
+
+error() {
+    local msg="$*"
+    echo "message-error '${msg//\'/\\\'}'" >> "$QUTE_FIFO"
+}
+msg() {
+    local msg="$*"
+    echo "message-info '${msg//\'/\\\'}'" >> "$QUTE_FIFO"
+}
+die() {
+    error "$*"
+    exit 0
+}
+
+javascript_escape() {
+    # print the first argument in an escaped way, such that it can safely
+    # be used within javascripts double quotes
+    sed "s,[\\\'\"],\\\&,g" <<< "$1"
+}
+
+# ======================================================= #
+# CONFIGURATION
+# ======================================================= #
+# The configuration file is per default located in
+# ~/.config/qutebrowser/password_fill_rc and is a bash script that is loaded
+# later in the present script. So basically you can replace all of the
+# following definitions and make them fit your needs.
+
+# The following simplifies a URL to the domain (e.g. "wiki.qutebrowser.org")
+# which is later used to search the correct entries in the password backend. If
+# you e.g. don't want the "www." to be removed or if you want to distinguish
+# between different paths on the same domain.
+
+simplify_url() {
+    simple_url="${1##*://}" # remove protocol specification
+    simple_url="${simple_url%%\?*}" # remove GET parameters
+    simple_url="${simple_url%%/*}" # remove directory path
+    simple_url="${simple_url%:*}" # remove port
+    simple_url="${simple_url##www.}" # remove www. subdomain
+}
+
+# no_entries_found() is called if the first query_entries() call did not find
+# any matching entries. Multiple implementations are possible:
+# The easiest behavior is to quit:
+#no_entries_found() {
+#    if [ 0 -eq "${#files[@]}" ] ; then
+#        die "No entry found for »$simple_url«"
+#    fi
+#}
+# But you could also fill the files array with all entries from your pass db
+# if the first db query did not find anything
+# no_entries_found() {
+#     if [ 0 -eq "${#files[@]}" ] ; then
+#         query_entries ""
+#         if [ 0 -eq "${#files[@]}" ] ; then
+#             die "No entry found for »$simple_url«"
+#         fi
+#     fi
+# }
+
+# Another behavior is to drop another level of subdomains until search hits
+# are found:
+no_entries_found() {
+    while [ 0 -eq "${#files[@]}" ] && [ -n "$simple_url" ]; do
+        shorter_simple_url=$(sed 's,^[^.]*\.,,' <<< "$simple_url")
+        if [ "$shorter_simple_url" = "$simple_url" ] ; then
+            # if no dot, then even remove the top level domain
+            simple_url=""
+            query_entries "$simple_url"
+            break
+        fi
+        simple_url="$shorter_simple_url"
+        query_entries "$simple_url"
+        #die "No entry found for »$simple_url«"
+        # enforce menu if we do "fuzzy" matching
+        menu_if_one_entry=1
+    done
+    if [ 0 -eq "${#files[@]}" ] ; then
+        die "No entry found for »$simple_url«"
+    fi
+}
+
+# Backend implementations tell, how the actual password store is accessed.
+# Right now, there is only one fully functional password backend, namely for
+# the program "pass".
+# A password backend consists of three actions:
+#  - init() initializes backend-specific things and does sanity checks.
+#  - query_entries() is called with a simplified url and is expected to fill
+#    the bash array $files with the names of matching password entries. There
+#    are no requirements how these names should look like.
+#  - open_entry() is called with some specific entry of the $files array and is
+#    expected to write the username of that entry to the $username variable and
+#    the corresponding password to $password
+
+reset_backend() {
+    init() { true ; }
+    query_entries() { true ; }
+    open_entry() { true ; }
+}
+
+# choose_entry() is expected to choose one entry from the array $files and
+# write it to the variable $file.
+choose_entry() {
+    choose_entry_zenity
+}
+
+# The default implementation chooses a random entry from the array. So if there
+# are multiple matching entries, multiple calls to this userscript will
+# eventually pick the "correct" entry. I.e. if this userscript is bound to
+# "zl", the user has to press "zl" until the correct username shows up in the
+# login form.
+choose_entry_random() {
+    local nr=${#files[@]}
+    file="${files[$((RANDOM % nr))]}"
+    # Warn user, that there might be other matching password entries
+    if [ "$nr" -gt 1 ] ; then
+        msg "Picked $file out of $nr entries: ${files[*]}"
+    fi
+}
+
+# another implementation would be to ask the user via some menu (like rofi or
+# dmenu or zenity or even qutebrowser completion in future?) which entry to
+# pick
+MENU_COMMAND=( head -n 1 )
+# whether to show the menu if there is only one entry in it
+menu_if_one_entry=0
+choose_entry_menu() {
+    local nr=${#files[@]}
+    if [ "$nr" -eq 1 ] && ! ((menu_if_one_entry)) ; then
+        file="${files[0]}"
+    else
+        file=$( printf "%s\n" "${files[@]}" | "${MENU_COMMAND[@]}" )
+    fi
+}
+
+choose_entry_rofi() {
+    MENU_COMMAND=( rofi -p "qutebrowser> " -dmenu
+                        -mesg $'Pick a password entry for <b>'"${QUTE_URL//&/&amp;}"'</b>' )
+    choose_entry_menu || true
+}
+
+choose_entry_zenity() {
+    MENU_COMMAND=( zenity --list --title "Qutebrowser password fill"
+                          --text "Pick the password entry:"
+                          --column "Name" )
+    choose_entry_menu || true
+}
+
+choose_entry_zenity_radio() {
+    zenity_helper() {
+        awk '{ print $0 ; print $0 }'                   \
+        | zenity --list --radiolist                     \
+                 --title "Qutebrowser password fill"    \
+                 --text "Pick the password entry:"      \
+                 --column " " --column "Name"
+    }
+    MENU_COMMAND=( zenity_helper )
+    choose_entry_menu || true
+}
+
+# =======================================================
+# backend: PASS
+
+# configuration options:
+match_filename=1 # whether allowing entry match by filepath
+match_line=0     # whether allowing entry match by URL-Pattern in file
+                 # Note: match_line=1 gets very slow, even for small password stores!
+match_line_pattern='^url: .*' # applied using grep -iE
+user_pattern='^(user|username|login): '
+
+GPG_OPTS=( "--quiet" "--yes" "--compress-algo=none" "--no-encrypt-to" )
+GPG="gpg"
+export GPG_TTY="${GPG_TTY:-$(tty 2>/dev/null)}"
+which gpg2 &>/dev/null && GPG="gpg2"
+[[ -n $GPG_AGENT_INFO || $GPG == "gpg2" ]] && GPG_OPTS+=( "--batch" "--use-agent" )
+
+pass_backend() {
+    init() {
+        PREFIX="${PASSWORD_STORE_DIR:-$HOME/.password-store}"
+        if ! [ -d "$PREFIX" ] ; then
+            die "Can not open password store dir »$PREFIX«"
+        fi
+    }
+    query_entries() {
+        local url="$1"
+
+        if ((match_line)) ; then
+            # add entries with matching URL-tag
+            while read -r -d "" passfile ; do
+                if $GPG "${GPG_OPTS}" -d "$passfile" \
+                     | grep --max-count=1 -iE "${match_line_pattern}${url}" > /dev/null
+                then
+                    passfile="${passfile#$PREFIX}"
+                    passfile="${passfile#/}"
+                    files+=( "${passfile%.gpg}" )
+                fi
+            done < <(find -L "$PREFIX" -iname '*.gpg' -print0)
+        fi
+        if ((match_filename)) ; then
+            # add entries with matching filepath
+            while read -r passfile ; do
+                passfile="${passfile#$PREFIX}"
+                passfile="${passfile#/}"
+                files+=( "${passfile%.gpg}" )
+            done < <(find -L "$PREFIX" -iname '*.gpg' | grep "$url")
+        fi
+    }
+    open_entry() {
+        local path="$PREFIX/${1}.gpg"
+        password=""
+        local firstline=1
+        while read -r line ; do
+            if ((firstline)) ; then
+                password="$line"
+                firstline=0
+            else
+                if [[ $line =~ $user_pattern ]] ; then
+                    # remove the matching prefix "user: " from the beginning of the line
+                    username=${line#${BASH_REMATCH[0]}}
+                    break
+                fi
+            fi
+        done < <($GPG "${GPG_OPTS}" -d "$path" )
+    }
+}
+# =======================================================
+
+# =======================================================
+# backend: secret
+secret_backend() {
+    init() {
+        return
+    }
+    query_entries() {
+        local domain="$1"
+        while read -r line ; do
+            if [[ "$line" =~ "attribute.username = " ]] ; then
+                files+=("$domain ${line#${BASH_REMATCH[0]}}")
+            fi
+        done < <( secret-tool search --unlock --all domain "$domain" 2>&1 )
+    }
+    open_entry() {
+        local domain="${1%% *}"
+        username="${1#* }"
+        password=$(secret-tool lookup domain "$domain" username "$username")
+    }
+}
+# =======================================================
+
+# load some sane default backend
+reset_backend
+pass_backend
+# load configuration
+QUTE_CONFIG_DIR=${QUTE_CONFIG_DIR:-${XDG_CONFIG_HOME:-$HOME/.config}/qutebrowser/}
+PWFILL_CONFIG=${PWFILL_CONFIG:-${QUTE_CONFIG_DIR}/password_fill_rc}
+if [ -f "$PWFILL_CONFIG" ] ; then
+    source "$PWFILL_CONFIG"
+fi
+init
+
+simplify_url "$QUTE_URL"
+query_entries "${simple_url}"
+no_entries_found
+# remove duplicates
+mapfile -t files < <(printf "%s\n" "${files[@]}" | sort | uniq )
+choose_entry
+if [ -z "$file" ] ; then
+    # choose_entry didn't want any of these entries
+    exit 0
+fi
+open_entry "$file"
+#username="$(date)"
+#password="XYZ"
+#msg "$username, ${#password}"
+
+[ -n "$username" ] || die "Username not set in entry $file"
+[ -n "$password" ] || die "Password not set in entry $file"
+
+js() {
+cat <<EOF
+    function hasPasswordField(form) {
+        var inputs = form.getElementsByTagName("input");
+        for (var j = 0; j < inputs.length; j++) {
+            var input = inputs[j];
+            if (input.type == "password") {
+                return true;
+            }
+        }
+        return false;
+    };
+    function loadData2Form (form) {
+        var inputs = form.getElementsByTagName("input");
+        for (var j = 0; j < inputs.length; j++) {
+            var input = inputs[j];
+            if (input.type == "text" || input.type == "email") {
+                input.focus();
+                input.value = "$(javascript_escape "${username}")";
+                input.blur();
+            }
+            if (input.type == "password") {
+                input.focus();
+                input.value = "$(javascript_escape "${password}")";
+                input.blur();
+            }
+        }
+    };
+
+    var forms = document.getElementsByTagName("form");
+    for (i = 0; i < forms.length; i++) {
+        if (hasPasswordField(forms[i])) {
+            loadData2Form(forms[i]);
+        }
+    }
+EOF
+}
+
+printjs() {
+    js | sed 's,//.*$,,' | tr '\n' ' '
+}
+echo "jseval -q $(printjs)" >> "$QUTE_FIFO"

misc/userscripts/qutebrowser_viewsource

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+# Copyright 2015 Zach-Button <zachrey.button@gmail.com>
+#
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+#
+# This script fetches the unprocessed HTML source for a page and opens it in vim.
+#	:bind gf spawn --userscript qutebrowser_viewsource
+#
+# Caveat: Does not use authentication of any kind. Add it in if you want it to.
+#
+
+path=$(mktemp --tmpdir qutebrowser_XXXXXXXX.html)
+
+curl "$QUTE_URL" > "$path"
+urxvt -e vim "$path"
+
+rm "$path"

misc/userscripts/qutedmenu

@@ -0,0 +1,59 @@
+#!/usr/bin/env bash
+# Handle open -s && open -t with bemenu
+
+#:bind o spawn --userscript /path/to/userscripts/qutedmenu open
+#:bind O spawn --userscript /path/to/userscripts/qutedmenu tab
+
+# If you would like to set a custom colorscheme/font use these dirs.
+# https://github.com/halfwit/dotfiles/blob/master/.config/dmenu/bemenucolors
+readonly confdir=${XDG_CONFIG_HOME:-$HOME/.config}
+
+readonly optsfile=$confdir/dmenu/bemenucolors
+
+create_menu() {
+    # Check quickmarks
+    while read -r url; do
+        printf -- '%s\n' "$url"
+    done < "$QUTE_CONFIG_DIR"/quickmarks
+
+    # Next bookmarks
+    while read -r url _; do
+        printf -- '%s\n' "$url"
+    done < "$QUTE_CONFIG_DIR"/bookmarks/urls
+
+    # Finally history
+    while read -r _ url; do
+        printf -- '%s\n' "$url"
+    done < "$QUTE_DATA_DIR"/history
+    }
+
+get_selection() {
+    opts+=(-p qutebrowser)
+    #create_menu | dmenu -l 10 "${opts[@]}"
+    create_menu | bemenu -l 10 "${opts[@]}"
+}
+
+# Main
+# https://github.com/halfwit/dotfiles/blob/master/.config/dmenu/font
+if [[ -s $confdir/dmenu/font ]]; then
+    read -r font < "$confdir"/dmenu/font
+fi
+
+if [[ $font ]]; then
+    opts+=(-fn "$font")
+fi
+
+if [[ -s $optsfile ]]; then
+    source "$optsfile"
+fi
+
+url=$(get_selection)
+url=${url/*http/http}
+
+# If no selection is made, exit (escape pressed, e.g.)
+[[ ! $url ]] && exit 0
+
+case $1 in
+    open) printf '%s' "open $url" >> "$QUTE_FIFO" || qutebrowser "$url" ;;
+    tab)    printf '%s' "open -t $url" >> "$QUTE_FIFO" || qutebrowser "$url"  ;;
+esac

misc/userscripts/readability

@@ -0,0 +1,25 @@
+#!/usr/bin/env python2
+#
+# Executes python-readability on current page and opens the summary as new tab.
+#
+# Usage:
+#   :spawn --userscript readability
+#
+from __future__ import absolute_import
+import codecs, os
+from readability.readability import Document
+
+tmpfile=os.path.expanduser('~/.local/share/qutebrowser/userscripts/readability.html')
+if not os.path.exists(os.path.dirname(tmpfile)):
+    os.makedirs(os.path.dirname(tmpfile))
+
+with codecs.open(os.environ['QUTE_HTML'], 'r', 'utf-8') as source:
+    doc = Document(source.read())
+    content = doc.summary().replace('<html>', '<html><head><title>%s</title></head>' % doc.title())
+
+    with codecs.open(tmpfile, 'w', 'utf-8') as target:
+        target.write('<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />')
+        target.write(content)
+
+    with open(os.environ['QUTE_FIFO'], 'w') as fifo:
+        fifo.write('open -t %s' % tmpfile)

misc/userscripts/ripbang

@@ -0,0 +1,27 @@
+#!/usr/bin/env python2
+#
+# Adds DuckDuckGo bang as searchengine.
+#
+# Usage:
+#   :spawn --userscript ripbang [bang]...
+#
+# Example:
+#   :spawn --userscript ripbang amazon maps
+#
+import os, re, requests, sys, urllib
+
+for argument in sys.argv[1:]:
+    bang = '!' + argument
+    r = requests.get('https://duckduckgo.com/',
+                     params={'q': bang + ' SEARCHTEXT'})
+
+    searchengine = urllib.unquote(re.search("url=[^']+", r.text).group(0))
+    searchengine = searchengine.replace('url=', '')
+    searchengine = searchengine.replace('/l/?kh=-1&uddg=', '')
+    searchengine = searchengine.replace('SEARCHTEXT', '{}')
+
+    if os.getenv('QUTE_FIFO'):
+        with open(os.environ['QUTE_FIFO'], 'w') as fifo:
+            fifo.write('set searchengines %s %s' % (bang, searchengine))
+    else:
+        print '%s %s' % (bang, searchengine)

misc/userscripts/rss

@@ -0,0 +1,122 @@
+#!/bin/sh
+
+# Copyright 2016 Jan Verbeek (blyxxyz) <ring@openmailbox.org>
+#
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+# This script keeps track of URLs in RSS feeds and opens new ones.
+# New feeds can be added with ':spawn -u /path/to/userscripts/rss add' or
+# ':spawn -u /path/to/userscripts/rss <url>'.
+# New items can be opened with ':spawn -u /path/to/userscripts/rss'.
+# The script doesn't really parse XML, and searches for things that look like
+# item links. It might open things that aren't real links, and it might miss
+# real links.
+
+config_dir="$HOME/.qute-rss"
+
+add_feed () {
+    touch "feeds"
+    if grep -Fq "$1" "feeds"; then
+        notice "$1 is saved already."
+    else
+        printf "%s\n" "$1" >> "feeds"
+    fi
+}
+
+# Show an error message and exit
+fail () {
+    echo "message-error '$*'" > "$QUTE_FIFO"
+    exit 1
+}
+
+# Get a sorted list of item URLs from a RSS feed
+get_items () {
+    $curl "$@" | grep "$text_only" -zo -e '<guid[^<>]*>[^<>]*</guid>' \
+                      -e '<link[^<>]*>[^<>]*</link>' \
+                      -e '<link[^<>]*href="[^"]*"' |
+        grep "$text_only" -o 'http[^<>"]*' | sort | uniq
+}
+
+# Show an info message
+notice () {
+    echo "message-info '$*'" > "$QUTE_FIFO"
+}
+
+# Update a database of a feed and open new URLs
+read_items () {
+    cd read_urls
+    feed_file="$(echo "$1" | tr -d /)"
+    feed_temp_file="$(mktemp "$feed_file.tmp.XXXXXXXXXX")"
+    feed_new_items="$(mktemp "$feed_file.new.XXXXXXXXXX")"
+    get_items "$1" > "$feed_temp_file"
+    if [ ! -s "$feed_temp_file" ]; then
+        notice "No items found for $1."
+        rm "$feed_temp_file" "$feed_new_items"
+    elif [ ! -f "$feed_file" ]; then
+        notice "$1 is a new feed. All items will be marked as read."
+        mv "$feed_temp_file" "$feed_file"
+        rm "$feed_new_items"
+    else
+        sort -o "$feed_file" "$feed_file"
+        comm -2 -3 "$feed_temp_file" "$feed_file" | tee "$feed_new_items"
+        cat "$feed_new_items" >> "$feed_file"
+        sort -o "$feed_file" "$feed_file"
+        rm "$feed_temp_file" "$feed_new_items"
+    fi | while read item; do
+        echo "open -t $item" > "$QUTE_FIFO"
+    done
+}
+
+if [ ! -d "$config_dir/read_urls" ]; then
+    notice "Creating configuration directory."
+    mkdir -p "$config_dir/read_urls"
+fi
+
+cd "$config_dir"
+
+if [ $# != 0 ]; then
+    for arg in "$@"; do
+        if [ "$arg" = "add" ]; then
+            add_feed "$QUTE_URL"
+        else
+            add_feed "$arg"
+        fi
+    done
+    exit
+fi
+
+if [ ! -f "feeds" ]; then
+    fail "Add feeds by running ':spawn -u rss add' or ':spawn -u rss <url>'."
+fi
+
+if curl --version >&-; then
+    curl="curl -sL"
+elif wget --version >&-; then
+    curl="wget -qO -"
+else
+    fail "Either curl or wget is needed to run this script."
+fi
+
+# Detect GNU grep so we can force it to treat everything as text
+if < /dev/null grep --help 2>&1 | grep -q -- -a; then
+    text_only="-a"
+fi
+
+while read feed_url; do
+    read_items "$feed_url" &
+done < "$config_dir/feeds"
+
+wait

misc/userscripts/taskadd

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+#
+# Behavior:
+#   Userscript for qutebrowser which adds a task to taskwarrior.
+#   If run as a command (:spawn --userscript taskadd), it creates a new task
+#   with the description equal to the current page title and annotates it with
+#   the current page url. Additional arguments are passed along so you can add
+#   mods to the task (e.g. priority, due date, tags).
+#
+#   Example:
+#       :spawn --userscript taskadd due:eod pri:H
+#
+#   To enable passing along extra args, I suggest using a mapping like:
+#       :bind <somekey> set-cmd-text -s :spawn --userscript taskadd
+#
+#   If run from hint mode, it uses the selected hint text as the description
+#   and the selected hint url as the annotation.
+#
+# Ryan Roden-Corrent (rcorre), 2016
+# Any feedback is welcome!
+#
+# For more info on Taskwarrior, see http://taskwarrior.org/
+
+# use either the current page title or the hint text as the task description
+[[ $QUTE_MODE == 'hints' ]] && title=$QUTE_SELECTED_TEXT || title=$QUTE_TITLE
+
+# try to add the task and grab the output
+msg="$(task add $title $@ 2>&1)"
+
+if [[ $? == 0 ]]; then
+    # annotate the new task with the url, send the output back to the browser
+    task +LATEST annotate "$QUTE_URL"
+    echo "message-info '$msg'" >> $QUTE_FIFO
+else
+    echo "message-error '$msg'" >> $QUTE_FIFO
+fi

misc/userscripts/view_in_mpv

@@ -0,0 +1,143 @@
+#!/usr/bin/env bash
+#
+# Behavior:
+#   Userscript for qutebrowser which views the current web page in mpv using
+#   sensible mpv-flags. While viewing the page in MPV, all <video>, <embed>,
+#   and <object> tags in the original page are temporarily removed. Clicking on
+#   such a removed video restores the respective video.
+#
+#   In order to use this script, just start it using `spawn --userscript` from
+#   qutebrowser. I recommend using an alias, e.g. put this in the
+#   [alias]-section of qutebrowser.conf:
+#
+#     mpv = spawn --userscript /path/to/view_in_mpv
+#
+# Background:
+#   Most of my machines are too slow to play youtube videos using html5, but
+#   they work fine in mpv (and mpv has further advantages like video scaling,
+#   etc). Of course, I don't want the video to be played (or even to be
+#   downloaded) twice — in MPV and in qwebkit. So I often close the tab after
+#   opening it in mpv. However, I actually want to keep the rest of the page
+#   (comments and video suggestions), i.e. only the videos should disappear
+#   when mpv is started. And that's precisely what the present script does.
+#
+# Thorsten Wißmann, 2015 (thorsten` on freenode)
+# Any feedback is welcome!
+
+set -e
+
+if [ -z "$QUTE_FIFO" ] ; then
+    cat 1>&2 <<EOF
+Error: $0 can not be run as a standalone script.
+
+It is a qutebrowser userscript. In order to use it, call it using
+'spawn --userscript' as described in qute://help/userscripts.html
+EOF
+    exit 1
+fi
+
+msg() {
+    local cmd="$1"
+    shift
+    local msg="$*"
+    if [ -z "$QUTE_FIFO" ] ; then
+        echo "$cmd: $msg" >&2
+    else
+        echo "message-$cmd '${msg//\'/\\\'}'" >> "$QUTE_FIFO"
+    fi
+}
+
+MPV_COMMAND=${MPV_COMMAND:-mpv}
+# Warning: spaces in single flags are not supported
+MPV_FLAGS=${MPV_FLAGS:- --force-window --no-terminal --keep-open=yes --ytdl }
+video_command=( "$MPV_COMMAND"  $MPV_FLAGS )
+
+js() {
+cat <<EOF
+
+    function descendantOfTagName(child, ancestorTagName) {
+        // tells whether child has some (proper) ancestor
+        // with the tag name ancestorTagName
+        while (child.parentNode != null) {
+            child = child.parentNode;
+            if (typeof child.tagName === 'undefined') break;
+            if (child.tagName.toUpperCase() == ancestorTagName.toUpperCase()) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    var App = {};
+
+    var all_videos = [];
+    all_videos.push.apply(all_videos, document.getElementsByTagName("video"));
+    all_videos.push.apply(all_videos, document.getElementsByTagName("object"));
+    all_videos.push.apply(all_videos, document.getElementsByTagName("embed"));
+    App.backup_videos = Array();
+    App.all_replacements = Array();
+    for (i = 0; i < all_videos.length; i++) {
+        var video = all_videos[i];
+        if (descendantOfTagName(video, "object")) {
+            // skip tags that are contained in an object, because we hide
+            // the object anyway.
+            continue;
+        }
+        var replacement = document.createElement("div");
+        replacement.innerHTML = "
+            <p style=\\"margin-bottom: 0.5em\\">
+            Opening page with:
+            <span style=\\"font-family: monospace;\\">${video_command[*]}</span>
+            </p>
+            <p>
+            In order to restore this particular video
+            <a style=\\"font-weight: bold;
+                        color: white;
+                        background: transparent;
+                     \\"
+               onClick=\\"restore_video(this, " + i + ");\\"
+               href=\\"javascript: restore_video(this, " + i + ")\\"
+              >click here</a>.
+            </p>
+        ";
+        replacement.style.position = "relative";
+        replacement.style.zIndex = "100003000000";
+        replacement.style.fontSize = "1rem";
+        replacement.style.textAlign = "center";
+        replacement.style.verticalAlign = "middle";
+        replacement.style.height = "100%";
+        replacement.style.background = "#101010";
+        replacement.style.color = "white";
+        replacement.style.border = "4px dashed #545454";
+        replacement.style.padding = "2em";
+        replacement.style.margin = "auto";
+        App.all_replacements[i] = replacement;
+        App.backup_videos[i] = video;
+        video.parentNode.replaceChild(replacement, video);
+    }
+
+    function restore_video(obj, index) {
+        obj = App.all_replacements[index];
+        video = App.backup_videos[index];
+        console.log(video);
+        obj.parentNode.replaceChild(video, obj);
+    }
+
+    /** force repainting the video, thanks to:
+     * http://martinwolf.org/2014/06/10/force-repaint-of-an-element-with-javascript/
+     */
+    var siteHeader = document.getElementById('header');
+    siteHeader.style.display='none';
+    siteHeader.offsetHeight; // no need to store this anywhere, the reference is enough
+    siteHeader.style.display='block';
+
+EOF
+}
+
+printjs() {
+    js | sed 's,//.*$,,' | tr '\n' ' '
+}
+echo "jseval -q $(printjs)" >> "$QUTE_FIFO"
+
+msg info "Opening $QUTE_URL with mpv"
+"${video_command[@]}" "$QUTE_URL"

pytest.ini

@@ -0,0 +1,54 @@
+[pytest]
+addopts = --strict -rfEw --faulthandler-timeout=70 --instafail --pythonwarnings error
+markers =
+    gui: Tests using the GUI (e.g. spawning widgets)
+    posix: Tests which only can run on a POSIX OS.
+    windows: Tests which only can run on Windows.
+    linux: Tests which only can run on Linux.
+    osx: Tests which only can run on OS X.
+    not_osx: Tests which can not run on OS X.
+    not_frozen: Tests which can't be run if sys.frozen is True.
+    no_xvfb: Tests which can't be run with Xvfb.
+    frozen: Tests which can only be run if sys.frozen is True.
+    integration: Tests which test a bigger portion of code
+    end2end: End to end tests which run qutebrowser as subprocess
+    xfail_norun: xfail the test with out running it
+    ci: Tests which should only run on CI.
+    qtwebengine_todo: Features still missing with QtWebEngine
+    qtwebengine_skip: Tests not applicable with QtWebEngine
+    qtwebkit_skip: Tests not applicable with QtWebKit
+    qtwebkit_ng_xfail: Tests failing with QtWebKit-NG
+    qtwebkit_ng_skip: Tests skipped with QtWebKit-NG
+    qtwebengine_flaky: Tests which are flaky (and currently skipped) with QtWebEngine
+    qtwebengine_osx_xfail: Tests which fail on OS X with QtWebEngine
+    js_prompt: Tests needing to display a javascript prompt
+    this: Used to mark tests during development
+    no_invalid_lines: Don't fail on unparseable lines in end2end tests
+qt_log_level_fail = WARNING
+qt_log_ignore =
+    ^SpellCheck: .*
+    ^SetProcessDpiAwareness failed: .*
+    ^QWindowsWindow::setGeometryDp: Unable to set geometry .*
+    ^QProcess: Destroyed while process .* is still running\.
+    ^"Method "GetAll" with signature "s" on interface "org\.freedesktop\.DBus\.Properties" doesn't exist
+    ^"Method \\"GetAll\\" with signature \\"s\\" on interface \\"org\.freedesktop\.DBus\.Properties\\" doesn't exist\\n"
+    ^propsReply "Method \\"GetAll\\" with signature \\"s\\" on interface \\"org\.freedesktop\.DBus\.Properties\\" doesn't exist\\n"
+    ^nmReply "Method \\"GetDevices\\" with signature \\"\\" on interface \\"org\.freedesktop\.NetworkManager\\" doesn't exist\\n"
+    ^"Object path cannot be empty"
+    ^virtual void QSslSocketBackendPrivate::transmit\(\) SSL write failed with error: -9805
+    ^virtual void QSslSocketBackendPrivate::transmit\(\) SSLRead failed with: -9805
+    ^Type conversion already registered from type .*
+    ^QNetworkReplyImplPrivate::error: Internal problem, this method must only be called once\.
+    ^QWaitCondition: Destroyed while threads are still waiting
+    ^QXcbXSettings::QXcbXSettings\(QXcbScreen\*\) Failed to get selection owner for XSETTINGS_S atom
+    ^QStandardPaths: XDG_RUNTIME_DIR not set, defaulting to .*
+    ^QGeoclueMaster error creating GeoclueMasterClient\.
+    ^Geoclue error: Process org\.freedesktop\.Geoclue\.Master exited with status 127
+    ^QObject::connect: Cannot connect \(null\)::stateChanged\(QNetworkSession::State\) to QNetworkReplyHttpImpl::_q_networkSessionStateChanged\(QNetworkSession::State\)
+    ^QXcbClipboard: Cannot transfer data, no data available
+    ^load glyph failed
+    ^Error when parsing the netrc file
+    ^Image of format '' blocked because it is not considered safe. If you are sure it is safe to do so, you can white-list the format by setting the environment variable QTWEBKIT_IMAGEFORMAT_WHITELIST=
+    ^QPainter::end: Painter ended with \d+ saved states
+    ^QSslSocket: cannot resolve SSLv[23]_(client|server)_method
+xfail_strict = true

qutebrowser.desktop

@@ -8,3 +8,4 @@ Exec=qutebrowser %u
 Terminal=false
 StartupNotify=false
 MimeType=text/html;text/xml;application/xhtml+xml;application/xml;application/rdf+xml;image/gif;image/jpeg;image/png;x-scheme-handler/http;x-scheme-handler/https;
+Keywords=Browser

qutebrowser/__init__.py

@@ -1,6 +1,6 @@
 # vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
 
-# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# Copyright 2014-2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -17,19 +17,17 @@
 # You should have received a copy of the GNU General Public License
 # along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
 
-# pylint: disable=line-too-long
-
-"""A keyboard-driven, vim-like browser based on PyQt5 and QtWebKit."""
+"""A keyboard-driven, vim-like browser based on PyQt5."""
 
 import os.path
 
 __author__ = "Florian Bruhin"
-__copyright__ = "Copyright 2014-2015 Florian Bruhin (The Compiler)"
+__copyright__ = "Copyright 2014-2016 Florian Bruhin (The Compiler)"
 __license__ = "GPL"
 __maintainer__ = __author__
 __email__ = "mail@qutebrowser.org"
-__version_info__ = (0, 2, 0)
-__version__ = '.'.join(map(str, __version_info__))
-__description__ = "A keyboard-driven, vim-like browser based on PyQt5 and QtWebKit."
+__version_info__ = (0, 10, 0)
+__version__ = '.'.join(str(e) for e in __version_info__)
+__description__ = "A keyboard-driven, vim-like browser based on PyQt5."
 
 basedir = os.path.dirname(os.path.realpath(__file__))

qutebrowser/__main__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
 
-# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# Copyright 2014-2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #

qutebrowser/browser/__init__.py

@@ -1,6 +1,6 @@
 # vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
 
-# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# Copyright 2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #

qutebrowser/browser/adblock.py

@@ -1,6 +1,6 @@
 # vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
 
-# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# Copyright 2014-2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -24,7 +24,9 @@ import os.path
 import functools
 import posixpath
 import zipfile
+import fnmatch
 
+from qutebrowser.browser import downloads
 from qutebrowser.config import config
 from qutebrowser.utils import objreg, standarddir, log, message
 from qutebrowser.commands import cmdutils
@@ -47,7 +49,7 @@ def guess_zip_filename(zf):
 
 
 def get_fileobj(byte_io):
-    """Get an usable file object to read the hosts file from."""
+    """Get a usable file object to read the hosts file from."""
     byte_io.seek(0)  # rewind downloaded file
     if zipfile.is_zipfile(byte_io):
         byte_io.seek(0)  # rewind what zipfile.is_zipfile did
@@ -59,6 +61,22 @@ def get_fileobj(byte_io):
     return io.TextIOWrapper(byte_io, encoding='utf-8')
 
 
+def is_whitelisted_host(host):
+    """Check if the given host is on the adblock whitelist.
+
+    Args:
+        host: The host of the request as string.
+    """
+    whitelist = config.get('content', 'host-blocking-whitelist')
+    if whitelist is None:
+        return False
+
+    for pattern in whitelist:
+        if fnmatch.fnmatch(host, pattern.lower()):
+            return True
+    return False
+
+
 class FakeDownload:
 
     """A download stub to use on_download_finished with local files."""
@@ -74,10 +92,12 @@ class HostBlocker:
     """Manage blocked hosts based from /etc/hosts-like files.
 
     Attributes:
-        blocked_hosts: A set of blocked hosts.
+        _blocked_hosts: A set of blocked hosts.
+        _config_blocked_hosts: A set of blocked hosts from ~/.config.
         _in_progress: The DownloadItems which are currently downloading.
         _done_count: How many files have been read successfully.
-        _hosts_file: The path to the blocked-hosts file.
+        _local_hosts_file: The path to the blocked-hosts file.
+        _config_hosts_file: The path to a blocked-hosts in ~/.config
 
     Class attributes:
         WHITELISTED: Hosts which never should be blocked.
@@ -87,35 +107,81 @@ class HostBlocker:
                    'local')
 
     def __init__(self):
-        self.blocked_hosts = set()
+        self._blocked_hosts = set()
+        self._config_blocked_hosts = set()
         self._in_progress = []
         self._done_count = 0
-        self._hosts_file = os.path.join(standarddir.data(), 'blocked-hosts')
+
+        data_dir = standarddir.data()
+        self._local_hosts_file = os.path.join(data_dir, 'blocked-hosts')
+        self.on_config_changed()
+
+        config_dir = standarddir.config()
+        self._config_hosts_file = os.path.join(config_dir, 'blocked-hosts')
+
         objreg.get('config').changed.connect(self.on_config_changed)
 
+    def is_blocked(self, url):
+        """Check if the given URL (as QUrl) is blocked."""
+        if not config.get('content', 'host-blocking-enabled'):
+            return False
+        host = url.host()
+        return ((host in self._blocked_hosts or
+                 host in self._config_blocked_hosts) and
+                not is_whitelisted_host(host))
+
+    def _read_hosts_file(self, filename, target):
+        """Read hosts from the given filename.
+
+        Args:
+            filename: The file to read.
+            target: The set to store the hosts in.
+
+        Return:
+            True if a read was attempted, False otherwise
+        """
+        if not os.path.exists(filename):
+            return False
+
+        try:
+            with open(filename, 'r', encoding='utf-8') as f:
+                for line in f:
+                    target.add(line.strip())
+        except OSError:
+            log.misc.exception("Failed to read host blocklist!")
+
+        return True
+
     def read_hosts(self):
         """Read hosts from the existing blocked-hosts file."""
-        self.blocked_hosts = set()
-        if os.path.exists(self._hosts_file):
-            try:
-                with open(self._hosts_file, 'r', encoding='utf-8') as f:
-                    for line in f:
-                        self.blocked_hosts.add(line.strip())
-            except OSError:
-                log.misc.exception("Failed to read host blocklist!")
-        else:
-            if config.get('content', 'host-block-lists') is not None:
-                message.info('current',
-                             "Run :adblock-update to get adblock lists.")
+        self._blocked_hosts = set()
+
+        self._read_hosts_file(self._config_hosts_file,
+                              self._config_blocked_hosts)
+
+        found = self._read_hosts_file(self._local_hosts_file,
+                                      self._blocked_hosts)
+
+        if not found:
+            args = objreg.get('args')
+            if (config.get('content', 'host-block-lists') is not None and
+                    args.basedir is None):
+                message.info("Run :adblock-update to get adblock lists.")
 
     @cmdutils.register(instance='host-blocker')
-    def adblock_update(self, win_id: {'special': 'win_id'}):
-        """Update the adblock block lists."""
-        self.blocked_hosts = set()
+    def adblock_update(self):
+        """Update the adblock block lists.
+
+        This updates `~/.local/share/qutebrowser/blocked-hosts` with downloaded
+        host lists and re-reads `~/.config/qutebrowser/blocked-hosts`.
+        """
+        self._read_hosts_file(self._config_hosts_file,
+                              self._config_blocked_hosts)
+        self._blocked_hosts = set()
         self._done_count = 0
         urls = config.get('content', 'host-block-lists')
-        download_manager = objreg.get('download-manager', scope='window',
-                                      window='last-focused')
+        download_manager = objreg.get('qtnetwork-download-manager',
+                                      scope='window', window='last-focused')
         if urls is None:
             return
         for url in urls:
@@ -123,8 +189,8 @@ class HostBlocker:
                 try:
                     fileobj = open(url.path(), 'rb')
                 except OSError as e:
-                    message.error(win_id, "adblock: Error while reading {}: "
-                                  "{}".format(url.path(), e.strerror))
+                    message.error("adblock: Error while reading {}: {}".format(
+                        url.path(), e.strerror))
                     continue
                 download = FakeDownload(fileobj)
                 self._in_progress.append(download)
@@ -132,7 +198,8 @@ class HostBlocker:
             else:
                 fobj = io.BytesIO()
                 fobj.name = 'adblock: ' + url.host()
-                download = download_manager.get(url, fileobj=fobj,
+                target = downloads.FileObjDownloadTarget(fobj)
+                download = download_manager.get(url, target=target,
                                                 auto_remove=True)
                 self._in_progress.append(download)
                 download.finished.connect(
@@ -152,9 +219,9 @@ class HostBlocker:
         try:
             f = get_fileobj(byte_io)
         except (OSError, UnicodeDecodeError, zipfile.BadZipFile,
-                zipfile.LargeZipFile) as e:
-            message.error('current', "adblock: Error while reading {}: {} - "
-                          "{}".format(byte_io.name, e.__class__.__name__, e))
+                zipfile.LargeZipFile, LookupError) as e:
+            message.error("adblock: Error while reading {}: {} - {}".format(
+                byte_io.name, e.__class__.__name__, e))
             return
         for line in f:
             line_count += 1
@@ -179,19 +246,19 @@ class HostBlocker:
                 error_count += 1
                 continue
             if host not in self.WHITELISTED:
-                self.blocked_hosts.add(host)
+                self._blocked_hosts.add(host)
         log.misc.debug("{}: read {} lines".format(byte_io.name, line_count))
         if error_count > 0:
-            message.error('current', "adblock: {} read errors for {}".format(
+            message.error("adblock: {} read errors for {}".format(
                 error_count, byte_io.name))
 
     def on_lists_downloaded(self):
         """Install block lists after files have been downloaded."""
-        with open(self._hosts_file, 'w', encoding='utf-8') as f:
-            for host in sorted(self.blocked_hosts):
+        with open(self._local_hosts_file, 'w', encoding='utf-8') as f:
+            for host in sorted(self._blocked_hosts):
                 f.write(host + '\n')
-            message.info('current', "adblock: Read {} hosts from {} sources."
-                         .format(len(self.blocked_hosts), self._done_count))
+            message.info("adblock: Read {} hosts from {} sources.".format(
+                len(self._blocked_hosts), self._done_count))
 
     @config.change_filter('content', 'host-block-lists')
     def on_config_changed(self):
@@ -199,9 +266,11 @@ class HostBlocker:
         urls = config.get('content', 'host-block-lists')
         if urls is None:
             try:
-                os.remove(self._hosts_file)
-            except OSError:
-                log.misc.exception("Failed to delete hosts file.")
+                os.remove(self._local_hosts_file)
+            except FileNotFoundError:
+                pass
+            except OSError as e:
+                log.misc.exception("Failed to delete hosts file: {}".format(e))
 
     def on_download_finished(self, download):
         """Check if all downloads are finished and if so, trigger reading.

qutebrowser/browser/browsertab.py

@@ -0,0 +1,799 @@
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+# Copyright 2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+#
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Base class for a wrapper over QWebView/QWebEngineView."""
+
+import itertools
+
+from PyQt5.QtCore import pyqtSignal, pyqtSlot, QUrl, QObject, QSizeF
+from PyQt5.QtGui import QIcon
+from PyQt5.QtWidgets import QWidget, QApplication
+
+from qutebrowser.keyinput import modeman
+from qutebrowser.config import config
+from qutebrowser.utils import utils, objreg, usertypes, log, qtutils
+from qutebrowser.misc import miscwidgets, objects
+from qutebrowser.browser import mouse, hints
+
+
+tab_id_gen = itertools.count(0)
+
+
+def create(win_id, parent=None):
+    """Get a QtWebKit/QtWebEngine tab object.
+
+    Args:
+        win_id: The window ID where the tab will be shown.
+        parent: The Qt parent to set.
+    """
+    # Importing modules here so we don't depend on QtWebEngine without the
+    # argument and to avoid circular imports.
+    mode_manager = modeman.instance(win_id)
+    if objects.backend == usertypes.Backend.QtWebEngine:
+        from qutebrowser.browser.webengine import webenginetab
+        tab_class = webenginetab.WebEngineTab
+    else:
+        from qutebrowser.browser.webkit import webkittab
+        tab_class = webkittab.WebKitTab
+    return tab_class(win_id=win_id, mode_manager=mode_manager, parent=parent)
+
+
+def init():
+    """Initialize backend-specific modules."""
+    if objects.backend == usertypes.Backend.QtWebEngine:
+        from qutebrowser.browser.webengine import webenginetab
+        webenginetab.init()
+    else:
+        from qutebrowser.browser.webkit import webkittab
+        webkittab.init()
+
+
+class WebTabError(Exception):
+
+    """Base class for various errors."""
+
+
+class UnsupportedOperationError(WebTabError):
+
+    """Raised when an operation is not supported with the given backend."""
+
+
+TerminationStatus = usertypes.enum('TerminationStatus', [
+    'normal',
+    'abnormal',  # non-zero exit status
+    'crashed',   # e.g. segfault
+    'killed',
+    'unknown',
+])
+
+
+class TabData:
+
+    """A simple namespace with a fixed set of attributes.
+
+    Attributes:
+        keep_icon: Whether the (e.g. cloned) icon should not be cleared on page
+                   load.
+        inspector: The QWebInspector used for this webview.
+        viewing_source: Set if we're currently showing a source view.
+        override_target: Override for open_target for fake clicks (like hints).
+                         Only used for QtWebKit.
+    """
+
+    def __init__(self):
+        self.keep_icon = False
+        self.viewing_source = False
+        self.inspector = None
+        self.override_target = None
+
+
+class AbstractAction:
+
+    """Attribute of AbstractTab for Qt WebActions."""
+
+    def __init__(self):
+        self._widget = None
+
+    def exit_fullscreen(self):
+        """Exit the fullscreen mode."""
+        raise NotImplementedError
+
+    def save_page(self):
+        """Save the current page."""
+        raise NotImplementedError
+
+
+class AbstractPrinting:
+
+    """Attribute of AbstractTab for printing the page."""
+
+    def __init__(self):
+        self._widget = None
+
+    def check_pdf_support(self):
+        raise NotImplementedError
+
+    def check_printer_support(self):
+        raise NotImplementedError
+
+    def check_preview_support(self):
+        raise NotImplementedError
+
+    def to_pdf(self, filename):
+        raise NotImplementedError
+
+    def to_printer(self, printer, callback=None):
+        """Print the tab.
+
+        Args:
+            printer: The QPrinter to print to.
+            callback: Called with a boolean
+                      (True if printing succeeded, False otherwise)
+        """
+        raise NotImplementedError
+
+
+class AbstractSearch(QObject):
+
+    """Attribute of AbstractTab for doing searches.
+
+    Attributes:
+        text: The last thing this view was searched for.
+        _flags: The flags of the last search (needs to be set by subclasses).
+        _widget: The underlying WebView widget.
+    """
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self._widget = None
+        self.text = None
+
+    def search(self, text, *, ignore_case=False, reverse=False,
+               result_cb=None):
+        """Find the given text on the page.
+
+        Args:
+            text: The text to search for.
+            ignore_case: Search case-insensitively. (True/False/'smart')
+            reverse: Reverse search direction.
+            result_cb: Called with a bool indicating whether a match was found.
+        """
+        raise NotImplementedError
+
+    def clear(self):
+        """Clear the current search."""
+        raise NotImplementedError
+
+    def prev_result(self, *, result_cb=None):
+        """Go to the previous result of the current search.
+
+        Args:
+            result_cb: Called with a bool indicating whether a match was found.
+        """
+        raise NotImplementedError
+
+    def next_result(self, *, result_cb=None):
+        """Go to the next result of the current search.
+
+        Args:
+            result_cb: Called with a bool indicating whether a match was found.
+        """
+        raise NotImplementedError
+
+
+class AbstractZoom(QObject):
+
+    """Attribute of AbstractTab for controlling zoom.
+
+    Attributes:
+        _neighborlist: A NeighborList with the zoom levels.
+        _default_zoom_changed: Whether the zoom was changed from the default.
+    """
+
+    def __init__(self, win_id, parent=None):
+        super().__init__(parent)
+        self._widget = None
+        self._win_id = win_id
+        self._default_zoom_changed = False
+        self._init_neighborlist()
+        objreg.get('config').changed.connect(self._on_config_changed)
+
+        # # FIXME:qtwebengine is this needed?
+        # # For some reason, this signal doesn't get disconnected automatically
+        # # when the WebView is destroyed on older PyQt versions.
+        # # See https://github.com/qutebrowser/qutebrowser/issues/390
+        # self.destroyed.connect(functools.partial(
+        #     cfg.changed.disconnect, self.init_neighborlist))
+
+    @pyqtSlot(str, str)
+    def _on_config_changed(self, section, option):
+        if section == 'ui' and option in ['zoom-levels', 'default-zoom']:
+            if not self._default_zoom_changed:
+                factor = float(config.get('ui', 'default-zoom')) / 100
+                self._set_factor_internal(factor)
+            self._default_zoom_changed = False
+            self._init_neighborlist()
+
+    def _init_neighborlist(self):
+        """Initialize self._neighborlist."""
+        levels = config.get('ui', 'zoom-levels')
+        self._neighborlist = usertypes.NeighborList(
+            levels, mode=usertypes.NeighborList.Modes.edge)
+        self._neighborlist.fuzzyval = config.get('ui', 'default-zoom')
+
+    def offset(self, offset):
+        """Increase/Decrease the zoom level by the given offset.
+
+        Args:
+            offset: The offset in the zoom level list.
+
+        Return:
+            The new zoom percentage.
+        """
+        level = self._neighborlist.getitem(offset)
+        self.set_factor(float(level) / 100, fuzzyval=False)
+        return level
+
+    def _set_factor_internal(self, factor):
+        raise NotImplementedError
+
+    def set_factor(self, factor, *, fuzzyval=True):
+        """Zoom to a given zoom factor.
+
+        Args:
+            factor: The zoom factor as float.
+            fuzzyval: Whether to set the NeighborLists fuzzyval.
+        """
+        if fuzzyval:
+            self._neighborlist.fuzzyval = int(factor * 100)
+        if factor < 0:
+            raise ValueError("Can't zoom to factor {}!".format(factor))
+        self._default_zoom_changed = True
+        self._set_factor_internal(factor)
+
+    def factor(self):
+        raise NotImplementedError
+
+    def set_default(self):
+        default_zoom = config.get('ui', 'default-zoom')
+        self._set_factor_internal(float(default_zoom) / 100)
+
+
+class AbstractCaret(QObject):
+
+    """Attribute of AbstractTab for caret browsing."""
+
+    def __init__(self, win_id, tab, mode_manager, parent=None):
+        super().__init__(parent)
+        self._tab = tab
+        self._win_id = win_id
+        self._widget = None
+        self.selection_enabled = False
+        mode_manager.entered.connect(self._on_mode_entered)
+        mode_manager.left.connect(self._on_mode_left)
+
+    def _on_mode_entered(self, mode):
+        raise NotImplementedError
+
+    def _on_mode_left(self):
+        raise NotImplementedError
+
+    def move_to_next_line(self, count=1):
+        raise NotImplementedError
+
+    def move_to_prev_line(self, count=1):
+        raise NotImplementedError
+
+    def move_to_next_char(self, count=1):
+        raise NotImplementedError
+
+    def move_to_prev_char(self, count=1):
+        raise NotImplementedError
+
+    def move_to_end_of_word(self, count=1):
+        raise NotImplementedError
+
+    def move_to_next_word(self, count=1):
+        raise NotImplementedError
+
+    def move_to_prev_word(self, count=1):
+        raise NotImplementedError
+
+    def move_to_start_of_line(self):
+        raise NotImplementedError
+
+    def move_to_end_of_line(self):
+        raise NotImplementedError
+
+    def move_to_start_of_next_block(self, count=1):
+        raise NotImplementedError
+
+    def move_to_start_of_prev_block(self, count=1):
+        raise NotImplementedError
+
+    def move_to_end_of_next_block(self, count=1):
+        raise NotImplementedError
+
+    def move_to_end_of_prev_block(self, count=1):
+        raise NotImplementedError
+
+    def move_to_start_of_document(self):
+        raise NotImplementedError
+
+    def move_to_end_of_document(self):
+        raise NotImplementedError
+
+    def toggle_selection(self):
+        raise NotImplementedError
+
+    def drop_selection(self):
+        raise NotImplementedError
+
+    def has_selection(self):
+        raise NotImplementedError
+
+    def selection(self, html=False):
+        raise NotImplementedError
+
+    def follow_selected(self, *, tab=False):
+        raise NotImplementedError
+
+
+class AbstractScroller(QObject):
+
+    """Attribute of AbstractTab to manage scroll position."""
+
+    perc_changed = pyqtSignal(int, int)
+
+    def __init__(self, tab, parent=None):
+        super().__init__(parent)
+        self._tab = tab
+        self._widget = None
+        self.perc_changed.connect(self._log_scroll_pos_change)
+
+    @pyqtSlot()
+    def _log_scroll_pos_change(self):
+        log.webview.vdebug("Scroll position changed to {}".format(
+            self.pos_px()))
+
+    def _init_widget(self, widget):
+        self._widget = widget
+
+    def pos_px(self):
+        raise NotImplementedError
+
+    def pos_perc(self):
+        raise NotImplementedError
+
+    def to_perc(self, x=None, y=None):
+        raise NotImplementedError
+
+    def to_point(self, point):
+        raise NotImplementedError
+
+    def delta(self, x=0, y=0):
+        raise NotImplementedError
+
+    def delta_page(self, x=0, y=0):
+        raise NotImplementedError
+
+    def up(self, count=1):
+        raise NotImplementedError
+
+    def down(self, count=1):
+        raise NotImplementedError
+
+    def left(self, count=1):
+        raise NotImplementedError
+
+    def right(self, count=1):
+        raise NotImplementedError
+
+    def top(self):
+        raise NotImplementedError
+
+    def bottom(self):
+        raise NotImplementedError
+
+    def page_up(self, count=1):
+        raise NotImplementedError
+
+    def page_down(self, count=1):
+        raise NotImplementedError
+
+    def at_top(self):
+        raise NotImplementedError
+
+    def at_bottom(self):
+        raise NotImplementedError
+
+
+class AbstractHistory:
+
+    """The history attribute of a AbstractTab."""
+
+    def __init__(self, tab):
+        self._tab = tab
+        self._history = None
+
+    def __len__(self):
+        return len(self._history)
+
+    def __iter__(self):
+        return iter(self._history.items())
+
+    def current_idx(self):
+        raise NotImplementedError
+
+    def back(self):
+        raise NotImplementedError
+
+    def forward(self):
+        raise NotImplementedError
+
+    def can_go_back(self):
+        raise NotImplementedError
+
+    def can_go_forward(self):
+        raise NotImplementedError
+
+    def serialize(self):
+        """Serialize into an opaque format understood by self.deserialize."""
+        raise NotImplementedError
+
+    def deserialize(self, data):
+        """Serialize from a format produced by self.serialize."""
+        raise NotImplementedError
+
+    def load_items(self, items):
+        """Deserialize from a list of WebHistoryItems."""
+        raise NotImplementedError
+
+
+class AbstractElements:
+
+    """Finding and handling of elements on the page."""
+
+    def __init__(self, tab):
+        self._widget = None
+        self._tab = tab
+
+    def find_css(self, selector, callback, *, only_visible=False):
+        """Find all HTML elements matching a given selector async.
+
+        Args:
+            callback: The callback to be called when the search finished.
+            selector: The CSS selector to search for.
+            only_visible: Only show elements which are visible on screen.
+        """
+        raise NotImplementedError
+
+    def find_id(self, elem_id, callback):
+        """Find the HTML element with the given ID async.
+
+        Args:
+            callback: The callback to be called when the search finished.
+            elem_id: The ID to search for.
+        """
+        raise NotImplementedError
+
+    def find_focused(self, callback):
+        """Find the focused element on the page async.
+
+        Args:
+            callback: The callback to be called when the search finished.
+                      Called with a WebEngineElement or None.
+        """
+        raise NotImplementedError
+
+    def find_at_pos(self, pos, callback):
+        """Find the element at the given position async.
+
+        This is also called "hit test" elsewhere.
+
+        Args:
+            pos: The QPoint to get the element for.
+            callback: The callback to be called when the search finished.
+                      Called with a WebEngineElement or None.
+        """
+        raise NotImplementedError
+
+
+class AbstractTab(QWidget):
+
+    """A wrapper over the given widget to hide its API and expose another one.
+
+    We use this to unify QWebView and QWebEngineView.
+
+    Attributes:
+        history: The AbstractHistory for the current tab.
+        registry: The ObjectRegistry associated with this tab.
+
+        _load_status: loading status of this page
+                      Accessible via load_status() method.
+        _has_ssl_errors: Whether SSL errors happened.
+                         Needs to be set by subclasses.
+
+        for properties, see WebView/WebEngineView docs.
+
+    Signals:
+        See related Qt signals.
+
+        new_tab_requested: Emitted when a new tab should be opened with the
+                           given URL.
+        load_status_changed: The loading status changed
+        fullscreen_requested: Fullscreen display was requested by the page.
+                              arg: True if fullscreen should be turned on,
+                                   False if it should be turned off.
+        renderer_process_terminated: Emitted when the underlying renderer
+                                     process terminated.
+                                     arg 0: A TerminationStatus member.
+                                     arg 1: The exit code.
+    """
+
+    window_close_requested = pyqtSignal()
+    link_hovered = pyqtSignal(str)
+    load_started = pyqtSignal()
+    load_progress = pyqtSignal(int)
+    load_finished = pyqtSignal(bool)
+    icon_changed = pyqtSignal(QIcon)
+    title_changed = pyqtSignal(str)
+    load_status_changed = pyqtSignal(str)
+    new_tab_requested = pyqtSignal(QUrl)
+    url_changed = pyqtSignal(QUrl)
+    shutting_down = pyqtSignal()
+    contents_size_changed = pyqtSignal(QSizeF)
+    add_history_item = pyqtSignal(QUrl, QUrl, str)  # url, requested url, title
+    fullscreen_requested = pyqtSignal(bool)
+    renderer_process_terminated = pyqtSignal(TerminationStatus, int)
+
+    def __init__(self, win_id, mode_manager, parent=None):
+        self.win_id = win_id
+        self.tab_id = next(tab_id_gen)
+        super().__init__(parent)
+
+        self.registry = objreg.ObjectRegistry()
+        tab_registry = objreg.get('tab-registry', scope='window',
+                                  window=win_id)
+        tab_registry[self.tab_id] = self
+        objreg.register('tab', self, registry=self.registry)
+
+        # self.history = AbstractHistory(self)
+        # self.scroller = AbstractScroller(self, parent=self)
+        # self.caret = AbstractCaret(win_id=win_id, tab=self,
+        #                            mode_manager=mode_manager, parent=self)
+        # self.zoom = AbstractZoom(win_id=win_id)
+        # self.search = AbstractSearch(parent=self)
+        # self.printing = AbstractPrinting()
+        # self.elements = AbstractElements(self)
+        # self.action = AbstractAction()
+
+        self.data = TabData()
+        self._layout = miscwidgets.WrapperLayout(self)
+        self._widget = None
+        self._progress = 0
+        self._has_ssl_errors = False
+        self._mode_manager = mode_manager
+        self._load_status = usertypes.LoadStatus.none
+        self._mouse_event_filter = mouse.MouseEventFilter(
+            self, parent=self)
+        self.backend = None
+
+        # FIXME:qtwebengine  Should this be public api via self.hints?
+        #                    Also, should we get it out of objreg?
+        hintmanager = hints.HintManager(win_id, self.tab_id, parent=self)
+        objreg.register('hintmanager', hintmanager, scope='tab',
+                        window=self.win_id, tab=self.tab_id)
+
+    def _set_widget(self, widget):
+        # pylint: disable=protected-access
+        self._widget = widget
+        self._layout.wrap(self, widget)
+        self.history._history = widget.history()
+        self.scroller._init_widget(widget)
+        self.caret._widget = widget
+        self.zoom._widget = widget
+        self.search._widget = widget
+        self.printing._widget = widget
+        self.action._widget = widget
+        self.elements._widget = widget
+
+        self._install_event_filter()
+        self.zoom.set_default()
+
+    def _install_event_filter(self):
+        raise NotImplementedError
+
+    def _set_load_status(self, val):
+        """Setter for load_status."""
+        if not isinstance(val, usertypes.LoadStatus):
+            raise TypeError("Type {} is no LoadStatus member!".format(val))
+        log.webview.debug("load status for {}: {}".format(repr(self), val))
+        self._load_status = val
+        self.load_status_changed.emit(val.name)
+
+    def event_target(self):
+        """Return the widget events should be sent to."""
+        raise NotImplementedError
+
+    def send_event(self, evt):
+        """Send the given event to the underlying widget.
+
+        The event will be sent via QApplication.postEvent.
+        Note that a posted event may not be re-used in any way!
+        """
+        # This only gives us some mild protection against re-using events, but
+        # it's certainly better than a segfault.
+        if getattr(evt, 'posted', False):
+            raise AssertionError("Can't re-use an event which was already "
+                                 "posted!")
+        recipient = self.event_target()
+        evt.posted = True
+        QApplication.postEvent(recipient, evt)
+
+    @pyqtSlot(QUrl)
+    def _on_url_changed(self, url):
+        """Update title when URL has changed and no title is available."""
+        if url.isValid() and not self.title():
+            self.title_changed.emit(url.toDisplayString())
+        self.url_changed.emit(url)
+
+    @pyqtSlot()
+    def _on_load_started(self):
+        self._progress = 0
+        self._has_ssl_errors = False
+        self.data.viewing_source = False
+        self._set_load_status(usertypes.LoadStatus.loading)
+        self.load_started.emit()
+
+    def _handle_auto_insert_mode(self, ok):
+        """Handle auto-insert-mode after loading finished."""
+        if not config.get('input', 'auto-insert-mode') or not ok:
+            return
+
+        cur_mode = self._mode_manager.mode
+        if cur_mode == usertypes.KeyMode.insert:
+            return
+
+        def _auto_insert_mode_cb(elem):
+            """Called from JS after finding the focused element."""
+            if elem is None:
+                log.webview.debug("No focused element!")
+                return
+            if elem.is_editable():
+                modeman.enter(self.win_id, usertypes.KeyMode.insert,
+                              'load finished', only_if_normal=True)
+
+        self.elements.find_focused(_auto_insert_mode_cb)
+
+    @pyqtSlot(bool)
+    def _on_load_finished(self, ok):
+        sess_manager = objreg.get('session-manager')
+        sess_manager.save_autosave()
+
+        if ok and not self._has_ssl_errors:
+            if self.url().scheme() == 'https':
+                self._set_load_status(usertypes.LoadStatus.success_https)
+            else:
+                self._set_load_status(usertypes.LoadStatus.success)
+        elif ok:
+            self._set_load_status(usertypes.LoadStatus.warn)
+        else:
+            self._set_load_status(usertypes.LoadStatus.error)
+        self.load_finished.emit(ok)
+        if not self.title():
+            self.title_changed.emit(self.url().toDisplayString())
+        self._handle_auto_insert_mode(ok)
+
+    @pyqtSlot()
+    def _on_history_trigger(self):
+        """Emit add_history_item when triggered by backend-specific signal."""
+        raise NotImplementedError
+
+    @pyqtSlot(int)
+    def _on_load_progress(self, perc):
+        self._progress = perc
+        self.load_progress.emit(perc)
+
+    @pyqtSlot()
+    def _on_ssl_errors(self):
+        self._has_ssl_errors = True
+
+    def url(self, requested=False):
+        raise NotImplementedError
+
+    def progress(self):
+        return self._progress
+
+    def load_status(self):
+        return self._load_status
+
+    def _openurl_prepare(self, url):
+        qtutils.ensure_valid(url)
+        self.title_changed.emit(url.toDisplayString())
+
+    def openurl(self, url):
+        raise NotImplementedError
+
+    def reload(self, *, force=False):
+        raise NotImplementedError
+
+    def stop(self):
+        raise NotImplementedError
+
+    def clear_ssl_errors(self):
+        raise NotImplementedError
+
+    def dump_async(self, callback, *, plain=False):
+        """Dump the current page to a file ascync.
+
+        The given callback will be called with the result when dumping is
+        complete.
+        """
+        raise NotImplementedError
+
+    def run_js_async(self, code, callback=None, *, world=None):
+        """Run javascript async.
+
+        The given callback will be called with the result when running JS is
+        complete.
+
+        Args:
+            code: The javascript code to run.
+            callback: The callback to call with the result, or None.
+            world: A world ID (int or usertypes.JsWorld member) to run the JS
+                   in the main world or in another isolated world.
+        """
+        raise NotImplementedError
+
+    def shutdown(self):
+        raise NotImplementedError
+
+    def title(self):
+        raise NotImplementedError
+
+    def icon(self):
+        raise NotImplementedError
+
+    def set_html(self, html, base_url):
+        raise NotImplementedError
+
+    def networkaccessmanager(self):
+        """Get the QNetworkAccessManager for this tab.
+
+        This is only implemented for QtWebKit.
+        For QtWebEngine, always returns None.
+        """
+        raise NotImplementedError
+
+    def user_agent(self):
+        """Get the user agent for this tab.
+
+        This is only implemented for QtWebKit.
+        For QtWebEngine, always returns None.
+        """
+        raise NotImplementedError
+
+    def __repr__(self):
+        try:
+            url = utils.elide(self.url().toDisplayString(QUrl.EncodeUnicode),
+                              100)
+        except AttributeError:
+            url = '<AttributeError>'
+        return utils.get_repr(self, tab_id=self.tab_id, url=url)

qutebrowser/browser/downloadview.py

@@ -1,6 +1,6 @@
 # vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
 
-# Copyright 2014-2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# Copyright 2014-2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -39,8 +39,8 @@ def update_geometry(obj):
 
     Here we check if obj ("self") was deleted and just ignore the event if so.
 
-    Original bug:   https://github.com/The-Compiler/qutebrowser/issues/167
-    Workaround bug: https://github.com/The-Compiler/qutebrowser/issues/171
+    Original bug:   https://github.com/qutebrowser/qutebrowser/issues/167
+    Workaround bug: https://github.com/qutebrowser/qutebrowser/issues/171
     """
     def _update_geometry():
         """Actually update the geometry if the object still exists."""
@@ -64,8 +64,8 @@ class DownloadView(QListView):
 
     STYLESHEET = """
         QListView {
-            {{ color['downloads.bg.bar'] }}
-            {{ font['downloads'] }}
+            background-color: {{ color['downloads.bg.bar'] }};
+            font: {{ font['downloads'] }};
         }
 
         QListView::item {
@@ -79,10 +79,11 @@ class DownloadView(QListView):
         self.setResizeMode(QListView.Adjust)
         self.setVerticalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
         self.setSizePolicy(QSizePolicy.MinimumExpanding, QSizePolicy.Fixed)
+        self.setFocusPolicy(Qt.NoFocus)
         self.setFlow(QListView.LeftToRight)
         self.setSpacing(1)
         self._menu = None
-        model = objreg.get('download-manager', scope='window', window=win_id)
+        model = objreg.get('download-model', scope='window', window=win_id)
         model.rowsInserted.connect(functools.partial(update_geometry, self))
         model.rowsRemoved.connect(functools.partial(update_geometry, self))
         model.dataChanged.connect(functools.partial(update_geometry, self))
@@ -112,7 +113,7 @@ class DownloadView(QListView):
         item = self.model().data(index, downloads.ModelRole.item)
         if item.done and item.successful:
             item.open_file()
-            self.model().remove_item(item)
+            item.remove()
 
     def _get_menu_actions(self, item):
         """Get the available context menu actions for a given DownloadItem.
@@ -125,6 +126,7 @@ class DownloadView(QListView):
                 - (QAction, callable) tuples.
                 - (None, None) for a separator
         """
+        model = self.model()
         actions = []
         if item is None:
             pass
@@ -133,14 +135,12 @@ class DownloadView(QListView):
                 actions.append(("Open", item.open_file))
             else:
                 actions.append(("Retry", item.retry))
-            actions.append(("Remove",
-                            functools.partial(self.model().remove_item, item)))
+            actions.append(("Remove", item.remove))
         else:
             actions.append(("Cancel", item.cancel))
-        if self.model().can_clear():
+        if model.can_clear():
             actions.append((None, None))
-            actions.append(("Remove all finished", functools.partial(
-                self.model().download_remove, True)))
+            actions.append(("Remove all finished", model.download_clear))
         return actions
 
     @pyqtSlot('QPoint')

qutebrowser/browser/history.py

@@ -1,6 +1,6 @@
 # vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
 
-# Copyright 2015 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# Copyright 2015-2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -22,86 +22,140 @@
 import time
 import collections
 
-from PyQt5.QtCore import pyqtSignal, QUrl
-from PyQt5.QtWebKit import QWebHistoryInterface
+from PyQt5.QtCore import pyqtSignal, pyqtSlot, QUrl, QObject
 
-from qutebrowser.utils import utils, objreg, standarddir, log
+from qutebrowser.commands import cmdutils
+from qutebrowser.utils import (utils, objreg, standarddir, log, qtutils,
+                               usertypes, message)
 from qutebrowser.config import config
-from qutebrowser.misc import lineparser
+from qutebrowser.misc import lineparser, objects
 
 
-class HistoryEntry:
+class Entry:
 
     """A single entry in the web history.
 
     Attributes:
         atime: The time the page was accessed.
         url: The URL which was accessed as QUrl.
-        url_string: The URL which was accessed as string.
+        redirect: If True, don't save this entry to disk
     """
 
-    def __init__(self, atime, url):
+    def __init__(self, atime, url, title, redirect=False):
         self.atime = float(atime)
-        self.url = QUrl(url)
-        self.url_string = url
+        self.url = url
+        self.title = title
+        self.redirect = redirect
+        qtutils.ensure_valid(url)
 
     def __repr__(self):
         return utils.get_repr(self, constructor=True, atime=self.atime,
-                              url=self.url.toDisplayString())
+                              url=self.url_str(), title=self.title,
+                              redirect=self.redirect)
 
     def __str__(self):
-        return '{} {}'.format(int(self.atime), self.url_string)
+        atime = str(int(self.atime))
+        if self.redirect:
+            atime += '-r'  # redirect flag
+        elems = [atime, self.url_str()]
+        if self.title:
+            elems.append(self.title)
+        return ' '.join(elems)
+
+    def __eq__(self, other):
+        return (self.atime == other.atime and
+                self.title == other.title and
+                self.url == other.url and
+                self.redirect == other.redirect)
+
+    def url_str(self):
+        """Get the URL as a lossless string."""
+        return self.url.toString(QUrl.FullyEncoded | QUrl.RemovePassword)
 
     @classmethod
-    def from_str(cls, s):
-        """Get a history based on a 'TIME URL' string."""
-        return cls(*s.split(' ', maxsplit=1))
+    def from_str(cls, line):
+        """Parse a history line like '12345 http://example.com title'."""
+        data = line.split(maxsplit=2)
+        if len(data) == 2:
+            atime, url = data
+            title = ""
+        elif len(data) == 3:
+            atime, url, title = data
+        else:
+            raise ValueError("2 or 3 fields expected")
+
+        url = QUrl(url)
+        if not url.isValid():
+            raise ValueError("Invalid URL: {}".format(url.errorString()))
+
+        # https://github.com/qutebrowser/qutebrowser/issues/670
+        atime = atime.lstrip('\0')
+
+        if '-' in atime:
+            atime, flags = atime.split('-')
+        else:
+            flags = ''
+
+        if not set(flags).issubset('r'):
+            raise ValueError("Invalid flags {!r}".format(flags))
+
+        redirect = 'r' in flags
+
+        return cls(atime, url, title, redirect=redirect)
 
 
-class WebHistory(QWebHistoryInterface):
+class WebHistory(QObject):
 
-    """A QWebHistoryInterface which supports being written to disk.
+    """The global history of visited pages.
+
+    This is a little more complex as you'd expect so the history can be read
+    from disk async while new history is already arriving.
+
+    self.history_dict is the main place where the history is stored, in an
+    OrderedDict (sorted by time) of URL strings mapped to Entry objects.
+
+    While reading from disk is still ongoing, the history is saved in
+    self._temp_history instead, and then appended to self.history_dict once
+    that's fully populated.
+
+    All history which is new in this session (rather than read from disk from a
+    previous browsing session) is also stored in self._new_history.
+    self._saved_count tracks how many of those entries were already written to
+    disk, so we can always append to the existing data.
 
     Attributes:
+        history_dict: An OrderedDict of URLs read from the on-disk history.
         _lineparser: The AppendLineParser used to save the history.
-        _history_dict: An OrderedDict of URLs read from the on-disk history.
-        _new_history: A list of HistoryEntry items of the current session.
+        _new_history: A list of Entry items of the current session.
         _saved_count: How many HistoryEntries have been written to disk.
+        _initial_read_started: Whether async_read was called.
+        _initial_read_done: Whether async_read has completed.
+        _temp_history: OrderedDict of temporary history entries before
+                       async_read was called.
 
     Signals:
-        item_about_to_be_added: Emitted before a new HistoryEntry is added.
-                                arg: The new HistoryEntry.
-        item_added: Emitted after a new HistoryEntry is added.
-                    arg: The new HistoryEntry.
+        add_completion_item: Emitted before a new Entry is added.
+                             Used to sync with the completion.
+                             arg: The new Entry.
+        item_added: Emitted after a new Entry is added.
+                    Used to tell the savemanager that the history is dirty.
+                    arg: The new Entry.
+        cleared: Emitted after the history is cleared.
     """
 
-    item_about_to_be_added = pyqtSignal(HistoryEntry)
-    item_added = pyqtSignal(HistoryEntry)
+    add_completion_item = pyqtSignal(Entry)
+    item_added = pyqtSignal(Entry)
+    cleared = pyqtSignal()
+    async_read_done = pyqtSignal()
 
-    def __init__(self, parent=None):
+    def __init__(self, hist_dir, hist_name, parent=None):
         super().__init__(parent)
-        self._lineparser = lineparser.AppendLineParser(
-            standarddir.data(), 'history', parent=self)
-        self._history_dict = collections.OrderedDict()
-        with self._lineparser.open():
-            for line in self._lineparser:
-                data = line.rstrip().split(maxsplit=1)
-                if not data:
-                    # empty line
-                    continue
-                elif len(data) != 2:
-                    # other malformed line
-                    log.init.warning("Invalid history entry {!r}!".format(
-                        line))
-                    continue
-                atime, url = data
-                # This de-duplicates history entries; only the latest
-                # entry for each URL is kept. If you want to keep
-                # information about previous hits change the items in
-                # old_urls to be lists or change HistoryEntry to have a
-                # list of atimes.
-                self._history_dict[url] = HistoryEntry(atime, url)
-                self._history_dict.move_to_end(url)
+        self._initial_read_started = False
+        self._initial_read_done = False
+        self._lineparser = lineparser.AppendLineParser(hist_dir, hist_name,
+                                                       parent=self)
+        self.history_dict = collections.OrderedDict()
+        self._temp_history = collections.OrderedDict()
         self._new_history = []
         self._saved_count = 0
         objreg.get('save-manager').add_saveable(
@@ -110,14 +164,58 @@ class WebHistory(QWebHistoryInterface):
     def __repr__(self):
         return utils.get_repr(self, length=len(self))
 
-    def __getitem__(self, key):
-        return self._new_history[key]
-
     def __iter__(self):
-        return iter(self._history_dict.values())
+        return iter(self.history_dict.values())
 
     def __len__(self):
-        return len(self._history_dict)
+        return len(self.history_dict)
+
+    def async_read(self):
+        """Read the initial history."""
+        if self._initial_read_started:
+            log.init.debug("Ignoring async_read() because reading is started.")
+            return
+        self._initial_read_started = True
+
+        with self._lineparser.open():
+            for line in self._lineparser:
+                yield
+
+                line = line.rstrip()
+                if not line:
+                    continue
+
+                try:
+                    entry = Entry.from_str(line)
+                except ValueError as e:
+                    log.init.warning("Invalid history entry {!r}: {}!".format(
+                        line, e))
+                    continue
+
+                # This de-duplicates history entries; only the latest
+                # entry for each URL is kept. If you want to keep
+                # information about previous hits change the items in
+                # old_urls to be lists or change Entry to have a
+                # list of atimes.
+                self._add_entry(entry)
+
+        self._initial_read_done = True
+        self.async_read_done.emit()
+
+        for entry in self._temp_history.values():
+            self._add_entry(entry)
+            self._new_history.append(entry)
+            if not entry.redirect:
+                self.add_completion_item.emit(entry)
+        self._temp_history.clear()
+
+    def _add_entry(self, entry, target=None):
+        """Add an entry to self.history_dict or another given OrderedDict."""
+        if target is None:
+            target = self.history_dict
+        url_str = entry.url_str()
+        target[url_str] = entry
+        target.move_to_end(url_str)
 
     def get_recent(self):
         """Get the most recent history entries."""
@@ -131,32 +229,68 @@ class WebHistory(QWebHistoryInterface):
         self._lineparser.save()
         self._saved_count = len(self._new_history)
 
-    def addHistoryEntry(self, url_string):
-        """Called by WebKit when an URL should be added to the history.
+    @cmdutils.register(name='history-clear', instance='web-history')
+    def clear(self, force=False):
+        """Clear all browsing history.
+
+        Note this only clears the global history
+        (e.g. `~/.local/share/qutebrowser/history` on Linux) but not cookies,
+        the back/forward history of a tab, cache or other persistent data.
 
         Args:
-            url_string: An url as string to add to the history.
+            force: Don't ask for confirmation.
         """
-        if not url_string:
+        if force:
+            self._do_clear()
+        else:
+            message.confirm_async(self._do_clear, title="Clear all browsing "
+                                "history?")
+
+    def _do_clear(self):
+        self._lineparser.clear()
+        self.history_dict.clear()
+        self._temp_history.clear()
+        self._new_history.clear()
+        self._saved_count = 0
+        self.cleared.emit()
+
+    @pyqtSlot(QUrl, QUrl, str)
+    def add_from_tab(self, url, requested_url, title):
+        """Add a new history entry as slot, called from a BrowserTab."""
+        no_formatting = QUrl.UrlFormattingOption(0)
+        if (requested_url.isValid() and
+                not requested_url.matches(url, no_formatting)):
+            # If the url of the page is different than the url of the link
+            # originally clicked, save them both.
+            self.add_url(requested_url, title, redirect=True)
+        self.add_url(url, title)
+
+    def add_url(self, url, title="", *, redirect=False, atime=None):
+        """Called via add_from_tab when a URL should be added to the history.
+
+        Args:
+            url: A url (as QUrl) to add to the history.
+            redirect: Whether the entry was redirected to another URL
+                      (hidden in completion)
+            atime: Override the atime used to add the entry
+        """
+        if config.get('general', 'private-browsing'):
             return
-        if not config.get('general', 'private-browsing'):
-            entry = HistoryEntry(time.time(), url_string)
-            self.item_about_to_be_added.emit(entry)
+        if not url.isValid():
+            log.misc.warning("Ignoring invalid URL being added to history")
+            return
+
+        if atime is None:
+            atime = time.time()
+        entry = Entry(atime, url, title, redirect=redirect)
+        if self._initial_read_done:
+            self._add_entry(entry)
             self._new_history.append(entry)
-            self._history_dict[url_string] = entry
-            self._history_dict.move_to_end(url_string)
             self.item_added.emit(entry)
-
-    def historyContains(self, url_string):
-        """Called by WebKit to determine if an URL is contained in the history.
-
-        Args:
-            url_string: The URL (as string) to check for.
-
-        Return:
-            True if the url is in the history, False otherwise.
-        """
-        return url_string in self._history_dict
+            if not entry.redirect:
+                self.add_completion_item.emit(entry)
+        else:
+            self._add_entry(entry, target=self._temp_history)
 
 
 def init(parent=None):
@@ -165,6 +299,10 @@ def init(parent=None):
     Args:
         parent: The parent to use for WebHistory.
     """
-    history = WebHistory(parent)
+    history = WebHistory(hist_dir=standarddir.data(), hist_name='history',
+                         parent=parent)
     objreg.register('web-history', history)
-    QWebHistoryInterface.setDefaultInterface(history)
+
+    if objects.backend == usertypes.Backend.QtWebKit:
+        from qutebrowser.browser.webkit import webkithistory
+        webkithistory.init(history)