man_intro.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. :orphan:
  2. SYNOPSIS
  3. --------
  4. borg [common options] <command> [options] [arguments]
  5. DESCRIPTION
  6. -----------
  7. .. we don't include the README.rst here since we want to keep this terse.
  8. BorgBackup (short: Borg) is a deduplicating backup program.
  9. Optionally, it supports compression and authenticated encryption.
  10. The main goal of Borg is to provide an efficient and secure way to back data up.
  11. The data deduplication technique used makes Borg suitable for daily backups
  12. since only changes are stored.
  13. The authenticated encryption technique makes it suitable for backups to targets not
  14. fully trusted.
  15. Borg stores a set of files in an *archive*. A *repository* is a collection
  16. of *archives*. The format of repositories is Borg-specific. Borg does not
  17. distinguish archives from each other in any way other than their name,
  18. it does not matter when or where archives were created (e.g. different hosts).
  19. EXAMPLES
  20. --------
  21. A step-by-step example
  22. ~~~~~~~~~~~~~~~~~~~~~~
  23. .. include:: quickstart_example.rst.inc
  24. NOTES
  25. -----
  26. .. include:: usage_general.rst.inc
  27. SEE ALSO
  28. --------
  29. `borg-common(1)` for common command line options
  30. `borg-repo-create(1)`, `borg-repo-delete(1)`, `borg-repo-list(1)`, `borg-repo-info(1)`,
  31. `borg-create(1)`, `borg-mount(1)`, `borg-extract(1)`,
  32. `borg-list(1)`, `borg-info(1)`,
  33. `borg-delete(1)`, `borg-prune(1)`, `borg-compact(1)`,
  34. `borg-recreate(1)`
  35. `borg-compression(1)`, `borg-patterns(1)`, `borg-placeholders(1)`
  36. * Main web site https://www.borgbackup.org/
  37. * Releases https://github.com/borgbackup/borg/releases
  38. * Changelog https://github.com/borgbackup/borg/blob/master/docs/changes.rst
  39. * GitHub https://github.com/borgbackup/borg
  40. * Security contact https://borgbackup.readthedocs.io/en/latest/support.html#security-contact