borg-analyze.1 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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-ANALYZE" "1" "2025-12-23" "" "borg backup tool"
  31. .SH NAME
  32. borg-analyze \- Analyzes archives.
  33. .SH SYNOPSIS
  34. .sp
  35. borg [common options] analyze [options]
  36. .SH DESCRIPTION
  37. .sp
  38. Analyze archives to find \(dqhot spots\(dq.
  39. .sp
  40. \fBborg analyze\fP relies on the usual archive matching options to select the
  41. archives that should be considered for analysis (e.g. \fB\-a series_name\fP).
  42. Then it iterates over all matching archives, over all contained files, and
  43. collects information about chunks stored in all directories it encounters.
  44. .sp
  45. It considers chunk IDs and their plaintext sizes (we do not have the compressed
  46. size in the repository easily available) and adds up the sizes of added and removed
  47. chunks per direct parent directory, and outputs a list of \(dqdirectory: size\(dq.
  48. .sp
  49. You can use that list to find directories with a lot of \(dqactivity\(dq — maybe
  50. some of these are temporary or cache directories you forgot to exclude.
  51. .sp
  52. To avoid including these unwanted directories in your backups, you can carefully
  53. exclude them in \fBborg create\fP (for future backups) or use \fBborg recreate\fP
  54. to recreate existing archives without them.
  55. .SH OPTIONS
  56. .sp
  57. See \fIborg\-common(1)\fP for common options of Borg commands.
  58. .SS Archive filters
  59. .INDENT 0.0
  60. .TP
  61. .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
  62. only consider archives matching all patterns. See \(dqborg help match\-archives\(dq.
  63. .TP
  64. .BI \-\-sort\-by \ KEYS
  65. Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
  66. .TP
  67. .BI \-\-first \ N
  68. consider the first N archives after other filters are applied
  69. .TP
  70. .BI \-\-last \ N
  71. consider the last N archives after other filters are applied
  72. .TP
  73. .BI \-\-oldest \ TIMESPAN
  74. consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g., 7d or 12m.
  75. .TP
  76. .BI \-\-newest \ TIMESPAN
  77. consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g., 7d or 12m.
  78. .TP
  79. .BI \-\-older \ TIMESPAN
  80. consider archives older than (now \- TIMESPAN), e.g., 7d or 12m.
  81. .TP
  82. .BI \-\-newer \ TIMESPAN
  83. consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
  84. .UNINDENT
  85. .SH SEE ALSO
  86. .sp
  87. \fIborg\-common(1)\fP
  88. .SH AUTHOR
  89. The Borg Collective
  90. .\" Generated by docutils manpage writer.
  91. .