summaryrefslogtreecommitdiffstats
path: root/docs/usage/extract.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/usage/extract.rst')
-rw-r--r--docs/usage/extract.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/usage/extract.rst b/docs/usage/extract.rst
new file mode 100644
index 000000000..292f84bdc
--- /dev/null
+++ b/docs/usage/extract.rst
@@ -0,0 +1,23 @@
+.. include:: extract.rst.inc
+
+Examples
+~~~~~~~~
+::
+
+ # Extract entire archive
+ $ borg extract /path/to/repo::my-files
+
+ # Extract entire archive and list files while processing
+ $ borg extract --list /path/to/repo::my-files
+
+ # Verify whether an archive could be successfully extracted, but do not write files to disk
+ $ borg extract --dry-run /path/to/repo::my-files
+
+ # Extract the "src" directory
+ $ borg extract /path/to/repo::my-files home/USERNAME/src
+
+ # Extract the "src" directory but exclude object files
+ $ borg extract /path/to/repo::my-files home/USERNAME/src --exclude '*.o'
+
+ # Restore a raw device (must not be active/in use/mounted at that time)
+ $ borg extract --stdout /path/to/repo::my-sdx | dd of=/dev/sdx bs=10M