Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 177f878

Browse files
bastimeyergravyboat
authored andcommitted
docs: explain XDG base dir and parameter expansion
The docs should be as explicit as possible, but this might confuse inexperienced users, so an explanation might be useful.
1 parent 20ea832 commit 177f878

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/cli/config.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ You can also specify the location yourself using the :option:`--config` option.
4040
Streamlink's Windows installers automatically create a config file if it doesn't exist yet, but on any
4141
other platform or installation method, you must create the file yourself.
4242

43+
.. note::
44+
45+
The ``XDG_CONFIG_HOME`` environment variable is part of the `XDG base directory specification`_ (`Arch Wiki <xdg-base-dir-arch-wiki_>`_).
46+
47+
The ``${VARIABLENAME:-DEFAULTVALUE}`` syntax is explained `here <Parameter expansion_>`_.
48+
49+
.. _XDG base directory specification: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
50+
.. _xdg-base-dir-arch-wiki: https://wiki.archlinux.org/title/XDG_Base_Directory
51+
.. _Parameter expansion: https://wiki.bash-hackers.org/syntax/pe
52+
53+
4354
Syntax
4455
------
4556

0 commit comments

Comments
 (0)