borg/docs/global.rst.inc

.. highlight:: bash
.. |project_name| replace:: Borg
.. |package_dirname| replace:: borgbackup-|version|
.. |package_filename| replace:: |package_dirname|.tar.gz
.. |package_url| replace:: https://pypi.python.org/packages/source/b/borgbackup/|package_filename|
.. |git_url| replace:: https://github.com/borgbackup/borg.git
.. _github: https://github.com/borgbackup/borg
.. _issue tracker: https://github.com/borgbackup/borg/issues
.. _deduplication: https://en.wikipedia.org/wiki/Data_deduplication
.. _AES: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
.. _HMAC-SHA256: https://en.wikipedia.org/wiki/HMAC
.. _SHA256: https://en.wikipedia.org/wiki/SHA-256
.. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2
.. _ACL: https://en.wikipedia.org/wiki/Access_control_list
.. _libacl: https://savannah.nongnu.org/projects/acl/
.. _libattr: https://savannah.nongnu.org/projects/attr/
.. _liblz4: https://github.com/Cyan4973/lz4
.. _libzstd: https://github.com/facebook/zstd
.. _libb2: https://github.com/BLAKE2/libb2
.. _OpenSSL: https://www.openssl.org/
.. _`Python 3`: https://www.python.org/
.. _Buzhash: https://en.wikipedia.org/wiki/Buzhash
.. _msgpack: https://msgpack.org/
.. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
.. _llfuse: https://pypi.python.org/pypi/llfuse/
.. _homebrew: http://brew.sh/
.. _userspace filesystems: https://en.wikipedia.org/wiki/Filesystem_in_Userspace
.. _Cython: http://cython.org/
.. _virtualenv: https://pypi.python.org/pypi/virtualenv/
.. _mailing list discussion about internals: http://librelist.com/browser/attic/2014/5/6/questions-and-suggestions-about-inner-working-of-attic>
More documentation work 2013-07-31 18:51:01 +00:00			`.. highlight:: bash`
docs: replace "\|project_name\|" with just "Borg", less ugly 2016-01-12 23:25:43 +00:00			`.. \|project_name\| replace:: Borg`
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS use borg instead attic except at the places where it was used: - as toplevel package name, directory name, file name - to refer to original attic remove sphinx upload make command, will be replaced by github.io site later remove references to binary downloads and linux packages for now remove some software name references, fix grammar use borgbackup rather than borg-backup (or borg) in URLs, less name collision issues, better search results, no validity issues with "-" 2015-05-09 16:40:55 +00:00			`.. \|package_dirname\| replace:: borgbackup-\|version\|`
Update documentation 2013-07-08 19:19:50 +00:00			`.. \|package_filename\| replace:: \|package_dirname\|.tar.gz`
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS use borg instead attic except at the places where it was used: - as toplevel package name, directory name, file name - to refer to original attic remove sphinx upload make command, will be replaced by github.io site later remove references to binary downloads and linux packages for now remove some software name references, fix grammar use borgbackup rather than borg-backup (or borg) in URLs, less name collision issues, better search results, no validity issues with "-" 2015-05-09 16:40:55 +00:00			`.. \|package_url\| replace:: https://pypi.python.org/packages/source/b/borgbackup/\|package_filename\|`
			`.. \|git_url\| replace:: https://github.com/borgbackup/borg.git`
			`.. _github: https://github.com/borgbackup/borg`
			`.. _issue tracker: https://github.com/borgbackup/borg/issues`
Docs improvements 2013-06-29 21:56:44 +00:00			`.. _deduplication: https://en.wikipedia.org/wiki/Data_deduplication`
			`.. _AES: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard`
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 21:31:08 +00:00			`.. _HMAC-SHA256: https://en.wikipedia.org/wiki/HMAC`
fix formatting issues 2014-12-16 15:59:02 +00:00			`.. _SHA256: https://en.wikipedia.org/wiki/SHA-256`
Docs improvements 2013-06-29 21:56:44 +00:00			`.. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2`
			`.. _ACL: https://en.wikipedia.org/wiki/Access_control_list`
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 21:31:08 +00:00			`.. _libacl: https://savannah.nongnu.org/projects/acl/`
			`.. _libattr: https://savannah.nongnu.org/projects/attr/`
add a wrapper around liblz4 2015-08-01 13:07:54 +00:00			`.. _liblz4: https://github.com/Cyan4973/lz4`
update requirements and install docs about bundled lz4 and zstd (cherry picked from commit 061321b668a8099bfafce7e86773969e2939b7f0) 2017-12-18 04:44:36 +00:00			`.. _libzstd: https://github.com/facebook/zstd`
crypto: link against system libb2, if possible 2016-11-10 21:14:09 +00:00			`.. _libb2: https://github.com/BLAKE2/libb2`
Added more installation documentation. 2013-06-30 19:30:17 +00:00			`.. _OpenSSL: https://www.openssl.org/`
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 21:31:08 +00:00			.. _`Python 3`: https://www.python.org/
document more internals, based on mailing list discussion this should address #27, #28 and #29 at least at a basic level it is mostly based on the mailing list discussion mentionned in #27, with some reformatting and merging of different posts. 2014-12-16 15:04:35 +00:00			`.. _Buzhash: https://en.wikipedia.org/wiki/Buzhash`
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 21:31:08 +00:00			`.. _msgpack: https://msgpack.org/`
Added more installation documentation. 2013-06-30 19:30:17 +00:00			.. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
Various minor documentation updates: mention sshfs, Linux packages, minor changes to prose, etc. 2014-02-04 02:26:36 +00:00			`.. _llfuse: https://pypi.python.org/pypi/llfuse/`
docs: restructure installation.rst, add OSX instructions Moved the list of dependencies to the corresponding subsection. Collected all preparation steps under one heading. Added link to the Arch Linux AUR package. Install docs for OS X. 2015-10-16 08:59:38 +00:00			`.. _homebrew: http://brew.sh/`
Documentation: Added info about mailing list 2013-08-06 19:35:43 +00:00			`.. _userspace filesystems: https://en.wikipedia.org/wiki/Filesystem_in_Userspace`
Documentation update. Added links to Debian, Ubuntu and Arch linux packages and added a comment about Cython dependency when installing from git. Closes #21. 2014-01-26 11:51:56 +00:00			`.. _Cython: http://cython.org/`
Improve installatoin instructions. Specifically refer to pip3 instead of pip to avoid potential confusion. Also mention virtualenv 2015-04-27 20:35:06 +00:00			`.. _virtualenv: https://pypi.python.org/pypi/virtualenv/`
PR #155 - Merge branch 'doc-encryption' of https://github.com/anarcat/attic into merge 2015-03-06 20:44:47 +00:00			`.. _mailing list discussion about internals: http://librelist.com/browser/attic/2014/5/6/questions-and-suggestions-about-inner-working-of-attic>`