Antoine Beaupré
50e7d0f345
more human-readable output in usage generation
2015-09-30 17:42:18 -04:00
Antoine Beaupré
e3433f433c
generate usage include files only as needed
...
right now, the update_usage script regenerates the usage files at
every call
by moving this into the makefile, we make those files be generated
only when the source file change, which makes testing docs much faster
2015-09-30 17:30:56 -04:00
Thomas Waldmann
bc9679f0e5
development docs: update / fix / add Vagrant section
...
thanks to level323 for the vagrant docs
2015-09-30 17:38:51 +02:00
Thomas Waldmann
ba5fa0ba99
update / improve / reformat FAQ
...
- reduce redundancy (platforms are documented in README.rst)
- reformat to 80 chars width
- clarify checkpoints
- remove workarounds for stuff that was fixed
2015-09-30 17:13:22 +02:00
Thomas Waldmann
524ca297ea
document binary and non-binary requirements
2015-09-28 00:22:20 +02:00
Thomas Waldmann
86502d2729
docs: explain --read-special in more detail, fixes #220
2015-09-26 14:24:37 +02:00
Thomas Waldmann
22f335e0a0
docs: add how to build wheels and standalone binaries
2015-09-21 21:48:46 +02:00
Thomas Waldmann
7dbe2b80b3
docs: add a note about the single-file binaries
2015-09-21 21:28:18 +02:00
Thomas Waldmann
4410f1c3c3
docs: must run make html after tagging, so the html titel says correct version
2015-09-19 22:38:00 +02:00
Thomas Waldmann
688488d62d
docs: must run make html before release
2015-09-19 22:20:41 +02:00
Thomas Waldmann
0f68f1ccd1
add docs about release process
2015-09-19 21:35:02 +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
ff64b4c424
be more precise about OpenBSD/NetBSD support
...
xattrs/ACLs need platform specific code and new have none (yet) for them.
2015-09-16 11:53:53 +02:00
Thomas Waldmann
f138d06dd5
more platform support, works on py 3.5
...
xattrs and ACLs on OpenBSD and NetBSD need development or adaptation of
the platform-specific code.
2015-09-16 11:44:53 +02:00
Thomas Waldmann
cff7dffc95
detect lz4.h header file location
...
use similar code as for openssl headers
2015-09-12 19:38:38 +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
TW
947fc095d8
Merge pull request #183 from ThomasWaldmann/borg-repo-envvar
...
BORG_REPO env var support
2015-09-06 21:51:24 +02:00
Thomas Waldmann
b3f5231bac
BORG_REPO env var support
...
sets the default repository to use, e.g. like:
export BORG_REPO=/mnt/backup/repo
borg init
borg create ::archive
borg list
borg mount :: /mnt
fusermount -u /mnt
borg delete ::archive
2015-09-06 18:18:24 +02:00
Thomas Waldmann
0b1035746e
read special files as if they were regular files, update docs, closes #79
...
do not use the files cache for such special files
2015-09-06 00:29:46 +02:00
Thomas Waldmann
2332ee433e
remove docs/misc/create_compression.txt
...
outdated - it just showed different levels of zlib compression,
but not we additionally have "lzma", "lz4" and "none" compression.
the "usage" and "internals" docs give some hints about them, too.
2015-08-29 13:35:58 +02:00
Thomas Waldmann
d2e5ce90f2
add FAQ entry about OS X commandline vs. HFS+ encoding issue, see #143 .
...
a real fix for this is in development, but needs some time.
2015-08-29 05:41:41 +02:00
Thomas Waldmann
1a949eab3e
docs: internals: improve structure and formatting
2015-08-29 04:23:57 +02:00
Thomas Waldmann
ddd0e2700b
docs: improve faq and support section
2015-08-29 04:16:03 +02:00
Thomas Waldmann
c823554b6b
docs: usage: improved formatting, cosmetic changes
2015-08-29 04:00:22 +02:00
Thomas Waldmann
e4dc482598
docs: quickstart: key modes, cosmetic changes
2015-08-29 03:39:53 +02:00
Thomas Waldmann
8a483511cb
docs: theme: use a lighter green
2015-08-29 03:01:39 +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
Thomas Waldmann
fdc18eb0a0
support docs: write some words about BountySource
2015-08-21 00:25:24 +02:00
Thomas Waldmann
2402a2269e
update docs about fakeroot
2015-08-20 23:39:40 +02:00
Thomas Waldmann
1e11e24fc4
document locking system
2015-08-20 22:37:38 +02:00
Per Guth
0926c2821f
docs: installation: korora/fedora -> lz4-devel
2015-08-17 17:10:37 +02:00
Per Guth
8cf0ead693
docs: added favicon.ico
2015-08-17 12:58:49 +02:00
Per Guth
1c7b5b23f4
minor change in copyright notice
2015-08-17 11:31:42 +02:00
Thomas Waldmann
1d16e7a37c
compression: update / refine docs
2015-08-15 15:45:15 +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
8b1d46caa4
docs: more about compression
2015-08-10 20:36:21 +02:00
Thomas Waldmann
8af3aa3397
merged master
2015-08-09 23:51:46 +02:00
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
