summaryrefslogtreecommitdiffstats
path: root/docs/man
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2022-06-24 01:19:19 +0200
committerThomas Waldmann <tw@waldmann-edv.de>2022-06-25 21:58:19 +0200
commit51cf85e627233feaae689b53950372dd8298b743 (patch)
tree1405527058fc4605277e47b0a7181f1ae3c9d7bb /docs/man
parent7f99aa155e301bcf3abd6ab190a9e86ce6475b14 (diff)
build_usage / build_man / doc updates
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/borg-benchmark-cpu.114
-rw-r--r--docs/man/borg-benchmark-crud.111
-rw-r--r--docs/man/borg-benchmark.16
-rw-r--r--docs/man/borg-break-lock.114
-rw-r--r--docs/man/borg-check.127
-rw-r--r--docs/man/borg-common.135
-rw-r--r--docs/man/borg-compact.121
-rw-r--r--docs/man/borg-compression.16
-rw-r--r--docs/man/borg-config.123
-rw-r--r--docs/man/borg-create.1110
-rw-r--r--docs/man/borg-delete.163
-rw-r--r--docs/man/borg-diff.157
-rw-r--r--docs/man/borg-export-tar.116
-rw-r--r--docs/man/borg-extract.144
-rw-r--r--docs/man/borg-import-tar.138
-rw-r--r--docs/man/borg-info.182
-rw-r--r--docs/man/borg-key-change-algorithm.110
-rw-r--r--docs/man/borg-key-change-location.125
-rw-r--r--docs/man/borg-key-change-passphrase.121
-rw-r--r--docs/man/borg-key-export.114
-rw-r--r--docs/man/borg-key-import.112
-rw-r--r--docs/man/borg-key.16
-rw-r--r--docs/man/borg-list.1136
-rw-r--r--docs/man/borg-mount.121
-rw-r--r--docs/man/borg-patterns.1246
-rw-r--r--docs/man/borg-placeholders.18
-rw-r--r--docs/man/borg-prune.148
-rw-r--r--docs/man/borg-rcreate.1 (renamed from docs/man/borg-init.1)86
-rw-r--r--docs/man/borg-rdelete.190
-rw-r--r--docs/man/borg-recreate.157
-rw-r--r--docs/man/borg-rename.122
-rw-r--r--docs/man/borg-rinfo.183
-rw-r--r--docs/man/borg-rlist.1160
-rw-r--r--docs/man/borg-serve.18
-rw-r--r--docs/man/borg-transfer.1100
-rw-r--r--docs/man/borg-umount.125
-rw-r--r--docs/man/borg-upgrade.124
-rw-r--r--docs/man/borg-with-lock.111
-rw-r--r--docs/man/borg.1117
-rw-r--r--docs/man/borgfs.123
40 files changed, 1067 insertions, 853 deletions
diff --git a/docs/man/borg-benchmark-cpu.1 b/docs/man/borg-benchmark-cpu.1
index e6c51936b..9c3f4e0d4 100644
--- a/docs/man/borg-benchmark-cpu.1
+++ b/docs/man/borg-benchmark-cpu.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-BENCHMARK-CPU 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-benchmark-cpu \- Benchmark CPU bound operations.
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-BENCHMARK-CPU" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-benchmark-cpu \- Benchmark CPU bound operations.
.SH SYNOPSIS
.sp
borg [common options] benchmark cpu [options]
@@ -39,8 +39,12 @@ This command benchmarks misc. CPU bound borg operations.
.sp
It creates input data in memory, runs the operation and then displays throughput.
To reduce outside influence on the timings, please make sure to run this with:
-\- an otherwise as idle as possible machine
-\- enough free memory so there will be no slow down due to paging activity
+.INDENT 0.0
+.IP \(bu 2
+an otherwise as idle as possible machine
+.IP \(bu 2
+enough free memory so there will be no slow down due to paging activity
+.UNINDENT
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1
index efa4df554..89cd546ec 100644
--- a/docs/man/borg-benchmark-crud.1
+++ b/docs/man/borg-benchmark-crud.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-BENCHMARK-CRUD 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
.
.nr rst2man-indent-level 0
.
@@ -30,9 +27,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-BENCHMARK-CRUD" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
.SH SYNOPSIS
.sp
-borg [common options] benchmark crud [options] REPOSITORY PATH
+borg [common options] benchmark crud [options] PATH
.SH DESCRIPTION
.sp
This command benchmarks borg CRUD (create, read, update, delete) operations.
@@ -88,9 +88,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments
.INDENT 0.0
.TP
-.B REPOSITORY
-repository to use for benchmark (must exist)
-.TP
.B PATH
path were to create benchmark input data
.UNINDENT
diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1
index 0cd5e90cb..c832a7925 100644
--- a/docs/man/borg-benchmark.1
+++ b/docs/man/borg-benchmark.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-BENCHMARK 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-benchmark \- benchmark command
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-BENCHMARK" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-benchmark \- benchmark command
.SH SYNOPSIS
.nf
borg [common options] benchmark crud ...
diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1
index bd01367c9..81c290601 100644
--- a/docs/man/borg-break-lock.1
+++ b/docs/man/borg-break-lock.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-BREAK-LOCK 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
.
.nr rst2man-indent-level 0
.
@@ -30,9 +27,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-BREAK-LOCK" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
.SH SYNOPSIS
.sp
-borg [common options] break\-lock [options] [REPOSITORY]
+borg [common options] break\-lock [options]
.SH DESCRIPTION
.sp
This command breaks the repository and cache locks.
@@ -41,12 +41,6 @@ trying to access the Cache or the Repository.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY
-repository for which to break the locks
-.UNINDENT
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1
index 0dfbc27b1..9ec8e69f9 100644
--- a/docs/man/borg-check.1
+++ b/docs/man/borg-check.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-CHECK 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-check \- Check repository consistency
.
.nr rst2man-indent-level 0
.
@@ -30,9 +27,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-CHECK" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-check \- Check repository consistency
.SH SYNOPSIS
.sp
-borg [common options] check [options] [REPOSITORY_OR_ARCHIVE]
+borg [common options] check [options]
.SH DESCRIPTION
.sp
The check command verifies the consistency of a repository and the corresponding archives.
@@ -126,28 +126,25 @@ slow.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY_OR_ARCHIVE
-repository or archive to check consistency of
-.UNINDENT
.SS optional arguments
.INDENT 0.0
.TP
-.B \-\-repository\-only
+.BI \-\-name \ NAME
+specify the archive name
+.TP
+.B \-\-repository\-only
only perform repository checks
.TP
-.B \-\-archives\-only
+.B \-\-archives\-only
only perform archives checks
.TP
-.B \-\-verify\-data
+.B \-\-verify\-data
perform cryptographic archive data integrity verification (conflicts with \fB\-\-repository\-only\fP)
.TP
-.B \-\-repair
+.B \-\-repair
attempt to repair any inconsistencies found
.TP
-.B \-\-save\-space
+.B \-\-save\-space
work slower, but using less space
.TP
.BI \-\-max\-duration \ SECONDS
diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1
index 85b46e70f..5e960b713 100644
--- a/docs/man/borg-common.1
+++ b/docs/man/borg-common.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-COMMON 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-common \- Common options of Borg commands
.
.nr rst2man-indent-level 0
.
@@ -30,49 +27,52 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-COMMON" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-common \- Common options of Borg commands
.SH SYNOPSIS
.INDENT 0.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
-.B \-\-critical
+.B \-\-critical
work on log level CRITICAL
.TP
-.B \-\-error
+.B \-\-error
work on log level ERROR
.TP
-.B \-\-warning
+.B \-\-warning
work on log level WARNING (default)
.TP
-.B \-\-info\fP,\fB \-v\fP,\fB \-\-verbose
+.B \-\-info\fP,\fB \-v\fP,\fB \-\-verbose
work on log level INFO
.TP
-.B \-\-debug
+.B \-\-debug
enable debug output, work on log level DEBUG
.TP
.BI \-\-debug\-topic \ TOPIC
enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
.TP
-.B \-p\fP,\fB \-\-progress
+.B \-p\fP,\fB \-\-progress
show progress information
.TP
-.B \-\-iec
+.B \-\-iec
format using IEC units (1KiB = 1024B)
.TP
-.B \-\-log\-json
+.B \-\-log\-json
Output one JSON object per log line instead of formatted text.
.TP
.BI \-\-lock\-wait \ SECONDS
wait at most SECONDS for acquiring a repository/cache lock (default: 1).
.TP
-.B \-\-bypass\-lock
+.B \-\-bypass\-lock
Bypass locking mechanism
.TP
-.B \-\-show\-version
+.B \-\-show\-version
show/log the borg version
.TP
-.B \-\-show\-rc
+.B \-\-show\-rc
show/log the return code (rc)
.TP
.BI \-\-umask \ M
@@ -93,7 +93,7 @@ deprecated, use \fB\-\-upload\-buffer\fP instead
.BI \-\-upload\-buffer \ UPLOAD_BUFFER
set network upload buffer size in MiB. (default: 0=no buffer)
.TP
-.B \-\-consider\-part\-files
+.B \-\-consider\-part\-files
treat part files like normal files (e.g. to list/extract them)
.TP
.BI \-\-debug\-profile \ FILE
@@ -101,6 +101,9 @@ Write execution profile in Borg format into FILE. For local use a Python\-compat
.TP
.BI \-\-rsh \ RSH
Use this command to connect to the \(aqborg serve\(aq process (default: \(aqssh\(aq)
+.TP
+.BI \-r \ REPO\fR,\fB \ \-\-repo \ REPO
+repository to use
.UNINDENT
.SH SEE ALSO
.sp
diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1
index 79f8fc4e8..18d79ee76 100644
--- a/docs/man/borg-compact.1
+++ b/docs/man/borg-compact.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-COMPACT 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-compact \- compact segment files in the repository
.
.nr rst2man-indent-level 0
.
@@ -30,9 +27,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-COMPACT" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-compact \- compact segment files in the repository
.SH SYNOPSIS
.sp
-borg [common options] compact [options] [REPOSITORY]
+borg [common options] compact [options]
.SH DESCRIPTION
.sp
This command frees repository space by compacting segments.
@@ -60,16 +60,10 @@ See \fIseparate_compaction\fP in Additional Notes for more details.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY
-repository to compact
-.UNINDENT
.SS optional arguments
.INDENT 0.0
.TP
-.B \-\-cleanup\-commits
+.B \-\-cleanup\-commits
cleanup commit\-only 17\-byte segment files
.TP
.BI \-\-threshold \ PERCENT
@@ -82,10 +76,7 @@ set minimum threshold for saved space in PERCENT (Default: 10)
.nf
.ft C
# compact segments and free repo disk space
-$ borg compact /path/to/repo
-
-# same as above plus clean up 17byte commit\-only segments
-$ borg compact \-\-cleanup\-commits /path/to/repo
+$ borg compact
.ft P
.fi
.UNINDENT
diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1
index a55a7dba7..ff348a7e3 100644
--- a/docs/man/borg-compression.1
+++ b/docs/man/borg-compression.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-COMPRESSION 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-compression \- Details regarding compression
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-COMPRESSION" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-compression \- Details regarding compression
.SH DESCRIPTION
.sp
It is no problem to mix different compression methods in one repo,
diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1
index 26ccffdd6..35cc426d9 100644
--- a/docs/man/borg-config.1
+++ b/docs/man/borg-config.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-CONFIG 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-config \- get, set, and delete values in a repository or cache config file
.
.nr rst2man-indent-level 0
.
@@ -30,9 +27,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-CONFIG" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-config \- get, set, and delete values in a repository or cache config file
.SH SYNOPSIS
.sp
-borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]
+borg [common options] config [options] [NAME] [VALUE]
.SH DESCRIPTION
.sp
This command gets and sets options in a local repository or cache config file.
@@ -53,9 +53,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments
.INDENT 0.0
.TP
-.B REPOSITORY
-repository to configure
-.TP
.B NAME
name of config key
.TP
@@ -65,13 +62,13 @@ new value for key
.SS optional arguments
.INDENT 0.0
.TP
-.B \-c\fP,\fB \-\-cache
+.B \-c\fP,\fB \-\-cache
get and set values from the repo cache
.TP
-.B \-d\fP,\fB \-\-delete
+.B \-d\fP,\fB \-\-delete
delete the key from the config file
.TP
-.B \-l\fP,\fB \-\-list
+.B \-l\fP,\fB \-\-list
list the configuration of the repo
.UNINDENT
.SH EXAMPLES
@@ -90,13 +87,13 @@ making changes!
.nf
.ft C
# find cache directory
-$ cd ~/.cache/borg/$(borg config /path/to/repo id)
+$ cd ~/.cache/borg/$(borg config id)
# reserve some space
-$ borg config /path/to/repo additional_free_space 2G
+$ borg config additional_free_space 2G
# make a repo append\-only
-$ borg config /path/to/repo append_only 1
+$ borg config append_only 1
.ft P
.fi
.UNINDENT
diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1
index 887814626..7d36f0940 100644
--- a/docs/man/borg-create.1
+++ b/docs/man/borg-create.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-CREATE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-create \- Create new archive
.
.nr rst2man-indent-level 0
.
@@ -30,9 +27,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-CREATE" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-create \- Create new archive
.SH SYNOPSIS
.sp
-borg [common options] create [options] ARCHIVE [PATH...]
+borg [common options] create [options] NAME [PATH...]
.SH DESCRIPTION
.sp
This command creates a backup archive containing all files found while recursively
@@ -126,8 +126,8 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments
.INDENT 0.0
.TP
-.B ARCHIVE
-name of archive to create (must be also a valid directory name)
+.B NAME
+specify the archive name
.TP
.B PATH
paths to archive
@@ -135,22 +135,22 @@ paths to archive
.SS optional arguments
.INDENT 0.0
.TP
-.B \-n\fP,\fB \-\-dry\-run
+.B \-n\fP,\fB \-\-dry\-run
do not create a backup archive
.TP
-.B \-s\fP,\fB \-\-stats
+.B \-s\fP,\fB \-\-stats
print statistics for the created archive
.TP
-.B \-\-list
+.B \-\-list
output verbose list of items (files, dirs, ...)
.TP
.BI \-\-filter \ STATUSCHARS
only display items with the given status characters (see description)
.TP
-.B \-\-json
+.B \-\-json
output stats as JSON. Implies \fB\-\-stats\fP\&.
.TP
-.B \-\-no\-cache\-sync
+.B \-\-no\-cache\-sync
experimental: do not synchronize the cache. Implies not using the files cache.
.TP
.BI \-\-stdin\-name \ NAME
@@ -160,18 +160,18 @@ use NAME in archive for stdin data (default: \(aqstdin\(aq)
set user USER in archive for stdin data (default: \(aqroot\(aq)
.TP
.BI \-\-stdin\-group \ GROUP
-set group GROUP in archive for stdin data (default: \(aqroot\(aq)
+set group GROUP in archive for stdin data (default: \(aqwheel\(aq)
.TP
.BI \-\-stdin\-mode \ M
set mode to M in archive for stdin data (default: 0660)
.TP
-.B \-\-content\-from\-command
+.B \-\-content\-from\-command
interpret PATH as command and store its stdout. See also section Reading from stdin below.
.TP
-.B \-\-paths\-from\-stdin
+.B \-\-paths\-from\-stdin
read DELIM\-separated list of paths to backup from stdin. Will not recurse into directories.
.TP
-.B \-\-paths\-from\-command
+.B \-\-paths\-from\-command
interpret PATH as command and treat its output as \fB\-\-paths\-from\-stdin\fP
.TP
.BI \-\-paths\-delimiter \ DELIM
@@ -192,61 +192,61 @@ include/exclude paths matching PATTERN
.BI \-\-patterns\-from \ PATTERNFILE
read include/exclude patterns from PATTERNFILE, one per line
.TP
-.B \-\-exclude\-caches
+.B \-\-exclude\-caches
exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.bford.info/cachedir/spec.html\fP)
.TP
.BI \-\-exclude\-if\-present \ NAME
exclude directories that are tagged by containing a filesystem object with the given NAME
.TP
-.B \-\-keep\-exclude\-tags
+.B \-\-keep\-exclude\-tags
if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive
.TP
-.B \-\-exclude\-nodump
+.B \-\-exclude\-nodump
exclude files flagged NODUMP
.UNINDENT
.SS Filesystem options
.INDENT 0.0
.TP
-.B \-x\fP,\fB \-\-one\-file\-system
+.B \-x\fP,\fB \-\-one\-file\-system
stay in the same file system and do not store mount points of other file systems. This might behave different from your expectations, see the docs.
.TP
-.B \-\-numeric\-owner
+.B \-\-numeric\-owner
deprecated, use \fB\-\-numeric\-ids\fP instead
.TP
-.B \-\-numeric\-ids
+.B \-\-numeric\-ids
only store numeric user and group identifiers
.TP
-.B \-\-noatime
+.B \-\-noatime
do not store atime into archive
.TP
-.B \-\-atime
+.B \-\-atime
do store atime into archive
.TP
-.B \-\-noctime
+.B \-\-noctime
do not store ctime into archive
.TP
-.B \-\-nobirthtime
+.B \-\-nobirthtime
do not store birthtime (creation date) into archive
.TP
-.B \-\-nobsdflags
+.B \-\-nobsdflags
deprecated, use \fB\-\-noflags\fP instead
.TP
-.B \-\-noflags
+.B \-\-noflags
do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive
.TP
-.B \-\-noacls
+.B \-\-noacls
do not read and store ACLs into archive
.TP
-.B \-\-noxattrs
+.B \-\-noxattrs
do not read and store xattrs into archive
.TP
-.B \-\-sparse
+.B \-\-sparse
detect sparse holes in input (supported only by fixed chunker)
.TP
.BI \-\-files\-cache \ MODE
operate files cache in MODE. default: ctime,size,inode
.TP
-.B \-\-read\-special
+.B \-\-read\-special
open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files.
.UNINDENT
.SS Archive options
@@ -274,86 +274,84 @@ select compression algorithm, see the output of the "borg help compression" comm
.nf
.ft C
# Backup ~/Documents into an archive named "my\-documents"
-$ borg create /path/to/repo::my\-documents ~/Documents
+$ borg create my\-documents ~/Documents
# same, but list all files as we process them
-$ borg create \-\-list /path/to/repo::my\-documents ~/Documents
+$ borg create \-\-list my\-documents ~/Documents
# Backup ~/Documents and ~/src but exclude pyc files
-$ borg create /path/to/repo::my\-files \e
+$ borg create my\-files \e
~/Documents \e
~/src \e
\-\-exclude \(aq*.pyc\(aq
# Backup home directories excluding image thumbnails (i.e. only
# /home/<one directory>/.thumbnails is excluded, not /home/*/*/.thumbnails etc.)
-$ borg create /path/to/repo::my\-files /home \e
- \-\-exclude \(aqsh:/home/*/.thumbnails\(aq
+$ borg create my\-files /home \-\-exclude \(aqsh:home/*/.thumbnails\(aq
# Backup the root filesystem into an archive named "root\-YYYY\-MM\-DD"
# use zlib compression (good, but slow) \- default is lz4 (fast, low compression ratio)
-$ borg create \-C zlib,6 \-\-one\-file\-system /path/to/repo::root\-{now:%Y\-%m\-%d} /
+$ borg create \-C zlib,6 \-\-one\-file\-system root\-{now:%Y\-%m\-%d} /
-# Backup onto a remote host ("push" style) via ssh to port 2222,
-# logging in as user "borg" and storing into /path/to/repo
-$ borg create ssh://borg@backup.example.org:2222/path/to/repo::{fqdn}\-root\-{now} /
+# Backup into an archive name like FQDN\-root\-TIMESTAMP
+$ borg create \(aq{fqdn}\-root\-{now}\(aq /
# Backup a remote host locally ("pull" style) using sshfs
$ mkdir sshfs\-mount
$ sshfs root@example.com:/ sshfs\-mount
$ cd sshfs\-mount
-$ borg create /path/to/repo::example.com\-root\-{now:%Y\-%m\-%d} .
+$ borg create example.com\-root\-{now:%Y\-%m\-%d} .
$ cd ..
$ fusermount \-u sshfs\-mount
# Make a big effort in fine granular deduplication (big chunk management
# overhead, needs a lot of RAM and disk space, see formula in internals
# docs \- same parameters as borg < 1.0 or attic):
-$ borg create \-\-chunker\-params buzhash,10,23,16,4095 /path/to/repo::small /smallstuff
+$ borg create \-\-chunker\-params buzhash,10,23,16,4095 small /smallstuff
# Backup a raw device (must not be active/in use/mounted at that time)
-$ borg create \-\-read\-special \-\-chunker\-params fixed,4194304 /path/to/repo::my\-sdx /dev/sdX
+$ borg create \-\-read\-special \-\-chunker\-params fixed,4194304 my\-sdx /dev/sdX
# Backup a sparse disk image (must not be active/in use/mounted at that time)
-$ borg create \-\-sparse \-\-chunker\-params fixed,4194304 /path/to/repo::my\-disk my\-disk.raw
+$ borg create \-\-sparse \-\-chunker\-params fixed,4194304 my\-disk my\-disk.raw
# No compression (none)
-$ borg create \-\-compression none /path/to/repo::arch ~
+$ borg create \-\-compression none arch ~
# Super fast, low compression (lz4, default)
-$ borg create /path/to/repo::arch ~
+$ borg create arch ~
# Less fast, higher compression (zlib, N = 0..9)
-$ borg create \-\-compression zlib,N /path/to/repo::arch ~
+$ borg create \-\-compression zlib,N arch ~
# Even slower, even higher compression (lzma, N = 0..9)
-$ borg create \-\-compression lzma,N /path/to/repo::arch ~
+$ borg create \-\-compression lzma,N arch ~
# Only compress compressible data with lzma,N (N = 0..9)
-$ borg create \-\-compression auto,lzma,N /path/to/repo::arch ~
+$ borg create \-\-compression auto,lzma,N arch ~
# Use short hostname, user name and current time in archive name
-$ borg create /path/to/repo::{hostname}\-{user}\-{now} ~
+$ borg create \(aq{hostname}\-{user}\-{now}\(aq ~
# Similar, use the same datetime format that is default as of borg 1.1
-$ borg create /path/to/repo::{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S} ~
+$ borg create \(aq{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S}\(aq ~
# As above, but add nanoseconds
-$ borg create /path/to/repo::{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S.%f} ~
+$ borg create \(aq{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S.%f}\(aq ~
# 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
+$ borg create \(aqdaily\-projectA\-{now:%Y\-%m\-%d}\(aq projectA
# Use external command to determine files to archive
# Use \-\-paths\-from\-stdin with find to only backup files less than 1MB in size
-$ find ~ \-size \-1000k | borg create \-\-paths\-from\-stdin /path/to/repo::small\-files\-only
+$ find ~ \-size \-1000k | borg create \-\-paths\-from\-stdin small\-files\-only
# Use \-\-paths\-from\-command with find to only backup files from a given user
-$ borg create \-\-paths\-from\-command /path/to/repo::joes\-files \-\- find /srv/samba/shared \-user joe
+$ borg create \-\-paths\-from\-command joes\-files \-\- find /srv/samba/shared \-user joe
# Use \-\-paths\-from\-stdin with \-\-paths\-delimiter (for example, for filenames with newlines in them)
$ find ~ \-size \-1000k \-print0 | borg create \e
\-\-paths\-from\-stdin \e
\-\-paths\-delimiter "\e0" \e
- /path/to/repo::smallfiles\-handle\-newline
+ smallfiles\-handle\-newline
.ft P
.fi
.UNINDENT
diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1
index 68639c1ea..7a213de1d 100644
--- a/docs/man/borg-delete.1
+++ b/docs/man/borg-delete.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-DELETE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-delete \- Delete an existing repository or archives
.
.nr rst2man-indent-level 0
.
@@ -30,21 +27,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-DELETE" 1 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-delete \- Delete archives
.SH SYNOPSIS
.sp
-borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
+borg [common options] delete [options]
.SH DESCRIPTION
.sp
-This command deletes an archive from the repository or the complete repository.
+This command deletes archives from the repository.
.sp
Important: When deleting archives, repository disk space is \fBnot\fP freed until
you run \fBborg compact\fP\&.