borg-compact.1 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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-COMPACT" 1 "2024-10-03" "" "borg backup tool"
  31. .SH NAME
  32. borg-compact \- Collect garbage in repository
  33. .SH SYNOPSIS
  34. .sp
  35. borg [common options] compact [options]
  36. .SH DESCRIPTION
  37. .sp
  38. Free repository space by deleting unused chunks.
  39. .sp
  40. borg compact analyzes all existing archives to find out which chunks are
  41. actually used. There might be unused chunks resulting from borg delete or prune,
  42. which can be removed to free space in the repository.
  43. .sp
  44. Differently than borg 1.x, borg2\(aqs compact needs the borg key if the repo is
  45. encrypted.
  46. .SH OPTIONS
  47. .sp
  48. See \fIborg\-common(1)\fP for common options of Borg commands.
  49. .SH EXAMPLES
  50. .INDENT 0.0
  51. .INDENT 3.5
  52. .sp
  53. .nf
  54. .ft C
  55. # compact segments and free repo disk space
  56. $ borg compact
  57. .ft P
  58. .fi
  59. .UNINDENT
  60. .UNINDENT
  61. .SH SEE ALSO
  62. .sp
  63. \fIborg\-common(1)\fP
  64. .SH AUTHOR
  65. The Borg Collective
  66. .\" Generated by docutils manpage writer.
  67. .