From 3ea1f8e80a33edff8d944ea2e82b0dfe4ff25215 Mon Sep 17 00:00:00 2001 From: sfan5 Date: Sat, 30 Oct 2021 23:58:58 +0200 Subject: DOCS: clarify what the ~~/ path means As it turns out the manual was very wrong about this. --- DOCS/man/mpv.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst index 0f93556d12..7a4c0b64d0 100644 --- a/DOCS/man/mpv.rst +++ b/DOCS/man/mpv.rst @@ -433,23 +433,28 @@ need to escape special characters. To work this around, the path can be additionally wrapped in the fixed-length syntax, e.g. ``%n%string_of_length_n`` (see above). -Some mpv options interpret paths starting with ``~``. Currently, the prefix -``~~/`` expands to the mpv configuration directory (usually ``~/.config/mpv/``). +Some mpv options interpret paths starting with ``~``. +Currently, the prefix ``~~home/`` expands to the mpv configuration directory +(usually ``~/.config/mpv/``). ``~/`` expands to the user's home directory. (The trailing ``/`` is always required.) The following paths are currently recognized: ================ =============================================================== Name Meaning ================ =============================================================== -``~~/`` mpv config dir (for example ``~/.config/mpv/``) +``~~/`` If the subpath exists in any of the mpv's config directories + the path of the existing file/dir is returned. Otherwise this + is equivalent to ``~~home/``. + Note that if --no-config is used ``~~/foobar`` will resolve to + ``foobar`` which can be unexpected. ``~/`` user home directory root (similar to shell, ``$HOME``) -``~~home/`` same as ``~~/`` +``~~home/`` mpv config dir (for example ``~/.config/mpv/``) ``~~global/`` the global config path, if available (not on win32) ``~~osxbundle/`` the macOS bundle resource path (macOS only) ``~~desktop/`` the path to the desktop (win32, macOS) -``~~exe_dir`` win32 only: the path to the directory containing the exe (for +``~~exe_dir/`` win32 only: the path to the directory containing the exe (for config file purposes; ``$MPV_HOME`` overrides it) -``~~old_home`` do not use +``~~old_home/`` do not use ================ =============================================================== -- cgit v1.2.3