commit 75e6024f1284d9dc9f6b5ed1cef653cbc6b69a6b from: Thomas Böhler date: Sat Dec 16 07:43:12 2023 UTC doc: Add XDG base dir spec note to man pages Signed-off-by: Thomas Böhler commit - 0ed21b988c6d853b89a994dc6795e387a9ce3731 commit + 75e6024f1284d9dc9f6b5ed1cef653cbc6b69a6b blob - 025e26bae294268867448905eac01152e9c80bef blob + 9bd40d2a21ea7151e5b45087b50243f03774ea2d --- docs/rss-email.1.scd +++ docs/rss-email.1.scd @@ -18,6 +18,10 @@ the commandline. The database used is *sqlite3*. +*rss-email* adheres to the *XDG Base Directory specification*. If the variables +*$XDG_CONFIG_HOME* or *$XDG_DATA_HOME* are not set, the values *$HOME/.config* +and *$HOME/.local/share*, respectively, will be used as a fallback. + ## OPTIONS The following options are recognized by *rss-email*: @@ -73,6 +77,10 @@ If all of these options are given, no configuration fi no configuration file is necessary. Missing options will be read from the configuration file. +# CONFORMING TO + +https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html + # SEE ALSO *rss-email*(5) blob - 2cf4f0a840923f1242b4b45ae1c0648da56eca3c blob + a8b0205620f0b07444048622e9656544737de51a --- docs/rss-email.5.scd +++ docs/rss-email.5.scd @@ -15,6 +15,10 @@ Both files can be found in *$XDG_CONFIG_HOME/rss-email files in potentially different directories can be specified as command line arguments to *rss-email*(1). +*rss-email* adheres to the *XDG Base Directory specification*. If the variable +*$XDG_CONFIG_HOME* is not set, the value *$HOME/.config* will be used as a +fallback. + # Configuration file The configuration file contains all necessary configuration to @@ -54,6 +58,10 @@ The URLs file is a list of URLs with RSS/Atom feeds se Comments are supported only at the beginning of a line and are specified with *#*. If a line starts with the comment character it will be ignored completely. +# CONFORMING TO + +https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html + # SEE ALSO *rss-email*(1)