Commit Graph

42 Commits

Author SHA1 Message Date
Jakob Schnitzer da926f2eb4 docs: fix code blocks in installation.rst
In one case removed the |project_name| and |git_url| variables to fix
the display of the code block. Shouldn't be problematic, as they are not
used consistently in this document anyway.

Put two notes in their own nice '.. note::' blocks.
2015-10-13 17:25:52 +02:00
Thomas Waldmann 04ac82d3e2 do binary releases via "github releases", closes #214 2015-10-07 15:41:17 +02:00
Thomas Waldmann 30bd38b51b update linux glibc requirement (binaries built on debian7 now) 2015-10-07 15:08:09 +02:00
Thomas Waldmann ee66c4c435 remove docs about binary wheels
we stop supporting them, because there are better alternatives:
- use a distribution package (from your linux distribution), if available
- use a pyinstaller binary provided by us (they include all you need in 1 file and
  thus have better compatibility properties and are easier to install than a wheel)
- install from source (pypi or git) if everything else fails
2015-10-06 21:49:21 +02:00
Thomas Waldmann 524ca297ea document binary and non-binary requirements 2015-09-28 00:22:20 +02:00
Thomas Waldmann 7dbe2b80b3 docs: add a note about the single-file binaries 2015-09-21 21:28:18 +02:00
Thomas Waldmann fb8d1cc602 also mention libattr
ACLs are implemented as xattrs, so libattr is pulled in as a dependency of libacl.
2015-09-19 20:31:26 +02:00
Thomas Waldmann d74da7c031 llfuse 0.41 install troubles on some platforms, require < 0.41
UnicodeDecodeError exception due to non-ascii llfuse setup.py
2015-09-12 19:26:46 +02:00
Thomas Waldmann e8f4fe0b88 pkg-config is needed for llfuse installation 2015-09-12 19:19:52 +02:00
Thomas Waldmann e4dc482598 docs: quickstart: key modes, cosmetic changes 2015-08-29 03:39:53 +02:00
Thomas Waldmann cebb61d8dd docs: add pypi, wheel, dist package based install docs 2015-08-29 02:55:09 +02:00
Thomas Waldmann 79d7f49a44 docs: split install into system-specific preparations and generic instructions 2015-08-29 01:17:19 +02:00
Thomas Waldmann ee58d4f074 docs: be more specific about Debian/Ubuntu release 2015-08-29 00:45:54 +02:00
Per Guth 0926c2821f docs: installation: korora/fedora -> `lz4-devel` 2015-08-17 17:10:37 +02:00
Thomas Waldmann bf757738f7 Merge branch 'master' into compression 2015-08-14 23:24:04 +02:00
Thomas Waldmann feff0f0c94 install docs: replace hack for llfuse with proper solution
found out why it could not install llfuse into virtual env: it always complained about
not being able to find fuse.pc - which is part of libfuse-dev / fuse-devel and was missing.

once one adds the fuse dev stuff, llfuse installs to virtual env without problems.
2015-08-12 03:15:44 +02:00
Thomas Waldmann 27de1b0a43 add a wrapper around liblz4 2015-08-01 15:07:54 +02:00
Thomas Waldmann fb998cbd66 docs: add note about how to run borg from virtual env 2015-07-26 14:47:18 +02:00
Thomas Waldmann 859c33d42b docs: add solutions for (ll)fuse installation problems 2015-07-25 19:07:24 +02:00
Thomas Waldmann 12a50bc6fe tested and updated cygwin docs, thanks to fvia 2015-07-25 18:38:16 +02:00
Thomas Harold e3472a248a Fix format issue in installation.rst for Cygwin
Fixed formatting issue in installation.rst where packages were listed all on one line.
2015-07-16 16:40:33 -04:00
Thomas Waldmann f330b4bd2a some doc updates, see below
faq about redundancy / integrity
compression is optional
having borg installed on backup server is optional (but faster)
cygwin installation tipps
do not document passphrase encryption mode example, use keyfile mode
2015-07-14 21:31:35 +02:00
Per Guth e168b41406 Update installation.rst 2015-06-15 14:40:11 +02:00
Per Guth 041357e48a Update installation.rst
Replicated Ubuntus dependency list.
2015-06-15 14:39:04 +02:00
Per Guth 1dc00e7937 Update installation.rst
please test on fresh installation.
2015-06-15 13:09:39 +02:00
Thomas Waldmann dd78e1a56e improve docs, usage help, changelog 2015-06-11 22:18:12 +02:00
Thomas Waldmann 906ea629f6 use py.test for testing, document it
locally (via tox) and also on travis ci.
2015-05-22 21:26:41 +02:00
Thomas Waldmann f30d05fcd4 docs: install docs, faq improvements, other minor changes 2015-05-14 20:47:08 +02:00
Thomas Waldmann cb5c9b63b3 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-13 15:02:33 +02:00
Thomas Waldmann f9d90482c4 merged master 2015-05-10 16:36:10 +02:00
Jonas Borgström c79b5357f8 Improve installatoin instructions.
Specifically refer to pip3 instead of pip to avoid potential
confusion.

Also mention virtualenv
2015-04-27 22:35:06 +02:00
Antoine Beaupré ac87360c7c document better different dependencies
this is written with recent Ubuntu and Debian in mind, but should be
working everywhere. the idea here is to make sure anyone can install
this without knowning too much about ACLs or anything similar.

closes #135
2014-12-15 22:07:05 -05:00
Jonas Borgström 7ce3290fb2 docs: Added link to prebuilt Linux binaries. 2014-06-29 14:24:45 +02:00
Jonas Borgström c20aba8c4c docs: Add link to Slackware packages 2014-03-12 21:00:30 +01:00
Dan Christensen 0b9969d162 Various minor documentation updates: mention sshfs, Linux packages,
minor changes to prose, etc.
2014-02-03 21:26:36 -05:00
Jonas Borgström 9c80089c04 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 12:51:56 +01:00
Jonas Borgström b6c8392c03 More documentation work 2013-08-03 13:05:06 +02:00
Jonas Borgström 43a4bf6829 Updated documentation 2013-07-30 13:54:04 +02:00
Jonas Borgström b718a443a8 Project rename 2013-07-09 20:14:18 +02:00
Jonas Borgström a9272ce913 Update documentation 2013-07-08 21:19:50 +02:00
Jonas Borgström 6052a1ed74 Minor docs tweaks 2013-07-03 22:38:07 +02:00
Jonas Borgström 445b862d8c Added more installation documentation. 2013-06-30 21:30:17 +02:00