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

@@ -0,0 +1,18 @@
+[run]
+source = qutebrowser
+branch = true
+omit =
+    qutebrowser/__main__.py
+    */__init__.py
+    qutebrowser/resources.py
+
+[report]
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    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,19 +1,47 @@
-# vim: ft=dosini fileencoding=utf-8:
-
 [flake8]
-# E241: Multiple spaces after ,
+exclude = .*,__pycache__,resources.py
+# E128: continuation line under-indented for visual indent
+# E226: missing whitespace around arithmetic operator
 # E265: Block comment should start with '#'
-# checked by pylint:
-# F401: Unused import
 # E501: Line too long
-# F821: undefined name
-# F841: unused variable
-# E222: Multiple spaces after operator
-# F811: Redifiniton
-# W292: No newline at end of file
-# E701: multiple statements on one line
-# E702: multiple statements on one line
-# E225: missing whitespace around operator
-ignore=E241,E265,F401,E501,F821,F841,E222,F811,W292,E701,E702,E225
-max_complexity = 12
-exclude = ez_setup.py
+# E402: module level import not at top of file
+# E266: too many leading '#' for block comment
+# 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,33 @@ __pycache__
 /setuptools-*.egg
 /setuptools-*.zip
 /qutebrowser/git-commit-id
+/qutebrowser/3rdparty
 /doc/*.html
 /README.html
+/CHANGELOG.html
+/CONTRIBUTING.html
+/FAQ.html
+/INSTALL.html
 /qutebrowser/html/doc/
+/.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

@@ -1,44 +1,59 @@
 # vim: ft=dosini fileencoding=utf-8:
 
 [MASTER]
-ignore=ez_setup.py
+ignore=resources.py
+extension-pkg-whitelist=PyQt5,sip
+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,
-        super-on-old-class,
-        old-style-class,
-        abstract-class-little-used,
-        bad-builtin,
-        star-args,
         fixme,
         global-statement,
-        no-init,
         locally-disabled,
+        locally-enabled,
         too-many-ancestors,
         too-few-public-methods,
         too-many-public-methods,
         cyclic-import,
-        bad-option-value,
         bad-continuation,
         too-many-instance-attributes,
-        unnecessary-lambda,
         blacklisted-name,
-        too-many-lines
+        too-many-lines,
+        logging-format-interpolation,
+        broad-except,
+        bare-except,
+        eval-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=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
@@ -46,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

.run_checks

@@ -1,20 +0,0 @@
-# vim: ft=dosini
-
-[DEFAULT]
-targets=qutebrowser,scripts
-
-[pep257]
-# D102: Docstring missing, will be handled by others
-# D209: Blank line before closing """ (removed from PEP257)
-# D402: First line should not be function's signature (false-positives)
-disable=D102,D209,D402
-exclude=test_.*
-
-[pylint]
-args=--output-format=colorized,--reports=no,--rcfile=.pylintrc
-plugins=config,crlf,modeline,settrace,openencoding
-exclude=resources.py
-
-[flake8]
-args=--config=.flake8
-exclude=resources.py

.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}"

CONTRIBUTING.asciidoc

@@ -1,5 +1,5 @@
-qutebrowser HACKING
-===================
+Contributing to qutebrowser
+===========================
 The Compiler <mail@qutebrowser.org>
 :icons:
 :data-uri:
@@ -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,19 +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/milestones/v0.1[Open issues for
-the v0.1 release]
-* 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.).
 
@@ -57,24 +55,29 @@ qutebrowser uses http://git-scm.com/[git] for its development. You can clone
 the repo like this:
 
 ----
-git clone git://the-compiler.org/qutebrowser
+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
 ~~~~~~~~~~~~~~~
 
-After you finished your work and did `git commit`, you can get patches of your
-changes like this:
+The preferred way of submitting changes is to
+https://help.github.com/articles/fork-a-repo/[fork the repository] and to
+https://help.github.com/articles/creating-a-pull-request/[submit a pull
+request].
+
+If you prefer to send a patch to the mailinglist, you can generate a patch
+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
@@ -83,37 +86,49 @@ Useful utilities
 Checkers
 ~~~~~~~~
 
-In the _scripts/_ subfolder, there is a `run_checks.py` script.
+qutebrowser uses http://tox.readthedocs.org/en/latest/[tox] to run its
+unittests and several linters/checkers.
 
-It runs a bunch of static checks on all source files, using the following
-checkers:
+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/1.3.1[flake8]
-* https://github.com/GreenSteam/pep257/[pep257]
-* http://pylint.org/[pylint]
-* A custom checker 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
 
-If you changed `setup.py` or `MANIFEST.in`, add the `--setup` argument to run
-the following additional checkers:
+The default test suite is run with `tox`; the list of default
+environments is obtained with `tox -l`.
 
-* https://pypi.python.org/pypi/pyroma/0.9.3[pyroma]
-* https://github.com/mgedmin/check-manifest[check-manifest]
+Please make sure the checks run without any warnings on your new contributions.
 
-It needs all the checkers to be installed and also needs
-https://pypi.python.org/pypi/colorama/[colorama].
-
-Please make sure this script runs without any warnings on your new
-contributions. There's of course the possibility of false-positives, and the
-following techniques are useful to handle these:
+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
@@ -125,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.
 
@@ -156,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]
@@ -169,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:
 
@@ -214,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]
@@ -231,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
@@ -282,7 +324,7 @@ There are currently these object registries, also called 'scopes':
 `cookie-jar`, etc.)
 * The `tab` scope with objects which are per-tab (`hintmanager`, `webview`,
 etc.). Passing this scope to `objreg.get()` selects the object in the currently
-focused tab by default. A tab can be explicitely selected by passing
+focused tab by default. A tab can be explicitly selected by passing
 +tab=_tab-id_, window=_win-id_+ to it.
 
 A new object can be registered by using
@@ -296,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
 ~~~~~~~
@@ -307,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
@@ -331,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.
@@ -369,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 behaviour 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
@@ -416,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.
@@ -436,6 +501,51 @@ displaying it to the user.
 `QUrl` and take appropriate action if not. Note the URL of the current page
 always could be an invalid QUrl (if nothing is loaded yet).
 
+Running valgrind on QtWebKit
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to run qutebrowser (and thus QtWebKit) with
+http://valgrind.org/[valgrind], you'll need to pass `--smc-check=all` to it or
+recompile QtWebKit with the Javascript JIT disabled.
+
+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 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.
+
+...
+
+Note that the default option will catch the vast majority of cases. The main
+case it will not catch is programs such as JIT compilers that dynamically
+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
 -----------------
@@ -505,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
@@ -521,42 +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.
-* Build developer packages.
-* Build non-developer symbol packages.
-* Upload symbols patch to http://www.qutebrowser.org/qt-symbols.patch
-* Upload symbols packages to http://www.qutebrowser.org/qt-symbols-pkg/
+* Update own PKGBUILDs based on upstream Archlinux updates and rebuild.
 * Update recommended Qt version in `README`
-* Update OS X instructions in `README`
-* Make sure Gentoo instructions are up to date.
 * Grep for `WORKAROUND` in the code and test if fixed stuff works without the
 workaround.
+* Check relevant
+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.1" -m "Release v0.1"`)
-* Create git branch `v0.1.x`
-* Push including `--tags`
+* 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`
-* Maybe upload to http://qt-apps.org/
-* Upload to webpage with checksum/GPG (when/if it exists)
-
-* Announce to qutebrowser mailinglist
-* Maybe annouce at other places?
+* 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,21 +1,22 @@
 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
-keybindings are similar to dwb.
+key bindings are similar to dwb.
 
 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.
@@ -75,6 +75,55 @@ Is there an adblocker?::
     usage], so implementing it properly might take some time and won't be done
     for v0.1 if at all.
 
+How do I play Youtube videos with mpv?::
+    You can easily add a key binding to play youtube videos inside a real video
+    player - optionally even with hinting for links:
++
+----
+: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
 
 Configuration not saved after modifying config.::
@@ -91,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.::
@@ -103,15 +152,22 @@ 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
+70 important bugs] have been fixed in QtWebKit. For Debian Jessie (using Qt 5.3.2)
+it's still
+https://bugreports.qt.io/browse/QTBUG-42417?jql=component%20%3D%20WebKit%20and%20resolution%20%3D%20Done%20and%20fixVersion%20in%20(5.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)[nearly
+20 important bugs].
 
 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

@@ -0,0 +1,356 @@
+Installing qutebrowser
+======================
+
+On Debian / Ubuntu
+------------------
+
+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 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-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 source-highlight
+$ python3 scripts/asciidoc2html.py
+----
+
+If video or sound don't seem to work, try installing the gstreamer plugins:
+
+----
+# apt-get install gstreamer1.0-plugins-{bad,base,good,ugly}
+----
+
+Then <<tox,install qutebrowser via tox>>.
+
+On Fedora
+---------
+
+qutebrowser is available in the official repositories for Fedora 22 and newer.
+
+----
+# dnf install qutebrowser
+----
+
+On Archlinux
+------------
+
+qutebrowser is available in the official [community] repository.
+
+----
+# 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
+---------
+
+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
+-------------
+
+qutebrowser is available in the official repositories and can be installed
+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
+----------
+
+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).
+* Use the installer from
+http://www.riverbankcomputing.com/software/pyqt/download5[Riverbank computing]
+to get Qt and PyQt5.
+* Install https://testrun.org/tox/latest/index.html[tox] via
+https://pip.pypa.io/en/latest/[pip]:
+
+----
+$ pip install tox
+----
+
+Then <<tox,install qutebrowser via tox>>.
+
+On OS X
+-------
+
+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 cask install qutebrowser
+----
+
+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
+
+----
+$ brew install qt5
+$ pip3 install 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
+---------
+
+There are example .desktop and icon files provided. They would go in the
+standard location for your distro (`/usr/share/applications` and
+`/usr/share/pixmaps` for example).
+
+The normal `setup.py install` doesn't install these files, so you'll have to do
+it as part of the packaging process.
+
+[[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
+code. However, if dependencies got added, this won't be reflected in the
+virtualenv. Thus it's recommended to run the following command to recreate the
+virtualenv:
+
+----
+$ tox -r -e mkvenv
+----

MANIFEST.in

@@ -1,17 +1,49 @@
-recursive-include qutebrowser/html *.html
-recursive-include qutebrowser/test *.py
-recursive-include icons *
-include qutebrowser/test/testfile
-include qutebrowser/git-commit-id
-include COPYING doc/* README.asciidoc
-include qutebrowser.desktop
-
-exclude scripts/run_checks.py
-exclude scripts/cleanup.py
-exclude scripts/minimal_webkit_testbrowser.py
-exclude scripts/run_profile.py
-exclude scripts/generate_authors.sh
-exclude .flake8
-exclude .pylintrc
-exclude doc/notes
-prune pkg
+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,35 +1,45 @@
 // 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[] _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.*
 
-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.
+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://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"]
+
+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.
 
 Screenshots
 -----------
 
-image:doc/img/main.png[width=300,link="doc/img/main.png"]
-image:doc/img/downloads.png[width=300,link="doc/img/downloads.png"]
-image:doc/img/completion.png[width=300,link="doc/img/completion.png"]
-image:doc/img/hints.png[width=300,link="doc/img/hints.png"]
+image:doc/img/main.png["screenshot 1",width=300,link="doc/img/main.png"]
+image:doc/img/downloads.png["screenshot 2",width=300,link="doc/img/downloads.png"]
+image:doc/img/completion.png["screenshot 3",width=300,link="doc/img/completion.png"]
+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).
 
-See link:doc/INSTALL.asciidoc[INSTALL] for detailed instructions on how to get
+See link:INSTALL.asciidoc[INSTALL] for detailed instructions on how to get
 qutebrowser running for various platforms.
 
 Documentation
@@ -38,13 +48,16 @@ Documentation
 In addition to the topics mentioned in this README, the following documents are
 available:
 
-* A http://qutebrowser.org/img/cheatsheet-big.png[keybinding cheatsheet]: +
-image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser keybinding 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]
-* link:doc/FAQ.asciidoc[Frequently asked questions]
-* link:doc/HACKING.asciidoc[HACKING]
-* link:doc/INSTALL.asciidoc[INSTALL]
+* 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]
+* link:CHANGELOG.asciidoc[Change Log]
 * link:doc/stacktrace.asciidoc[Reporting segfaults]
+* link:doc/userscripts.asciidoc[How to write userscripts]
 
 Getting help
 ------------
@@ -57,11 +70,15 @@ 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/HACKING.asciidoc[HACKING] for details and useful hints.
+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
 ways:
@@ -73,34 +90,36 @@ 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 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.3.2 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:
+On Windows, https://pypi.python.org/pypi/colorama/[colorama] is needed to
+display colored log output.
 
-* https://pypi.python.org/pypi/colorlog/[colorlog]
-* On Windows: https://pypi.python.org/pypi/colorama/[colorama]
-
-See link:doc/INSTALL.asciidoc[INSTALL] for directions on how to install
-qutebrowser and its dependencies.
+See link:INSTALL.asciidoc[INSTALL] for directions on how to install qutebrowser
+and its dependencies.
 
 Donating
 --------
@@ -125,27 +144,155 @@ Contributors, sorted by the number of commits in descending order:
 
 // QUTE_AUTHORS_START
 * Florian Bruhin
-* Claude
-* John ShaggyTwoDope Jenkins
-* rikn00
-* Brian Jackson
-* Martin Zimmermann
-* Mathias Fussenegger
-* Larry Hynes
-* Johannes Altmanninger
+* Daniel Schadt
+* Ryan Roden-Corrent
+* Jan Verbeek
+* Jakub Klinkovský
+* Antoni Boucher
+* Lamar Pavel
+* Marshall Lochbaum
+* Bruno Oliveira
+* Alexander Cogneau
+* Felix Van der Jeugt
+* Daniel Karbach
+* Martin Tournoij
+* Kevin Velghe
+* Raphael Pierzina
 * Joel Torstensson
-* Regina Hug
+* 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
+* 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
+* 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
+* 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)
-* regines (keybinding cheatsheet)
+* 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:
 
@@ -186,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.
@@ -208,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/INSTALL.asciidoc

@@ -1,142 +0,0 @@
-Installing qutebrowser
-======================
-
-On Debian / Ubuntu
-------------------
-
-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)
-
-Install the dependencies via apt-get:
-
-----
-# apt-get install python3-pyqt5 python3-pyqt5.qtwebkit python-virtualenv
-----
-
-To generate the documentation for the `:help` command, when using the git
-repository (rather than a release):
-
-----
-# apt-get install asciidoc
-# python3 scripts/asciidoc2html.py
-----
-
-Then run the supplied script to run qutebrowser inside a
-https://virtualenv.pypa.io/en/latest/virtualenv.html[virtualenv]:
-
-----
-# python3 scripts/init_venv.py
-----
-
-This installs all needed Python dependencies in a `.venv` subfolder. The
-system-wide Qt5/PyQt5 installations are symlinked into the virtualenv.
-
-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
-----
-
-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:
-
-----
-$ mkdir qutebrowser
-$ cd qutebrowser
-$ wget https://aur.archlinux.org/packages/qu/qutebrowser-git/PKGBUILD
-$ makepkg -si
-----
-
-or you could use an AUR helper, e.g. `yaourt -S qutebrowser-git`.
-
-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]:
-
-----
-# wget https://raw.githubusercontent.com/posativ/qutebrowser-overlay/master/overlays.xml -O /etc/layman/overlays/qutebrowser.xml
-# 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:
-
-----
-# emerge -av 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:
-
-* Use the installer from http://www.python.org/downloads[python.org] to get
-Python 3 (be sure to install pip).
-* Use the installer from
-http://www.riverbankcomputing.com/software/pyqt/download5[Riverbank computing]
-to get Qt and PyQt5.
-* Run `pip install virtualenv` or
-http://www.lfd.uci.edu/~gohlke/pythonlibs/#virtualenv[the installer from here]
-to install virtualenv.
-
-Then run the supplied script to run qutebrowser inside a
-https://virtualenv.pypa.io/en/latest/virtualenv.html[virtualenv]:
-
-----
-# python3 scripts/init_venv.py
-----
-
-This installs all needed Python dependencies in a `.venv` subfolder. The
-system-wide Qt5/PyQt5 installations are used in the virtualenv.
-
-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.
-
-----
-$ brew install python3 pyqt5
-$ pip3.4 install qutebrowser
-----
-
-if you are using Homebrew. For MacPorts, run:
-
-----
-$ sudo port install python34 py34-jinja2 asciidoc py34-pygments py34-pyqt5
-$ sudo pip3.4 install qutebrowser
-----
-
-The preferences for qutebrowser are stored in
-`~/Library/Preferences/qutebrowser`, the application data is stored in
-`~/Library/Application Support/qutebrowser`.
-
-Packagers
----------
-
-There are example .desktop and icon files provided. They would go in the
-standard location for your distro (`/usr/share/applications` and
-`/usr/share/pixmaps` for example).
-
-The normal `setup.py install` doesn't install these files, so you'll have to do
-it as part of the packaging process.

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,10 +6,13 @@ Documentation
 
 The following help pages are currently available:
 
-* link:quickstart.html[Quick start guide]
-* link:FAQ.html[Frequently asked questions]
+* 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:../../CONTRIBUTING.html[Contributing to qutebrowser]
 
 Getting help
 ------------

doc/notes

@@ -80,3 +80,117 @@ some cases passing the url to some cli program).
 I've also noticed the lack of completion. For example, on "o" pentadactyl will
 show sites (e.g. from history) that can be completed. I think I've been spoiled
 by pentadactyl having completion for just about everything.
+
+
+suckless surf ML post
+=====================
+
+From: Ben Woolley <tautolog_AT_gmail.com>
+Date: Wed, 7 Jan 2015 18:29:25 -0800
+
+Hi all,
+
+This patch is a bit of a beast for surf. It is intended to be applied after
+the disk cache patch. It breaks some internal interfaces, so it could
+conflict with other patches.
+
+I have been wanting a browser to implement a complete same-origin policy,
+and have been investigating how to do this in various browsers for many
+months. When I saw how surf opened new windows in a separate process, and
+was so simple, I knew I could do it quickly. Over the last two weeks, I
+have been developing this implementation on surf.
+
+The basic idea is to prevent browser-based tracking as you browse from site
+to site, or origin to origin. By "origin" domain, I mean the "first-party"
+domain, the domain normally in the location bar (of the typical browser
+interface). Each origin domain effectively gets its own browser profile,
+and a browser process only ever deals with one origin domain at a time.
+This isolates origins vertically, preventing cookies, disk cache, memory
+cache, and window.name vulnerabilities. Basically, all known
+vulnerabilities that google and Mozilla cite as counter-examples when they
+explain why they haven't disabled third-party cookies yet.
+
+When you are on msnbc.com, the tracking pixels will be stored in a cookie
+file for msnbc.com. When you go to cnn.com, the tracking pixels will be
+stored in a cookie file for cnn.com. You will not be tracked between them.
+However, third-party cookies, and the caching of third party resources will
+still work, but they will be isolated between origin domains. Instead of
+blocking cookies and cache entries, they are "double-keyed", or *also*
+keyed by origin.
+
+There is a unidirectional communication channel, however, from one origin
+to the next, through navigation from one origin to the next. That is, the
+query string is passed from one origin to the next, and may embed
+identifiers. One example is an affiliate link that identifies where the
+lead came from. I have implemented what I call "horizontal isolation", in
+the form of an "Origin Crossing Gate".
+
+Whenever you follow a link to a new domain, or even are just redirected to
+a new domain, a new window/tab is opened, and passed the referring origin
+via -R. The page passed to -O, for example -O originprompt.html, is an HTML
+page that is loaded in the new origin's context. That page tells you the
+origin you were on, the new origin, and the full link, and you can decide
+to go just to the new origin, or go to the full URL, after reviewing it for
+tracking data.
+
+Also, you may click links that store your trust of that relationship with
+various expiration times, the same way you would trust geolocation requests
+for a particular origin for a period of time. The database used is actually
+the new origin's cookie file. Since the origin prompt is loaded in the new
+origin's context, I can set a cookie on behalf of the new origin. The
+expiration time of the trust is the expiration time of the cookie. The
+cookie implementation in webkit automatically expires the trust as part of
+how cookies work. Each time you cross an origin, the origin crossing page
+checks the cookie to see if trust is still established. If so, it will use
+window.location.replace() to continue on automatically. The initial page
+renders blank until the trust is invalidated, in which case the content of
+the gate is made visible.
+
+However, the new origin is technically able to mess with those cookies, so
+a website could set trust for an origin crossing. I have addressed that by
+hashing the key with a salt, and setting the real expiration time as the
+value, along with an HMAC to verify the contents of the value. If the
+cookie is messed with in any way, the trust will be disabled, and the
+prompt will appear again. So it has a fail-safe function.
+
+I know it seems a bit convoluted, but it just started out as a nice little
+rabbit hole, and I just wanted to get something workable. At first I
+thought using the cookie expiration time was convenient, but then when I
+realized that I needed to protect the cookie, things got a bit hairy. But
+it works.
+
+Each profile is, by default, stored in ~/.surf/origins/$origin/
+The interesting side effect is that if there is a problem where a website
+relies on the cross-site cookie vulnerability to make a connection, you can
+simply make a symbolic link from one origin folder to another, and they
+will share the same profile. And if you want to delete cookies and/or cache
+for a particular origin, you just rm -rf the origin's profile folder, and
+don't have to interfere with your other sites that are working just fine.
+
+One thing I don't handle are cross-origins POSTs. They just end up as GET
+requests right now. I intend to do something about that, but I haven't
+figured that out yet.
+
+I have only been using this functionality for a few days myself, so I have
+absolutely no feedback yet. I wanted to provide the first implementation of
+the management of identity as a system resource the same way that things
+like geolocation, camera, and microphone resources are managed in browsers
+and mobile apps.
+
+Currently, Mozilla and Tor have are working on third-party tracking issues
+in Firefox.
+https://blog.mozilla.org/privacy/2014/11/10/introducing-polaris-privacy-initiative-to-accelerate-user-focused-privacy-online/
+
+Up to this point, Tor has provided a patch that double-keys cookies with
+the origin domain, but no other progress is visible. I have seen no
+discussion of how horizontal isolation is supposed to happen, and I wanted
+to show people that it can be done, and this is one way it can be done, and
+to compel the other browser makers to catch up, and hopefully the community
+can work toward a standard *without* the tracking loopholes, by showing
+people what a *complete* solution looks like.
+
+Thank you,
+
+Ben Woolley
+
+Patch: http://lists.suckless.org/dev/att-25070/0005-same-origin-policy.patch

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[keybinding cheatsheet]
-to make yourself familiar with the keybindings: +
-image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser keybinding cheatsheet",link="http://qutebrowser.org/img/cheatsheet-big.png"]
+* 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,20 +7,24 @@
 :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.
 
+Note the commands and settings of qutebrowser are not described in this
+manpage, but in the help integrated in qutebrowser - use the ":help" command to
+show it.
+
 == OPTIONS
 // QUTE_OPTIONS_START
 === positional arguments
@@ -34,14 +38,32 @@ It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.
 *-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.
 
+*-s* 'SECTION' 'OPTION' 'VALUE', *--set* 'SECTION' 'OPTION' 'VALUE'::
+    Set a temporary setting for this session.
+
+*-r* 'SESSION', *--restore* 'SESSION'::
+    Restore a named session.
+
+*-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'::
@@ -53,47 +75,59 @@ It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.
 *--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.
 
+*--relaxed-config*::
+    Silently remove unknown config options.
+
 *--nowindow*::
     Don't show the main window.
 
 *--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-style* 'STYLE'::
-    Set the Qt GUI style to use.
+*--temp-basedir*::
+    Use a temporary basedir.
 
-*--qt-stylesheet* 'STYLESHEET'::
-    Override the Qt application stylesheet.
+*--no-err-windows*::
+    Don't show any error windows (used for tests/smoke.py).
 
-*--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-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-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
 
 - '~/.config/qutebrowser/qutebrowser.conf': Main config file.
 - '~/.config/qutebrowser/quickmarks': Saved quickmarks.
-- '~/.config/qutebrowser/keys.conf': Defined keybindings.
-- '~/.local/share/qutebrowser/': Various state information
+- '~/.config/qutebrowser/keys.conf': Defined key bindings.
+- '~/.local/share/qutebrowser/': Various state information.
+- '~/.cache/qutebrowser/': Temporary data.
+
+Note qutebrowser conforms to the XDG basedir specification - if
+'XDG_CONFIG_HOME', 'XDG_DATA_HOME' or 'XDG_CACHE_HOME' are set in the
+environment, the directories configured there are used instead of the above
+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.
@@ -103,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
@@ -119,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

@@ -1,5 +1,6 @@
 Getting stacktraces on crashes
 ==============================
+:toc:
 The Compiler <mail@qutebrowser.org>
 
 When there is a fatal crash in qutebrowser - most of the times a
@@ -14,10 +15,17 @@ https://en.wikipedia.org/wiki/Debug_symbol[debugging symbols] is required.
 The rest of this guide is quite Linux specific, though there is a
 <<windows,section for Windows>> at the end.
 
-Getting debugging symbols
--------------------------
+Crashes which can be reproduced
+-------------------------------
 
-.Debian/Ubuntu/...
+If a crash can be reproduced, packages with debugging symbols should be
+installed, and the crash should be reproduced under gdb.
+
+Getting debugging symbols
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Debian/Ubuntu/...
+^^^^^^^^^^^^^^^^^
 
 For Debian based systems (Debian, Ubuntu, Linux Mint, ...), debug information
 is available in the repositories:
@@ -26,76 +34,71 @@ is available in the repositories:
 # apt-get install python3-pyqt5-dbg python3-pyqt5.qtwebkit-dbg python3-dbg libqt5webkit5-dbg
 ----
 
-.Archlinux
+Archlinux
+^^^^^^^^^
 
 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 by me (x86_64 only).
+debugging symbols compiled/packaged by me (x86_64 only).
 
-To compile by yourself:
+To install my pre-built packages
+++++++++++++++++++++++++++++++++
+
+First download and sign the key:
 
 ----
-$ git clone https://github.com/The-Compiler/qt-debug-pkgbuild.git
+# pacman-key -r 0xD6A1C70FE80A0C82
+$ pacman-key -f 0xD6A1C70FE80A0C82
+  Key fingerprint = 14AF EC28 70C6 4863 C5C7  ACCB D6A1 C70F E80A 0C82
+# pacman-key --lsign-key 0xD6A1C70FE80A0C82
+----
+
+Then edit your `/etc/pacman.conf` to add the repository to the bottom:
+
+----
+[qt-debug]
+Server = http://qutebrowser.org/qt-debug/$arch
+----
+
+Then install the packages:
+
+----
+# 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
-$ git checkout symbols
+$ export DEBUG_CFLAGS='-ggdb3 -fvar-tracking-assignments -Og'
+$ export DEBUG_CXXFLAGS='-ggdb3 -fvar-tracking-assignments -Og'
 $ cd qt5
-$ makepkg -si
+$ makepkg -si --pkg qt5-base-debug,qt5-webkit-debug,qt5-webengine-debug
 $ cd ../pyqt5
-$ makepkg -si
+$ makepkg -si --pkg pyqt5-common-debug,python-pyqt5-debug
 ----
 
-To install my pre-built packages:
+Getting the stack trace
+~~~~~~~~~~~~~~~~~~~~~~~
+
+First install `gdb` on your system if it's not installed already.
+
+Then run qutebrowser directly inside gdb like this:
 
 ----
-$ mkdir qt-debug
-$ cd qt-debug
-$ wget -r -l1 -A '*.tar.xz' -L -np -nd http://www.qutebrowser.org/qt-symbols-pkg/
-# pacman -U *.pkg.tar.xz
+$ gdb $(readlink -f $(which python3)) -ex 'run -m qutebrowser --debug'
 ----
 
-After you are done debugging, make sure to install the system packages again so
-you get updates. This can be done with this command:
-
-----
-# pacman -S qt5
-----
-
-Getting a core dump
--------------------
-
-The next step is finding the core dump so we can get a stacktrace from it.
-
-First of all, try to reproduce your problem. If you can, run qutebrowser
-directly inside gdb like this:
-
-----
-$ gdb $(which python3) -ex 'run -m qutebrowser --debug'
-----
-
-If you cannot reproduce the problem, you need to check if a coredump got
-written somewhere.
-
-Check the file `/proc/sys/kernel/core_pattern` on your system. If it does not
-start with a `|` character (pipe), check if there is a file named `core` or
-`core.NNNN` in the directory from that file, or in the current directory.
-
-If so, execute gdb like this:
-
-----
-$ gdb $(which python3) /path/to/core
-----
-
-If your `/proc/sys/kernel/core_pattern` contains something like
-`|/usr/lib/systemd/systemd-coredump`, use `coredumpctl` as root to run gdb:
-
-----
-# coredumpctl gdb $(which python3)
-----
-
-Getting a stack trace
----------------------
-
-Regardless of the way you used to open gdb, you should now see something like:
+After you reproduce the crash, you should now see something like:
 
 ----
 Program received signal SIGSEGV, Segmentation fault.
@@ -107,16 +110,58 @@ Now enter these commands at the gdb prompt:
 
 ----
 (gdb) set logging on
-(gdb) set logging redirect on
-(gdb) bt
+(gdb) bt full
 # you might have to press enter a few times until you get the prompt back
-(gdb) set logging redirect off
 (gdb) quit
 ----
 
-Now copy the last few lines of the debug log (before you got the gdb prompt)
-and the full content of `gdb.txt` into the bug report. Please also add some
-words about what you were doing (or what pages you visited) before the crash
+This will create a `gdb.txt` in your current directory.
+
+Copy the last few lines of the debug log (before you got the gdb prompt) and
+the full content of `gdb.txt` into the bug report. Please also add some words
+about what you were doing (or what pages you visited) before the crash
+happened.
+
+Crashes which can NOT be reproduced
+-----------------------------------
+
+If you cannot reproduce the problem, you need to check if a coredump got
+written somewhere. You should not install debug symbols as they won't match the
+generated coredump.
+
+First install `gdb` on your system if it's not installed already.
+
+Then check the file `/proc/sys/kernel/core_pattern` on your system. If it does
+not start with a `|` character (pipe), check if there is a file named `core` or
+`core.NNNN` in the directory from that file, or in the current directory.
+
+If so, execute gdb like this:
+
+----
+$ gdb $(readlink -f $(which python3)) /path/to/core
+----
+
+If your `/proc/sys/kernel/core_pattern` contains something like
+`|/usr/lib/systemd/systemd-coredump`, use `coredumpctl` to run gdb:
+
+----
+$ coredumpctl gdb $(readlink -f $(which python3))
+----
+
+Getting the stack trace
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Now enter these commands at the gdb prompt:
+
+----
+(gdb) set logging on
+(gdb) bt
+# you might have to press enter a few times until you get the prompt back
+(gdb) quit
+----
+
+Copy the content of `gdb.txt` into the bug report. Please also add some words
+about what you were doing (or what pages you visited) before the crash
 happened.
 
 [[windows]]
@@ -129,10 +174,10 @@ 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
-Microsoft, then run the "DebugDiag 2 Analysis" tool. There, check
-"CrashHangAnalysis" and add your crash dump via "Add Data files". Then click
-"Start analysis".
+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*.
 
 Close the Internet Explorer which opens when it's done and use the
 folder-button at the top left to get to the reports. There find the report file

doc/userscripts.asciidoc

@@ -0,0 +1,80 @@
+Writing qutebrowser userscripts
+===============================
+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.
+
+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.
+
+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 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`: 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 (not supported
+  with QtWebEngine).
+
+In `hints` mode:
+
+- `QUTE_URL`: The URL selected via hints.
+- `QUTE_SELECTED_TEXT`: The plain text of the element selected via hints.
+- `QUTE_SELECTED_HTML` The HTML of the element selected via hints.
+
+Sending commands
+----------------
+
+Normal qutebrowser commands can be written to `$QUTE_FIFO` and will be
+executed.
+
+On Unix/OS X, this is a named pipe and commands written to it will get executed
+immediately.
+
+On Windows, this is a regular file, and the commands in it will be executed as
+soon as your userscript terminates. This means when writing multiple commands,
+you should append to the file (`>>` in bash) rather than overwrite it (`>`).
+
+Examples
+--------
+
+Opening the currently selected word on http://www.dict.cc/[dict.cc]:
+
+[source,bash]
+----
+#!/bin/bash
+
+echo "open -t http://www.dict.cc/?s=$QUTE_SELECTED_TEXT" >> "$QUTE_FIFO"
+----

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/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.py

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

qutebrowser/__init__.py

@@ -1,6 +1,6 @@
 # vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
 
-# Copyright 2014 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 Florian Bruhin (The Compiler)"
+__copyright__ = "Copyright 2014-2016 Florian Bruhin (The Compiler)"
 __license__ = "GPL"
 __maintainer__ = __author__
 __email__ = "mail@qutebrowser.org"
-__version_info__ = (0, 1, 1)
-__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 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 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 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# Copyright 2014-2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -17,16 +17,16 @@
 # You should have received a copy of the GNU General Public License
 # along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Functions related to adblocking."""
+"""Functions related to ad blocking."""
 
 import io
 import os.path
 import functools
 import posixpath
 import zipfile
+import fnmatch
 
-from PyQt5.QtCore import QStandardPaths
-
+from qutebrowser.browser import downloads
 from qutebrowser.config import config
 from qutebrowser.utils import objreg, standarddir, log, message
 from qutebrowser.commands import cmdutils
@@ -49,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
@@ -61,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."""
@@ -76,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.
@@ -89,51 +107,99 @@ 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
-        data_dir = standarddir.get(QStandardPaths.DataLocation)
-        self._hosts_file = os.path.join(data_dir, '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('last-focused',
-                             "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):
-        """Update the adblock block lists."""
-        self.blocked_hosts = set()
+        """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:
             if url.scheme() == 'file':
                 try:
                     fileobj = open(url.path(), 'rb')
-                except OSError:
-                    log.misc.exception("Failed to open block list!")
+                except OSError as e:
+                    message.error("adblock: Error while reading {}: {}".format(
+                        url.path(), e.strerror))
+                    continue
                 download = FakeDownload(fileobj)
                 self._in_progress.append(download)
                 self.on_download_finished(download)
             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(
@@ -153,10 +219,9 @@ class HostBlocker:
         try:
             f = get_fileobj(byte_io)
         except (OSError, UnicodeDecodeError, zipfile.BadZipFile,
-                zipfile.LargeZipFile) as e:
-            message.error('last-focused', "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
@@ -181,20 +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('last-focused', "adblock: {} read errors for "
-                          "{}".format(error_count, byte_io.name))
+            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('last-focused', "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):
@@ -202,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 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+# Copyright 2014-2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -31,9 +31,7 @@ from qutebrowser.utils import qtutils, utils, objreg
 
 
 def update_geometry(obj):
-    """WORKAROUND
-
-    This is a horrible workaround for some weird PyQt bug (probably).
+    """Weird WORKAROUND for some weird PyQt bug (probably).
 
     This actually should be a method of DownloadView, but for some reason the
     rowsInserted/rowsRemoved signals don't get disconnected from this method
@@ -41,10 +39,9 @@ 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."""
         if sip.isdeleted(obj):
@@ -67,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 {
@@ -82,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))
@@ -115,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.
@@ -126,8 +124,9 @@ class DownloadView(QListView):
         Return:
             A list of either:
                 - (QAction, callable) tuples.
-                - (None, None) for a seperator
+                - (None, None) for a separator
         """
+        model = self.model()
         actions = []
         if item is None:
             pass
@@ -136,13 +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", self.model().clear))
+            actions.append(("Remove all finished", model.download_clear))
         return actions
 
     @pyqtSlot('QPoint')

qutebrowser/browser/history.py

@@ -0,0 +1,308 @@
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+# Copyright 2015-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/>.
+
+"""Simple history which gets written to disk."""
+
+import time
+import collections
+
+from PyQt5.QtCore import pyqtSignal, pyqtSlot, QUrl, QObject
+
+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, objects
+
+
+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.
+        redirect: If True, don't save this entry to disk
+    """
+
+    def __init__(self, atime, url, title, redirect=False):
+        self.atime = float(atime)
+        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_str(), title=self.title,
+                              redirect=self.redirect)
+
+    def __str__(self):
+        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, 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(QObject):
+
+    """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.
+        _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:
+        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.
+    """
+
+    add_completion_item = pyqtSignal(Entry)
+    item_added = pyqtSignal(Entry)
+    cleared = pyqtSignal()
+    async_read_done = pyqtSignal()
+
+    def __init__(self, hist_dir, hist_name, parent=None):
+        super().__init__(parent)
+        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(
+            'history', self.save, self.item_added)
+
+    def __repr__(self):
+        return utils.get_repr(self, length=len(self))
+
+    def __iter__(self):
+        return iter(self.history_dict.values())
+
+    def __len__(self):
+        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."""
+        old = self._lineparser.get_recent()
+        return old + [str(e) for e in self._new_history]
+
+    def save(self):
+        """Save the history to disk."""
+        new = (str(e) for e in self._new_history[self._saved_count:])
+        self._lineparser.new_data = new
+        self._lineparser.save()
+        self._saved_count = len(self._new_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:
+            force: Don't ask for confirmation.
+        """
+        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 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.item_added.emit(entry)
+            if not entry.redirect:
+                self.add_completion_item.emit(entry)
+        else:
+            self._add_entry(entry, target=self._temp_history)
+
+
+def init(parent=None):
+    """Initialize the web history.
+
+    Args:
+        parent: The parent to use for WebHistory.
+    """
+    history = WebHistory(hist_dir=standarddir.data(), hist_name='history',
+                         parent=parent)
+    objreg.register('web-history', history)
+
+    if objects.backend == usertypes.Backend.QtWebKit:
+        from qutebrowser.browser.webkit import webkithistory
+        webkithistory.init(history)