Release v1.0.4

This is fixed in master, but it makes no sense to backport that.

.appveyor.yml

@@ -5,13 +5,15 @@ cache:
 build: off
 environment:
     PYTHONUNBUFFERED: 1
+    PYTHON: C:\Python36\python.exe
     matrix:
-    - TESTENV: py34
-    - TESTENV: unittests-frozen
+    - TESTENV: py36-pyqt59
     - TESTENV: pylint
 
 install:
-  - C:\Python27\python -u scripts\dev\ci_install.py
+  - '%PYTHON% -m pip install -U pip'
+  - '%PYTHON% -m pip install -r misc\requirements\requirements-tox.txt'
+  - 'set PATH=%PATH%;C:\Python36'
 
 test_script:
-  - C:\Python34\Scripts\tox -e %TESTENV% -- -p "no:sugar" -v --junitxml=junit.xml
+  - '%PYTHON% -m tox -e %TESTENV%'

.codecov.yml

@@ -0,0 +1,7 @@
+coverage:
+  status:
+    project: off
+    patch: off
+    changes: off
+
+comment: off

.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
+

.eslintignore

@@ -1 +0,0 @@
-qutebrowser/3rdparty/pdfjs/*

.eslintrc

@@ -1,49 +0,0 @@
-# vim: ft=yaml
-
-env:
-   browser: true
-
-rules:
-    block-scoped-var: 2
-    dot-location: 2
-    default-case: 2
-    guard-for-in: 2
-    no-div-regex: 2
-    no-param-reassign: 2
-    no-eq-null: 2
-    no-floating-decimal: 2
-    no-self-compare: 2
-    no-throw-literal: 2
-    no-void: 2
-    radix: 2
-    wrap-iife: [2, "inside"]
-    brace-style: [2, "1tbs", {"allowSingleLine": true}]
-    comma-style: [2, "last"]
-    consistent-this: [2, "self"]
-    func-style: [2, "declaration"]
-    indent: [2, 4, {"SwitchCase": 1}]
-    linebreak-style: [2, "unix"]
-    max-nested-callbacks: [2, 3]
-    no-lonely-if: 2
-    no-multiple-empty-lines: [2, {"max": 2}]
-    no-nested-ternary: 2
-    no-unneeded-ternary: 2
-    operator-assignment: [2, "always"]
-    operator-linebreak: [2, "after"]
-    space-after-keywords: [2, "always"]
-    space-before-blocks: [2, "always"]
-    space-before-function-paren: [2, {"anonymous": "never", "named": "never"}]
-    object-curly-spacing: [2, "never"]
-    array-bracket-spacing: [2, "never"]
-    computed-property-spacing: [2, "never"]
-    space-in-parens: [2, "never"]
-    space-unary-ops: [2, {"words": true, "nonwords": false}]
-    spaced-comment: [2, "always"]
-    max-depth: [2, 5]
-    max-len: [2, 79, 4]
-    max-params: [2, 5]
-    max-statements: [2, 30]
-    no-bitwise: 2
-    quote-props: [2, "always"]
-    global-strict: 0
-    quotes: 0

.flake8

@@ -0,0 +1,50 @@
+[flake8]
+exclude = .*,__pycache__,resources.py
+# E128: continuation line under-indented for visual indent
+# E226: missing whitespace around arithmetic operator
+# E265: Block comment should start with '#'
+# E501: Line too long
+# 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
+# N806: variable in function 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
+    /# pragma: no mccabe/ : +C901
+    tests/*/test_*.py : +D100,D101,D401
+    tests/conftest.py : +F403
+    tests/unit/browser/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
+    # FIXME:conf
+    tests/unit/completion/test_models.py : +F821
+copyright-check = True
+copyright-regexp = # Copyright [\d-]+ .*
+copyright-min-file-size = 110

.github/CODEOWNERS

