borg-delete.1 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. .\" Man page generated from reStructuredText.
  2. .
  3. .
  4. .nr rst2man-indent-level 0
  5. .
  6. .de1 rstReportMargin
  7. \\$1 \\n[an-margin]
  8. level \\n[rst2man-indent-level]
  9. level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  10. -
  11. \\n[rst2man-indent0]
  12. \\n[rst2man-indent1]
  13. \\n[rst2man-indent2]
  14. ..
  15. .de1 INDENT
  16. .\" .rstReportMargin pre:
  17. . RS \\$1
  18. . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  19. . nr rst2man-indent-level +1
  20. .\" .rstReportMargin post:
  21. ..
  22. .de UNINDENT
  23. . RE
  24. .\" indent \\n[an-margin]
  25. .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  26. .nr rst2man-indent-level -1
  27. .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28. .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  29. ..
  30. .TH "BORG-DELETE" 1 "2022-06-04" "" "borg backup tool"
  31. .SH NAME
  32. borg-delete \- Delete an existing repository or archives
  33. .SH SYNOPSIS
  34. .sp
  35. borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
  36. .SH DESCRIPTION
  37. .sp
  38. This command deletes an archive from the repository or the complete repository.
  39. Disk space is reclaimed accordingly. If you delete the complete repository, the
  40. local cache for it (if any) is also deleted.
  41. .sp
  42. When using \fB\-\-stats\fP, you will get some statistics about how much data was
  43. deleted \- the "Deleted data" deduplicated size there is most interesting as
  44. that is how much your repository will shrink.
  45. Please note that the "All archives" stats refer to the state after deletion.
  46. .SH OPTIONS
  47. .sp
  48. See \fIborg\-common(1)\fP for common options of Borg commands.
  49. .SS arguments
  50. .INDENT 0.0
  51. .TP
  52. .B REPOSITORY_OR_ARCHIVE
  53. repository or archive to delete
  54. .TP
  55. .B ARCHIVE
  56. archives to delete
  57. .UNINDENT
  58. .SS optional arguments
  59. .INDENT 0.0
  60. .TP
  61. .B \-n\fP,\fB \-\-dry\-run
  62. do not change repository
  63. .TP
  64. .B \-s\fP,\fB \-\-stats
  65. print statistics for the deleted archive
  66. .TP
  67. .B \-\-cache\-only
  68. delete only the local cache for the given repository
  69. .TP
  70. .B \-\-force
  71. force deletion of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work.
  72. .TP
  73. .B \-\-save\-space
  74. work slower, but using less space
  75. .UNINDENT
  76. .SS Archive filters
  77. .INDENT 0.0
  78. .TP
  79. .BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX
  80. only consider archive names starting with this prefix.
  81. .TP
  82. .BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB
  83. only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
  84. .TP
  85. .BI \-\-sort\-by \ KEYS
  86. Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
  87. .TP
  88. .BI \-\-first \ N
  89. consider first N archives after other filters were applied
  90. .TP
  91. .BI \-\-last \ N
  92. consider last N archives after other filters were applied
  93. .UNINDENT
  94. .SH EXAMPLES
  95. .INDENT 0.0
  96. .INDENT 3.5
  97. .sp
  98. .nf
  99. .ft C
  100. # delete a single backup archive:
  101. $ borg delete /path/to/repo::Monday
  102. # delete the whole repository and the related local cache:
  103. $ borg delete /path/to/repo
  104. You requested to completely DELETE the repository *including* all archives it contains:
  105. repo Mon, 2016\-02\-15 19:26:54
  106. root\-2016\-02\-15 Mon, 2016\-02\-15 19:36:29
  107. newname Mon, 2016\-02\-15 19:50:19
  108. Type \(aqYES\(aq if you understand this and want to continue: YES
  109. .ft P
  110. .fi
  111. .UNINDENT
  112. .UNINDENT
  113. .SH SEE ALSO
  114. .sp
  115. \fIborg\-common(1)\fP
  116. .SH AUTHOR
  117. The Borg Collective
  118. .\" Generated by docutils manpage writer.
  119. .