index.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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:`quickstart` chapter 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. Getting help
  30. ============
  31. If you've found a bug or have a concrete feature request you can add your bug
  32. report or feature request directly to the project `issue tracker`_. For more
  33. general questions or discussions a post to the mailing list is preferred.
  34. Mailing list
  35. ------------
  36. There is a mailing list for Attic on librelist_ you can use for feature
  37. requests and general discussions about Attic. A mailing list archive is
  38. available `here <http://librelist.com/browser/attic/>`_.
  39. To subscribe to the list send an email to attic@librelist.com and reply
  40. to the confirmation mail. Likevise To unsubscribe send an email to
  41. attic-unsubscribe@librelist.com and reply to the confirmation mail.