@@ -0,0 +1,8 @@
+qutebrowser/browser/history.py  @rcorre
+qutebrowser/completion/*  @rcorre
+qutebrowser/misc/sql.py  @rcorre
+tests/end2end/features/completion.feature  @rcorre
+tests/end2end/features/test_completion_bdd.py  @rcorre
+tests/unit/browser/test_history.py  @rcorre
+tests/unit/completion/*  @rcorre
+tests/unit/misc/test_sql.py  @rcorre

.github/CONTRIBUTING.asciidoc

@@ -0,0 +1,9 @@
+- Before you start to work on something, please leave a comment on the relevant
+  issue (or open one). This makes sure there is no duplicate work done.
+
+- Either run the testsuite locally, or keep an eye on Travis CI / AppVeyor
+  after pushing changes.
+
+See the full contribution docs for details:
+
+include::../doc/contributing.asciidoc[]

.github/ISSUE_TEMPLATE.md

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

.gitignore

@@ -1,4 +1,5 @@
 __pycache__
+*.py~
 *.pyc
 *.swp
 /build
@@ -11,14 +12,12 @@ __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
+/qutebrowser/html/*.html
+/.venv*
 /.coverage
 /htmlcov
 /coverage.xml
@@ -28,4 +27,15 @@ __pycache__
 /.cache
 /.testmondata
 /.hypothesis
+/prof
+/venv
 TODO
+/scripts/testbrowser_cpp/webkit/Makefile
+/scripts/testbrowser_cpp/webkit/main.o
+/scripts/testbrowser_cpp/webkit/testbrowser
+/scripts/testbrowser_cpp/webkit/.qmake.stash
+/scripts/testbrowser_cpp/webengine/Makefile
+/scripts/testbrowser_cpp/webengine/main.o
+/scripts/testbrowser_cpp/webengine/testbrowser
+/scripts/testbrowser_cpp/webengine/.qmake.stash
+/scripts/dev/pylint_checkers/qute_pylint.egg-info

.pydocstylerc

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

.pylintrc

@@ -3,10 +3,13 @@
 [MASTER]
 ignore=resources.py
 extension-pkg-whitelist=PyQt5,sip
-load-plugins=pylint_checkers.config,
-             pylint_checkers.modeline,
-             pylint_checkers.openencoding,
-             pylint_checkers.settrace
+load-plugins=qute_pylint.config,
+             qute_pylint.modeline,
+             qute_pylint.openencoding,
+             qute_pylint.settrace,
+             pylint.extensions.bad_builtin,
+             pylint.extensions.docstyle
+persistent=n
 
 [MESSAGES CONTROL]
 enable=all
@@ -14,6 +17,7 @@ disable=no-self-use,
         fixme,
         global-statement,
         locally-disabled,
+        locally-enabled,
         too-many-ancestors,
         too-few-public-methods,
         too-many-public-methods,
@@ -27,39 +31,48 @@ disable=no-self-use,
         bare-except,
         eval-used,
         exec-used,
-        file-ignored,
-        wrong-import-order,
         ungrouped-imports,
-        redefined-variable-type,
-        suppressed-message
+        suppressed-message,
+        too-many-return-statements,
+        duplicate-code,
+        wrong-import-position,
+        no-else-return,
+        # https://github.com/PyCQA/pylint/issues/1698
+        unsupported-membership-test,
+        unsupported-assignment-operation,
+        unsubscriptable-object
 
 [BASIC]
 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,50}$
+method-rgx=[a-z_][A-Za-z0-9_]{1,50}$
 attr-rgx=[a-z_][a-z0-9_]{0,30}$
+class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{1,30}|(__.*__))$
 argument-rgx=[a-z_][a-z0-9_]{0,30}$
 variable-rgx=[a-z_][a-z0-9_]{0,30}$
 docstring-min-length=3
+no-docstring-rgx=(^_|^main$)
 
 [FORMAT]
 max-line-length=79
 ignore-long-lines=(<?https?://|^# Copyright 201\d)
 expected-line-ending-format=LF
 
-[SIMILARITIES]
-min-similarity-lines=8
-
 [VARIABLES]
 dummy-variables-rgx=_.*
 
 [DESIGN]
 max-args=10
 
+[CLASSES]
+valid-metaclass-classmethod-first-arg=cls
+
 [TYPECHECK]
-# 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.webelem.WebElementWrapper,
-                scripts.dev.check_coverage.MsgType
+ignored-modules=PyQt5,PyQt5.QtWebKit
+ignored-classes=_CountingAttr
+
+[IMPORTS]
+# WORKAROUND
+# For some reason, pylint doesn't know about some Python 3 modules on
+# AppVeyor...
+known-standard-library=faulthandler,http,enum,tokenize,posixpath,importlib,types

.pyup.yml

@@ -0,0 +1 @@
+schedule: "every week on monday"

.travis.yml

@@ -1,76 +1,86 @@
-# So we get Ubuntu Trusty - using "dist: trusty" breaks OS X.
-sudo: required
+sudo: false
 dist: trusty
+language: python
+group: edge
+python: 3.6
 
-os:
-  - linux
-  - osx
-
-
-env:
-  global:
-    - PATH=/home/travis/bin:/home/travis/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
-  matrix:
-    - TESTENV=py35
-    - TESTENV=py34
-    - TESTENV=unittests-nodisp
-    - TESTENV=misc
-    - TESTENV=vulture
-    - TESTENV=pep257
-    - TESTENV=pyflakes
-    - TESTENV=pep8
-    - TESTENV=mccabe
-    - TESTENV=pyroma
-    - TESTENV=check-manifest
-    - TESTENV=pylint
-    - TESTENV=eslint
-
-# Not really, but this is here so we can do stuff by hand.
-language: c
+matrix:
+  include:
+    - os: linux
+      env: DOCKER=archlinux
+      services: docker
+    - os: linux
+      env: DOCKER=archlinux-webengine QUTE_BDD_WEBENGINE=true
+      services: docker
+    - os: linux
+      env: TESTENV=py36-pyqt571
+    - os: linux
+      env: TESTENV=py36-pyqt58
+    - os: linux
+      python: 3.5
+      env: TESTENV=py35-pyqt59
+    - os: linux
+      env: TESTENV=py36-pyqt59-cov
+    - os: osx
+      env: TESTENV=py36 OSX=sierra
+      osx_image: xcode8.3
+      language: generic
+    # https://github.com/qutebrowser/qutebrowser/issues/2013
+    # - os: osx
+    #   env: TESTENV=py35 OSX=yosemite
+    #   osx_image: xcode6.4
+    - os: linux
+      env: TESTENV=pylint PYTHON=python3.6
+    - os: linux
+      env: TESTENV=flake8
+    - os: linux
+      env: TESTENV=docs
+      addons:
+         apt:
+           packages:
+           - asciidoc
+    - 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
+      language: node_js
+      python: null
+      node_js: "lts/*"
+  fast_finish: true
 
 cache:
   directories:
     - $HOME/.cache/pip
-    - $HOME/build/The-Compiler/qutebrowser/.cache
+    - $HOME/build/qutebrowser/qutebrowser/.cache
 
 install:
-  - python scripts/dev/ci_install.py
+  - bash scripts/dev/ci/travis_install.sh
+  - ulimit -c unlimited
 
 script:
-  - tox -e $TESTENV -- -p no:sugar -v --cov-report term tests
+  - bash scripts/dev/ci/travis_run.sh
 
 after_success:
-  - '[[ ($TESTENV == py34 || $TESTENV == py35) && $TRAVIS_OX == linux ]] && codecov -e TESTENV -X gcov'
+  - '[[ $TESTENV == *-cov ]] && codecov -e TESTENV -X gcov'
 
-matrix:
-  exclude:
-    - os: linux
-      env: TESTENV=py35
-    - os: osx
-      env: TESTENV=py34
-    - os: osx
-      env: TESTENV=unittests-nodisp
-    - os: osx
-      env: TESTENV=misc
-    - os: osx
-      env: TESTENV=vulture
-    - os: osx
-      env: TESTENV=pep257
-    - os: osx
-      env: TESTENV=pyflakes
-    - os: osx
-      env: TESTENV=pep8
-    - os: osx
-      env: TESTENV=mccabe
-    - os: osx
-      env: TESTENV=pyroma
-    - os: osx
-      env: TESTENV=check-manifest
-    - os: osx
-      env: TESTENV=pylint
-    - os: osx
-      env: TESTENV=eslint
+after_failure:
+  - bash scripts/dev/ci/travis_backtrace.sh
 
 notifications:
   webhooks:
     - https://buildtimetrend.herokuapp.com/travis
+  irc:
+    channels:
+      - "chat.freenode.net#qutebrowser-dev"
+    on_success: always
+    on_failure: always
+    skip_join: true
+    template:
+      - "%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}"
+      - "%{compare_url} - %{build_url}"

CHANGELOG.asciidoc

@@ -1,640 +0,0 @@
-Change Log
-===========
-
-// http://keepachangelog.com/
-
-All notable changes to this project will be documented in this file.
-This project adheres to http://semver.org/[Semantic Versioning].
-
-// tags:
-// `Added` for new features.
-// `Changed` for changes in existing functionality.
-// `Deprecated` for once-stable features removed in upcoming releases.
-// `Removed` for deprecated features removed in this release.
-// `Fixed` for any bug fixes.
-// `Security` to invite users to upgrade in case of vulnerabilities.
-
-v0.5.0
-------
-
-Added
-~~~~~
-
-- Ability to preview PDFs using pdf.js in the browser if it's installed. This
-  is disabled by default and can be enabled using the
-  `content -> pdfjs-enabled` setting.
-- New setting `ui -> hide-wayland-decoration` to hide the window decoration
-  when using wayland.
-- New userscripts in `misc/userscripts`:
-    - `open_download` to easily open a file in your downloads folder.
-    - `view_in_mpv` to open a video in mpv and remove it from the page.
-    - `qutedmenu` and `dmenu_qutebrowser` to select URLs via dmenu
-- New setting `content -> host-blocking-whitelist` to whitelist certain domains
-  from the adblocker.
-- `{scroll_pos}` can now be used in `ui -> window-title-format` and
-  `tabs -> title-format`.
-- New setting `general -> url-incdec-segments` to configure which segments of
-  the URL should be affected by `:navigate increment/decrement`.
-- New `--target` argument to specify how URLs should be opened in an existing
-  instance.
-- New setting `statusbar.url.fg.success.https` to set the foreground color for
-  the URL when a page was loaded via HTTPS.
-- The scrollbar in the completion is now styled, and the following new options
-  got added:
-    * `completion -> scrollbar-width`
-    * `completion -> scrollbar-padding`
-    * `colors -> completion.scrollbar.fg`
-    * `colors -> completion.scrollbar.bg`
-- New value `none` for options taking a color system so they don't display a
-  gradient:
-    * `colors -> tabs.indicator.system`
-    * `colors -> downloads.fg.system`
-    * `colors -> downloads.bg.system`
-- New command `:download-retry` to retry a failed download.
-- New command `:download-clear` which replaces `:download-remove --all`.
-- `:set-cmd-text` has a new `--append` argument to append to the current
-  statusbar text.
-- qutebrowser now uses `~/.netrc` if available to authenticate via HTTP.
-- New `:fake-key` command to send a fake keypress to a website or to
-  qutebrowser.
-- New `--mhtml` argument for `:download` to download a page including all
-  ressources as MHTML file.
-- New option `tabs -> title-alignment` to change the alignment of tab titles.
-
-Changed
-~~~~~~~
-
-- The `colors -> tabs.bg/fg.selected` option got split into
-  `tabs.bg/fg.selected.odd/even`.
-- `:spawn --userscript` and `:hint` with the `userscript` target now look up
-  relative paths in `~/.local/share/qutebrowser/userscripts` or
-  `$XDG_DATA_DIR`. Using a binary in `$PATH` won't work anymore with
-  `--userscript`.
-- New design for error pages
-- Link filtering for hints now checks if the text is contained anywhere in
-  the link, and matches case-insensitively.
-- The `ui -> remove-finished-downloads` option got changed to an integer and
-  now takes a time (in milliseconds) to keep the download around after it's
-  finished. When set to `-1`, downloads are never removed.
-- The `:follow-hint` command now optionally takes the keystring of a hint to
-  follow.
-- `:scroll-px` now doesn't take floats anymore, which made little sense.
-- Updated the user agent list for the `:set network user-agent` completion.
-- Starting with `--debug` doesn't log `VDEBUG` messages anymore (add
-  `--loglevel VDEBUG` to get them).
-- `:debug-console` now hides the console if it's already shown.
-- `:yank-selected` now doesn't log the selected text anymore.
-- `general -> log-javascript-console` got changed from a boolean to an option
-  taking a loglevel (`none`, `info`, `debug`).
-- `:tab-move +/-` now wraps around if `tabs -> wrap` is `true`.
-- When a subprocess (like launched by `:spawn`) fails, its stdout/stderr is now
-  logged to the console.
-- A search engine name can now contain any non-space character, like dashes.
-
-Deprecated
-~~~~~~~~~~
-
-- `:download-remove --all` is now deprecated and `:download-clear` should be
-  used instead.
-- `:download <url> <destination>` is now deprecated and
-  `:download --dest <destination> <url>` should be used instead.
-
-Removed
-~~~~~~~
-
-- `:scroll` with two pixel-arguments (deprecated in v0.3.0)
-- The `:run-userscript` command (deprecated in v0.2.0)
-- The `rapid` and `rapid-win` targets for `:hint` (deprecated in v0.2.0)
-- The `:cancel-download` command (deprecated in v0.2.0)
-- The `:download-page` command (deprecated in v0.2.0)
-
-Fixed
-~~~~~
-
-- Fixed retrying of downloads which were started in a now closed tab.
-- Fixed displaying of web history if `web-history-max-items` is set to -1.
-- Cloned tabs now don't display favicons anymore if show-favicons is False.
-- Fixed a crash when clicking a bookmark name and pressing `Ctrl-D`.
-- Fixed a crash when a website presents a very small favicon.
-- Fixed prompting for download directory when
-  `storage -> prompt-download-directory` was unset.
-- Fixed crash when using `:follow-hint` outside of hint mode.
-- Fixed crash when using `:set foo bar?` with invalid section/option.
-- Fixed scrolling to the very left/right with `:scroll-perc`.
-- Using an external editor should now work correctly with some funny chars
-  (U+2028/U+2029/BOM).
-- Movements in caret mode now should work correctly on OS X and Windows.
-- Fixed upgrade from earlier config versions.
-- Fixed crash when killing a running userscript.
-- Fixed characters being passed through when shifted with
-  `forward-unbound-keys` set to `auto`.
-- Fixed restarting after a crash is reported.
-- Removed `.pyc` files accidentally contained in source releases.
-
-v0.4.1
-------
-
-Fixed
-~~~~~
-
-- Adjusted AppArmor config for the IPC changes in v0.4.0.
-- Fixed atime update frequency for IPC file.
-- Worked around a Qt issue where middle-clicking caused scrolling with a
-  touchpad to restart at the beginning of the page.
-- The `completion -> web-history-max-items` setting is now also respected for
-  items added after starting qutebrowser.
-- Search terms are now shared between different tabs again
-- Tests (a reduced subset of them) now run correctly again when DISPLAY is not
-  set.
-- Fixed an issue causing qutebrowser to crash with Python 3.5 as soon as an ad
-  was blocked.
-- Fixed an issue causing qutebrowser to not start with more recent Python 3.4
-  versions (e.g. on Debian experimental).
-- Fixed various `PendingDeprecationWarnings` shown with Python 3.5.
-
-v0.4.0
-------
-
-Added
-~~~~~
-
-- New bookmark functionality (similar to quickmarks without a name).
-    * New command `:bookmark-add` to bookmark the current page (bound to `M`).
-    * New command `:bookmark-load` to load a bookmark (bound to `gb`/`gB`/`wB`).
-- New (hidden) command `:completion-item-del` (bound to `<Ctrl-D>`) to delete
-  the current item in the completion (for quickmarks/bookmarks).
-- New settings `tabs -> padding` and `tabs -> indicator-tabbing` to control the
-  size/padding of the tabbar.
-- New setting `ui -> statusbar-padding` to control the size/padding of the
-  status bar.
-- New setting `network -> referer-header` to configure when the referer should
-  be sent (by default it's only sent while on the same domain).
-- New setting `tabs -> show` which supersedes the old `tabs -> hide-*` options
-  and has an additional `switching` option which shows tab while switching
-  them. There's also a new `show-switching` option to configure the timeout.
-- New setting `storage -> remember-download-directory` to remember the last
-  used download directory.
-- New setting `storage -> prompt-download-directory` to download all downloads
-  without asking.
-- Rapid hinting is now also possible for downloads.
-- Directory browsing via `file://` is now supported.
-
-Changed
-~~~~~~~
-
-- Some developer scripts got moved to `scripts/dev/`
-- When downloading to a FIFO or special file, a confirmation is displayed as
-  this might cause qutebrowser to hang.
-- The `:yank-selected` command now works in all modes instead of just caret
-  mode and is not hidden anymore.
-- `minimal_webkit_testbrowser.py` now has a `--webengine` switch to test
-  QtWebEngine if it's installed.
-- The column width percentages for the completion view now depend on the
-  completion model.
-- The values for `tabs -> position` and `ui -> downloads-position` got changed
-  from `north`/`south`/`west/`east` to `top`/`bottom`/`left`/`right`. Existing
-  configs should be adjusted automatically.
-- `:tab-focus`/`gt` now behaves like `:tab-next` if no count/index is given.
-- The completion widget doesn't show a border anymore.
-- The tabbar doesn't display ugly arrows anymore if there isn't enough space
-  for all tabs.
-- Some insignificant Qt warnings which were printed on OS X are now hidden.
-- Better support for Qt 5.5 and Python 3.5.
-
-Fixed
-~~~~~
-
-- Fixed a bug where cookies were saved despite qutebrowser being started in
-  private browsing mode.
-- The local socket used for inter-process communication (opening new instances)
-  is now ensured to only be accessible by the user on all operating systems.
-- Various corner cases for inter-process communication issues got fixed.
-- `link_pyqt.py` now should work better on untested distributions.
-- Fixed various corner-cases with crashes when reading invalid config values
-  and the history file.
-- Fixed various corner-cases when setting text via an external editor.
-- Fixed potential crash when hinting a text field.
-- Fixed entering of insert mode when certain disabled text fields were clicked.
-- Fixed a crash when using `:set` with `-p` and `!` (invert value)
-- Downloads with unknown size are now handled correctly.
-- `:navigate increment/decrement` (`<Ctrl-A>`/`<Ctrl-X>`) now handles some
-  corner-cases better.
-- Fixed a bug where the completion got affected by another window's completion
-  if it was open in both windows.
-- Fixed a performance issue with large histories when opening previously
-  unvisited websites.
-- The progress bar now doesn't cause the statusbar to change it's height
-  anymore.
-- `~` is now always expanded when spawning a script.
-- Fixed various corner cases when opening links in an existing instance.
-- Fixed a race-condition causing an exception when starting qutebrowser.
-
-Removed
-~~~~~~~
-
-- The `tabs -> indicator-space` setting got removed as the new padding settings
-  should be used instead.
-- The `tabs -> hide-always` and `tabs -> hide-auto` settings got merged into
-  the new `tabs -> show` setting.
-
-v0.3.0
-------
-
-Added
-~~~~~
-
-- New commands `:message-info`, `:message-error` and `:message-warning` to show messages in the statusbar, e.g. from a userscript.
-- New command `:scroll-px` which replaces `:scroll` for pixel-exact scrolling.
-- New command `:jseval` to run a javascript snippet on the current page.
-- New (hidden) command `:follow-selected` (bound to `Enter`/`Ctrl-Enter` by default) to follow the link which is currently selected (e.g. after searching via `/`).
-- New (hidden) command `:clear-keychain` to clear a partially entered keychain (bound to `<Escape>` by default, in addition to clearing search).
-- New setting `ui -> smooth-scrolling`.
-- New setting `content -> webgl` to enable/disable https://www.khronos.org/webgl/[WebGL].
-- New setting `content -> css-regions` to enable/disable support for http://dev.w3.org/csswg/css-regions/[CSS Regions].
-- New setting `content -> hyperlink-auditing` to enable/disable support for https://html.spec.whatwg.org/multipage/semantics.html#hyperlink-auditing[hyperlink auditing].
-- New setting `tabs -> mousewheel-tab-switching` to control mousewheel behavior on the tab bar.
-- New arguments `--datadir` and `--cachedir` to set the data/cache location.
-- New arguments `--basedir` and `--temp-basedir` (intended for debugging) to set a different base directory for all data, which allows multiple invocations.
-- New argument `--no-err-windows` to suppress all error windows.
-- New arguments `--top-navigate` and `--bottom-navigate` (`-t`/`-b`) for `:scroll-page` to specify a navigation action (e.g. automatically go to the next page when arriving at the bottom).
-- New flag `-d`/`--detach` for `:spawn` to detach the spawned process so it's not closed when qutebrowser is.
-- New flag `-v`/`--verbose` for `:spawn` to print informations when the process started/exited successfully.
-- Many new color settings (foreground setting for every background setting).
-- New setting `ui -> modal-js-dialog` to use the standard modal dialogs for javascript questions instead of using the statusbar.
-- New setting `colors -> webpage.bg` to set the background color to use for websites which don't set one.
-- New setting `completion -> auto-open` to only open the completion when tab is pressed (if set to false).
-- New visual/caret mode (bound to `v`) to select text by keyboard.
-- There are now some example userscripts in `misc/userscripts`.
-- Support for Qt 5.5 and tox 2.0
-
-Changed
-~~~~~~~
-
-- *Breaking change for userscripts:* `QUTE_HTML` and `QUTE_TEXT` for userscripts now don't store the contents directly, and instead contain a filename.
-- The `content -> geolocation` and `notifications` settings now support a `true` value to always allow those. However, this is *not recommended*.
-- New bindings `<Ctrl-R>` (rapid), `<Ctrl-F>` (foreground) and `<Ctrl-B>` (background) to switch hint modes while hinting.
-- `<Ctrl-M>` and numpad-enter are now bound by default for bindings where `<Return>` was bound.
-- `:hint tab` and `F` now respect the `background-tabs` setting. To enforce a foreground tab (what `F` did before), use `:hint tab-fg` or `;f`.
-- `:scroll` now takes a direction argument (`up`/`down`/`left`/`right`/`top`/`bottom`/`page-up`/`page-down`) instead of two pixel arguments (`dx`/`dy`). The old form still works but is deprecated.
-- The `ui -> user-stylesheet` setting now also takes file paths relative to the config directory.
-- The `content -> cookies-accept` setting now has new `no-3rdparty` (default) and `no-unknown-3rdparty` values to block third-party cookies. The `default` value got renamed to `all`.
-- Improved startup time by reading the webpage history while qutebrowser is open.
-- The way `:spawn` splits its commandline has been changed slightly to allow commands with flags.
-- The default for the `new-instance-open-target` setting has been changed to `tab`.
-- Sessions now store zoom/scroll-position separately for each entry.
-
-Deprecated
-~~~~~~~~~~
-
-- `:scroll` with two pixel-arguments is now deprecated - `:scroll-px` should be used instead.
-
-Removed
-~~~~~~~
-
-- The `--no-crash-dialog` argument which was intended for debugging only was removed as it's replaced by `--no-err-windows` which suppresses all error windows.
-- Support for Qt installations without SSL support was dropped.
-
-Fixed
-~~~~~
-
-- Scrolling should now work more reliably on some pages where arrow keys worked but `hjkl` didn't.
-- Small improvements when checking if an input is an URL or not.
-- Fixed wrong cursor position when completing the first item in the completion.
-- Fixed exception when using search engines with {foo} in their name.
-- Fixed a bug where the same title was shown for all tabs on some systems.
-- Don't install the scripts package when installing qutebrowser.
-- Fixed searching for terms starting with a hyphen (e.g. `/-foo`)
-- Proxy authentication credentials are now remembered between different tabs.
-- Fixed updating of the tab title on pages without title.
-- Fixed AssertionError when closing many windows quickly.
-- Various fixes for deprecated key bindings and auto-migrations.
-- Workaround for qutebrowser not starting when there are NUL-bytes in the history (because of a currently unknown bug).
-- Fixed handling of keybindings containing Ctrl/Meta on OS X.
-- Fixed crash when downloading an URL without filename (e.g. magnet links) via "Save as...".
-- Fixed exception when starting qutebrowser with `:set` as argument.
-- Fixed horrible completion performance when the `shrink` option was set.
-- Sessions now store zoom/scroll-position correctly.
-
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.2.1[v0.2.1]
------------------------------------------------------------------------
-
-Fixed
-~~~~~
-
-- Added missing manpage (doc/qutebrowser.1.asciidoc) to archive.
-
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.2.0[v0.2.0]
------------------------------------------------------------------------
-
-Added
-~~~~~
-
-- Session support
-    * new command `:session-load` to load a session.
-    * new command `:session-save` to save a session.
-    * new command `:session-delete` to delete a session.
-    * new setting `general -> save-session` to always save the session on quit.
-    * new setting `general -> session-default-name` to configure the session name to use if none is given.
-    * new argument `-r`/`--restore` to specify a session to load.
-    * new argument `-R`/`--override-restore` to not load a session even if one was saved.
-- New commands to manage downloads:
-    * `:download` to download a URL or the current page.
-    * `:download-cancel` to cancel a download.
-    * `:download-delete` to delete a download from disk.
-    * `:download-open` to open a finished download.
-    * `:download-remove` to remove a download from the list. `:download-remove --all` or the new 'cd' keybinding can be used to clear all finished downloads.
-- History completion
-    * New option `completion -> timestamp-format` to set the format used to display the history timestamps.
-    * New option `completion -> web-history-max-items` to configure how many history items to show in the completion.
-    * The option `completion -> history-length` for the command history got renamed to `cmd-history-max-items`.
-- Better save logic for the config/state:
-    * Only save files if modified (e.g. don't overwrite the config if it was edited outside of qutebrowser and nothing was changed in qutebrowser).
-    * Save things (cookies, config, quickmarks, ...) periodically all 15 seconds (time can be changed with the `general -> auto-save-interval` option).
-- Opera-like mouse rocker gestures
-    * New option `input -> rocker-gestures`. When turned on, the history can be navigated back/forward by holding a mouse button and pressing the other one.
-- New `-f` option for `:reload` to reload and bypass the cache.
-- Pass more information (`QUTE_MODE`, `QUTE_SELECTED_TEXT`, `QUTE_SELECTED_HTML`, `QUTE_USER_AGENT`, `QUTE_HTML`, `QUTE_TEXT`) to userscripts.
-- New `--userscript` option to `:spawn` (which deprecates `:run-userscript`).
-- Ability to toggle a value to `:set` by appending a `!` to the value.
-- New options to hide the tab-/statusbar:
-    * `tabs -> hide-always` for the tabbar
-    * `ui -> hide-statusbar` for the statusbar
-- New options to configure how the tab/window titles should look:
-    * `tabs -> title-format` for the tabbar
-    * `ui -> window-title-format` for the window title
-- HTML5 Geolocation/Notification support:
-    * New option `content -> geolocation` to permanently turn the geolocation off.
-    * New option `content -> notifications` to permanently turn notifications off.
-- New options to disable javascript prompts/alerts:
-    * `content -> ignore-javascript-prompt` to turn off prompts.
-    * `content -> ignore-javascript-alerts` to turn off alerts.
-- Two new options to customize the behavior of hints:
-    * `hints -> min-chars` to set minimum number of chars in hints.
-    * `hints -> scatter` which when turned off distributes the hints sequentially (like dwb) instead of scattering their positions (like Vimium).
-- Make it possible to use `:open -[twb]` without url.
-    * New option `general -> default-page` to set the page to be opened when doing that.
-- New `input -> partial-timeout` option to clear partial keystrings.
-- New option `completion -> download-path-suggestion` to configure what to show in the completion for downloads.
-- Queue messages shown in unfocused windows and show them when the window is focused.
-    * New option `ui -> message-unfocused` to disable this behavior.
-- New `--relaxed-config` argument which ignores unknown options.
-- New `:tab-detach` command to open the current tab in a new window.
-- Zooming via Ctrl-Mousewheel.
-    * New option `input -> mouse-zoom-divider` to control how much the page is zoomed when rotating the wheel.
-- New option (`content -> host-blocking-enabled`) to enable/disable host blocking.
-- New values `tab-bg`/`tab-bg-silent` for `new-instance-open-target` to open a background tab.
-- New `ui -> downloads-position` setting to move the downloads to the bottom.
-- New `ui -> hide-mouse-cursor` option to hide the mouse cursor inside qutebrowser.
-- New argument `-s` for qutebrowser to set a temporary config option.
-- New argument `-p` for the `:set` command to print the new value.
-- New `--rapid` option to `:hint`. The `rapid`/`rapid-win` targets are now deprecated, and `--rapid` can be used as well with the targets run/hover/userscript/spawn as well.
-- New `-f` argument to `:bind` to overwrite the old binding.
-- New `--qt-name` argument to qutebrowser which is passed to Qt to set `WM_CLASS`.
-- Alternating row colors in completion. This adds a new `colors -> completion.alternate-bg` option.
-
-Changed
-~~~~~~~
-
-- Ignore quotes with maxsplit-commands (`:open`, `:quickmark-load`, etc.) and don't quote arguments for those commands in the completions. This also means some commands needed adjustments:
-    * Clear search when `:search` without arguments is given.  (`:search ""` will now search for the literal text `""`)
-    * Add `-s`/`--space` argument to `:set-cmd-text` (as `:set-cmd-text "foo "` will now set the literal text `"foo "`)
-- Ignore `;;` for splitting with some commands like `:bind`.
-- Add unbound (new) default keybindings to config. This also adds a new `<unbound>` special command.
-    * To unbind a command keybinding without binding it to a new key, you now have to bind it to `<unbound>` or it'll be readded automatically.
-- If an SSL error is raised multiple times with the same error/certificate/host/scheme/port, the user is only asked once.
-- Jump to last instead of first item when pressing Shift-Tab the first time in the completion.
-- Add a fullscreen keybinding.
-- Add a `:search` command in addition to `/foo` so it's more visible and can be used from scripts.
-- Various improvements to documentation, logging, and the crash reporter.
-- Expand `~` to the users home directory with `:run-userscript`.
-- Improve the userscript runner on Linux/OS X by using `QSocketNotifier`.
-- Add luakit-like `gt`/`gT` keybindings to cycle through tabs.
-- Show default value for config values in the completion.
-- Clone tab icon, tab text and zoom level when cloning tabs.
-- Don't open relative file paths with `:open`, only with commandline arguments.
-- Expand environment variables in config settings which take a file path.
-- Add a list of common user agents to the user agent setting completion.
-- Move cursor to end of textboxes when hinting.
-- Don't start searches on invalid URLs for quickmarks/startpage.
-- Various performance improvements for the completion.
-- Always open URLs given as argument in the foreground.
-- Improve various error messages.
-- Add `startpage`/`default-page` values to `tabs -> last-close`.
-- Various improvements to `:restart` - it should be more robust now and uses sessions so all state (focused tab, scroll position, etc.) gets remembered.
-- Add tab index display to the statusbar.
-- Keep progress bar height fixed when the statusbar is multiline.
-- Many improvements to tests and related infrastructure:
-    * `init_venv.py` and `run_checks.py` have been replaced by http://tox.readthedocs.org/[tox]. Install tox and run `tox -e mkvenv` instead.
-    * The tests now use http://pytest.org/[pytest]
-    * Many new tests added
-    * Mac Mini buildbot to run the tests on OS X.
-    * Coverage recording via http://nedbatchelder.com/code/coverage/[coverage.py].
-    * New `--pdb-postmortem argument` to drop into the pdb debugger on exceptions.
-    * Use https://github.com/ionelmc/python-hunter[hunter] for line tracing instead of a selfmade solution.
-
-Deprecated
-~~~~~~~~~~
-
-- The `:run-userscript` command - use `:spawn --userscript` instead.
-- The `rapid` and `rapid-win` targets for `:hint` - use the `--rapid` argument to `:hint` instead.
-- The `:cancel-download` command - use `:download-cancel` instead.
-- The `:download-page` command - use `:download` instead.
-
-Removed
-~~~~~~~
-
-- `init_venv.py` and `run_checks.py` have been replaced by http://tox.readthedocs.org/[tox]. Install tox and run `tox -e mkvenv` instead..
-
-Fixed
-~~~~~
-
-- Fix for cache never being used.
-- Fixed handling of key release events (e.g. for javascript) when holding a key and pressing a second one.
-- Fix handling of commands using `;;` at various places (key config, command parser, `:bind`)
-- Fix splitting of flags with arguments (`:bind -m`/`--mode`).
-- Fix bindings of special keys with lower-case modifiers (e.g.  `<ctrl-x>`)
-- Fix for weird search highlights when changing tabs while search is active.
-- Fix starting with `-c ""`.
-- Fix removing of partial downloads when a download is cancelled via context menu.
-- Fix retrying of downloads which were started in a now closed tab.
-- Highlight text case-insensitively in completion.
-- Scroll completion to top when showing it.
-- Handle unencodable file paths in config types correctly.
-- Fix for crash when executing a delayed command (because of a shadowed keybinding) and then unfocusing the window.
-- Fix for crash when hinting on a page which doesn't have an URL yet.
-- Fix exception when using `:set-cmd-text` with an empty argument.
-- Add a timeout to pastebin HTTP replies.
-- Various other fixes for small/rare bugs.
-
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.4[v0.1.4]
------------------------------------------------------------------------
-
-Changed
-~~~~~~~
-
-* The Windows builds come with Qt 5.4.1 which has some https://lists.schokokeks.org/pipermail/qutebrowser/2015-March/000054.html[related bugfixes].
-* Improvements to CPU usage when idle.
-* Ensure there's no size for `font-family` settings.
-* Handle URLs with double-colon as search strings.
-* Adjust prompt size hint based on content.
-* Refactor websettings and save/restore defaults.
-* Various small improvements to logging.
-* Various improvements for hinting.
-* Improve parsing of `faulthandler` logs.
-
-Removed
-~~~~~~~
-
-* Remove default search engines.
-* Remove debug console completing completely.
-
-Fixed
-~~~~~
-
-* Ignore RuntimeError in `mouserelease_insertmode`.
-* Hide Qt warning when aborting download reply.
-* Hide "Error while shutting down tabs" message.
-* Clear open target in `acceptNavigationRequest`.
-* Fix handling of signals with deleted tabs.
-* Restore `sys.std*` in `utils.fake_io` on exceptions.
-* Allow font names with integers in them.
-* Fix `QIODevice` warnings when closing tabs.
-* Set the `QSettings` path to a config-subdirectory.
-* Add workaround for adblock-message without window.
-* Fix searching for terms starting with a slash.
-* Ignore tab key presses if they'd switch focus.
-
-Security
-~~~~~~~~
-
-* Stop the icon database from being created when private-browsing is set to true.
-* Disable insecure SSL ciphers.
-
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.3[v0.1.3]
------------------------------------------------------------------------
-
-Changed
-~~~~~~~
-
-* Various small logging improvements.
-* Don't open relative files in `fuzzy_url` with `:open`
-* Various crashdialog improvements.
-* Hide adblocked iframes.
-
-Fixed
-~~~~~
-
-* Handle shutdown of page with prompt correctly.
-* fuzzy_url: handle invalid URLs with autosearch off
-* Handle explicit searches with `auto-search=false`.
-* Abort download override question on error/cancel.
-* Set a higher z-index for hint labels.
-* Close contextmenu when closing tab to avoid crash.
-* Fix statusbar quickly popping up as window.
-* Clean up `NetworkManager` after downloads finished.
-* Fix restoring of cmd widget after an error.
-* Fix retrying of downloads after the tab is closed.
-* Fix `check_libraries()` output for Arch Linux.
-* Handle all `IPCErrors` properly.
-* Handle another `webelem.IsNullError` with hints.
-* Handle `UnicodeDecodeError` when reading configs.
-
-Security
-~~~~~~~~
-
-* Fix for HTTP passwords accidentally being written to debug log.
-
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.2[v0.1.2]
------------------------------------------------------------------------
-
-Changed
-~~~~~~~
-
-* Uncheck sending of debug log by default when private browsing is on.
-* Add SSL info to version info.
-
-Removed
-~~~~~~~
-
-* Remove hosts-file.net from blocker default lists.
-
-Fixed
-~~~~~
-
-* Fix rare exception when a key is pressed shortly after opening a window
-* Fix exception with certain invalid URLs like `http:foo:0`
-* Work around Qt bug which renders checkboxes on OS X unusable
-* Fix exception when a local files can't be read in `:adblock-update`
-* Hide 2 more Qt warnings.
-* Add `!important` to hint CSS so websites don't override the hint look
-* Make `init_venv.py` work with multiple sip `.so` files.
-* Fix splitting with certain commands with an empty argument
-* Fix uppercase hints.
-* Fix segfaults if another page is loaded while a prompt is open
-* Fix exception with invalid `ShellCommand` config values.
-* Replace unencodable chars
-* Fix user-stylesheet setting with an empty value.
-
-
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.1[v0.1.1]
------------------------------------------------------------------------
-
-Added
-~~~~~
-
-* Set window icon and add a qutebrowser.ico file for Windows.
-* Ask the user when downloading to an already existing file.
-* Add a `network -> proxy-dns-requests` option.
-* Add "Remove finished" to the download context menu
-* Open and remove clicked downloads.
-
-Changes
-~~~~~~~
-
-* Windows releases are now built with Qt 5.4 which brings many improvements and bugfixes.
-* Add a troubleshooting section to the FAQ.
-* Display IPC errors to the user.
-* Rewrite keymode handling to use only one mode which also fixes various bugs.
-* Save version to state config.
-* Set zoom to default instead of 100% with `:zoom`/`=`.
-* Adjust page zoom if default zoom changed.
-* Force tabs to be focused on `:undo`.
-* Replace manual installation instructions on OS X with homebrew/macports.
-* Allow min-/maximizing of print preview on Windows.
-* Various documentation improvements.
-* Various other small improvements and cleanups.
-
-Removed
-~~~~~~~
-
-* Clean up and temporarily disable alias completion.
-
-Fixed
-~~~~~
-
-* Fix setting of `QWebSettings` (e.g. web fonts) with empty strings.
-* Re-focus web view when leaving prompt/yesno mode.
-* Handle `:restart` correctly with Python eggs.
-* Handle an invalid cwd properly.
-* Fix popping of a dead question in prompter.
-* Fix `AttributeError` on config changes on Ubuntu.
-* Don't treat things like "31c3" as IP address.
-* Handle category being `None` in Qt message handler.
-* Force-include pygments in `freeze.py`.
-* Fix scroll percentage not updating on some pages like twitter.
-* Encode `Content-Disposition` header name properly.
-* Fix item sorting in `NeighborList`.
-* Handle data being `None` in download read timer.
-* Stop download read timer when reply has finished.
-* Fix handling of small/big `fuzzyval`'s in `NeighborList`.
-* Fix crashes when entering invalid values in `qute:settings`.
-* Abort questions in `NetworkManager` when destroyed.
-* Fix height calculation of download view.
-* Always auto-remove adblock downloads when done.
-* Ensure the docs get included in `freeze.py`.
-* Fix crash with `:zoom`.
-
-https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1[v0.1]
--------------------------------------------------------------------
-
-Initial release.

INSTALL.asciidoc

@@ -1,240 +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 17+)
-
-Unfortunately there is no Debian package yet, but installing qutebrowser is
-still relatively easy! If you want to help packaging it for Debian, please
-https://github.com/The-Compiler/qutebrowser/issues/582[get in touch]!
-
-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-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 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
-----
-
-Then <<tox,install qutebrowser via tox>>.
-
-On Fedora
----------
-
-qutebrowser should run on Fedora 22.
-
-Unfortunately there is no Fedora package yet, but installing qutebrowser is
-still relatively easy! If you want to help packaging it for Fedora, please
-mailto:mail@qutebrowser.org[get in touch]!
-
-Install the dependencies via dnf:
-
-----
-# dnf update
-# dnf install python3-qt5 python-tox python3-sip
-----
-
-To generate the documentation for the `:help` command, when using the git
-repository (rather than a release):
-
-----
-# dnf install asciidoc source-highlight
-$ python3 scripts/asciidoc2html.py
-----
-
-Then <<tox,install qutebrowser via tox>>.
-
-On Archlinux
-------------
-
-There are two Archlinux packages available in the AUR:
-https://aur.archlinux.org/packages/qutebrowser/[qutebrowser] and
-https://aur.archlinux.org/packages/qutebrowser-git/[qutebrowser-git].
-
-You can install them (and the needed pypeg2 dependency) like this:
-
-----
-$ wget https://aur.archlinux.org/packages/py/python-pypeg2/python-pypeg2.tar.gz
-$ tar xzf python-pypeg2.tar.gz
-$ cd python-pypeg2
-$ makepkg -si
-$ cd ..
-$ rm -r python-pypeg2 python-pypeg2.tar.gz
-
-$ wget https://aur.archlinux.org/packages/qu/qutebrowser/qutebrowser.tar.gz
-$ tar xzf qutebrowser.tar.gz
-$ cd qutebrowser
-$ makepkg -si
-$ cd ..
-$ rm -r qutebrowser qutebrowser.tar.gz
-----
-
-or you could use an AUR helper, e.g. `yaourt -S qutebrowser-git`.
-
-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.
-
-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 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.
-* 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
--------
-
-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.
-
-[[tox]]
-Installing qutebrowser with tox
--------------------------------
-
-Run tox inside the qutebrowser repository to set up a
-https://docs.python.org/3/library/venv.html[virtual environment]:
-
-----
-$ tox -e mkvenv
-----
-
-This installs all needed Python dependencies in a `.venv` subfolder. The
-system-wide Qt5/PyQt5 installations are 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 "$@"
-----
-
-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,37 +1,45 @@
 recursive-include qutebrowser *.py
-recursive-include qutebrowser/html *.html
 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
-recursive-include scripts *.py
+graft misc/apparmor
+graft misc/userscripts
+recursive-include scripts *.py *.sh
 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 LICENSE doc/* README.asciidoc
+include misc/qutebrowser.desktop
 include requirements.txt
 include tox.ini
 include qutebrowser.py
+include misc/cheatsheet.svg
+include qutebrowser/config/configdata.yml
 
 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
+include doc/changelog.asciidoc
 prune tests
+prune qutebrowser/3rdparty
+prune misc/requirements
+prune misc/docker
 exclude pytest.ini
 exclude qutebrowser.rcc
-exclude .coveragerc
-exclude .pylintrc
-exclude .eslintrc
-exclude .eslintignore
+exclude qutebrowser/javascript/.eslintrc.yaml
+exclude qutebrowser/javascript/.eslintignore
 exclude doc/help
-exclude .appveyor.yml
-exclude .travis.yml
+exclude .*
 exclude misc/appveyor_install.py
+exclude misc/qutebrowser.spec
+exclude misc/qutebrowser.nsi
 
 global-exclude __pycache__ *.pyc *.pyo

README.asciidoc

@@ -1,24 +1,25 @@
 // 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
 ===========
 
 // QUTE_WEB_HIDE
-image:icons/qutebrowser-64x64.png[qutebrowser logo] *A keyboard-driven, vim-like browser based on PyQt5 and QtWebKit.*
+image:icons/qutebrowser-64x64.png[qutebrowser logo] *A keyboard-driven, vim-like browser based on PyQt5 and Qt.*
 
-image:https://img.shields.io/pypi/l/qutebrowser.svg?style=flat["license badge",link="https://github.com/The-Compiler/qutebrowser/blob/master/COPYING"]
+image:https://img.shields.io/pypi/l/qutebrowser.svg?style=flat["license badge",link="https://github.com/qutebrowser/qutebrowser/blob/master/LICENSE"]
 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/The-Compiler/qutebrowser/requirements.svg?branch=master["requirements badge",link="https://requires.io/github/The-Compiler/qutebrowser/requirements/?branch=master"]
-image:https://travis-ci.org/The-Compiler/qutebrowser.svg?branch=master["Build Status", link="https://travis-ci.org/The-Compiler/qutebrowser"]
-image:https://ci.appveyor.com/api/projects/status/9gmnuip6i1oq7046?svg=true["AppVeyor build status", link="https://ci.appveyor.com/project/The-Compiler/qutebrowser"]
-image:https://codecov.io/github/The-Compiler/qutebrowser/coverage.svg?branch=master["coverage badge",link="https://codecov.io/github/The-Compiler/qutebrowser?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, PyQt5 and QtWebKit and free software, licensed under the GPL.
+on Python and PyQt5 and free software, licensed under the GPL.
 
 It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.
 
@@ -33,12 +34,9 @@ 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
-page] for available downloads (currently a source archive, and standalone
-packages as well as MSI installers for Windows).
-
-See link:INSTALL.asciidoc[INSTALL] for detailed instructions on how to get
-qutebrowser running for various platforms.
+See the https://github.com/qutebrowser/qutebrowser/releases[github releases
+page] for available downloads and the link:doc/install.asciidoc[INSTALL] file for
+detailed instructions on how to get qutebrowser running on various platforms.
 
 Documentation
 -------------
@@ -46,13 +44,15 @@ Documentation
 In addition to the topics mentioned in this README, the following documents are
 available:
 
-* A http://qutebrowser.org/img/cheatsheet-big.png[key binding cheatsheet]: +
-image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser key binding cheatsheet",link="http://qutebrowser.org/img/cheatsheet-big.png"]
+* 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:FAQ.asciidoc[Frequently asked questions]
-* link:CONTRIBUTING.asciidoc[Contributing to qutebrowser]
-* link:INSTALL.asciidoc[INSTALL]
-* link:CHANGELOG.asciidoc[Change Log]
+* https://www.shortcutfoo.com/app/dojos/qutebrowser[Free training course] to remember those key bindings
+* link:doc/faq.asciidoc[Frequently asked questions]
+* link:doc/help/configuring.asciidoc[Configuring qutebrowser]
+* link:doc/contributing.asciidoc[Contributing to qutebrowser]
+* link:doc/install.asciidoc[Installing qutebrowser]
+* link:doc/changelog.asciidoc[Change Log]
 * link:doc/stacktrace.asciidoc[Reporting segfaults]
 * link:doc/userscripts.asciidoc[How to write userscripts]
 
@@ -67,11 +67,18 @@ message to the
 https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at
 mailto:qutebrowser@lists.qutebrowser.org[].
 
+There's also an https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[announce-only mailinglist]
+at mailto:qutebrowser-announce@lists.qutebrowser.org[] (the announcements also
+get sent to the general qutebrowser@ list).
+
+If you're a reddit user, there's a
+https://www.reddit.com/r/qutebrowser/[/r/qutebrowser] subreddit there.
+
 Contributions / Bugs
 --------------------
 
 You want to contribute to qutebrowser? Awesome! Please read
-link:CONTRIBUTING.asciidoc[the contribution guidelines] for details and
+link:doc/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
@@ -84,39 +91,43 @@ 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 or newer
-* http://qt.io/[Qt] 5.2.0 or newer (5.5.1 recommended)
-* QtWebKit
-* http://www.riverbankcomputing.com/software/pyqt/intro[PyQt] 5.2.0 or newer
-(5.5.1 recommended) for Python 3
+* http://www.python.org/[Python] 3.5 or newer (3.6 recommended)
+* http://qt.io/[Qt] 5.7.1 or newer with the following modules:
+  - QtCore / qtbase
+  - QtQuick (part of qtbase in some distributions)
+  - QtSQL (part of qtbase in some distributions)
+  - QtOpenGL
+  - QtWebEngine, or
+  - QtWebKit - only the
+    link:https://github.com/annulen/webkit/wiki[updated fork] (5.212) is
+    supported
+* http://www.riverbankcomputing.com/software/pyqt/intro[PyQt] 5.7.0 or newer
+  (5.9.2 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]
+* http://www.attrs.org/[attrs]
 
-The following libraries are optional and provide a better user experience:
+The following libraries are optional:
 
-* http://cthedot.de/cssutils/[cssutils]
+* http://cthedot.de/cssutils/[cssutils] (for an improved `:download --mhtml`
+  with QtWebKit).
+* On Windows, https://pypi.python.org/pypi/colorama/[colorama] for colored log
+  output.
+* http://asciidoc.org/[asciidoc] to generate the documentation for the `:help`
+  command, when using the git repository (rather than a release).
 
-To generate the documentation for the `:help` command, when using the git
-repository (rather than a release), http://asciidoc.org/[asciidoc] is needed.
-
-The following libraries are optional and provide colored logging in the
-console:
-
-* https://pypi.python.org/pypi/colorlog/[colorlog]
-* On Windows: https://pypi.python.org/pypi/colorama/[colorama]
-
-See link:INSTALL.asciidoc[INSTALL] for directions on how to install qutebrowser
-and its dependencies.
+See link:doc/install.asciidoc[the documentation] for directions on how to
+install qutebrowser and its dependencies.
 
 Donating
 --------
@@ -137,125 +148,62 @@ get in touch!
 Authors
 -------
 
-Contributors, sorted by the number of commits in descending order:
+qutebrowser's primary author is Florian Bruhin (The Compiler), but qutebrowser
+wouldn't be what it is without the help of
+https://github.com/qutebrowser/qutebrowser/graphs/contributors[hundreds of contributors]!
 
-// QUTE_AUTHORS_START
-* Florian Bruhin
-* Daniel Schadt
-* Antoni Boucher
-* Lamar Pavel
-* Bruno Oliveira
-* Alexander Cogneau
-* Martin Tournoij
-* Raphael Pierzina
-* Joel Torstensson
-* Claude
-* meles5
-* Patric Schmitz
-* Artur Shaik
-* Nathan Isom
-* Austin Anderson
-* Thorsten Wißmann
-* Alexey "Averrin" Nabrodov
-* ZDarian
-* John ShaggyTwoDope Jenkins
-* Peter Vilim
-* Jonas Schürmann
-* Panagiotis Ktistakis
-* Jimmy
-* skinnay
-* error800
-* Zach-Button
-* Halfwit
-* Felix Van der Jeugt
-* rikn00
-* Martin Zimmermann
-* Brian Jackson
-* sbinix
-* neeasade
-* jnphilipp
-* Tobias Patzl
-* Peter Michely
-* Larry Hynes
-* Johannes Altmanninger
-* Samir Benmendil
-* Regina Hug
-* Mathias Fussenegger
-* Fritz V155 Reichwald
-* Franz Fellner
-* Corentin Jule
-* zwarag
-* xd1le
-* dylan araps
-* Tim Harder
-* Thiago Barroso Perrotta
-* Samuel Loury
-* Matthias Lisin
-* Marcel Schilling
-* Jean-Christophe Petkovich
-* Helen Sherwood-Taylor
-* HalosGhost
-* Gregor Pohl
-* Eivind Uggedal
-* Daniel Lu
-* Arseniy Seroka
-* Andy Balaam
-* Andreas Fischer
-// QUTE_AUTHORS_END
+Additionally, the following people have contributed graphics:
 
-The following people have contributed graphics:
-
-* WOFall (icon)
+* Jad/link:http://yelostudio.com[yelo] (new icon)
+* WOFall (original icon)
 * regines (key binding cheatsheet)
 
-Thanks / Similar projects
--------------------------
+Also, thanks to everyone who contributed to one of qutebrowser's
+link:doc/backers.asciidoc[crowdfunding campaigns]!
 
-Many projects with a similar goal as qutebrowser exist:
-
-* http://portix.bitbucket.org/dwb/[dwb] (C, GTK+ with WebKit1, currently
-http://www.reddit.com/r/linux/comments/2huqbc/dwb_abandoned/[unmaintained] -
-main inspiration for qutebrowser)
-* https://github.com/fanglingsu/vimb[vimb] (C, GTK+ with WebKit1, active)
-* http://sourceforge.net/p/vimprobable/wiki/Home/[vimprobable] (C, GTK+ with
-WebKit1, dead)
-* http://surf.suckless.org/[surf] (C, GTK+ with WebKit1, active)
-* https://mason-larobina.github.io/luakit/[luakit] (C/Lua, GTK+ with
-WebKit1, not very active)
-* http://pwmt.org/projects/jumanji/[jumanji] (C, GTK+ with WebKit1, not very
-active)
-* http://www.uzbl.org/[uzbl] (C, GTK+ with WebKit1/WebKit2, active)
-* http://conkeror.org/[conkeror] (Javascript, Emacs-like, XULRunner/Gecko,
-active)
-* https://github.com/AeroNotix/lispkit[lispkit] (quite new, lisp, GTK+ with
-WebKit, active)
-* http://www.vimperator.org/[Vimperator] (Firefox addon)
-* http://5digits.org/pentadactyl/[Pentadactyl] (Firefox addon)
-* https://github.com/akhodakivskiy/VimFx[VimFx] (Firefox addon)
-* https://github.com/1995eaton/chromium-vim[cVim] (Chrome/Chromium addon)
-* http://vimium.github.io/[vimium] (Chrome/Chromium addon)
-* https://chrome.google.com/webstore/detail/vichrome/gghkfhpblkcmlkmpcpgaajbbiikbhpdi?hl=en[ViChrome] (Chrome/Chromium addon)
-* https://github.com/jinzhu/vrome[Vrome] (Chrome/Chromium addon)
+Similar projects
+----------------
 
+Many projects with a similar goal as qutebrowser exist.
 Most of them were inspirations for qutebrowser in some way, thanks for that!
 
-Thanks as well to the following projects and people for helping me with
-problems and helpful hints:
+Active
+~~~~~~
 
-* http://eric-ide.python-projects.org/[eric5] / Detlev Offenbach
-* https://code.google.com/p/devicenzo/[devicenzo]
-* portix
-* seir
-* nitroxleecher
+* https://fanglingsu.github.io/vimb/[vimb] (C, GTK+ with WebKit2)
+* https://luakit.github.io/luakit/[luakit] (C/Lua, GTK+ with WebKit2)
+* http://surf.suckless.org/[surf] (C, GTK+ with WebKit1/WebKit2)
+* http://www.uzbl.org/[uzbl] (C, GTK+ with WebKit1/WebKit2)
+* Chrome/Chromium addons:
+  https://github.com/1995eaton/chromium-vim[cVim],
+  http://vimium.github.io/[Vimium],
+  https://github.com/brookhong/Surfingkeys[Surfingkeys],
+  https://key.saka.io/[Saka Key]
+* Firefox addons (based on WebExtensions):
+  https://addons.mozilla.org/en-GB/firefox/addon/vimium-ff/[Vimium-FF] (experimental),
+  https://key.saka.io[Saka Key],
+  https://github.com/cmcaine/tridactyl[Tridactyl] (in early development, working
+  on a https://bugzilla.mozilla.org/show_bug.cgi?id=1215061[better API] for
+  keyboard integration in Firefox).
 
-Also, thanks to:
+Inactive
+~~~~~~~~
 
-* Everyone who had the patience to test qutebrowser before v0.1.
-* Everyone triaging/fixing my bugs in the
-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.
+* https://bitbucket.org/portix/dwb[dwb] (C, GTK+ with WebKit1,
+https://bitbucket.org/portix/dwb/pull-requests/22/several-cleanups-to-increase-portability/diff[unmaintained] -
+main inspiration for qutebrowser)
+* http://sourceforge.net/p/vimprobable/wiki/Home/[vimprobable] (C, GTK+ with
+  WebKit1)
+* http://pwmt.org/projects/jumanji/[jumanji] (C, GTK+ with WebKit1)
+* http://conkeror.org/[conkeror] (Javascript, Emacs-like, XULRunner/Gecko)
+* Firefox addons (not based on WebExtensions or no recent activity):
+  http://www.vimperator.org/[Vimperator],
+  http://5digits.org/pentadactyl/[Pentadactyl],
+  https://github.com/akhodakivskiy/VimFx[VimFx],
+  https://github.com/shinglyu/QuantumVim[QuantumVim]
+* Chrome/Chromium addons:
+  https://chrome.google.com/webstore/detail/vichrome/gghkfhpblkcmlkmpcpgaajbbiikbhpdi?hl=en[ViChrome],
+  https://github.com/jinzhu/vrome[Vrome]
 
 License
 -------
@@ -271,7 +219,7 @@ 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+along with this program.  If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.
 
 pdf.js
 ------

doc/backers.asciidoc

@@ -0,0 +1,294 @@
+Crowdfunding backers
+====================
+
+2017
+----
+
+Mid-2017, qutebrowser had its
+https://www.kickstarter.com/projects/the-compiler/qutebrowser-v10-with-per-domain-settings[second crowdfunding]
+with the goal of implementing the new config system and releasing v1.0.
+
+Thanks a lot to the following people who contributed to it:
+
+Gold sponsors
+~~~~~~~~~~~~~
+
+TODO
+
+Silver sponsors
+~~~~~~~~~~~~~~~
+
+TODO
+
+Other sponsors
+~~~~~~~~~~~~~~
+
+TODO: people with t-shirts or higher pledge levels
+
+- 7scan
+- Alex Suykov
+- Alexey Zhikhartsev
+- Allan Nordhøy
+- Anirudh Sanjeev
+- Anssi Puustinen
+- Benedikt Steindorf
+- Bernardo Kuri
+- Blaise Duszynski
+- Bostan
+- Bruno Oliveira
+- Colin Jacobs
+- Daniel Andersson
+- Danilo
+- David Beley
+- David Hollings
+- David Parrish
+- Derin Yarsuvat
+- Dmytro Kostiuchenko
+- Frederik Thorøe
+- G4v4g4i
+- Gyula Teleki
+- H
+- Hosaka
+- Iordanis Grigoriou
+- Isaac Sandaljian
+- Jakub Podeszwik
+- Jamie Anderson
+- Jasper Woudenberg
+- Jens Højgaard
+- Johannes
+- John Baber-Lucero
+- Jonas Schürmann
+- Kenichiro Ito
+- Kenny Low
+- Lars Ivar Igesund
+- Lucas Aride Moulin
+- Ludovic Chabant
+- Lukas Gierth
+- Marulkan
+- Matthew Chun-Lum
+- Matthew Cronen
+- Matthew Quigley
+- Michael Schönwälder
+- Mika Kutila
+- Mitchell Stokes
+- Nathan Howell
+- Nathan Schlehlein
+- Noël Zindel
+- Obri
+- Patrik Peng
+- Peter DiMarco
+- Peter Rice
+- Philipp Middendorf
+- Pkill9
+- Prescott
+- Robotichead
+- Roshless
+- Ryan Ellis
+- Ryan P Deslandes
+- Sam Doshi
+- Sam Stone
+- Sean Herman
+- Sebastian Frysztak
+- Shelby Cruver
+- SirCmpwn
+- Soham Pal
+- Stewart Webb
+- Sven Reinecke
+- Tom Bass
+- Tomas Slusny
+- Tomasz Kramkowski
+- Tommy Thomas
+- Vasilij Schneidermann
+- Vlaaaaaaad
+- beanieuptop
+- demure
+- evenorbert
+- fishss
+- gsnewmark
+- guillermohs9
+- hubcaps
+- lobachevsky
+- neodarz
+- nihlaeth
+- notbenh
+- patrick suwanvithaya
+- pyratebeard
+- randm_dave
+- sabreman
+- toml
+- vimja
+- wiz
+- 43 Anonymous
+
+2016
+----
+
+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/contributing.asciidoc

@@ -11,9 +11,9 @@ This document contains guidelines for contributing to qutebrowser, as well as
 useful hints when doing so.
 
 If anything mentioned here would prevent you from contributing, please let me
-know, and contribute anyways! The guidelines are only meant to make life easier
-for me, but if you don't follow anything in here, I won't be mad at you. I will
-probably change it for you then, though.
+know, and contribute anyways! The guidelines are meant to make life easier for
+me, but if you don't follow everything in here, I won't be mad at you. In
+fact, I will probably change it for you.
 
 If you have any problems, I'm more than happy to help! You can get help in
 several ways:
@@ -34,17 +34,22 @@ this. It might be a good idea to ask on the mailing list or IRC channel to make
 sure nobody else started working on the same thing already.
 
 If you want to find something useful to do, check the
-https://github.com/The-Compiler/qutebrowser/issues[issue tracker]. Some
+https://github.com/qutebrowser/qutebrowser/issues[issue tracker]. Some
 pointers:
 
-* https://github.com/The-Compiler/qutebrowser/labels/easy[Issues which should
+* https://github.com/qutebrowser/qutebrowser/labels/easy[Issues which should
 be easy to solve]
-* https://github.com/The-Compiler/qutebrowser/labels/not%20code[Issues which
-require little/no coding]
+* https://github.com/qutebrowser/qutebrowser/labels/component%3A%20docs[Documentation issues which require little/no coding]
+
+If you prefer C++ or Javascript to Python, see the relevant issues which involve
+work in those languages:
+
+* https://github.com/qutebrowser/qutebrowser/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3Ac%2B%2B[C++] (mostly work on Qt, the library behind qutebrowser)
+* https://github.com/qutebrowser/qutebrowser/issues?q=is%3Aopen+is%3Aissue+label%3Ajavascript[JavaScript]
 
 There are also some things to do if you don't want to write code:
 
-* Help the community, e.g. on the mailinglist and the IRC channel.
+* Help the community, e.g., on the mailinglist and the IRC channel.
 * Improve the documentation.
 * Help on the website and graphics (logo, etc.).
 
@@ -55,12 +60,12 @@ qutebrowser uses http://git-scm.com/[git] for its development. You can clone
 the repo like this:
 
 ----
-git clone https://github.com/The-Compiler/qutebrowser.git
+git clone https://github.com/qutebrowser/qutebrowser.git
 ----
 
 If you don't know git, a http://git-scm.com/[git cheatsheet] might come in
 handy. Of course, if using git is the issue which prevents you from
-contributing, feel free to send normal patches instead, e.g. generated via
+contributing, feel free to send normal patches instead, e.g., generated via
 `diff -Nur`.
 
 Getting patches
@@ -77,7 +82,7 @@ based on your changes like this:
 ----
 git format-patch origin/master <1>
 ----
-<1> Replace `master` by the branch your work was based on, e.g.
+<1> Replace `master` by the branch your work was based on, e.g.,
 `origin/develop`.
 
 Useful utilities
@@ -89,28 +94,45 @@ Checkers
 qutebrowser uses http://tox.readthedocs.org/en/latest/[tox] to run its
 unittests and several linters/checkers.
 
-Currently, the following tools will be invoked when you run `tox`:
+Currently, the following tox environments are available:
 
-* Unit tests using https://www.pytest.org[pytest].
-* https://pypi.python.org/pypi/pyflakes[pyflakes] via https://pypi.python.org/pypi/pytest-flakes[pytest-flakes]
-* https://pypi.python.org/pypi/pep8[pep8] via https://pypi.python.org/pypi/pytest-pep8[pytest-pep8]
-* https://pypi.python.org/pypi/mccabe[mccabe] via https://pypi.python.org/pypi/pytest-mccabe[pytest-mccabe]
-* https://github.com/GreenSteam/pep257/[pep257]
-* http://pylint.org/[pylint]
-* https://pypi.python.org/pypi/pyroma/[pyroma]
-* https://github.com/mgedmin/check-manifest[check-manifest]
-* `scripts/misc_checks.py` which checks for the following things:
+* Tests using https://www.pytest.org[pytest]:
+  - `py35`, `py36`: Run pytest for python 3.5/3.6 with the system-wide PyQt.
+  - `py36-pyqt57`, ..., `py36-pyqt59`: Run pytest with the given PyQt version (`py35-*` also works).
+  - `py36-pyqt59-cov`: Run with coverage support (other Python/PyQt versions work too).
+* `flake8`: Run https://pypi.python.org/pypi/flake8[flake8] checks:
+                https://pypi.python.org/pypi/pyflakes[pyflakes],
+                https://pypi.python.org/pypi/pep8[pep8],
+                https://pypi.python.org/pypi/mccabe[mccabe].
+* `vulture`: Run https://pypi.python.org/pypi/vulture[vulture] to find
+  unused code portions.
+* `pylint`: Run http://pylint.org/[pylint] static code analysis.
+* `pydocstyle`: Check
+  https://www.python.org/dev/peps/pep-0257/[PEP257] compliance with
+  https://github.com/PyCQA/pydocstyle[pydocstyle].
+* `pyroma`: Check packaging practices with
+  https://pypi.python.org/pypi/pyroma/[pyroma].
+* `eslint`: Run http://eslint.org/[ESLint] javascript checker.
+* `check-manifest`: Check MANIFEST.in completeness with
+  https://github.com/mgedmin/check-manifest[check-manifest].
+* `mkvenv`: Bootstrap a virtualenv for testing.
+* `misc`: Run `scripts/misc_checks.py` to check for:
     - untracked git files
     - VCS conflict markers
+    - common spelling mistakes
+
+The default test suite is run with `tox`; the list of default
+environments is obtained with `tox -l`.
 
 Please make sure the checks run without any warnings on your new contributions.
-There's of course the possibility of false-positives, and the following
+
+There's always the possibility of false positives; the following
 techniques are useful to handle these:
 
 * Use `_foo` for unused parameters, with `foo` being a descriptive name. Using
 `_` is discouraged.
-* If you think you have a good reason to suppress a message, add the following
-comment:
+* If you think you have a good reason to suppress a message, then add the
+following comment:
 +
 ----
 # pylint: disable=message-name
@@ -122,24 +144,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.6/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.
 
@@ -164,9 +218,8 @@ Documentation of used Python libraries:
 * http://pygments.org/docs/[pygments]
 * http://fdik.org/pyPEG/index.html[pyPEG2]
 * http://pythonhosted.org/setuptools/[setuptools]
-* http://cx-freeze.readthedocs.org/en/latest/overview.html[cx_Freeze]
+* http://www.pyinstaller.org/[PyInstaller]
 * https://pypi.python.org/pypi/colorama[colorama]
-* https://pypi.python.org/pypi/colorlog[colorlog]
 
 Related RFCs and standards:
 
@@ -227,41 +280,40 @@ Hints
 Python and Qt objects
 ~~~~~~~~~~~~~~~~~~~~~
 
-For many tasks, there are solutions in both Qt and the Python standard library
-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`
+* `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
@@ -273,7 +325,7 @@ dictionaries which map object names to the actual long-living objects.
 There are currently these object registries, also called 'scopes':
 
 * The `global` scope, with objects which are used globally (`config`,
-`cookie-jar`, etc.)
+`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 explicitly selected by passing
@@ -290,8 +342,8 @@ 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
+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.
 
@@ -301,7 +353,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
@@ -325,7 +377,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.
@@ -363,43 +415,68 @@ then gets passed as the `self` parameter to the handler. The `scope` argument
 selects which object registry (global, per-tab, etc.) to use.  See the
 <<object-registry,object registry>> section for details.
 
-There are also other arguments to customize the way the command is registered,
-see the class documentation for `register` in `qutebrowser.commands.utils` for
-details.
+There are also other arguments to customize the way the command is
+registered; see the class documentation for `register` in
+`qutebrowser.commands.cmdutils` for details.
 
 The types of the function arguments are inferred based on their default values,
-e.g. an argument `foo=True` will be converted to a flag `-f`/`--foo` in
+e.g., an argument `foo=True` will be converted to a flag `-f`/`--foo` in
 qutebrowser's commandline.
 
-This behavior can be overridden using Python's
-http://legacy.python.org/dev/peps/pep-3107/[function annotations]. The
-annotation should always be a `dict`, like this:
+The type can be overridden using Python's
+http://legacy.python.org/dev/peps/pep-3107/[function annotations]:
 
 [source,python]
 ----
 @cmdutils.register(...)
-def foo(bar: {'type': int}, baz=True):
+def foo(bar: int, baz=True):
     ...
 ----
 
-The following keys are supported in the dict:
+Possible values:
 
-* `type`: The type this value should have. The value entered by the user is
-then automatically checked. 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).
-* `nargs`: Gets passed to argparse, see
-https://docs.python.org/dev/library/argparse.html#nargs[its documentation].
+- A callable (`int`, `float`, etc.): Gets called to validate/convert the value.
+- A python enum type: All members of the enum are possible values.
+- 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 completion function (see `qutebrowser.completions.models.*`)
+  to use when completing arguments for the given command.
+- `choices`: The allowed string choices for the argument.
 
 The name of an argument will always be the parameter name, with any trailing
-underscores stripped.
+underscores stripped and underscores replaced by dashes.
 
 [[handling-urls]]
 Handling URLs
@@ -409,13 +486,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.
@@ -441,8 +518,8 @@ This is needed so valgrind handles self-modifying code correctly:
 [quote]
 ____
 This option controls Valgrind's detection of self-modifying code. If no
-checking is done, if a program executes some code, then overwrites it with new
-code, and executes the new code, Valgrind will continue to execute the
+checking is done and a program executes some code, overwrites it with new
+code, and then executes the new code, Valgrind will continue to execute the
 translations it made for the old code. This will likely lead to incorrect
 behavior and/or crashes.
 
@@ -454,6 +531,49 @@ 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-362/[Python 3.6].
+* Install PyQt via `pip install PyQt5`.
+* Create a file at `C:\Windows\system32\python3.bat` with the following content (adjust the path as necessary):
+  `@C:\Python36\python %*`.
+  This will make the Python 3.6 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>`.
+
+Chrome URLs
+~~~~~~~~~~~
+
+With the QtWebEngine backend, qutebrowser supports several chrome:// urls which
+can be useful for debugging:
+
+- chrome://appcache-internals/
+- chrome://blob-internals/
+- chrome://gpu/
+- chrome://histograms/
+- chrome://indexeddb-internals/
+- chrome://media-internals/
+- chrome://network-errors/
+- chrome://serviceworker-internals/
+- chrome://webrtc-internals/
+- chrome://crash/ (crashes the current renderer process!)
+- chrome://kill/ (kills the current renderer process!)
+- chrome://gpucrash/ (crashes qutebrowser!)
+- chrome://gpuhang/ (hangs qutebrowser!)
+- chrome://gpuclean/ (crashes the current renderer process!)
+- chrome://ppapiflashcrash/
+- chrome://ppapiflashhang/
+
 Style conventions
 -----------------
 
@@ -522,10 +642,7 @@ Return:
 * The layout of a class should be like this:
   - docstring
   - `__magic__` methods
-  - properties
-  - _private methods
-  - public methods
-  - `on_*` methods
+  - other methods
   - overrides of Qt methods
 
 Checklists
@@ -541,47 +658,42 @@ New Qt release
 https://bugreports.qt.io/issues/?jql=reporter%20%3D%20%22The%20Compiler%22%20ORDER%20BY%20fixVersion%20ASC[Qt bugtracker]
 and make sure all bugs marked as resolved are actually fixed.
 * Update own PKGBUILDs based on upstream Archlinux updates and rebuild.
-* Update recommended Qt version in `README`
+* Update recommended Qt version in `README`.
 * Grep for `WORKAROUND` in the code and test if fixed stuff works without the
 workaround.
 * Check relevant
-https://github.com/The-Compiler/qutebrowser/issues?q=is%3Aopen+is%3Aissue+label%3Aqt[qutebrowser
+https://github.com/qutebrowser/qutebrowser/issues?q=is%3Aopen+is%3Aissue+label%3Aqt[qutebrowser
 bugs] and check if they're fixed.
 
 New PyQt release
 ~~~~~~~~~~~~~~~~
 
-* See above
-* Install new PyQt in Windows VM (32- and 64-bit)
+* 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 and the tests are green.
+* Run `x=... y=...` to set the respective shell variables.
 
 * Adjust `__version_info__` in `qutebrowser/__init__.py`.
-* Remove *(unreleased)* from changelog.
-* Run tests again
-* Run `asciidoc2html.py`.
-* Commit
+* Update changelog (remove *(unreleased)*).
+* Run tests again.
+* Commit.
 
-* Create annotated git tag (`git tag -s "v0.X.Y" -m "Release v0.X.Y"`)
-* If it's a new minor, create git branch `v0.X.x`
+* Create annotated git tag (`git tag -s "v1.$x.$y" -m "Release v1.$x.$y"`).
+* `git push origin`; `git push origin v1.$x.$y`.
 * If committing on minor branch, cherry-pick release commit to master.
-* `git push origin`; `git push origin v0.X.Y`
-* Create release on github
-* Mark the milestone at https://github.com/The-Compiler/qutebrowser/milestones
+* Create release on github.
+* Mark the milestone at https://github.com/qutebrowser/qutebrowser/milestones
 as closed.
 
-* Run `scripts/dev/build_release.py` on Linux to build an sdist
-* Upload to PyPI: `twine upload dist/foo{,.asc}`
-* Create Windows packages via `scripts/dev/build_release.py` and upload.
-
-* Upload to qutebrowser.org with checksum/GPG
-    - On server: `sudo mkdir -p /srv/http/qutebrowser/releases/v0.X.Y/windows`
-    - `rsync -avPh dist/ tonks:`
-    - On server: `sudo mv qutebrowser-0.X.Y.tar.gz* /srv/http/qutebrowser/releases/v0.X.Y`
-
-* Update AUR package
-* Announce to qutebrowser mailinglist
+* Linux: Run `python3 scripts/dev/build_release.py --upload v1.$x.$y`.
+* Windows: Run `C:\Python36-32\python scripts\dev\build_release.py --asciidoc C:\Python27\python C:\asciidoc-8.6.9\asciidoc.py --upload v1.X.Y` (replace X/Y by hand).
+* macOS: Run `python3 scripts/dev/build_release.py --upload v1.X.Y` (replace X/Y by hand).
+* On server: Run `python3 scripts/dev/download_release.py v1.X.Y` (replace X/Y by hand).
+* Update `qutebrowser-git` PKGBUILD if dependencies/install changed.
+* Announce to qutebrowser and qutebrowser-announce mailinglist.

doc/faq.asciidoc

@@ -72,32 +72,118 @@ Is there an adblocker?::
     http://www.reddit.com/r/programming/comments/25j41u/adblock_pluss_effect_on_firefoxs_memory_usage/chhpomw[big
     impact] on browsing speed and
     https://blog.mozilla.org/nnethercote/2014/05/14/adblock-pluss-effect-on-firefoxs-memory-usage/[RAM
-    usage], so implementing it properly might take some time and won't be done
-    for v0.1 if at all.
+    usage], so implementing support for AdBlockPlus-like lists is currently not
+    a priority.
 
 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 x spawn mpv {url}
-:bind ;x hint links spawn mpv {hint-url}
+:bind m spawn mpv {url}
+:bind M hint links spawn mpv {hint-url}
 ----
 +
 Note that you might need an additional package (e.g.
 https://www.archlinux.org/packages/community/any/youtube-dl/[youtube-dl] on
 Archlinux) to play web videos with mpv.
++
+There is a very useful script for mpv, which emulates "unique application"
+functionality. This way you can add links to the mpv playlist instead of
+playing them all at once.
++
+You can find the script here: https://github.com/mpv-player/mpv/blob/master/TOOLS/umpv
++
+It also works nicely with rapid hints:
++
+----
+:bind m spawn umpv {url}
+:bind M hint links spawn umpv {hint-url}
+:bind ;M hint --rapid links spawn umpv {hint-url}
+----
 
 How do I use qutebrowser with mutt?::
     Due to a Qt limitation, local files without `.html` extensions are
     "downloaded" instead of displayed, see
-    https://github.com/The-Compiler/qutebrowser/issues/566[#566]. You can work
+    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.
+
+How do I use spell checking?::
+	Configuring spell checking in qutebrowser depends on the backend in use
+    (see https://github.com/qutebrowser/qutebrowser/issues/700[#700] for
+	a more detailed discussion).
++
+For QtWebKit:
+
+. Install https://github.com/QupZilla/qtwebkit-plugins[qtwebkit-plugins].
+  . Note: with QtWebKit reloaded you may experience some issues. See
+    https://github.com/QupZilla/qtwebkit-plugins/issues/10[#10].
+. The dictionary to use is taken from the `DICTIONARY` environment variable.
+  The default is `en_US`. For example to use Dutch spell check set `DICTIONARY`
+  to `nl_NL`; you can't use multiple dictionaries or change them at runtime at
+  the moment.
+  (also see the README file for `qtwebkit-plugins`).
+. Remember to install the hunspell dictionaries if you don't have them already
+  (most distros should have packages for this).
+
++
+For QtWebEngine:
+
+. Make sure your versions of PyQt and Qt are 5.8 or higher.
+. Use `install_dict.py` script to install dictionaries.
+  Run the script with `-h` for the parameter description.
+. Set `spellcheck.languages` to the desired list of languages, e.g.:
+  `:set spellcheck.languages "['en-US', 'pl-PL']"`
+
+How do I use Tor with qutebrowser?::
+    Start tor on your machine, and do `:set network proxy socks://localhost:9050/`
+    in qutebrowser. Note this won't give you the same amount of fingerprinting
+    protection that the Tor Browser does, but it's useful to be able to access
+    `.onion` sites.
+
+Why does J move to the next (right) tab, and K to the previous (left) one?::
+    One reason is because https://bitbucket.org/portix/dwb[dwb] did it that way,
+    and qutebrowser's keybindings are designed to be compatible with dwb's.
+    The rationale behind it is that J is "down" in vim, and K is "up", which
+    corresponds nicely to "next"/"previous". It also makes much more sense with
+    vertical tabs (e.g. `:set tabs position left`).
+
+What's the difference between insert and passthrough mode?::
+    They are quite similar, but insert mode has some bindings (like `Ctrl-e` to
+    open an editor) while passthrough mode only has escape bound. It might also
+    be useful to rebind escape to something else in passthrough mode only, to be
+    able to send an escape keypress to the website.
+
+Why takes it longer to open an URL in qutebrowser than in chromium?::
+    When opening an URL in an existing instance the normal qutebrowser
+    Python script is started and a few PyQt libraries need to be
+    loaded until it is detected that there is an instance running
+    where the URL is then passed to. This takes some time.
+    One workaround is to use this
+    https://github.com/qutebrowser/qutebrowser/blob/master/scripts/open_url_in_instance.sh[script]
+    and place it in your $PATH with the name "qutebrowser". This
+    script passes the URL via an unix socket to qutebrowser (if its
+    running already) using socat which is much faster and starts a new
+    qutebrowser if it is not running already. Also check if you want
+    to use webengine as backend in line 17 and change it to your
+    needs.
+    
 == Troubleshooting
 
 Configuration not saved after modifying config.::
@@ -106,7 +192,7 @@ Configuration not saved after modifying config.::
 
 Unable to view flash content.::
     If you have flash installed for on your system, it's necessary to enable plugins
-    to use the flash plugin. Using the command `:set content allow-plugins true`
+    to use the flash plugin. Using the command `:set content.plugins true`
     in qutebrowser will enable plugins. Packages for flash should
     be provided for your platform or it can be obtained from
     http://get.adobe.com/flashplayer/[Adobe].
@@ -115,33 +201,25 @@ 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 qutebrowser and removing `~/.mozilla/plugins/mozplugger*.so`.
-    See https://github.com/The-Compiler/qutebrowser/issues/357[Issue #357]
+    See https://github.com/qutebrowser/qutebrowser/issues/357[Issue #357]
     for more details.
 
-Experiencing segfaults (crashes) on Debian systems.::
-    For Debian it's highly recommended to install the `gstreamer0.10-plugins-base` package.
-    This is a workaround for a bug in Qt, it has been fixed upstream in Qt 5.4
-    More details can be found
-    https://bugs.webkit.org/show_bug.cgi?id=119951[here].
-
-Segfaults on Facebook, Medium, Amazon, ...::
-    If you are on a Debian or Ubuntu based system, you might experience some crashes
-    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. On Debian Jessie, it's recommended to use the experimental
-    repos as described in https://github.com/The-Compiler/qutebrowser/blob/master/INSTALL.asciidoc#on-debian--ubuntu[INSTALL].
+When using QtWebEngine, qutebrowser reports "Render Process Crashed" and the console prints a traceback on Gentoo Linux or another Source-Based Distro::
+    As stated in https://gcc.gnu.org/gcc-6/changes.html[GCC's Website] GCC 6 has introduced some optimizations that could break non-conforming codebases, like QtWebEngine. +
+    As a workaround, you can disable the nullpointer check optimization by adding the -fno-delete-null-pointer-checks flag while compiling. +
+    On gentoo, you just need to add it into your make.conf, like this: +
+    
+    CFLAGS="... -fno-delete-null-pointer-checks"
+    CXXFLAGS="... -fno-delete-null-pointer-checks"
 +
-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].
+And then re-emerging qtwebengine with: +
+    
+    emerge -1 qtwebengine
 
 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.

doc/help/configuring.asciidoc

@@ -0,0 +1,369 @@
+Configuring qutebrowser
+=======================
+
+IMPORTANT: qutebrowser's configuration system was completely rewritten in
+September 2017. This information is not applicable to older releases, and older
+information elsewhere might be outdated. **If you had an old configuration
+around and upgraded, this page will automatically open once**. To view it at a
+later time, use the `:help` command.
+
+Migrating older configurations
+------------------------------
+
+qutebrowser does no automatic migration for the new configuration. However,
+there's a special link:qute://configdiff/old[configdiff] page in qutebrowser,
+which will show you the changes you did in your old configuration, compared to
+the old defaults.
+
+Other changes in default settings:
+
+- `<Up>` and `<Down>` in the completion now navigate through command history
+  instead of selecting completion items. You can get back the old behavior by
+  doing:
++
+----
+:bind -m command <Up> completion-item-focus prev
+:bind -m command <Down> completion-item-focus next
+----
+
+- The default for `completion.web_history_max_items` is now set to `-1`, showing
+  an unlimited number of items in the completion for `:open` as the new
+  sqlite-based completion is much faster. If the `:open` completion is too slow
+  on your machine, set an appropriate limit again.
+
+Configuring qutebrowser via the user interface
+----------------------------------------------
+
+The easy (but less flexible) way to configure qutebrowser is using its user
+interface or command line. Changes you make this way are immediately active
+(with the exception of a few settings, where this is pointed out in the
+documentation) and are persisted in an `autoconfig.yml` file.
+
+The `autoconfig.yml` file is located in the "config" folder listed on the
+link:qute://version[] page. On macOS, the "auto config" folder is used, which is
+different from where hand-written config files are kept.
+
+However, **do not** edit `autoconfig.yml` by hand. Instead, see the next
+section.
+
+If you want to customize many settings, you can open the link:qute://settings[]
+page by running `:set` without any arguments, where all settings are listed and
+customizable.
+
+Using the link:commands.html#set[`:set`] command and command completion, you
+can quickly set settings interactively, for example `:set tabs.position left`.
+
+To get more help about a setting, use e.g. `:help tabs.position`.
+
+To bind and unbind keys, you can use the link:commands.html#bind[`:bind`] and
+link:commands.html#unbind[`:unbind`] commands:
+
+- Binding the key chain `,v` to the `:spawn mpv {url}` command:
+  `:bind ,v spawn mpv {url}`
+- Unbinding the same key chain: `:unbind ,v`
+
+Key chains starting with a comma are ideal for custom bindings, as the comma key
+will never be used in a default keybinding.
+
+See the help pages linked above (or `:help :bind`, `:help :unbind`) for more
+information.
+
+Other useful commands for config manipulation are
+link:commands.html#config-unset[`:config-unset`] to reset a value to its default,
+link:commands.html#config-clear[`:config-clear`] to reset the entire configuration,
+and link:commands.html#config-cycle[`:config-cycle`] to cycle a setting between
+different values.
+
+Configuring qutebrowser via config.py
+-------------------------------------
+
+For more powerful configuration possibilities, you can create a `config.py`
+file. Since it's a Python file, you have much more flexibility for
+configuration. Note that qutebrowser will never touch this file - this means
+you'll be responsible for updating it when upgrading to a newer qutebrowser
+version.
+
+You can run `:config-edit` inside qutebrowser to open the file in your editor,
+`:config-source` to reload the file (`:config-edit` does this automatically), or
+`:config-write-py --defaults` to write a template file to work with.
+
+The file should be located in the "config" location listed on
+link:qute://version[], which is typically `~/.config/qutebrowser/config.py` on
+Linux, `~/.qutebrowser/config.py` on macOS, and
+`%APPDATA%/qutebrowser/config.py` on Windows.
+
+Two global objects are pre-defined when running `config.py`: `c` and `config`.
+
+Changing settings
+~~~~~~~~~~~~~~~~~
+
+While you can set settings using the `config.set()` method (which is explained
+in the next section), it's easier to use the `c` shorthand object to easily set
+settings like this:
+
+.config.py:
+[source,python]
+----
+c.tabs.position = "left"
+c.completion.shrink = True
+----
+
+Note that qutebrowser does some Python magic so it's able to warn you about
+mistyped config settings. As an example, if you do `c.tabs.possition = "left"`,
+you'll get an error when starting.
+
+See the link:settings.html[settings help page] for all available settings. The
+accepted values depend on the type of the option. Commonly used are:
+
+- Strings: `c.tabs.position = "left"`
+- Booleans: `c.completion.shrink = True`
+- Integers: `c.messages.timeout = 5000`
+- Dictionaries:
+  * `c.headers.custom = {'X-Hello': 'World', 'X-Awesome': 'yes'}` to override
+    any other values in the dictionary.
+  * `c.aliases['foo'] = 'message-info foo'` to add a single value.
+- Lists:
+  * `c.url.start_pages = ["https://www.qutebrowser.org/"]` to override any
+    previous elements.
+  * `c.url.start_pages.append("https://www.python.org/")` to add a new value.
+
+Any other config types (e.g. a color) are specified as a string. The only
+exception is the `Regex` type, which can take either a string (with an `r`
+prefix to preserve backslashes) or a Python regex object:
+
+- `c.hints.next_regexes.append(r'\bvor\b')`
+- `c.hints.prev_regexes.append(re.compile(r'\bzurück\b'))`
+
+If you want to read a setting, you can use the `c` object to do so as well:
+`c.colors.tabs.even.bg = c.colors.tabs.odd.bg`.
+
+
+Using strings for setting names
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to set settings based on their name as a string, use the
+`config.set` method:
+
+.config.py:
+[source,python]
+----
+# Equivalent to:
+# c.content.javascript.enabled = False
+config.set('content.javascript.enabled', False)
+----
+
+To read a setting, use the `config.get` method:
+
+[source,python]
+----
+# Equivalent to:
+# color = c.colors.completion.fg
+color = config.get('colors.completion.fg')
+----
+
+Binding keys
+~~~~~~~~~~~~
+
+While it's possible to change the `bindings.commands` setting to bind keys, it's
+preferred to use the `config.bind` command. Doing so ensures the commands are
+valid and normalizes different expressions which map to the same key.
+
+For details on how to specify keys and the available modes, see the
+link:settings.html#bindings.commands[documentation] for the `bindings.commands`
+setting.
+
+To bind a key:
+
+.config.py:
+[source,python]
+----
+config.bind('<Ctrl-v>', 'spawn mpv {url}')
+----
+
+To bind a key in a mode other than `'normal'`, add a `mode` argument:
+
+[source,python]
+----
+config.bind('<Ctrl-y>', 'prompt-yes', mode='prompt')
+----
+
+To unbind a key (either a key which has been bound before, or a default binding):
+
+[source,python]
+----
+config.unbind('<Ctrl-v>', mode='normal')
+----
+
+To bind keys without modifiers, specify a key chain to bind as a string. Key
+chains starting with a comma are ideal for custom bindings, as the comma key
+will never be used in a default keybinding.
+
+[source,python]
+----
+config.bind(',v', 'spawn mpv {url}')
+----
+
+To suppress loading of any default keybindings, you can set
+`c.bindings.default = {}`.
+
+Loading `autoconfig.yml`
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, all customization done via `:set`, `:bind` and `:unbind` is
+temporary as soon as a `config.py` exists. The settings done that way are always
+saved in the `autoconfig.yml` file, but you'll need to explicitly load it in
+your `config.py` by doing:
+
+.config.py:
+[source,python]
+----
+config.load_autoconfig()
+----
+
+If you do so at the top of your file, your `config.py` settings will take
+precedence as they overwrite the settings done in `autoconfig.yml`.
+
+Importing other modules
+~~~~~~~~~~~~~~~~~~~~~~~
+
+You can import any module from the
+https://docs.python.org/3/library/index.html[Python standard library] (e.g.
+`import os.path`), as well as any module installed in the environment
+qutebrowser is run with.
+
+If you have an `utils.py` file in your qutebrowser config folder, you can import
+that via `import utils` as well.
+
+While it's in some cases possible to import code from the qutebrowser
+installation, doing so is unsupported and discouraged.
+
+Getting the config directory
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you need to get the qutebrowser config directory, you can do so by reading
+`config.configdir`. Similarily, you can get the qutebrowser data directory via
+`config.datadir`.
+
+This gives you a https://docs.python.org/3/library/pathlib.html[`pathlib.Path`
+object], on which you can use `/` to add more directory parts, or `str(...)` to
+get a string:
+
+.config.py:
+[source,python]
+----
+print(str(config.configdir / 'config.py')
+----
+
+Handling errors
+~~~~~~~~~~~~~~~
+
+If there are errors in your `config.py`, qutebrowser will try to apply as much
+of it as possible, and show an error dialog before starting.
+
+qutebrowser tries to display errors which are easy to understand even for people
+who are not used to writing Python. If you see a config error which you find
+confusing or you think qutebrowser could handle better, please
+https://github.com/qutebrowser/qutebrowser/issues[open an issue]!
+
+Recipes
+~~~~~~~
+
+Reading a YAML file
+^^^^^^^^^^^^^^^^^^^
+
+To read a YAML config like this:
+
+.config.yml:
+----
+tabs.position: left
+tabs.show: switching
+----
+
+You can use:
+
+.config.py:
+[source,python]
+----
+import yaml
+
+with (config.configdir / 'config.yml').open() as f:
+    yaml_data = yaml.load(f)
+
+for k, v in yaml_data.items():
+    config.set(k, v)
+----
+
+Reading a nested YAML file
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To read a YAML file with nested values like this:
+
+.colors.yml:
+----
+colors:
+  statusbar:
+    normal:
+      bg: lime
+      fg: black
+    url:
+      fg: red
+----
+
+You can use:
+
+.config.py:
+[source,python]
+----
+import yaml
+
+with (config.configdir / 'colors.yml').open() as f:
+    yaml_data = yaml.load(f)
+
+def dict_attrs(obj, path=''):
+    if isinstance(obj, dict):
+        for k, v in obj.items():
+            yield from dict_attrs(v, '{}.{}'.format(path, k) if path else k)
+    else:
+        yield path, obj
+
+for k, v in dict_attrs(yaml_data):
+    config.set(k, v)
+----
+
+Note that this won't work for values which are dictionaries.
+
+Binding chained commands
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you have a lot of chained commands you want to bind, you can write a helper
+to do so:
+
+[source,python]
+----
+def bind_chained(key, *commands):
+    config.bind(key, ' ;; '.join(commands))
+
+bind_chained('<Escape>', 'clear-keychain', 'search')
+----
+
+Avoiding flake8 errors
+^^^^^^^^^^^^^^^^^^^^^^
+
+If you use an editor with flake8 integration which complains about `c` and `config` being undefined, you can use:
+
+[source,python]
+----
+c = c  # noqa: F821
+config = config  # noqa: F821
+----
+
+For type annotation support (note that those imports aren't guaranteed to be
+stable across qutebrowser versions):
+
+[source,python]
+----
+from qutebrowser.config.configfiles import ConfigAPI  # noqa: F401
+from qutebrowser.config.config import ConfigContainer  # noqa: F401
+config = config  # type: ConfigAPI # noqa: F821
+c = c  # type: ConfigContainer # noqa: F821
+----

doc/help/index.asciidoc

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

doc/install.asciidoc

@@ -0,0 +1,380 @@
+Installing qutebrowser
+======================
+
+toc::[]
+
+NOTE: qutebrowser recently had some bigger dependency changes for v1.0.0, which
+means those instructions might be out of date in some places.
+https://github.com/qutebrowser/qutebrowser/blob/master/doc/contributing.asciidoc[Please help]
+updating them if you notice something being broken!
+
+On Debian / Ubuntu
+------------------
+
+How to install qutebrowser depends a lot on the version of Debian/Ubuntu you're
+running.
+
+Debian Jessie / Ubuntu 14.04 LTS / Linux Mint < 18
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Those distributions only have Python 3.4 and a too old Qt version available,
+while qutebrowser requires Python 3.5 and Qt 5.7.1 or newer.
+
+It should be possible to install Python 3.5 e.g. from the
+https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa[deadsnakes PPA] or via_ipca
+https://github.com/pyenv/pyenv[pyenv], but nobody tried that yet.
+
+If you get qutebrowser running on those distributions, please
+https://github.com/qutebrowser/qutebrowser/blob/master/doc/contributing.asciidoc[contribute]
+to update this documentation!
+
+Ubuntu 16.04 LTS / Linux Mint 18
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Ubuntu 16.04 doesn't come with an up-to-date engine (a new enough QtWebKit, or
+QtWebEngine). However, it comes with Python 3.5, so you can
+<<tox,install qutebrowser via tox>>.
+
+Debian Stretch / Ubuntu 17.04 and newer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Those versions come with QtWebEngine in the repositories. This makes it possible
+to install qutebrowser via the Debian package.
+
+Install the dependencies via apt-get:
+
+----
+# apt install python-tox python3-{lxml,pyqt5,sip,jinja2,pygments,yaml,attr} python3-pyqt5.qt{webengine,quick,opengl,sql} libqt5sql5-sqlite
+----
+
+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
+----
+
+Some additional hints:
+
+- Alternatively, you can <<tox,install qutebrowser via tox>> to get a newer
+  QtWebEngine version.
+- If running from git, run the following to generate the documentation for the
+  `:help` command:
++
+----
+# apt-get install --no-install-recommends asciidoc source-highlight
+$ python3 scripts/asciidoc2html.py
+----
+
+- If you prefer using QtWebKit, there's an up-to-date version available in
+  Debian experimental, or from http://repo.paretje.be/unstable/[this repository]
+  for Debian Stretch.
+- If video or sound don't work with QtWebKit, try installing the gstreamer plugins:
++
+----
+# apt-get install gstreamer1.0-plugins-{bad,base,good,ugly}
+----
+
+On Fedora
+---------
+
+qutebrowser is available in the official repositories for Fedora 22 and newer.
+
+----
+# dnf install qutebrowser
+----
+
+It's also recommended to install `python3-qt5-webengine` and start with `--backend
+webengine` to use the new backend. v1.0.0 (which is not in the Fedora repos
+currently) uses QtWebEngine by default.
+
+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 work with QtWebKit, try installing the gstreamer plugins:
+
+----
+# pacman -S gst-plugins-{base,good,bad,ugly} gst-libav
+----
+
+On Gentoo
+---------
+
+The Gentoo packages (even the live version) are lagging behind a lot and are
+effectively unmaintained. If you want to create and maintain an official
+qutebrowser overlay for Gentoo, please mailto:mail@qutebrowser.org[get in
+touch.]
+
+It's recommended to <<tox,install qutebrowser via tox>> instead.
+
+To get an up-to-date QtWebKit, you can use
+https://gist.github.com/annulen/309569fb61e5d64a703c055c1e726f71[this ebuild].
+
+If video or sound don't work with QtWebKit, try installing the gstreamer
+plugins:
+
+----
+# emerge -av gst-plugins-{base,good,bad,ugly,libav}
+----
+
+To be able to play videos with proprietary codecs with QtWebEngine, you will
+need to turn off the `bindist` flag for `dev-qt/qtwebengine`.
+
+See the https://wiki.gentoo.org/wiki/Qutebrowser#USE_flags[Gentoo Wiki] for
+more information.
+
+On Void Linux
+-------------
+
+qutebrowser is available in the official repositories and can be installed
+with:
+
+----
+# xbps-install qutebrowser
+----
+
+It's currently recommended to install `python3-PyQt5-webengine` and
+`python3-PyQt5-opengl`, then start with `--backend webengine` to use the new
+backend.
+
+Since the v1.0 release, qutebrowser uses QtWebEngine by default.
+
+On NixOS
+--------
+
+Nixpkgs collection contains `pkgs.qutebrowser` since June 2015. You can install
+it with:
+
+----
+$ nix-env -i qutebrowser
+----
+
+It's recommended to install `qt5.qtwebengine` and start with
+`--backend webengine` to use the new backend.
+
+Since the v1.0 release, qutebrowser uses QtWebEngine by default.
+
+On openSUSE
+-----------
+
+There are prebuilt RPMs available at https://software.opensuse.org/download.html?project=network&package=qutebrowser[OBS].
+
+To use the QtWebEngine backend, install `libqt5-qtwebengine`.
+
+On OpenBSD
+----------
+
+qutebrowser is in http://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/www/qutebrowser/[OpenBSD ports].
+
+Install the package:
+
+----
+# pkg_add qutebrowser
+----
+
+Or alternatively, use the ports system :
+
+----
+# cd /usr/ports/www/qutebrowser
+# make install
+----
+
+On Windows
+----------
+
+There are different ways to install qutebrowser on Windows:
+
+Prebuilt binaries
+~~~~~~~~~~~~~~~~~
+
+Prebuilt standalone packages and installers
+https://github.com/qutebrowser/qutebrowser/releases[are built] for every
+release.
+
+Note that you'll need to upgrade to new versions manually (subscribe to the
+https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[qutebrowser-announce
+mailinglist] to get notified on new releases). You can install a newer version
+without uninstalling the older one.
+
+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).
+* 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 macOS
+--------
+
+Prebuilt binary
+~~~~~~~~~~~~~~~
+
+The easiest way to install qutebrowser on macOS is to use the prebuilt `.app`
+files from the
+https://github.com/qutebrowser/qutebrowser/releases[release page].
+
+Note that you'll need to upgrade to new versions manually (subscribe to the
+https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[qutebrowser-announce
+mailinglist] to get notified on new releases).
+
+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
+----
+
+Since the v1.0 release, qutebrowser uses QtWebEngine by default.
+
+Homebrew's builds of Qt and PyQt don't come with QtWebKit (and `--with-qtwebkit`
+uses an old version of QtWebKit which qutebrowser doesn't support anymore). If
+you want QtWebKit support, you'll need to build an up-to-date QtWebKit
+https://github.com/annulen/webkit/wiki/Building-QtWebKit-on-OS-X[manually].
+
+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
+-------------------------------
+
+Getting the repository
+~~~~~~~~~~~~~~~~~~~~~~
+
+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
+----
+
+Installing depdendencies (including Qt)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Then run tox inside the qutebrowser repository to set up a
+https://docs.python.org/3/library/venv.html[virtual environment]:
+
+----
+$ tox -e mkvenv-pypi
+----
+
+This installs all needed Python dependencies in a `.venv` subfolder.
+
+This comes with an up-to-date Qt/PyQt including QtWebEngine, but has a few
+caveats:
+
+- Make sure your `python3` is Python 3.5 or newer, otherwise you'll get a "No
+  matching distribution found" error. Note that qutebrowser itself also requires
+  this.
+- It only works on 64-bit x86 systems, with other architectures you'll get the
+  same error.
+- If your distribution uses OpenSSL 1.1 (like Debian Stretch or Archlinux),
+  you'll need to set `LD_LIBRARY_PATH` to the OpenSSL 1.0 directory
+  (`export LD_LIBRARY_PATH=/usr/lib/openssl-1.0` on Archlinux) before starting
+  qutebrowser if you want SSL to work in certain downloads (e.g. for
+  `:adblock-update` or `:download`).
+- It comes with a QtWebEngine compiled without proprietary codec support (such
+  as h.264).
+
+See the next section for an alternative.
+
+Installing dependencies (system-wide Qt)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Alternatively, you can use `tox -e mkvenv` (without `-pypi`) to symlink your
+local Qt install instead of installing PyQt in the virtualenv. However, unless
+you have a new QtWebKit or QtWebEngine available, qutebrowser will not work. It
+also typically means you'll be using an older release of QtWebEngine.
+
+On Windows, run `tox -e 'mkvenv-win' instead, however make sure that ONLY
+Python3 is in your PATH before running tox.
+
+Creating a wrapper script
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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 "$@"
+----
+
+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-pypi
+----

doc/notes

@@ -1,196 +0,0 @@
-henk's thoughts
-===============
-
-1. Power to the user! Protect privacy!
-Things the browser should only do with explicit consent from the user, if
-applicable the user should be able to choose which protocol/host/port triplets
-to white/blacklist:
-
-- load/run executable code, like js, flash, java applets, ... (think NoScript)
-- requests to other domains, ports or using a different protocol than what the
-  user requested (think RequestPolicy)
-- accept cookies
-- storing/saving/caching things, e.g. open tabs ("session"), cookies, page
-  contents, browsing/download history, form data, ...
-- send referrer
-- disclose any (presence, type, version, settings, capabilities, etc.)
-  information about OS, browser, installed fonts, plugins, addons, etc.
-
-2. Be efficient!
-I tend to leave a lot of tabs open and nobody can deny that some websites
-simply suck, so the browser should, unless told otherwise by the user:
-
-- load tabs only when needed
-- run code in tabs only when needed, i.e. when the tab is currently being
-  used/viewed (background tabs doing some JS magic even when they are not being
-  used can create a lot of unnecessary load on the machine)
-- finish requests to the domain the user requested (e.g. www.example.org)
-  before doing any requests to other subdomains (e.g. images.example.org) and
-  finish those before doing requests to thirdparty domains (e.g. example.com)
-
-3. Be stable!
-- one site should not make the complete browser crash, only that site's tab
-
-
-Upstream Bugs
-=============
-
-- Web inspector is blank unless .hide()/.show() is called.
-    Asked on SO: http://stackoverflow.com/q/23499159/2085149
-    TODO: Report to PyQt/Qt
-
-- Report some other crashes
-
-
-/u/angelic_sedition's thoughts
-==============================
-
-Well support for greasemonkey scripts and bookmarklets/js (which was mentioned
-in the arch forum post) would be a big addition. What I've usually missed when
-using other vim-like browsers is things that allow for different settings and
-key bindings for different contexts. With that implemented I think I could
-switch to a lightweight browser (and believe me, I'd like to) for the most part
-and only use firefox when I needed downthemall or something.
-
-For example, I have different bindings based on tab position that are reloaded
-with a pentadactyl autocmd so that <space><homerow keys> will take me to tab
-1-10 if I'm in that range or 2-20 if I'm in that range. I have an autocmd that
-will run on completed downloads that passes the file path to a script that will
-open ranger in a floating window with that file cut (this is basically like
-using ranger to save files instead of the crappy gui popup).
-
-I also have a few bindings based on tabgroups. Tabgroups are a firefox feature,
-but I find them very useful for sorting things by topic so that only the tabs
-I'm interested at the moment are visible.
-
-Pentadactyl has a feature it calls groups. You can create a group that will
-activate for sites/urls that match a pattern with some regex support. This
-allows me, for example, to set up different (more convenient) bindings for
-zooming only on images. I'll never need use the equivalent of vim n (next text
-search match), so I can bind that to zoom. This allows setting up custom
-quickmarks/gotos using the same keys for different websites. For example, on
-reddit I have different g(some key) bindings to go to different subreddits.
-This can also be used to pass certain keys directly to the site (e.g. for use
-with RES). For sites that don't have modifiable bindings, I can use this with
-pentadactyl's feedkeys or xdotool to create my own custom bindings. I even have
-a binding that will call out to bash script with different arguments depending
-on the site to download an image or an image gallery depending on the site (in
-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,19 +5,36 @@ The Compiler <mail@qutebrowser.org>
 NOTE: This page will only appear on the first start. To view it at a later
 time, use the `:help` command.
 
+Basic keybindings to get you started
+------------------------------------
+
+* Use the arrow keys or `hjkl` to move around a webpage (vim-like syntax is used in quite a few places)
+* To go to a new webpage, press `o`, then type a url, then press Enter (Use `O` to open the url in a new tab, `go` to edit the current URL)
+* If what you've typed isn't a url, then a search engine will be used instead (DuckDuckGo, by default)
+* To switch between tabs, use `J` (next tab) and `K` (previous tab), or press `<Alt-num>`, where `num` is the position of the tab to switch to
+* To close the current tab, press `d` (and press `u` to undo closing a tab)
+* Use `H` and `L` to go back and forth in the history
+* To click on something without using the mouse, press `f` to show the hints, then type the keys next to what you want to click on (if that sounds weird, then just try pressing `f` and see what happens)
+* Press `:` to show the commandline
+* To search in a page, press `/`, type the phrase to search for, then press Enter. Use `n` and `N` to go back and forth through the matches, and press Esc to stop doing the search.
+* To close qutebrowser, press `Alt-F4`, or `:q`, or `:wq` to save the currently open tabs and quit (note that in the settings you can make qutebrowser always save the currently open tabs)
+
 What to do now
 --------------
 
-* View the http://qutebrowser.org/img/cheatsheet-big.png[key binding cheatsheet]
+* View the link:http://qutebrowser.org/img/cheatsheet-big.png[key binding cheatsheet]
 to make yourself familiar with the key bindings: +
 image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser key binding cheatsheet",link="http://qutebrowser.org/img/cheatsheet-big.png"]
+* There's also a https://www.shortcutfoo.com/app/dojos/qutebrowser[free training
+  course] on shortcutfoo for the keybindings - note that you need to be in
+  insert mode (i) for it to work.
 * Run `:adblock-update` to download adblock lists and activate adblocking.
 * If you just cloned the repository, you'll need to run
 `scripts/asciidoc2html.py` to generate the documentation.
 * Go to the link:qute://settings[settings page] to set up qutebrowser the way you want it.
 * Subscribe to
-https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[the mailinglist]
-where there are weekly "what's new in qutebrowser" posts.
+https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[the mailinglist] or
+https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[the announce-only mailinglist].
 * Let me know what features you are missing or things that need (even small!)
 improvements.
 

doc/qutebrowser.1.asciidoc

@@ -7,17 +7,17 @@
 :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 a minimal GUI. It's based
-on Python, PyQt5 and QtWebKit and free software, licensed under the GPL.
+on Python and Qt5 and is free software, licensed under the GPL.
 
 It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.
 
@@ -38,22 +38,13 @@ show it.
 *-h*, *--help*::
     show this help message and exit
 
-*-c* 'CONFDIR', *--confdir* 'CONFDIR'::
-    Set config directory (empty for no config storage).
-
-*--datadir* 'DATADIR'::
-    Set data directory (empty for no data storage).
-
-*--cachedir* 'CACHEDIR'::
-    Set cache directory (empty for no cache storage).
-
 *--basedir* 'BASEDIR'::
-    Base directory for all storage. Other --*dir arguments are ignored if this is given.
+    Base directory for all storage.
 
 *-V*, *--version*::
     Show version and quit.
 
-*-s* 'SECTION' 'OPTION' 'VALUE', *--set* 'SECTION' 'OPTION' 'VALUE'::
+*-s* 'OPTION' 'VALUE', *--set* 'OPTION' 'VALUE'::
     Set a temporary setting for this session.
 
 *-r* 'SESSION', *--restore* 'SESSION'::
@@ -65,8 +56,14 @@ show it.
 *--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.
+
+*--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'::
@@ -78,54 +75,39 @@ show it.
 *--debug*::
     Turn on debugging options.
 
+*--json-logging*::
+    Output log lines in JSON format (one object per line).
+
 *--nocolor*::
     Turn off colored logging.
 
-*--harfbuzz* '{old,new,system,auto}'::
-    HarfBuzz engine version to use. Default: auto.
-
-*--relaxed-config*::
-    Silently remove unknown config options.
+*--force-color*::
+    Force colored logging
 
 *--nowindow*::
     Don't show the main window.
 
-*--debug-exit*::
-    Turn on debugging of late exit.
-
-*--pdb-postmortem*::
-    Drop into pdb on exceptions.
-
 *--temp-basedir*::
     Use a temporary basedir.
 
 *--no-err-windows*::
     Don't show any error windows (used for tests/smoke.py).
 
-*--qt-name* 'NAME'::
-    Set the window name.
+*--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-style* 'STYLE'::
-    Set the Qt GUI style to use.
+*--qt-flag* 'QT_FLAG'::
+    Pass an argument to Qt as flag.
 
-*--qt-stylesheet* 'STYLESHEET'::
-    Override the Qt application stylesheet.
-
-*--qt-widgetcount*::
-    Print debug message at the end about number of widgets left undestroyed and maximum number of widgets existed at the same time.
-
-*--qt-reverse*::
-    Set the application's layout direction to right-to-left.
-
-*--qt-qmljsdebugger* 'port:PORT[,block]'::
-    Activate the QML/JS debugger with a specified port. 'block' is optional and will make the application wait until a debugger connects to it.
+*--debug-flag* 'DEBUG_FLAGS'::
+    Pass name of debugging feature to be turned on.
 // QUTE_OPTIONS_END
 
 == FILES
 
-- '~/.config/qutebrowser/qutebrowser.conf': Main config file.
+- '~/.config/qutebrowser/config.py': Configuration file.
+- '~/.config/qutebrowser/autoconfig.yml': Configuration done via the GUI.
 - '~/.config/qutebrowser/quickmarks': Saved quickmarks.
-- '~/.config/qutebrowser/keys.conf': Defined key bindings.
 - '~/.local/share/qutebrowser/': Various state information.
 - '~/.cache/qutebrowser/': Temporary data.
 
@@ -136,7 +118,7 @@ defaults.
 
 == BUGS
 Bugs are tracked in the Github issue tracker at 
-https://github.com/The-Compiler/qutebrowser/issues.
+https://github.com/qutebrowser/qutebrowser/issues.
 
 If you found a bug, use the built-in ':report' command to create a bug report
 with all information needed.
@@ -146,7 +128,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
@@ -162,12 +144,14 @@ You should have received a copy of the GNU General Public License along with
 this program.  If not, see <http://www.gnu.org/licenses/>.
 
 == RESOURCES
-* Website: http://www.qutebrowser.org/
+* Website: https://www.qutebrowser.org/
 * Mailinglist: mailto:qutebrowser@lists.qutebrowser.org[] /
 https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser
+* Announce-only mailinglist: mailto:qutebrowser-announce@lists.qutebrowser.org[] /
+https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce
 * IRC: irc://irc.freenode.org/#qutebrowser[`#qutebrowser`] on
 http://freenode.net/[Freenode]
-* Github: https://github.com/The-Compiler/qutebrowser
+* Github: https://github.com/qutebrowser/qutebrowser
 
 == AUTHOR
 *qutebrowser* was written by Florian Bruhin. All contributors can be found in

doc/stacktrace.asciidoc

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

doc/userscripts.asciidoc

@@ -22,6 +22,8 @@ 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
 -------------------
 
@@ -33,13 +35,18 @@ The following environment variables will be set when a userscript is launched:
 - `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.
+- `QUTE_SELECTED_HTML` The HTML currently selected on the page (not supported
+  with QtWebEngine).
 
 In `hints` mode:
 
@@ -53,7 +60,7 @@ 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
+On Unix/macOS, 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
@@ -71,3 +78,11 @@ Opening the currently selected word on http://www.dict.cc/[dict.cc]:
 
 echo "open -t http://www.dict.cc/?s=$QUTE_SELECTED_TEXT" >> "$QUTE_FIFO"
 ----
+
+Libraries
+---------
+
+Some third-party libraries are available to make writing userscripts easier:
+
+- Python: https://github.com/hiway/python-qutescript[python-qutescript]
+- Node.js: https://www.npmjs.com/package/qutejs[qutejs]

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/qt_menu.nib/README

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

misc/qt_menu.nib/classes.nib

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

misc/qt_menu.nib/info.nib

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

misc/qutebrowser.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

misc/qutebrowser.nsi

@@ -0,0 +1,77 @@
+Name "qutebrowser"
+
+Unicode true
+RequestExecutionLevel admin
+SetCompressor /solid lzma
+
+!ifdef X64
+  OutFile "..\dist\qutebrowser-${VERSION}-amd64.exe"
+  InstallDir "$ProgramFiles64\qutebrowser"
+!else
+  OutFile "..\dist\qutebrowser-${VERSION}-win32.exe"
+  InstallDir "$ProgramFiles\qutebrowser"
+!endif
+
+;Default installation folder
+  
+!include "MUI2.nsh"
+;!include "MultiUser.nsh"
+
+!define MUI_ABORTWARNING
+;!define MULTIUSER_MUI
+;!define MULTIUSER_INSTALLMODE_COMMANDLINE
+!define MUI_ICON "../icons/qutebrowser.ico"
+!define MUI_UNICON "../icons/qutebrowser.ico"
+
+!insertmacro MUI_PAGE_LICENSE "..\LICENSE"
+!insertmacro MUI_PAGE_DIRECTORY
+!insertmacro MUI_PAGE_INSTFILES
+!insertmacro MUI_UNPAGE_CONFIRM
+!insertmacro MUI_UNPAGE_INSTFILES
+
+!insertmacro MUI_LANGUAGE "English"
+
+; depends on admin status
+;SetShellVarContext current
+
+
+Section "Install"
+
+  ; Uninstall old versions
+  ExecWait 'MsiExec.exe /quiet /qn /norestart /X{633F41F9-FE9B-42D1-9CC4-718CBD01EE11}'
+  ExecWait 'MsiExec.exe /quiet /qn /norestart /X{9331D947-AC86-4542-A755-A833429C6E69}'
+
+  SetOutPath "$INSTDIR"
+  
+  !ifdef X64
+	file /r "..\dist\qutebrowser-${VERSION}-x64\*.*"
+  !else
+	file /r "..\dist\qutebrowser-${VERSION}-x86\*.*"
+  !endif
+
+  SetShellVarContext all
+  CreateShortCut "$SMPROGRAMS\qutebrowser.lnk" "$INSTDIR\qutebrowser.exe"
+  
+  ;Create uninstaller
+  WriteUninstaller "$INSTDIR\uninst.exe"
+
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\qutebrowser" "DisplayName" "qutebrowser"
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\qutebrowser" "UninstallString" '"$INSTDIR\uninst.exe"'
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\qutebrowser" "QuietUninstallString" '"$INSTDIR\uninst.exe" /S'
+
+SectionEnd
+
+;--------------------------------
+;Uninstaller Section
+
+Section "Uninstall"
+
+  SetShellVarContext all
+  Delete "$SMPROGRAMS\qutebrowser.lnk"
+
+  RMDir /r "$INSTDIR\*.*"
+  RMDir "$INSTDIR"
+
+  DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\qutebrowser"
+
+SectionEnd

misc/qutebrowser.spec

@@ -0,0 +1,75 @@
+# -*- 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', ''),
+        ('../qutebrowser/config/configdata.yml', 'config'),
+    ]
+
+    # 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=['PyQt5.QtOpenGL', 'PyQt5._QOpenGLFunctions_2_0'],
+             hookspath=[],
+             runtime_hooks=[],
+             excludes=['tkinter'],
+             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,
+             # 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,9 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+certifi==2017.7.27.1
+chardet==3.0.4
+codecov==2.0.9
+coverage==4.4.1
+idna==2.6
+requests==2.18.4
+urllib3==1.22

misc/requirements/requirements-codecov.txt-raw

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

misc/requirements/requirements-flake8.txt

@@ -0,0 +1,23 @@
+# 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.2.1
+flake8-docstrings==1.0.3  # rq.filter: < 1.1.0
+flake8-future-import==0.4.3
+flake8-mock==0.3
+flake8-pep3101==1.0  # rq.filter: < 1.1
+flake8-polyfill==1.0.1
+flake8-putty==0.4.0
+flake8-string-format==0.2.3
+flake8-tidy-imports==1.1.0
+flake8-tuple==0.2.13
+mccabe==0.6.1
+packaging==16.8
+pep8-naming==0.4.1
+pycodestyle==2.3.1
+pydocstyle==1.1.1  # rq.filter: < 2.0.0
+pyflakes==1.6.0
+pyparsing==2.2.0
+six==1.11.0

misc/requirements/requirements-flake8.txt-raw

@@ -0,0 +1,29 @@
+flake8<3.0.0
+flake8-copyright
+flake8-debugger!=2.0.0
+flake8-deprecated
+flake8-docstrings<1.1.0
+flake8-future-import
+flake8-mock
+flake8-pep3101<1.1
+flake8-putty
+flake8-string-format
+flake8-tidy-imports
+flake8-tuple
+pep8-naming
+pydocstyle<2.0.0
+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
+#@ filter: pydocstyle < 2.0.0
+#@ filter: flake8-docstrings < 1.1.0
+#@ filter: flake8-pep3101 < 1.1
+
+# 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.3
+packaging==16.8
+pyparsing==2.2.0
+setuptools==36.5.0
+six==1.11.0
+wheel==0.30.0

misc/requirements/requirements-pyinstaller.txt

@@ -0,0 +1,7 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+altgraph==0.14
+future==0.16.0
+macholib==1.8
+pefile==2017.9.3
+-e git+https://github.com/pyinstaller/pyinstaller.git@develop#egg=PyInstaller

misc/requirements/requirements-pyinstaller.txt-raw

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

misc/requirements/requirements-pylint-master.txt

@@ -0,0 +1,18 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+-e git+https://github.com/PyCQA/astroid.git#egg=astroid
+certifi==2017.7.27.1
+chardet==3.0.4
+github3.py==0.9.6
+idna==2.6
+isort==4.2.15
+lazy-object-proxy==1.3.1
+mccabe==0.6.1
+-e git+https://github.com/PyCQA/pylint.git#egg=pylint
+./scripts/dev/pylint_checkers
+requests==2.18.4
+six==1.11.0
+uritemplate==3.0.0
+uritemplate.py==3.0.2
+urllib3==1.22
+wrapt==1.10.11

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

@@ -0,0 +1,11 @@
+-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
+github3.py
+
+# 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,18 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+astroid==1.5.3
+certifi==2017.7.27.1
+chardet==3.0.4
+github3.py==0.9.6
+idna==2.6
+isort==4.2.15
+lazy-object-proxy==1.3.1
+mccabe==0.6.1
+pylint==1.7.4
+./scripts/dev/pylint_checkers
+requests==2.18.4
+six==1.11.0
+uritemplate==3.0.0
+uritemplate.py==3.0.2
+urllib3==1.22
+wrapt==1.10.11

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-pyqt.txt

@@ -0,0 +1,4 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+PyQt5==5.9.2
+sip==4.19.6

misc/requirements/requirements-pyqt.txt-raw

@@ -0,0 +1 @@
+PyQt5

misc/requirements/requirements-pyroma.txt

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

misc/requirements/requirements-pyroma.txt-raw

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

misc/requirements/requirements-qutebrowser.txt-raw

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

misc/requirements/requirements-tests-git.txt

@@ -0,0 +1,48 @@
+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/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/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
+git+https://github.com/python-attrs/attrs.git
+
+# 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,39 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+attrs==17.2.0
+beautifulsoup4==4.6.0
+cheroot==5.8.3
+click==6.7
+# colorama==0.3.9
+coverage==4.4.1
+EasyProcess==0.2.3
+fields==5.0.0
+Flask==0.12.2
+glob2==0.6
+hunter==2.0.1
+hypothesis==3.32.0
+itsdangerous==0.24
+# Jinja2==2.9.6
+Mako==1.0.7
+# MarkupSafe==1.0
+parse==1.8.2
+parse-type==0.4.2
+py==1.4.34
+py-cpuinfo==3.3.0
+pytest==3.2.3
+pytest-bdd==2.18.2
+pytest-benchmark==3.1.1
+pytest-catchlog==1.2.2
+pytest-cov==2.5.1
+pytest-faulthandler==1.3.1
+pytest-instafail==0.3.0
+pytest-mock==1.6.3
+pytest-qt==2.2.1
+pytest-repeat==0.4.1
+pytest-rerunfailures==3.1
+pytest-travis-fold==1.2.0
+pytest-xvfb==1.0.0
+PyVirtualDisplay==0.2.1
+six==1.11.0
+vulture==0.26
+Werkzeug==0.12.2

misc/requirements/requirements-tests.txt-raw

@@ -0,0 +1,22 @@
+beautifulsoup4
+cheroot
+coverage
+Flask
+hunter
+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-xvfb
+vulture
+
+#@ ignore: Jinja2, MarkupSafe, colorama

misc/requirements/requirements-tox.txt

@@ -0,0 +1,6 @@
+# This file is automatically generated by scripts/dev/recompile_requirements.py
+
+pluggy==0.5.2
+py==1.4.34
+tox==2.9.1
+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.26

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

@@ -1,6 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Copyright 2015 Zach-Button <zachrey.button@gmail.com>
+# Copyright 2015-2017 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -22,7 +23,7 @@
 # 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:
+# 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
@@ -39,10 +40,9 @@
 
 [ -z "$QUTE_URL" ] && QUTE_URL='http://google.com'
 
-url=$(echo "$QUTE_URL" | cat - ~/.config/qutebrowser/quickmarks ~/.local/share/qutebrowser/history | dmenu -l 15 -p qutebrowser)
-url=$(echo $url | sed -E 's/[^ ]+ +//g' | egrep "https?:" || echo $url)
+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/format_json

@@ -0,0 +1,47 @@
+#!/bin/sh
+#
+# Behavior:
+#   Userscript for qutebrowser which will take the raw JSON text of the current
+#   page, format it using `jq`, will add syntax highlighting using `pygments`,
+#   and open the syntax highlighted pretty printed html in a new tab. If the file
+#   is larger than 10MB then this script will only indent the json and will forego
+#   syntax highlighting using pygments.
+#
+#   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:
+#
+#     json = spawn --userscript /path/to/json_format
+#
+#   Note that the color style defaults to monokai, but a different pygments style
+#   can be passed as the first parameter to the script. A full list of the pygments
+#   styles can be found at: https://help.farbox.com/pygments.html
+#
+# Bryan Gilbert, 2017
+
+# default style to monokai if none is provided
+STYLE=${1:-monokai}
+# format json using jq
+FORMATTED_JSON="$(cat "$QUTE_TEXT" | jq '.')"
+
+# if jq command failed or formatted json is empty, assume failure and terminate
+if [ $? -ne 0 ] || [ -z "$FORMATTED_JSON" ]; then
+    echo "Invalid json, aborting..."
+    exit 1
+fi
+
+# calculate the filesize of the json document
+FILE_SIZE=$(ls -s --block-size=1048576 "$QUTE_TEXT" | cut -d' ' -f1)
+
+# use pygments to pretty-up the json (syntax highlight) if file is less than 10MB
+if [ "$FILE_SIZE" -lt "10" ]; then
+    FORMATTED_JSON="$(echo "$FORMATTED_JSON" | pygmentize -l json -f html -O full,style=$STYLE)"
+fi
+
+# create a temp file and write the formatted json to that file
+TEMP_FILE="$(mktemp --suffix '.html')"
+echo "$FORMATTED_JSON" > $TEMP_FILE
+
+
+# send the command to qutebrowser to open the new file containing the formatted json
+echo "open -t file://$TEMP_FILE" >> "$QUTE_FIFO"

misc/userscripts/open_download

@@ -1,4 +1,4 @@
-#!/bin/bash -e
+#!/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
@@ -12,13 +12,16 @@
 #  - 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
+#  - It comes in handy if you enable downloads.remove_finished. 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}
@@ -49,7 +52,7 @@ die() {
 if ! [ -d "$DOWNLOAD_DIR" ] ; then
     die "Download directory »$DOWNLOAD_DIR« not found!"
 fi
-if ! $(which "${ROFI_CMD}" > /dev/null ) ; then
+if ! which "${ROFI_CMD}" > /dev/null ; then
     die "Rofi command »${ROFI_CMD}« not found in PATH!"
 fi
 
@@ -109,5 +112,3 @@ fi
 msg info "Opening »$file« (of type $filetype) with ${application%.desktop}"
 
 xdg-open "$path" &
-
-

misc/userscripts/openfeeds

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Copyright 2015 jnphilipp <me@jnphilipp.org>
+# Copyright 2016-2017 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -20,7 +21,7 @@
 
 # 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:
+# 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
@@ -30,9 +31,10 @@ 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' % link.get('href'))
+        f.write('open -t %s\n' % urljoin(os.environ['QUTE_URL'], link.get('href')))

misc/userscripts/password_fill

@@ -0,0 +1,380 @@
+#!/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 isVisible(elem) {
+        var style = elem.ownerDocument.defaultView.getComputedStyle(elem, null);
+
+        if (style.getPropertyValue("visibility") !== "visible" ||
+            style.getPropertyValue("display") === "none" ||
+            style.getPropertyValue("opacity") === "0") {
+            return false;
+        }
+
+        return elem.offsetWidth > 0 && elem.offsetHeight > 0;
+    };
+    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 (isVisible(input) && (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

@@ -1,6 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Copyright 2015 Zach-Button <zachrey.button@gmail.com>
+# Copyright 2016-2017 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
 #
 # This file is part of qutebrowser.
 #
@@ -17,16 +18,16 @@
 # 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=/tmp/qutebrowser_$(mktemp XXXXXXXX).html
+path=$(mktemp --tmpdir qutebrowser_XXXXXXXX.html)
 
-curl "$QUTE_URL" > $path
+curl "$QUTE_URL" > "$path"
 urxvt -e vim "$path"
 
 rm "$path"

misc/userscripts/qutedmenu

@@ -7,7 +7,6 @@
 # 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 datadir=${XDG_DATA_HOME:-$HOME/.local/share}
 
 readonly optsfile=$confdir/dmenu/bemenucolors
 
@@ -15,17 +14,17 @@ create_menu() {
     # Check quickmarks
     while read -r url; do
         printf -- '%s\n' "$url"
-    done < "$confdir"/qutebrowser/quickmarks
+    done < "$QUTE_CONFIG_DIR"/quickmarks
 
     # Next bookmarks
     while read -r url _; do
         printf -- '%s\n' "$url"
-    done < "$confdir"/qutebrowser/bookmarks/urls
+    done < "$QUTE_CONFIG_DIR"/bookmarks/urls
 
     # Finally history
     while read -r _ url; do
         printf -- '%s\n' "$url"
-    done < "$datadir"/qutebrowser/history
+    done < "$QUTE_DATA_DIR"/history
     }
 
 get_selection() {

misc/userscripts/readability

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+#
+# Executes python-readability on current page and opens the summary as new tab.
+#
+# Depends on the python-readability package, or its fork:
+#
+#   - https://github.com/buriy/python-readability
+#   - https://github.com/bookieio/breadability
+#
+# Usage:
+#   :spawn --userscript readability
+#
+from __future__ import absolute_import
+import codecs, os
+
+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:
+    data = source.read()
+
+    try:
+        from breadability.readable import Article as reader
+        doc = reader(data)
+        content = doc.readable
+    except ImportError:
+        from readability import Document
+        doc = Document(data)
+        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,34 @@
+#!/usr/bin/env python
+#
+# Adds DuckDuckGo bang as searchengine.
+#
+# Usage:
+#   :spawn --userscript ripbang [bang]...
+#
+# Example:
+#   :spawn --userscript ripbang amazon maps
+#
+
+from __future__ import print_function
+import os, re, requests, sys
+
+try:
+    from urllib.parse import unquote
+except ImportError:
+    from urllib import unquote
+
+for argument in sys.argv[1:]:
+    bang = '!' + argument
+    r = requests.get('https://duckduckgo.com/',
+                     params={'q': bang + ' SEARCHTEXT'})
+
+    searchengine = 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