Merge branch 'release-1.1' into missy for 1.1.0 v1.1.0

1 files changed, 28 insertions, 7 deletions

diff --git a/badwolf.1 b/badwolf.1
index 1ee4a83..111c0cc 100644
--- a/badwolf.1
+++ b/badwolf.1
@@ -1,11 +1,11 @@
-./" BadWolf: Minimalist and privacy-oriented WebKitGTK+ browser
-./" Copyright © 2019-2020 Badwolf Authors <https://hacktivis.me/projects/badwolf>
-./" SPDX-License-Identifier: BSD-3-Clause
+.\" BadWolf: Minimalist and privacy-oriented WebKitGTK+ browser
+.\" Copyright © 2019-2021 Badwolf Authors <https://hacktivis.me/projects/badwolf>
+.\" SPDX-License-Identifier: BSD-3-Clause
 .Dd 2019-10-31
 .Dt BADWOLF 1
 .Sh NAME
 .Nm badwolf
-.Nd minimalist, privacy-oriented web browser based on WebKitGTK
+.Nd minimalist and privacy-oriented web browser based on WebKitGTK
 .Sh SYNOPSIS
 .Nm
 .Op Ar webkit/gtk options
@@ -75,6 +75,30 @@ A more generic variable name is also intended to be used in the future.
 .El
 .Sh FILES
 .Bl -tag -width Ds -compact
+.It Pa ${XDG_CONFIG_HOME:-$HOME/.config}/badwolf/content-filters.json
+WebKit-specific content-filter file, this allows to block unwanted content (ads, nagware, ...).
+For some introductory information about the format see:
+.Bl -compact
+.Lk https://webkit.org/blog/3476/content-blockers-first-look/
+.Lk https://webkit.org/blog/4062/targeting-domains-with-content-blockers/
+.Lk https://developer.apple.com/documentation/safariservices/creating_a_content_blocker
+.El
+.Pp
+For a converter using AblockPlus-style filters, try:
+.Lk https://gitlab.com/eyeo/adblockplus/abp2blocklist
+.Pp
+For a ready-to-use file (that you should update periodically), try:
+.Lk https://easylist-downloads.adblockplus.org/easylist_min_content_blocker.json
+.It Pa ${XDG_CACHE_HOME:-$HOME/.cache}/badwolf/filters
+This is where the compiled filters are stored, the file(s) in it are automatically generated and so shouldn't be edited.
+.It Pa ${XDG_DATA_HOME:-$HOME/.local/share}/badwolf/bookmarks.xbel
+XBEL (XML Bookmark Exchange Language) file, known to be currently supported by:
+.Xr elinks 1 ,
+.Xr konqueror 1 ,
+.Xr kbookmarkeditor 1 . Doing a symbolic link from their path works fine but you might also want to use XInclude to merge multiple XBEL files.
+.Pp
+For more information about this format see:
+.Lk http://pyxml.sourceforge.net/topics/xbel/
 .It Pa ${XDG_DATA_HOME:-$HOME/.local/share}/badwolf/webkit-web-extensions/
 Directory containing the
 .Lk https://webkitgtk.org/reference/webkit2gtk/stable/WebKitWebExtension.html WebKitWebExtensions
@@ -82,10 +106,7 @@ to be loaded into
 .Nm . Note: They aren't the JavaScript-based Web-Extensions supported by Firefox or Chrome, but native code in shared objects using the WebKitGTK API.
 .Pp
 Examples of useful extensions may be found at:
-.Bl -item -compact
 .Lk https://hacktivis.me/git/badwolf-extensions
-.Lk https://github.com/jun7/wyebadblock
-.El
 .It Pa ${DATADIR:-/usr/local/share}/badwolf/interface.css
 .It Pa ${XDG_DATA_HOME:-$HOME/.local/share}/badwolf/interface.css
 CSS files (respectively system and user-level) for styling badwolf interface.