From f20a2e583e075f728a133c920fd8479993d5233f Mon Sep 17 00:00:00 2001 From: "Haelwenn (lanodan) Monnier" Date: Fri, 1 Oct 2021 21:19:58 +0200 Subject: badwolf.1: Add more details in the FILES section --- badwolf.1 | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/badwolf.1 b/badwolf.1 index f27ef20..63b7e4a 100644 --- a/badwolf.1 +++ b/badwolf.1 @@ -80,6 +80,12 @@ 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, ...). @@ -95,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 , @@ -103,6 +110,9 @@ 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/ +.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 -- cgit v1.3.1-23-gd82d