man_intro.rst 1.9 KB

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