No Description

Haelwenn (lanodan) Monnier 83a8bb84a7 .builds/netbsd.yml: Explicitely pick pkgin-installed xgettext 2 months ago
.builds 83a8bb84a7 .builds/netbsd.yml: Explicitely pick pkgin-installed xgettext 2 months ago
.reuse 4f330a1168 Make repository reuse compliant 1 year ago
LICENSES 4f330a1168 Make repository reuse compliant 1 year ago
bookmarks_test.fixtures 4f330a1168 Make repository reuse compliant 1 year ago
icons fb3246adea Logo: increase stroke size and contrast 3 years ago
mo 6dae2b3442 Makefile: Add building *.mo on compilation 4 years ago
po 5b578e0c03 badwolf: Handle WEBKIT_WEB_PROCESS_TERMINATED_BY_API 3 months ago
.clang-format 27742f6afb .clang-format: AllowShortCaseLabelsOnASingleLine: false 1 year ago
.editorconfig 4f330a1168 Make repository reuse compliant 1 year ago
.gitignore 0a4778bfe2 .gitignore: ./*_test and ./install.sh 8 months ago
.gitlab-ci.yml 4f330a1168 Make repository reuse compliant 1 year ago
.mailmap bc68495911 .mailmap: Add gitlab placeholder email of Ben K 2 months ago
AUTHORS 98a2c0a463 AUTHORS: Add Страхиња Радић 2 months ago
COPYING 4f330a1168 Make repository reuse compliant 1 year ago
KnowledgeBase.md 4f330a1168 Make repository reuse compliant 1 year ago
README.md dc32b5fd7c README: Change mirror links from gitlab.com to git.sr.ht 5 months ago
badwolf.1 67d213f3f6 keybindings: Add Ctrl-Escape to terminate web-process 3 months ago
badwolf.c 5b578e0c03 badwolf: Handle WEBKIT_WEB_PROCESS_TERMINATED_BY_API 3 months ago
badwolf.de.1 caf0a4d2cd badwolf.de.1: Bundle 6 months ago
badwolf.desktop e4a3ceb7cc Add Serbian translation 5 months ago
badwolf.fr.1 6b89da092c manpage: Note the lack of GM-style userscript filtering 1 year ago
badwolf.h 9d7d1970c9 Replace casts to (void) to UNUSED macro 1 year ago
badwolf.inkscape.svg fb3246adea Logo: increase stroke size and contrast 3 years ago
badwolf.sr.1 e4a3ceb7cc Add Serbian translation 5 months ago
badwolf.svg fb3246adea Logo: increase stroke size and contrast 3 years ago
badwolf.tr.1 7472e3d607 po/tr_man.po: Fix syntax error due to ASCII apostrophe 8 months ago
badwolf.vi.1 40fe40ee4c Update Vietnamese translation and manpage 8 months ago
bookmarks.c 9d7d1970c9 Replace casts to (void) to UNUSED macro 1 year ago
bookmarks.h 4f330a1168 Make repository reuse compliant 1 year ago
bookmarks_test.c 4f330a1168 Make repository reuse compliant 1 year ago
build.ninja c8881b0345 configure: Simplify missing ed handling 5 months ago
config.h fe182d7a2c config.h: Remove deprecated enable-accelerated-2d-canvas 8 months ago
configure 6009738186 Revert "configure: Check for xgettext --package-name=" 2 months ago
decisions.md a75502e95b decisions: Switch from Makefile to *.ninja 8 months ago
downloads.c 9d7d1970c9 Replace casts to (void) to UNUSED macro 1 year ago
downloads.h 4f330a1168 Make repository reuse compliant 1 year ago
fmt.c 4f330a1168 Make repository reuse compliant 1 year ago
fmt.h 4f330a1168 Make repository reuse compliant 1 year ago
fmt_test.c 4f330a1168 Make repository reuse compliant 1 year ago
icons_size.sh 4f330a1168 Make repository reuse compliant 1 year ago
interface.css 4f330a1168 Make repository reuse compliant 1 year ago
interface.md 4f330a1168 Make repository reuse compliant 1 year ago
keybindings.c 67d213f3f6 keybindings: Add Ctrl-Escape to terminate web-process 3 months ago
keybindings.h 4f330a1168 Make repository reuse compliant 1 year ago
uri.c 4f330a1168 Make repository reuse compliant 1 year ago
uri.h 4f330a1168 Make repository reuse compliant 1 year ago
uri_test.c 4f330a1168 Make repository reuse compliant 1 year ago
userscripts.c 7371b0b682 userscripts: Formatting fix 8 months ago
userscripts.h 7f4b6c8400 Add UserScripts support 1 year ago
usr.bin.badwolf 46ce59c9d6 Update copyright year 3 years ago
version.sh 4f330a1168 Make repository reuse compliant 1 year ago

README.md

BadWolf

SPDX-FileCopyrightText: 2019-2022 Badwolf Authors <https://hacktivis.me/projects/badwolf>
SPDX-License-Identifier: BSD-3-Clause

Minimalist and privacy-oriented WebKitGTK+ browser.

Homepage: https://hacktivis.me/projects/badwolf

The name is a reference to BBC's Doctor Who TV series, I took it simply because I wanted to have a specie in the name, like some other web browsers do, but doesn't go into the “gentle” zone.

Differences

Comparing from other small WebKit browsers for unixes found in the wild:

  • Independent of environment, should just work if GTK and WebKitGTK does
  • Storing data should be:
    • explicit and optional (i.e. Applying preferences doesn't imply Saving to disk)
    • not queryabe by WebKit (so the web can't use it)
    • done in a standard format (like XBEL for bookmarks)
  • Static UI, no element should be added at runtime, this is to avoid potential tracking via viewport changes
  • Small codebase, should be possible to read and understand it completely over an afternoon.
  • Does not use modal editing (from vi) as that was designed for editing, not browsing
  • UTF-8 encoding by default

Motivation from other clients https://hacktivis.me/articles/www-client%20are%20broken

Contributing

Translations

You need to have gettext installed. If you want a GUI, poedit exists and Weblate is a good web platform that I might consider hosting at some point.

  • Syncing POT file with the source code: ninja po/messages.pot
  • Syncing PO file with the POT file: ninja po/de.po
  • Initialising a new PO file (example for German, de_DE): msginit -l de_DE -i po/messages.pot -o po/de.po

Contacts / Discussions

Repositories

git

release assets

Manual Installation

Dependencies

  • POSIX-compatible Shell (i.e. mrsh, dash, lksh)
  • ninja or samurai
  • A pkg-config implementation (pkgconf is recommended)
  • C11 Compiler (such as clang or gcc)
  • WebKitGTK, only the latest stable(2.32.0+) is supported
  • libxml-2.0, no known version limitation
  • (optional, translating) po4a to modify manpage translations
  • (optional, translating) gettext implementation (such as GNU Gettext)
  • (optional, translating) ed(1), the standard editor
  • (optional, lint) mandoc (the command) for linting the manpage
  • (optional, lint) shellcheck for linting the ./configure script
  • (optional, lint) flawfinder for examining C source code for flaws
  • (optional, lint) reuse for checking REUSE compliance

Note: Packagers can safely ignore the lint dependencies.

Compiling

./configure && ninja

Note: configure is a simple shell script (so not autotools) which supports variables like PREFIX.

Installing

ninja install
# DESTDIR is supported

Debian users will probably want to use checkinstall instead.

An example AppArmor profile is provided at usr.bin.badwolf, please do some long runtime checks before shipping it or a modified version, help can be provided but with no support.

If you modify the icons, you'll need inkscape (command line only), to regenerate the bitmap versions. It isn't needed for a normal installation as the bitmap icons are bundled.

Notes

Most of the privacy/security stuff will be done with patches against WebKit as quite a lot isn't into WebKitSettings and with generic WebKit extensions that should be reusable.