index.rst 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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 the 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 /somewhere/my-repository.attic
  13. $ attic create /somewhere/my-repository.attic::Monday ~/Documents
  14. $ attic create --stats /somewhere/my-repository.attic::Tuesday ~/Documents
  15. Archive name: Tuesday
  16. Archive fingerprint: 387a5e3f9b0e792e91ce87134b0f4bfe17677d9248cb5337f3fbf3a8e157942a
  17. Start time: Tue Mar 25 12:00:10 2014
  18. End time: Tue Mar 25 12:00:10 2014
  19. Duration: 0.08 seconds
  20. Number of files: 358
  21. Original size Compressed size Deduplicated size
  22. This archive: 57.16 MB 46.78 MB 151.67 kB
  23. All archives: 114.02 MB 93.46 MB 44.81 MB
  24. See the :ref:`quickstart` chapter for a more detailed example.
  25. Easy installation
  26. -----------------
  27. You can use pip to install |project_name| quickly and easily::
  28. $ pip install attic
  29. |project_name| is also part of the Debian_, Ubuntu_, `Arch Linux`_ and Slackware_
  30. distributions of GNU/Linux.
  31. Need more help with installing? See :ref:`installation`.
  32. User's Guide
  33. ============
  34. .. toctree::
  35. :maxdepth: 2
  36. foreword
  37. installation
  38. quickstart
  39. usage
  40. faq
  41. internals
  42. Getting help
  43. ============
  44. If you've found a bug or have a concrete feature request, you can add your bug
  45. report or feature request directly to the project's `issue tracker`_. For more
  46. general questions or discussions, a post to the mailing list is preferred.
  47. Mailing list
  48. ------------
  49. There is a mailing list for Attic on librelist_ that you can use for feature
  50. requests and general discussions about Attic. A mailing list archive is
  51. available `here <http://librelist.com/browser/attic/>`_.
  52. To subscribe to the list, send an email to attic@librelist.com and reply
  53. to the confirmation mail. Likewise, to unsubscribe, send an email to
  54. attic-unsubscribe@librelist.com and reply to the confirmation mail.