瀏覽代碼

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

Thomas Waldmann 2 年之前
父節點
當前提交
0a7baa53c4
共有 3 個文件被更改,包括 19 次插入38 次删除
  1. 18 37
      docs/man/borg-transfer.1
  2. 0 1
      docs/man/borg.1
  3. 1 0
      docs/usage/transfer.rst

+ 18 - 37
docs/man/borg-transfer.1

@@ -93,10 +93,12 @@ consider last N archives after other filters were applied
 .UNINDENT
 .SH EXAMPLES
 .INDENT 0.0
-.TP
-.B ::
-# 0. Have borg 2.0 installed on client AND server, have a b12 repo copy for testing.
+.INDENT 3.5
 .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:
 # 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.
@@ -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
 # 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".
-$ borg \-\-repo       \fI\%ssh://borg2@borgbackup/./tests/b20\fP rcreate 
-.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 88)"
-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
+$ borg \-\-repo       ssh://borg2@borgbackup/./tests/b20 rcreate \e
+       \-\-other\-repo ssh://borg2@borgbackup/./tests/b12 \-e repokey\-blake2\-aes\-ocb
+
 # 2. Check what and how much it would transfer:
-$ borg \-\-repo       \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer 
-.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 92)"
-Unexpected indentation.
-.INDENT 7.0
-.INDENT 3.5
-\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP \-\-dry\-run
-.UNINDENT
-.UNINDENT
-.sp
+$ borg \-\-repo       ssh://borg2@borgbackup/./tests/b20 transfer \e
+       \-\-other\-repo ssh://borg2@borgbackup/./tests/b12 \-\-dry\-run
+
 # 3. Transfer (copy) archives from old repo into new repo (takes time and space!):
-$ borg \-\-repo       \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer 
-.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 96)"
-Unexpected indentation.
-.INDENT 7.0
-.INDENT 3.5
-\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP
-.UNINDENT
-.UNINDENT
-.sp
+$ borg \-\-repo       ssh://borg2@borgbackup/./tests/b20 transfer \e
+       \-\-other\-repo ssh://borg2@borgbackup/./tests/b12
+
 # 4. Check if we have everything (same as 2.):
-$ borg \-\-repo       \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer 
-.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 100)"
-Unexpected indentation.
-.INDENT 7.0
-.INDENT 3.5
-\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP \-\-dry\-run
-.UNINDENT
+$ borg \-\-repo       ssh://borg2@borgbackup/./tests/b20 transfer \e
+       \-\-other\-repo ssh://borg2@borgbackup/./tests/b12 \-\-dry\-run
+.ft P
+.fi
 .UNINDENT
 .UNINDENT
 .SH SEE ALSO

+ 0 - 1
docs/man/borg.1

@@ -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,
 since this is used for locking.
 .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
 config file), but the code tries to work also if hardlinks are not supported.
 .UNINDENT

+ 1 - 0
docs/usage/transfer.rst

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