man_intro.rst 1.6 KB

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