mirror of
https://github.com/borgbackup/borg.git
synced 2026-02-19 02:29:19 -05:00
161 lines
4.4 KiB
Groff
161 lines
4.4 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.TH "BORG-EXTRACT" "1" "2025-12-23" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-extract \- Extracts archive contents.
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] extract [options] NAME [PATH...]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command extracts the contents of an archive.
|
|
.sp
|
|
By default, the entire archive is extracted, but a subset of files and directories
|
|
can be selected by passing a list of \fBPATH\fP arguments. The default interpretation
|
|
for the paths to extract is \fIpp:\fP which is a literal path\-prefix match. If you want
|
|
to use e.g. a wildcard, you must select a different pattern style such as \fIsh:\fP or
|
|
\fIfm:\fP\&. See \fIborg_patterns\fP for more information.
|
|
.sp
|
|
The file selection can be further restricted by using the \fB\-\-exclude\fP option.
|
|
For more help on include/exclude patterns, see the \fIborg_patterns\fP command output.
|
|
.sp
|
|
By using \fB\-\-dry\-run\fP, you can do all extraction steps except actually writing the
|
|
output data: reading metadata and data chunks from the repository, checking the hash/HMAC,
|
|
decrypting, and decompressing.
|
|
.sp
|
|
\fB\-\-progress\fP can be slower than no progress display, since it makes one additional
|
|
pass over the archive metadata.
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
Currently, extract always writes into the current working directory (\(dq.\(dq),
|
|
so make sure you \fBcd\fP to the right place before calling \fBborg extract\fP\&.
|
|
.sp
|
|
When parent directories are not extracted (because of using file/directory selection
|
|
or any other reason), Borg cannot restore parent directories\(aq metadata, e.g., owner,
|
|
group, permissions, etc.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B NAME
|
|
specify the archive name
|
|
.TP
|
|
.B PATH
|
|
paths to extract; patterns are supported
|
|
.UNINDENT
|
|
.SS options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-list
|
|
output a verbose list of items (files, dirs, ...)
|
|
.TP
|
|
.B \-n\fP,\fB \-\-dry\-run
|
|
do not actually change any files
|
|
.TP
|
|
.B \-\-numeric\-ids
|
|
only use numeric user and group identifiers
|
|
.TP
|
|
.B \-\-noflags
|
|
do not extract/set flags (e.g. NODUMP, IMMUTABLE)
|
|
.TP
|
|
.B \-\-noacls
|
|
do not extract/set ACLs
|
|
.TP
|
|
.B \-\-noxattrs
|
|
do not extract/set xattrs
|
|
.TP
|
|
.B \-\-stdout
|
|
write all extracted data to stdout
|
|
.TP
|
|
.B \-\-sparse
|
|
create holes in the output sparse file from all\-zero chunks
|
|
.TP
|
|
.B \-\-continue
|
|
continue a previously interrupted extraction of the same archive
|
|
.UNINDENT
|
|
.SS Include/Exclude options
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN
|
|
exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-exclude\-from \ EXCLUDEFILE
|
|
read exclude patterns from EXCLUDEFILE, one per line
|
|
.TP
|
|
.BI \-\-pattern \ PATTERN
|
|
include/exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-patterns\-from \ PATTERNFILE
|
|
read include/exclude patterns from PATTERNFILE, one per line
|
|
.TP
|
|
.BI \-\-strip\-components \ NUMBER
|
|
Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.EX
|
|
# Extract entire archive
|
|
$ borg extract my\-files
|
|
|
|
# Extract entire archive and list files while processing
|
|
$ borg extract \-\-list my\-files
|
|
|
|
# Verify whether an archive could be successfully extracted, but do not write files to disk
|
|
$ borg extract \-\-dry\-run my\-files
|
|
|
|
# Extract the \(dqsrc\(dq directory
|
|
$ borg extract my\-files home/USERNAME/src
|
|
|
|
# Extract the \(dqsrc\(dq directory but exclude object files
|
|
$ borg extract my\-files home/USERNAME/src \-\-exclude \(aq*.o\(aq
|
|
|
|
# Extract only the C files
|
|
$ borg extract my\-files \(aqsh:home/USERNAME/src/*.c\(aq
|
|
|
|
# Restore a raw device (must not be active/in use/mounted at that time)
|
|
$ borg extract \-\-stdout my\-sdx | dd of=/dev/sdx bs=10M
|
|
.EE
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP, \fIborg\-mount(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|