index.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .. include:: global.rst.inc
  2. Welcome to Attic
  3. ================
  4. |project_name| is a deduplicating backup program written in Python.
  5. The main goal of |project_name| is to provide an efficient and secure way
  6. to backup data. The data deduplication technique used makes |project_name|
  7. suitable for daily backups since only actual changes are stored.
  8. Easy to use
  9. -----------
  10. Initialize a new backup :ref:`repository <repository_def>` and create your
  11. first backup :ref:`archive <archive_def>` in two lines::
  12. $ attic init /usbdrive/my-backup.attic
  13. $ attic create -v /usbdrive/my-backup.attic::documents ~/Documents
  14. See the :ref:`generalusage` section for a more detailed example.
  15. Easy installation
  16. -----------------
  17. You can use pip to install |project_name| quickly and easily::
  18. $ pip install attic
  19. Need more help with installing? See :ref:`installation`.
  20. User's Guide
  21. ============
  22. .. toctree::
  23. :maxdepth: 2
  24. foreword
  25. installation
  26. quickstart
  27. usage
  28. faq
  29. Contribute
  30. ==========
  31. Found a bug? Have any ideas to improve |project_name|? Add bug reports and
  32. feature requests to the `issue tracker`_.
  33. You can also ask the author a question directly by
  34. `email <mailto:jonas@borgstrom.se>`_.