From 96ebb096e9ee4220eff2b404f1defce19064e2da Mon Sep 17 00:00:00 2001 From: kmq Date: Sun, 26 Feb 2017 20:33:15 +0200 Subject: [PATCH] Document relative path usage #1868 --- borg/archiver.py | 9 ++++++--- docs/usage.rst | 6 +++++- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/borg/archiver.py b/borg/archiver.py index cc214b682..99d21369b 100644 --- a/borg/archiver.py +++ b/borg/archiver.py @@ -1355,9 +1355,12 @@ class Archiver: create_epilog = textwrap.dedent(""" 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. diff --git a/docs/usage.rst b/docs/usage.rst index 18a7cdbdf..48f1894d5 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -435,6 +435,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 + Notes ~~~~~ @@ -443,7 +448,6 @@ Notes '\*/.bundler/gems' to get the same effect. See ``borg help patterns`` for more information. - .. include:: usage/extract.rst.inc Examples