Browse Source

[docs] improve remote-path description

(ported bebehei's 1.0-maint change to master)
Thomas Waldmann 8 years ago
parent
commit
d5707929fd
2 changed files with 2 additions and 2 deletions
  1. 1 1
      docs/usage_general.rst.inc
  2. 1 1
      src/borg/archiver.py

+ 1 - 1
docs/usage_general.rst.inc

@@ -148,7 +148,7 @@ General:
         When set, use this command instead of ``ssh``. This can be used to specify ssh options, such as
         a custom identity file ``ssh -i /path/to/private/key``. See ``man ssh`` for other options.
     BORG_REMOTE_PATH
-        When set, use the given path/filename as remote path (default is "borg").
+        When set, use the given path as borg executable on the remote (defaults to "borg" if unset).
         Using ``--remote-path PATH`` commandline option overrides the environment variable.
     BORG_FILES_CACHE_TTL
         When set to a numeric value, this determines the maximum "time to live" for the files cache

+ 1 - 1
src/borg/archiver.py

@@ -1888,7 +1888,7 @@ class Archiver:
         common_group.add_argument('--umask', dest='umask', type=lambda s: int(s, 8), default=UMASK_DEFAULT, metavar='M',
                                   help='set umask to M (local and remote, default: %(default)04o)')
         common_group.add_argument('--remote-path', dest='remote_path', metavar='PATH',
-                                  help='set remote path to executable (default: "borg")')
+                                  help='use PATH as borg executable on the remote (default: "borg")')
         common_group.add_argument('--remote-ratelimit', dest='remote_ratelimit', type=int, metavar='rate',
                                   help='set remote network upload rate limit in kiByte/s (default: 0=unlimited)')
         common_group.add_argument('--consider-part-files', dest='consider_part_files',