borg-delete.1 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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 "2024-10-03" "" "borg backup tool"
  31. .SH NAME
  32. borg-delete \- Delete archives
  33. .SH SYNOPSIS
  34. .sp
  35. borg [common options] delete [options] [NAME]
  36. .SH DESCRIPTION
  37. .sp
  38. This command deletes archives from the repository.
  39. .sp
  40. Important: When deleting archives, repository disk space is \fBnot\fP freed until
  41. you run \fBborg compact\fP\&.
  42. .sp
  43. When in doubt, use \fB\-\-dry\-run \-\-list\fP to see what would be deleted.
  44. .sp
  45. You can delete multiple archives by specifying a matching pattern,
  46. using the \fB\-\-match\-archives PATTERN\fP option (for more info on these patterns,
  47. see \fIborg_patterns\fP).
  48. .SH OPTIONS
  49. .sp
  50. See \fIborg\-common(1)\fP for common options of Borg commands.
  51. .SS arguments
  52. .INDENT 0.0
  53. .TP
  54. .B NAME
  55. specify the archive name
  56. .UNINDENT
  57. .SS optional arguments
  58. .INDENT 0.0
  59. .TP
  60. .B \-n\fP,\fB \-\-dry\-run
  61. do not change repository
  62. .TP
  63. .B \-\-list
  64. output verbose list of archives
  65. .UNINDENT
  66. .SS Archive filters
  67. .INDENT 0.0
  68. .TP
  69. .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
  70. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
  71. .TP
  72. .BI \-\-sort\-by \ KEYS
  73. Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
  74. .TP
  75. .BI \-\-first \ N
  76. consider first N archives after other filters were applied
  77. .TP
  78. .BI \-\-last \ N
  79. consider last N archives after other filters were applied
  80. .TP
  81. .BI \-\-oldest \ TIMESPAN
  82. consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
  83. .TP
  84. .BI \-\-newest \ TIMESPAN
  85. consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g. 7d or 12m.
  86. .TP
  87. .BI \-\-older \ TIMESPAN
  88. consider archives older than (now \- TIMESPAN), e.g. 7d or 12m.
  89. .TP
  90. .BI \-\-newer \ TIMESPAN
  91. consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m.
  92. .UNINDENT
  93. .SH EXAMPLES
  94. .INDENT 0.0
  95. .INDENT 3.5
  96. .sp
  97. .nf
  98. .ft C
  99. # delete all backup archives named \(dqkenny\-files\(dq:
  100. $ borg delete \-a kenny\-files
  101. # actually free disk space:
  102. $ borg compact
  103. # delete a specific backup archive using its unique archive ID prefix
  104. $ borg delete aid:d34db33f
  105. # delete all archives whose names begin with the machine\(aqs hostname followed by \(dq\-\(dq
  106. $ borg delete \-a \(aqsh:{hostname}\-*\(aq
  107. # delete all archives whose names contain \(dq\-2012\-\(dq
  108. $ borg delete \-a \(aqsh:*\-2012\-*\(aq
  109. # see what would be deleted if delete was run without \-\-dry\-run
  110. $ borg delete \-\-list \-\-dry\-run \-a \(aqsh:*\-May\-*\(aq
  111. .ft P
  112. .fi
  113. .UNINDENT
  114. .UNINDENT
  115. .SH SEE ALSO
  116. .sp
  117. \fIborg\-common(1)\fP, \fIborg\-compact(1)\fP, \fIborg\-repo\-delete(1)\fP
  118. .SH AUTHOR
  119. The Borg Collective
  120. .\" Generated by docutils manpage writer.
  121. .