Thomas Waldmann
822379048f
added some sidebar links
2015-08-09 22:32:14 +02:00
Thomas Waldmann
4c668a85b6
update docs copyright (to be same as project copyright)
2015-08-09 14:16:56 +02:00
Thomas Waldmann
dcdcbda87d
try if readthedocs finds the borg package this way
2015-08-06 15:17:07 +02:00
Thomas Waldmann
e3baeefa1b
docs: reorganize sidebar, prev/next at top
2015-08-06 13:10:56 +02:00
Thomas Waldmann
d65ca51d54
deduplicate and refactor the docs
...
README.rst (shown on github and also at the start of the html docs) shall
be like an elevator speech - convince readers in a very short time.
this is most important, everything else can come after we got the reader's interest.
include README into docs to avoid duplication.
also include CHANGES into docs.
add developer docs, move examples from tox.ini there
add separate support docs
remove glossary, most of what was there can be understood by an admin from context
move attic and compatibility note to the end
2015-08-06 12:59:51 +02:00
Thomas Waldmann
27de1b0a43
add a wrapper around liblz4
2015-08-01 15:07:54 +02:00
Thomas Waldmann
9d21e4ad69
docs: add some words about resource usage (fixed wording)
2015-07-29 21:48:57 +02:00
Thomas Waldmann
1e097bfd6b
docs: add some words about resource usage
2015-07-29 21:39:20 +02:00
Thomas Waldmann
729cc4d82d
document how to backup raw disk
2015-07-27 22:27:13 +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 Waldmann
59c519b3bb
remove outdated locking problem warning
2015-07-25 15:37:30 +02:00
Thomas Waldmann
2907dd0094
add BountySource link
2015-07-17 22:55:28 +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
9b9c808713
fixed some minor issues found by pycharm/pytest-flakes
2015-07-15 11:30:25 +02:00
Thomas Waldmann
50c0bb0c32
Merge branch 'master' into keyfile-in-repo
2015-07-15 00:05:18 +02:00
Thomas Waldmann
b644565546
repo key mode (and deprecate passphrase mode), fixes #85
...
see usage.rst change for a description and why this is needed
2015-07-15 00:01:07 +02: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
Thomas Waldmann
3c34ef8145
clarify that borg extract uses the cwd as extraction target
2015-07-14 20:25:10 +02:00
Thomas Waldmann
b5bdb52b6a
update internals doc about chunker params, memory usage and compression
2015-07-14 00:43:35 +02:00
Thomas Waldmann
b2f460d591
fix filenames used for locking, update docs about locking
2015-07-13 23:20:46 +02:00
Thomas Waldmann
afae720112
document environment variables
2015-07-11 20:08:22 +02:00
Thomas Waldmann
d1bb892c3d
fix placement of return codes docs
2015-07-11 19:45:37 +02:00
Thomas Waldmann
05b21e3c0d
document return codes
2015-07-11 19:27:00 +02:00
Jan Bader
8de8073345
Improve wording
2015-07-02 23:23:45 +02:00
Jan Bader
028e12473d
Update internals to reflect new --compression argument
2015-07-02 23:21:28 +02:00
Thomas Waldmann
77577b7417
add related projects, fix web site url
2015-06-29 23:30:36 +02:00
Thomas Waldmann
9ead4097cf
we are now on #borgbackup on chat.freenode.net
...
it seems like there is currently no bureaucracy required, freenode web site says group registration is suspended.
i also asked on the freenode channel, they said just make sure you are right here and use it. so we do that now.
2015-06-29 23:07:07 +02:00
Thomas Waldmann
6964799d13
borg create --compression 0..9 for variable compression
2015-06-25 22:16:23 +02:00
Thomas Waldmann
41a37e77db
add a misc docs directory, add a usecase for --chunker-params
2015-06-21 02:11:02 +02:00
Thomas Waldmann
54e8dd8419
misc chunker parameter changes
...
- use power-of-2 sizes / n bit hash mask so one can give them more easily
- chunker api: give seed first, so we can give *chunker_params after it
- fix some tests that aren't possible with 2^N
- make sparse file extraction zero detection flexible for variable chunk max size
2015-06-21 01:46:41 +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
21cfdde73b
adjust docs theme colours for note divs
2015-06-11 22:26:02 +02:00
Thomas Waldmann
dd78e1a56e
improve docs, usage help, changelog
2015-06-11 22:18:12 +02:00
Thomas Waldmann
83f520cfbe
improve internals docs
2015-06-07 02:15:13 +02:00
Thomas Waldmann
8d0c5316f8
remove gh-pages Makefile target (not used)
2015-05-23 00:40:30 +02:00
Thomas Waldmann
cd3a76909d
faq: markup fixes, typos
2015-05-23 00:15:58 +02:00
Thomas Waldmann
f6442fe7f0
automate updating the borgbackup.github.io repo/website
...
cd docs ; make gh-io
2015-05-23 00:12:17 +02:00
Thomas Waldmann
9d1560f830
faq: updates, fixes
2015-05-22 23:56:29 +02:00
TW
da8a600b44
Merge pull request #25 from anarcat/fork-faq
...
explain the reason behind the fork
2015-05-22 23:05:08 +02:00
Antoine Beaupré
1edd5daef9
try to clarify link
2015-05-22 16:09:46 -04:00
Antoine Beaupré
ef373b120f
uppercase borg
2015-05-22 16:09:38 -04: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
5e98400a5a
fix all references to package name
...
use relative imports if possible
reorder imports (1. stdlib 2. dependencies 3. borg 4. borg.testsuite)
2015-05-22 19:21:41 +02:00
Antoine Beaupré
622e05bcee
add more information about the objectives of borg
2015-05-21 21:55:29 -04:00
Antoine Beaupré
22acb80bf9
explain the reason behind the fork
2015-05-21 21:49:44 -04:00
Thomas Waldmann
afc2dab71e
docs: more borg (or project_name)
2015-05-15 19:22:52 +02:00
