From 6adf18d97c9f3b82dd5aeba17d6a147b1c02cba4 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 14 Oct 2024 23:30:12 +0200 Subject: [PATCH] update URL docs --- docs/usage/general/repository-urls.rst.inc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/usage/general/repository-urls.rst.inc b/docs/usage/general/repository-urls.rst.inc index 3d7464d48..17f9560b9 100644 --- a/docs/usage/general/repository-urls.rst.inc +++ b/docs/usage/general/repository-urls.rst.inc @@ -14,21 +14,21 @@ Note: you may also prepend a ``file://`` to a filesystem path to get URL style. **Remote repositories** accessed via ssh user@host: -``ssh://user@host:port/path/to/repo`` - absolute path +``ssh://user@host:port//abs/path/to/repo`` - absolute path -``ssh://user@host:port/./path/to/repo`` - path relative to current directory - -``ssh://user@host:port/~/path/to/repo`` - path relative to user's home directory +``ssh://user@host:port/rel/path/to/repo`` - path relative to current directory **Remote repositories** accessed via sftp: -``sftp://user@host:port/path/to/repo`` - absolute path +``sftp://user@host:port//abs/path/to/repo`` - absolute path + +``sftp://user@host:port/rel/path/to/repo`` - path relative to current directory For ssh and sftp URLs, the ``user@`` and ``:port`` parts are optional. **Remote repositories** accessed via rclone: -``rclone://remote:path`` - see the rclone docs for more details. +``rclone:remote:path`` - see the rclone docs for more details about remote:path. If you frequently need the same repo URL, it is a good idea to set the @@ -36,7 +36,7 @@ If you frequently need the same repo URL, it is a good idea to set the :: - export BORG_REPO='ssh://user@host:port/path/to/repo' + export BORG_REPO='ssh://user@host:port/rel/path/to/repo' Then just leave away the ``--repo`` option if you want to use the default - it will be read from BORG_REPO then.