commit 73389b007e8ed58f142c7c10d5dd157d992581dc
from: Omar Polo <op@omarpolo.com>
date: Fri Oct 08 10:00:23 2021 UTC

tweak the documentation wrt XDG and ~/.telescope

Point out that *by default* telescope uses XDG-style directories, but
if ~/.telescope exists XDG is ignored.

While here also use a shorter URL for the XDG spec and add it to the
STANDARDS section of the manpage.

commit - cb703731dd78cabe6a02e5b9d60c4b2c390b047e
commit + 73389b007e8ed58f142c7c10d5dd157d992581dc
blob - 75f3482e4c2a078554ed59ba188c66b6d06af796
blob + e6de7276eb9e1b0e9e7f84ce409d3ed4dd41ed65
--- README.md
+++ README.md
@@ -120,8 +120,8 @@ that could be helpful to others, consider adding it to
 
 ## User files
 
-Telescope stores user files according to the
-[XDG Base Directory Specification][xdg]. The usage and contents of these files
+Telescope stores user files according to the [XDG Base Directory
+Specification][xdg] by default.  The usage and contents of these files
 are described in [the man page](telescope.1), under "FILES".
 
 Only one instance of Telescope can be running at time per user.
@@ -137,4 +137,4 @@ distributed under the [UNICODE, Inc license agreement]
 
 
 [unicode-license]: https://www.unicode.org/license.html
-[xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
+[xdg]: https://specifications.freedesktop.org/basedir-spec/latest/
blob - 1546d7a1499832c05dec9700952b543cff9fd5d9
blob + aa00dcff04f26d61a983243817c5747da4da7f2f
--- telescope.1
+++ telescope.1
@@ -11,7 +11,7 @@
 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-.Dd $Mdocdate: September 15 2021$
+.Dd $Mdocdate: October 8 2021$
 .Dt TELESCOPE 1
 .Os
 .Sh NAME
@@ -636,7 +636,10 @@ During the startup,
 .Nm
 reads the configuration file at
 .Pa ~/.config/telescope/config
-or the one given with the
+or
+.Pa ~/.telescope/config .
+.Pp
+It's possible to load a custom configuration file using the
 .Fl c
 flag.
 .Pp
@@ -877,8 +880,23 @@ To decide whether to use colors or not.
 The content of the variable doesn't matter.
 .It Ev TERM
 The user's terminal name.
+.It Ev XDG_CACHE_HOME , Ev XDG_CONFIG_HOME , Ev XDG_DATA_HOME
+If defined can alter the default location of the files used.
 .El
 .Sh FILES
+By default
+.Nm
+follows the XDG Base Directory Specification.
+However, if
+.Pa ~/.telescope
+exists, XDG is ignored and all the files are stored inside it.
+The usage of
+.Ev XDG_CACHE_HOME ,
+.Ev XDG_CONFIG_HOME
+and
+.Ev XDG_DATA_HOME
+can further alter the location of these files.
+.Pp
 .Bl -tag -width Ds -compact
 .It Pa ~/.config/telescope/config
 Default configuration file.
@@ -920,6 +938,11 @@ without any configuration
 .Bd -literal -offset indent
 telescope -c /dev/null
 .Ed
+.Sh STANDARDS
+.Rs
+.%B XDG Base Directory Specification
+.%U https://specifications.freedesktop.org/basedir-spec/latest/
+.Re
 .Sh AUTHORS
 .An -nosplit
 The