Note: this is a fork with Q*browser, except without the bad Q-word, so that it becomes safe for use at work and school.

glimpsebrowser

A keyboard-driven, vim-like browser based on PyQt5 and Qt.

website | blog | FAQ | contributing | releases | installing

glimpsebrowser is a keyboard-focused browser with a minimal GUI. It’s based on Python and PyQt5 and free software, licensed under the GPL.

It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.

Screenshots

image:doc/img/main.png["screenshot 1",width=300,link="doc/img/main.png"]
image:doc/img/downloads.png["screenshot 2",width=300,link="doc/img/downloads.png"]
image:doc/img/completion.png["screenshot 3",width=300,link="doc/img/completion.png"]
image:doc/img/hints.png["screenshot 4",width=300,link="doc/img/hints.png"]

Downloads
---------

See the https://github.com/glimpsebrowser/glimpsebrowser/releases[github releases
page] for available downloads and the link:doc/install.asciidoc[INSTALL] file for
detailed instructions on how to get glimpsebrowser running on various platforms.

Documentation
-------------

In addition to the topics mentioned in this README, the following documents are
available:

* https://raw.githubusercontent.com/glimpsebrowser/glimpsebrowser/master/doc/img/cheatsheet-big.png[Key binding cheatsheet]: +
image:https://raw.githubusercontent.com/glimpsebrowser/glimpsebrowser/master/doc/img/cheatsheet-small.png["glimpsebrowser key binding cheatsheet",link="https://raw.githubusercontent.com/glimpsebrowser/glimpsebrowser/master/doc/img/cheatsheet-big.png"]
* link:doc/quickstart.asciidoc[Quick start guide]
* https://www.shortcutfoo.com/app/dojos/glimpsebrowser[Free training course] to remember those key bindings
* link:doc/faq.asciidoc[Frequently asked questions]
* link:doc/help/configuring.asciidoc[Configuring glimpsebrowser]
* link:doc/contributing.asciidoc[Contributing to glimpsebrowser]
* link:doc/install.asciidoc[Installing glimpsebrowser]
* link:doc/changelog.asciidoc[Change Log]
* link:doc/stacktrace.asciidoc[Reporting segfaults]
* link:doc/userscripts.asciidoc[How to write userscripts]

Getting help
------------

You can get help in the IRC channel
irc://irc.freenode.org/#glimpsebrowser[`#glimpsebrowser`] on
https://freenode.net/[Freenode]
(https://webchat.freenode.net/?channels=#glimpsebrowser[webchat]), or by writing a
message to the
https://lists.schokokeks.org/mailman/listinfo.cgi/glimpsebrowser[mailinglist] at
mailto:glimpsebrowser@lists.glimpsebrowser.org[].

There's also an https://lists.schokokeks.org/mailman/listinfo.cgi/glimpsebrowser-announce[announce-only mailinglist]
at mailto:glimpsebrowser-announce@lists.glimpsebrowser.org[] (the announcements also
get sent to the general glimpsebrowser@ list).

If you're a reddit user, there's a
https://www.reddit.com/r/glimpsebrowser/[/r/glimpsebrowser] subreddit there.

Contributions / Bugs
--------------------

You want to contribute to glimpsebrowser? Awesome! Please read
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
ways:

* Use the built-in `:report` command or the automatic crash dialog.
* Open an issue in the Github issue tracker.
* Write a mail to the
https://lists.schokokeks.org/mailman/listinfo.cgi/glimpsebrowser[mailinglist] at
mailto:glimpsebrowser@lists.glimpsebrowser.org[].

For security bugs, please contact me directly at mail@glimpsebrowser.org, GPG ID
https://www.the-compiler.org/pubkey.asc[0x916eb0c8fd55a072].

Requirements
------------

The following software and libraries are required to run glimpsebrowser:

* https://www.python.org/[Python] 3.5 or newer (3.6 recommended)
* https://www.qt.io/[Qt] 5.7.1 or newer (5.12 recommended due to https://bugreports.qt.io/browse/QTBUG-76913[segfaults on media pages with Qt 5.13]); support for < 5.9
  will be dropped soon) with the following modules:
  - QtCore / qtbase
  - QtQuick (part of qtbase in some distributions)
  - QtSQL (part of qtbase in some distributions)
  - QtOpenGL
  - QtWebEngine, or
  - alternatively QtWebKit - only the
    link:https://github.com/qtwebkit/qtwebkit/wiki[updated fork] (5.212) is
    supported. **Note: The latest QtWebKit release is based on old WebKit
    revision with known unpatched vulnerabilities. Please use it carefully and
    avoid visiting untrusted websites and using it for transmission of
    sensitive data.**
* https://www.riverbankcomputing.com/software/pyqt/intro[PyQt] 5.7.0 or newer
  (5.13 recommended, support for < 5.9 will be dropped soon) for Python 3
* https://pypi.python.org/pypi/setuptools/[pkg_resources/setuptools]
* https://fdik.org/pyPEG/[pyPEG2]
* http://jinja.pocoo.org/[jinja2]
* http://pygments.org/[pygments]
* https://github.com/yaml/pyyaml[PyYAML]
* https://www.attrs.org/[attrs]

