From 985e84e3690a9efab96aff4ebbd833ae65d615cc Mon Sep 17 00:00:00 2001 From: Dylan Whyte Date: Tue, 2 Mar 2021 14:50:19 +0100 Subject: [PATCH] Fix 3321: fix interactive restore command explanation The previous description in the docs was false. The restore command with the pattern parameter will search the entire backup archive, regardless of pwd. Signed-off-by: Dylan Whyte --- docs/backup-client.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index 384de958..598fd55d 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -460,16 +460,15 @@ subdirectory and add the corresponding pattern to the list for subsequent restor all files in the archive matching the patterns to ``/target/path`` on the local host. This will scan the whole archive. -With ``restore /target/path`` you can restore the sub-archive given by the current -working directory to the local target path ``/target/path`` on your host. -By additionally passing a glob pattern with ``--pattern ``, the restore is -further limited to files matching the pattern. -For example: +The ``restore`` command can be used to restore all the files contained within +the backup archive. This is most helpful when paired with the ``--pattern +`` option, as it allows you to restore all files matching a specific +pattern. For example, if you wanted to restore configuration files +located in ``/etc``, you could do the following: .. code-block:: console - pxar:/ > cd /etc/ - pxar:/etc/ > restore /target/ --pattern **/*.conf + pxar:/ > restore target/ --pattern etc/**/*.conf ... The above will scan trough all the directories below ``/etc`` and restore all