docs: fix borg transfer formatting / rendering, fixes #6800

This commit is contained in:
Thomas Waldmann 2022-06-26 20:11:41 +02:00
parent e2f7087aa8
commit 0a7baa53c4
3 changed files with 19 additions and 38 deletions

View File

@ -93,10 +93,12 @@ consider last N archives after other filters were applied
.UNINDENT .UNINDENT
.SH EXAMPLES .SH EXAMPLES
.INDENT 0.0 .INDENT 0.0
.TP .INDENT 3.5
.B ::
# 0. Have borg 2.0 installed on client AND server, have a b12 repo copy for testing.
.sp .sp
.nf
.ft C
# 0. Have borg 2.0 installed on client AND server, have a b12 repo copy for testing.
# 1. Create a new "related" repository: # 1. Create a new "related" repository:
# here, the existing borg 1.2 repo used repokey\-blake2 (and aes\-ctr mode), # here, the existing borg 1.2 repo used repokey\-blake2 (and aes\-ctr mode),
# thus we use repokey\-blake2\-aes\-ocb for the new borg 2.0 repo. # thus we use repokey\-blake2\-aes\-ocb for the new borg 2.0 repo.
@ -106,43 +108,22 @@ consider last N archives after other filters were applied
# the AEAD cipher does not matter (everything must be re\-encrypted and # the AEAD cipher does not matter (everything must be re\-encrypted and
# re\-authenticated anyway), you could also choose repokey\-blake2\-chacha20\-poly1305. # re\-authenticated anyway), you could also choose repokey\-blake2\-chacha20\-poly1305.
# in case your old borg repo did not use blake2, just remove the "\-blake2". # in case your old borg repo did not use blake2, just remove the "\-blake2".
$ borg \-\-repo \fI\%ssh://borg2@borgbackup/./tests/b20\fP rcreate $ borg \-\-repo ssh://borg2@borgbackup/./tests/b20 rcreate \e
.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 88)" \-\-other\-repo ssh://borg2@borgbackup/./tests/b12 \-e repokey\-blake2\-aes\-ocb
Unexpected indentation.
.INDENT 7.0
.INDENT 3.5
\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP \-e repokey\-blake2\-aes\-ocb
.UNINDENT
.UNINDENT
.sp
# 2. Check what and how much it would transfer: # 2. Check what and how much it would transfer:
$ borg \-\-repo \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer $ borg \-\-repo ssh://borg2@borgbackup/./tests/b20 transfer \e
.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 92)" \-\-other\-repo ssh://borg2@borgbackup/./tests/b12 \-\-dry\-run
Unexpected indentation.
.INDENT 7.0
.INDENT 3.5
\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP \-\-dry\-run
.UNINDENT
.UNINDENT
.sp
# 3. Transfer (copy) archives from old repo into new repo (takes time and space!): # 3. Transfer (copy) archives from old repo into new repo (takes time and space!):
$ borg \-\-repo \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer $ borg \-\-repo ssh://borg2@borgbackup/./tests/b20 transfer \e
.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 96)" \-\-other\-repo ssh://borg2@borgbackup/./tests/b12
Unexpected indentation.
.INDENT 7.0
.INDENT 3.5
\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP
.UNINDENT
.UNINDENT
.sp
# 4. Check if we have everything (same as 2.): # 4. Check if we have everything (same as 2.):
$ borg \-\-repo \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer $ borg \-\-repo ssh://borg2@borgbackup/./tests/b20 transfer \e
.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 100)" \-\-other\-repo ssh://borg2@borgbackup/./tests/b12 \-\-dry\-run
Unexpected indentation. .ft P
.INDENT 7.0 .fi
.INDENT 3.5
\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP \-\-dry\-run
.UNINDENT
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.SH SEE ALSO .SH SEE ALSO

View File

@ -615,7 +615,6 @@ it should be a move (not a copy) operation, and in case of a directory
it should fail if the destination exists and is not an empty directory, it should fail if the destination exists and is not an empty directory,
since this is used for locking. since this is used for locking.
.IP \(bu 2 .IP \(bu 2
Hardlinks are needed for \fIborg_upgrade\fP (if \fB\-\-inplace\fP option is not used).
Also hardlinks are used for more safe and secure file updating (e.g. of the repo Also hardlinks are used for more safe and secure file updating (e.g. of the repo
config file), but the code tries to work also if hardlinks are not supported. config file), but the code tries to work also if hardlinks are not supported.
.UNINDENT .UNINDENT

View File

@ -3,6 +3,7 @@
Examples Examples
~~~~~~~~ ~~~~~~~~
:: ::
# 0. Have borg 2.0 installed on client AND server, have a b12 repo copy for testing. # 0. Have borg 2.0 installed on client AND server, have a b12 repo copy for testing.
# 1. Create a new "related" repository: # 1. Create a new "related" repository: