浏览代码

Document relative path usage #1868

kmq 8 年之前
父节点
当前提交
757921dbdc
共有 2 个文件被更改,包括 11 次插入3 次删除
  1. 5 0
      docs/usage.rst
  2. 6 3
      src/borg/archiver.py

+ 5 - 0
docs/usage.rst

@@ -108,6 +108,11 @@ Examples
     # As above, but add nanoseconds
     $ borg create /path/to/repo::{hostname}-{user}-{now:%Y-%m-%dT%H:%M:%S.%f} ~
 
+    # Backing up relative paths by moving into the correct directory first
+    $ cd /home/user/Documents
+    # The root directory of the archive will be "projectA"
+    $ borg create /path/to/repo::daily-projectA-{now:%Y-%m-%d} projectA
+
 
 .. include:: usage/extract.rst.inc
 

+ 6 - 3
src/borg/archiver.py

@@ -2133,9 +2133,12 @@ class Archiver:
 
         create_epilog = process_epilog("""
         This command creates a backup archive containing all files found while recursively
-        traversing all paths specified. When giving '-' as path, borg will read data
-        from standard input and create a file 'stdin' in the created archive from that
-        data.
+        traversing all paths specified. Paths are added to the archive as they are given,
+        that means if relative paths are desired, the command has to be run from the correct
+        directory.
+
+        When giving '-' as path, borg will read data from standard input and create a
+        file 'stdin' in the created archive from that data.
 
         The archive will consume almost no disk space for files or parts of files that
         have already been stored in other archives.