The following libraries are optional:

* 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).

See link:doc/install.asciidoc[the documentation] for directions on how to
install glimpsebrowser and its dependencies.

Donating
--------

Working on glimpsebrowser is a very rewarding hobby, but like (nearly) all hobbies
it also costs some money (as an example, I have to pay for the server and
domain).

If you want to give me a beer or a pizza back, I'm trying to make it as easy as
possible for you to do so. If some other way would be easier for you, please
get in touch!

* SEPA bank transfer inside Europe (no fee): Contact me for details
* PayPal: https://www.paypal.me/thecompiler[thecompiler] / me@the-compiler.org
* Bitcoin: link:bitcoin:1PMzbcetAHfpxoXww8Bj5XqquHtVvMjJtE[1PMzbcetAHfpxoXww8Bj5XqquHtVvMjJtE]

Sponsors
--------

Thanks a lot to https://www.macstadium.com/[MacStadium] for supporting
glimpsebrowser with a free hosted Mac Mini via their
https://www.macstadium.com/opensource[Open Source Project].

(They don't require including this here - I've just been very happy with their
offer, and without them, no macOS releases or tests would exist)

Thanks to the https://www.hsr.ch/[HSR Hochschule für Technik Rapperswil], which
made it possible to work on glimpsebrowser extensions as a student research project.

image:.github/img/macstadium.png["powered by MacStadium",width=200,link="https://www.macstadium.com/"]
image:.github/img/hsr.png["HSR Hochschule für Technik Rapperswil",link="https://www.hsr.ch/"]

Authors
-------

glimpsebrowser's primary author is Florian Bruhin (The Compiler), but glimpsebrowser
wouldn't be what it is without the help of
https://github.com/glimpsebrowser/glimpsebrowser/graphs/contributors[hundreds of contributors]!

Additionally, the following people have contributed graphics:

* Jad/link:https://yelostudio.com[yelo] (new icon)
* WOFall (original icon)
* regines (key binding cheatsheet)

Also, thanks to everyone who contributed to one of glimpsebrowser's
link:doc/backers.asciidoc[crowdfunding campaigns]!

Similar projects
----------------

Many projects with a similar goal as glimpsebrowser exist.
Most of them were inspirations for glimpsebrowser in some way, thanks for that!

Active
~~~~~~

* https://fanglingsu.github.io/vimb/[vimb] (C, GTK+ with WebKit2)
* https://luakit.github.io/luakit/[luakit] (C/Lua, GTK+ with WebKit2)
* https://surf.suckless.org/[surf] (C, GTK+ with WebKit1/WebKit2)
* https://github.com/next-browser/next/[next] (Lisp, Emacs-like, GTK+ with WebKit)
* https://github.com/parkouss/webmacs/[webmacs] (Python, Emacs-like with QtWebEngine)
* Chrome/Chromium addons:
  https://vimium.github.io/[Vimium],
  https://github.com/brookhong/Surfingkeys[Surfingkeys]
* Firefox addons (based on WebExtensions):
  https://github.com/cmcaine/tridactyl[Tridactyl],
  https://addons.mozilla.org/en-GB/firefox/addon/vimium-ff/[Vimium-FF] (experimental),
  https://github.com/brookhong/Surfingkeys[Surfingkeys],
  https://github.com/ueokande/vim-vixen[Vim Vixen],
  https://github.com/amedama41/vvimpulation[VVimpulation]

Inactive
~~~~~~~~

* 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 glimpsebrowser)
* https://sourceforge.net/p/vimprobable/wiki/Home/[vimprobable] (C, GTK+ with
  WebKit1)
* https://wiki.archlinux.org/index.php?title=Jumanji[jumanji] (C, GTK+ with WebKit1,
original site is gone but the Arch Linux wiki has some data)
* http://conkeror.org/[conkeror] (Javascript, Emacs-like, XULRunner/Gecko)
* https://www.uzbl.org/[uzbl] (C, GTK+ with WebKit1/WebKit2)
* Firefox addons (not based on WebExtensions or no recent activity):
  http://www.vimperator.org/[Vimperator],
  http://bug.5digits.org/pentadactyl/index[Pentadactyl],
  https://github.com/akhodakivskiy/VimFx[VimFx],
  https://key.saka.io[Saka Key],
  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]
  https://github.com/lusakasa/saka-key[Saka Key],
  https://github.com/1995eaton/chromium-vim[cVim]

License
-------

This program 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.

This program 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 this program.  If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.

pdf.js
------

glimpsebrowser optionally uses https://github.com/mozilla/pdf.js/[pdf.js] to
display PDF files in the browser. Windows releases come with a bundled pdf.js.

pdf.js is distributed under the terms of the Apache License. You can
find a copy of the license in `glimpsebrowser/3rdparty/pdfjs/LICENSE` (in the
Windows release or after running `scripts/dev/update_3rdparty.py`), or online
https://www.apache.org/licenses/LICENSE-2.0.html[here].