Merge branch 'release-1.2' into missy for 1.2.0 v1.2.0

1 files changed, 20 insertions, 5 deletions

diff --git a/badwolf.1 b/badwolf.1
index 111c0cc..fc57955 100644
--- a/badwolf.1
+++ b/badwolf.1
@@ -3,6 +3,7 @@
 .\" SPDX-License-Identifier: BSD-3-Clause
 .Dd 2019-10-31
 .Dt BADWOLF 1
+.Os
 .Sh NAME
 .Nm badwolf
 .Nd minimalist and privacy-oriented web browser based on WebKitGTK
@@ -43,7 +44,7 @@ Toggles caret browsing.
 .It browser F12
 Opens the web inspector.
 .It browser Ctrl-[ / Ctrl-]
-Go back/forward in current tab’s history
+Go back/forward in current tab's history
 .It browser Ctrl-p
 Print the current page. (spawns a dialog)
 .It any Alt-Left / Alt-Right
@@ -72,17 +73,26 @@ For example
 .Ic BADWOLF_L10N="en_GB:fr_FR:de_DE" .
 When this variable isn't set, spelling isn't activated.
 A more generic variable name is also intended to be used in the future.
+.Pp
+To get the list of supported dictionaries execute
+.Ic enchant-lsmod-2 -list-dicts
+or before enchant 2.0:
+.Ic enchant-lsmod -list-dicts
 .El
 .Sh FILES
+The following paths are using
+.Xr sh 1
+syntax to correctly support XDG Base Directory Specification, you can use the
+.Xr echo 1
+command to check where it is on your system.
+.Pp
 .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
@@ -91,6 +101,7 @@ 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.
+Documented here only for sandboxing / access-control purposes.
 .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 ,
@@ -99,7 +110,10 @@ XBEL (XML Bookmark Exchange Language) file, known to be currently supported by:
 .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/
+.Pp
+For an example XBEL file see:
+.Lk https://hacktivis.me/bookmarks.xbel
+.It Pa ${XDG_DATA_HOME:-$HOME/.local/share}/badwolf/webkit-web-extension/
 Directory containing the
 .Lk https://webkitgtk.org/reference/webkit2gtk/stable/WebKitWebExtension.html WebKitWebExtensions
 to be loaded into
@@ -111,7 +125,8 @@ Examples of useful extensions may be found at:
 .It Pa ${XDG_DATA_HOME:-$HOME/.local/share}/badwolf/interface.css
 CSS files (respectively system and user-level) for styling badwolf interface.
 See
-.Lk https://developer.gnome.org/gtk3/stable/chap-css-properties.html
+.\" GNOME can't even into doing any redirections of the few docs available
+.Lk http://web.archive.org/web/20210420214617/https://developer.gnome.org/gtk3/stable/chap-css-properties.html
 for the properties being available.
 .Pp
 For testing your styles I would recommend using the