diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index c507178eb..b3d813ead 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -492,7 +492,7 @@ Borg supports paths with the slashdot hack to strip path prefixes here also. So, be careful not to unintentionally trigger that. .SH SEE ALSO .sp -\fIborg\-common(1)\fP, \fIborg\-delete(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-check(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-placeholders(1)\fP, \fIborg\-compression(1)\fP, \fIborg\-rcreate(1)\fP +\fIborg\-common(1)\fP, \fIborg\-delete(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-check(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-placeholders(1)\fP, \fIborg\-compression(1)\fP, \fIborg\-repo\-create(1)\fP .SH AUTHOR The Borg Collective .\" Generated by docutils manpage writer. diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index 7ecc0d314..b7945f165 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -109,7 +109,7 @@ $ borg delete \-\-list \-\-dry\-run \-a \(aqsh:*\-May\-*\(aq .UNINDENT .SH SEE ALSO .sp -\fIborg\-common(1)\fP, \fIborg\-compact(1)\fP, \fIborg\-rdelete(1)\fP +\fIborg\-common(1)\fP, \fIborg\-compact(1)\fP, \fIborg\-repo\-delete(1)\fP .SH AUTHOR The Borg Collective .\" Generated by docutils manpage writer. diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index 58dbd5d27..d7276578a 100644 --- a/docs/man/borg-info.1 +++ b/docs/man/borg-info.1 @@ -107,7 +107,7 @@ Deduplicated size: 531 B .UNINDENT .SH SEE ALSO .sp -\fIborg\-common(1)\fP, \fIborg\-list(1)\fP, \fIborg\-diff(1)\fP, \fIborg\-rinfo(1)\fP +\fIborg\-common(1)\fP, \fIborg\-list(1)\fP, \fIborg\-diff(1)\fP, \fIborg\-repo\-info(1)\fP .SH AUTHOR The Borg Collective .\" Generated by docutils manpage writer. diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index c2b8d5f63..1f2805885 100644 --- a/docs/man/borg-key-change-passphrase.1 +++ b/docs/man/borg-key-change-passphrase.1 @@ -52,7 +52,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .nf .ft C # Create a key file protected repository -$ borg rcreate \-\-encryption=keyfile\-aes\-ocb \-v +$ borg repo\-create \-\-encryption=keyfile\-aes\-ocb \-v Initializing repository at \(dq/path/to/repo\(dq Enter new passphrase: Enter same passphrase again: @@ -86,7 +86,7 @@ Fully automated using environment variables: .sp .nf .ft C -$ BORG_NEW_PASSPHRASE=old borg rcreate \-\-encryption=repokey\-aes\-ocb +$ BORG_NEW_PASSPHRASE=old borg repo\-create \-\-encryption=repokey\-aes\-ocb # now \(dqold\(dq is the current passphrase. $ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change\-passphrase # now \(dqnew\(dq is the current passphrase. diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1 index 113681b06..5983d1535 100644 --- a/docs/man/borg-list.1 +++ b/docs/man/borg-list.1 @@ -236,7 +236,7 @@ health: either \(dqhealthy\(dq (file ok) or \(dqbroken\(dq (if file has all\-zer .UNINDENT .SH SEE ALSO .sp -\fIborg\-common(1)\fP, \fIborg\-info(1)\fP, \fIborg\-diff(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-rlist(1)\fP +\fIborg\-common(1)\fP, \fIborg\-info(1)\fP, \fIborg\-diff(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-repo\-list(1)\fP .SH AUTHOR The Borg Collective .\" Generated by docutils manpage writer. diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1 index a1411e721..a71356127 100644 --- a/docs/man/borg-prune.1 +++ b/docs/man/borg-prune.1 @@ -82,7 +82,7 @@ backup archive in the same second). .sp You can influence how the \fB\-\-list\fP output is formatted by using the \fB\-\-short\fP option (less wide output) or by giving a custom format using \fB\-\-format\fP (see -the \fBborg rlist\fP description for more details about the format string). +the \fBborg repo\-list\fP description for more details about the format string). .SH OPTIONS .sp See \fIborg\-common(1)\fP for common options of Borg commands. diff --git a/docs/man/borg-rename.1 b/docs/man/borg-rename.1 index ce67e3947..2e802d9d8 100644 --- a/docs/man/borg-rename.1 +++ b/docs/man/borg-rename.1 @@ -57,11 +57,11 @@ specify the new archive name .nf .ft C $ borg create archivename ~ -$ borg rlist +$ borg repo\-list archivename Mon, 2016\-02\-15 19:50:19 $ borg rename archivename newname -$ borg rlist +$ borg repo\-list newname Mon, 2016\-02\-15 19:50:19 .ft P .fi diff --git a/docs/man/borg-rcompress.1 b/docs/man/borg-repo-compress.1 similarity index 81% rename from docs/man/borg-rcompress.1 rename to docs/man/borg-repo-compress.1 index 5f97ddd08..278c132e7 100644 --- a/docs/man/borg-rcompress.1 +++ b/docs/man/borg-repo-compress.1 @@ -27,12 +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-RCOMPRESS" 1 "2024-09-08" "" "borg backup tool" +.TH "BORG-REPO-COMPRESS" 1 "2024-09-08" "" "borg backup tool" .SH NAME -borg-rcompress \- Repository (re-)compression +borg-repo-compress \- Repository (re-)compression .SH SYNOPSIS .sp -borg [common options] rcompress [options] +borg [common options] repo\-compress [options] .SH DESCRIPTION .sp Repository (re\-)compression (and/or re\-obfuscation). @@ -48,13 +48,13 @@ type/level \- if no compression gives a shorter output, that might be chosen. Please note that this command can not work in low (or zero) free disk space conditions. .sp -If the \fBborg rcompress\fP process receives a SIGINT signal (Ctrl\-C), the repo +If the \fBborg repo\-compress\fP process receives a SIGINT signal (Ctrl\-C), the repo will be committed and compacted and borg will terminate cleanly afterwards. .sp -Both \fB\-\-progress\fP and \fB\-\-stats\fP are recommended when \fBborg rcompress\fP +Both \fB\-\-progress\fP and \fB\-\-stats\fP are recommended when \fBborg repo\-compress\fP is used interactively. .sp -You do \fBnot\fP need to run \fBborg compact\fP after \fBborg rcompress\fP\&. +You do \fBnot\fP need to run \fBborg compact\fP after \fBborg repo\-compress\fP\&. .SH OPTIONS .sp See \fIborg\-common(1)\fP for common options of Borg commands. @@ -74,10 +74,10 @@ print statistics .nf .ft C # recompress repo contents -$ borg rcompress \-\-progress \-\-compression=zstd,3 +$ borg repo\-compress \-\-progress \-\-compression=zstd,3 # recompress and obfuscate repo contents -$ borg rcompress \-\-progress \-\-compression=obfuscate,1,zstd,3 +$ borg repo\-compress \-\-progress \-\-compression=obfuscate,1,zstd,3 .ft P .fi .UNINDENT diff --git a/docs/man/borg-rcreate.1 b/docs/man/borg-repo-create.1 similarity index 87% rename from docs/man/borg-rcreate.1 rename to docs/man/borg-repo-create.1 index bb23f0d7a..ae38a3e63 100644 --- a/docs/man/borg-rcreate.1 +++ b/docs/man/borg-repo-create.1 @@ -27,12 +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-RCREATE" 1 "2024-09-08" "" "borg backup tool" +.TH "BORG-REPO-CREATE" 1 "2024-09-08" "" "borg backup tool" .SH NAME -borg-rcreate \- Create a new, empty repository +borg-repo-create \- Create a new, empty repository .SH SYNOPSIS .sp -borg [common options] rcreate [options] +borg [common options] repo\-create [options] .SH DESCRIPTION .sp This command creates a new, empty repository. A repository is a \fBborgstore\fP store @@ -48,7 +48,7 @@ tips will come below): .sp .nf .ft C -borg rcreate \-\-encryption repokey\-aes\-ocb +borg repo\-create \-\-encryption repokey\-aes\-ocb .ft P .fi .UNINDENT @@ -215,7 +215,7 @@ To normally work with \fBauthenticated\fP repos, you will need the passphrase, b there is an emergency workaround, see \fBBORG_WORKAROUNDS=authenticated_no_key\fP docs. .SS Creating a related repository .sp -You can use \fBborg rcreate \-\-other\-repo ORIG_REPO ...\fP to create a related repository +You can use \fBborg repo\-create \-\-other\-repo ORIG_REPO ...\fP to create a related repository that uses the same secret key material as the given other/original repository. .sp By default, only the ID key and chunker secret will be the same (these are important @@ -228,7 +228,7 @@ keys to manage. Creating related repositories is useful e.g. if you want to use \fBborg transfer\fP later. .SS Creating a related repository for data migration from borg 1.2 or 1.4 .sp -You can use \fBborg rcreate \-\-other\-repo ORIG_REPO \-\-from\-borg1 ...\fP to create a related +You can use \fBborg repo\-create \-\-other\-repo ORIG_REPO \-\-from\-borg1 ...\fP to create a related repository that uses the same secret key material as the given other/original repository. .sp Then use \fBborg transfer \-\-other\-repo ORIG_REPO \-\-from\-borg1 ...\fP to transfer the archives. @@ -268,28 +268,28 @@ copy the crypt_key (used for authenticated encryption) from the key of the other # Local repository $ export BORG_REPO=/path/to/repo # recommended repokey AEAD crypto modes -$ borg rcreate \-\-encryption=repokey\-aes\-ocb -$ borg rcreate \-\-encryption=repokey\-chacha20\-poly1305 -$ borg rcreate \-\-encryption=repokey\-blake2\-aes\-ocb -$ borg rcreate \-\-encryption=repokey\-blake2\-chacha20\-poly1305 +$ borg repo\-create \-\-encryption=repokey\-aes\-ocb +$ borg repo\-create \-\-encryption=repokey\-chacha20\-poly1305 +$ borg repo\-create \-\-encryption=repokey\-blake2\-aes\-ocb +$ borg repo\-create \-\-encryption=repokey\-blake2\-chacha20\-poly1305 # no encryption, not recommended -$ borg rcreate \-\-encryption=authenticated -$ borg rcreate \-\-encryption=authenticated\-blake2 -$ borg rcreate \-\-encryption=none +$ borg repo\-create \-\-encryption=authenticated +$ borg repo\-create \-\-encryption=authenticated\-blake2 +$ borg repo\-create \-\-encryption=none # Remote repository (accesses a remote borg via ssh) $ export BORG_REPO=ssh://user@hostname/~/backup # repokey: stores the (encrypted) key into /config -$ borg rcreate \-\-encryption=repokey\-aes\-ocb +$ borg repo\-create \-\-encryption=repokey\-aes\-ocb # keyfile: stores the (encrypted) key into ~/.config/borg/keys/ -$ borg rcreate \-\-encryption=keyfile\-aes\-ocb +$ borg repo\-create \-\-encryption=keyfile\-aes\-ocb .ft P .fi .UNINDENT .UNINDENT .SH SEE ALSO .sp -\fIborg\-common(1)\fP, \fIborg\-rdelete(1)\fP, \fIborg\-rlist(1)\fP, \fIborg\-check(1)\fP, \fIborg\-benchmark\-cpu(1)\fP, \fIborg\-key\-import(1)\fP, \fIborg\-key\-export(1)\fP, \fIborg\-key\-change\-passphrase(1)\fP +\fIborg\-common(1)\fP, \fIborg\-repo\-delete(1)\fP, \fIborg\-repo\-list(1)\fP, \fIborg\-check(1)\fP, \fIborg\-benchmark\-cpu(1)\fP, \fIborg\-key\-import(1)\fP, \fIborg\-key\-export(1)\fP, \fIborg\-key\-change\-passphrase(1)\fP .SH AUTHOR The Borg Collective .\" Generated by docutils manpage writer. diff --git a/docs/man/borg-rdelete.1 b/docs/man/borg-repo-delete.1 similarity index 93% rename from docs/man/borg-rdelete.1 rename to docs/man/borg-repo-delete.1 index f8056c562..25d133e9d 100644 --- a/docs/man/borg-rdelete.1 +++ b/docs/man/borg-repo-delete.1 @@ -27,12 +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-RDELETE" 1 "2024-09-08" "" "borg backup tool" +.TH "BORG-REPO-DELETE" 1 "2024-09-08" "" "borg backup tool" .SH NAME -borg-rdelete \- Delete a repository +borg-repo-delete \- Delete a repository .SH SYNOPSIS .sp -borg [common options] rdelete [options] +borg [common options] repo\-delete [options] .SH DESCRIPTION .sp This command deletes the complete repository. @@ -71,7 +71,7 @@ keep the local security info when deleting a repository .nf .ft C # delete the whole repository and the related local cache: -$ borg rdelete +$ borg repo\-delete You requested to DELETE the repository completely *including* all archives it contains: repo Mon, 2016\-02\-15 19:26:54 root\-2016\-02\-15 Mon, 2016\-02\-15 19:36:29 diff --git a/docs/man/borg-rinfo.1 b/docs/man/borg-repo-info.1 similarity index 90% rename from docs/man/borg-rinfo.1 rename to docs/man/borg-repo-info.1 index ba8a9a475..080fe9c83 100644 --- a/docs/man/borg-rinfo.1 +++ b/docs/man/borg-repo-info.1 @@ -27,12 +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-RINFO" 1 "2024-09-08" "" "borg backup tool" +.TH "BORG-REPO-INFO" 1 "2024-09-08" "" "borg backup tool" .SH NAME -borg-rinfo \- Show repository infos +borg-repo-info \- Show repository infos .SH SYNOPSIS .sp -borg [common options] rinfo [options] +borg [common options] repo\-info [options] .SH DESCRIPTION .sp This command displays detailed information about the repository. @@ -51,7 +51,7 @@ format output as JSON .sp .nf .ft C -$ borg rinfo +$ borg repo\-info Repository ID: 0e85a7811022326c067acb2a7181d5b526b7d2f61b34470fb8670c440a67f1a9 Location: /Users/tw/w/borg/path/to/repo Encrypted: Yes (repokey AES\-OCB) diff --git a/docs/man/borg-rlist.1 b/docs/man/borg-repo-list.1 similarity index 93% rename from docs/man/borg-rlist.1 rename to docs/man/borg-repo-list.1 index c3480b469..b195c596f 100644 --- a/docs/man/borg-rlist.1 +++ b/docs/man/borg-repo-list.1 @@ -27,12 +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-RLIST" 1 "2024-09-08" "" "borg backup tool" +.TH "BORG-REPO-LIST" 1 "2024-09-08" "" "borg backup tool" .SH NAME -borg-rlist \- List the archives contained in a repository +borg-repo-list \- List the archives contained in a repository .SH SYNOPSIS .sp -borg [common options] rlist [options] +borg [common options] repo\-list [options] .SH DESCRIPTION .sp This command lists the archives contained in a repository. @@ -84,7 +84,7 @@ consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m. .sp .nf .ft C -$ borg rlist +$ borg repo\-list Monday Mon, 2016\-02\-15 19:15:11 repo Mon, 2016\-02\-15 19:26:54 root\-2016\-02\-15 Mon, 2016\-02\-15 19:36:29 @@ -105,7 +105,7 @@ Examples: .sp .nf .ft C -$ borg rlist \-\-format \(aq{archive}{NL}\(aq +$ borg repo\-list \-\-format \(aq{archive}{NL}\(aq ArchiveFoo ArchiveBar \&... @@ -113,7 +113,7 @@ ArchiveBar # {VAR:NUMBER} \- pad to NUMBER columns. # Strings are left\-aligned, numbers are right\-aligned. # Note: time columns except \(ga\(gaisomtime\(ga\(ga, \(ga\(gaisoctime\(ga\(ga and \(ga\(gaisoatime\(ga\(ga cannot be padded. -$ borg rlist \-\-format \(aq{archive:36} {time} [{id}]{NL}\(aq /path/to/repo +$ borg repo\-list \-\-format \(aq{archive:36} {time} [{id}]{NL}\(aq /path/to/repo ArchiveFoo Thu, 2021\-12\-09 10:22:28 [0b8e9...3b274] \&... .ft P diff --git a/docs/man/borg-rspace.1 b/docs/man/borg-repo-space.1 similarity index 86% rename from docs/man/borg-rspace.1 rename to docs/man/borg-repo-space.1 index 8e5034c4d..2700230e8 100644 --- a/docs/man/borg-rspace.1 +++ b/docs/man/borg-repo-space.1 @@ -27,12 +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-RSPACE" 1 "2024-09-08" "" "borg backup tool" +.TH "BORG-REPO-SPACE" 1 "2024-09-08" "" "borg backup tool" .SH NAME -borg-rspace \- Manage reserved space in repository +borg-repo-space \- Manage reserved space in repository .SH SYNOPSIS .sp -borg [common options] rspace [options] +borg [common options] repo\-space [options] .SH DESCRIPTION .sp This command manages reserved space in a repository. @@ -54,19 +54,19 @@ Examples: .nf .ft C # Create a new repository: -$ borg rcreate ... +$ borg repo\-create ... # Reserve approx. 1GB of space for emergencies: -$ borg rspace \-\-reserve 1G +$ borg repo\-space \-\-reserve 1G # Check amount of reserved space in the repository: -$ borg rspace +$ borg repo\-space # EMERGENCY! Free all reserved space to get things back to normal: -$ borg rspace \-\-free +$ borg repo\-space \-\-free $ borg prune ... $ borg delete ... $ borg compact \-v # only this actually frees space of deleted archives -$ borg rspace \-\-reserve 1G # reserve space again for next time +$ borg repo\-space \-\-reserve 1G # reserve space again for next time .ft P .fi .UNINDENT diff --git a/docs/man/borg-transfer.1 b/docs/man/borg-transfer.1 index f7dc50f9a..ae5e7ed92 100644 --- a/docs/man/borg-transfer.1 +++ b/docs/man/borg-transfer.1 @@ -61,7 +61,7 @@ Transfer borg2 archives into a related other borg2 repository: .ft C # create a related DST_REPO (reusing key material from SRC_REPO), so that # chunking and chunk id generation will work in the same way as before. -borg \-\-repo=DST_REPO rcreate \-\-encryption=DST_ENC \-\-other\-repo=SRC_REPO +borg \-\-repo=DST_REPO repo\-create \-\-encryption=DST_ENC \-\-other\-repo=SRC_REPO # transfer archives from SRC_REPO to DST_REPO borg \-\-repo=DST_REPO transfer \-\-other\-repo=SRC_REPO \-\-dry\-run # check what it would do @@ -80,7 +80,7 @@ to the above, but you need the \fB\-\-from\-borg1\fP option: .sp .nf .ft C -borg \-\-repo=DST_REPO rcreate \-\-encryption=DST_ENC \-\-other\-repo=SRC_REPO \-\-from\-borg1 +borg \-\-repo=DST_REPO repocreate \-\-encryption=DST_ENC \-\-other\-repo=SRC_REPO \-\-from\-borg1 # to continue using lz4 compression as you did in SRC_REPO: borg \-\-repo=DST_REPO transfer \-\-other\-repo=SRC_REPO \-\-from\-borg1 \e @@ -161,7 +161,7 @@ consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m. # the AEAD cipher does not matter (everything must be re\-encrypted and # re\-authenticated anyway), you could also choose repokey\-blake2\-chacha20\-poly1305. # in case your old borg repo did not use blake2, just remove the \(dq\-blake2\(dq. -$ borg \-\-repo ssh://borg2@borgbackup/./tests/b20 rcreate \e +$ borg \-\-repo ssh://borg2@borgbackup/./tests/b20 repo\-create \e \-\-other\-repo ssh://borg2@borgbackup/./tests/b12 \-e repokey\-blake2\-aes\-ocb # 2. Check what and how much it would transfer: diff --git a/docs/man/borg.1 b/docs/man/borg.1 index 2990318f6..f0b95a0bf 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -60,7 +60,7 @@ Before a backup can be made, a repository has to be initialized: .sp .nf .ft C -$ borg \-r /path/to/repo rcreate \-\-encryption=repokey\-aes\-ocb +$ borg \-r /path/to/repo repo\-create \-\-encryption=repokey\-aes\-ocb .ft P .fi .UNINDENT @@ -121,7 +121,7 @@ List all archives in the repository: .sp .nf .ft C -$ borg \-r /path/to/repo rlist +$ borg \-r /path/to/repo repo\-list Monday Sat, 2022\-06\-25 20:21:14 [b80e24d2...b179f298] Tuesday Sat, 2022\-06\-25 20:21:43 [bcd1b53f...1877718d] .ft P @@ -571,10 +571,10 @@ Now you can init a fresh repo. Make sure you do not use the workaround any more. .INDENT 7.0 .TP .B BORG_LIST_FORMAT -Giving the default value for \fBborg list \-\-format=X\fP\&. +Giving the default value for \fBborg repo\-list \-\-format=X\fP\&. .TP .B BORG_RLIST_FORMAT -Giving the default value for \fBborg rlist \-\-format=X\fP\&. +Giving the default value for \fBborg repo\-list \-\-format=X\fP\&. .TP .B BORG_PRUNE_FORMAT Giving the default value for \fBborg prune \-\-format=X\fP\&. @@ -656,7 +656,7 @@ all directories in the given path must exist. .IP \(bu 2 this setting forces borg to use the key file at the given location. .IP \(bu 2 -the key file must either exist (for most commands) or will be created (\fBborg rcreate\fP). +the key file must either exist (for most commands) or will be created (\fBborg repo\-create\fP). .IP \(bu 2 you need to give a different path for different repositories. .IP \(bu 2