mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
1,377 Commits 9 Branches 138 Tags 59 MiB
Commit Graph

50 Commits

Author SHA1 Message Date
Thomas Waldmann 908e944bdd include the help offered by borg help <topic> in the usage docs, fixes #293 
it's not pretty yet, but better than nothing.
 2015-10-17 21:53:09 +02:00
Antoine Beaupré e6c2359a60 add missing rename usage to docs, closes #279 2015-10-17 12:13:59 -04:00
Thomas Waldmann e7f25d7821 docs: use zlib,6 compression in some examples, fixes #275 
This is what attic used by default, but borgbackup defaults to "no compression".

I just adjusted the command invocation, so we can keep the example output
(which shows that stuff was compressed).

Also: add FAQ item about compression.
 2015-10-16 01:18:37 +02:00
Jakob Schnitzer fb62435fc6 docs: remove 'Additional Notes' from TOC, fix markup 
What's covered in the 'Additional Notes' section of the documentation
hardly seems important enough to deserve its own entry in the sidebar.
 2015-10-13 16:50:27 +02:00
Jakob Schnitzer b42bbc6f68 docs: fix code blocks 2015-10-13 16:31:25 +02:00
Antoine Beaupré 7ba4d47f6e clarify the class name part 2015-10-08 15:31:46 -04:00
Antoine Beaupré 2f803b6489 fix typo, split sentence 2015-10-08 15:31:46 -04:00
Antoine Beaupré 6f9e04bc21 generalise the cython check hack 
instead of applying this only to usage generation, use it as a generic
mechanism to disable loading of Cython code.

it may be incomplete: there may be other places where Cython code is
loaded that is not checked, but that is sufficient to build the usage
docs. the environment variable used is documented as such in the
docs/usage.rst.

we also move the check to a helper function and document it
better. this has the unfortunate side effect of moving includes
around, but I can't think of a better way.
 2015-10-08 08:56:02 -04:00
Antoine Beaupré a0ef4e25dd add support for arbitrary SSH commands (attic#99) 
while SSH options can be specified through `~/.ssh/config`, some users
may want to use a completely different SSH command for their backups,
without overriding their $PATH variable. it may also be easier to do
ad-hoc configuration and tests that way.

plus, the POLA tells us that users expects something like this to be
supported by commands that talk to ssh. it is supported by rsync, git
and so on.
 2015-10-05 18:54:00 -04:00
Thomas Waldmann bf3cf21ac5 docs: add warning about prune 2015-10-03 14:12:16 +02:00
Thomas Waldmann 86502d2729 docs: explain --read-special in more detail, fixes #220 2015-09-26 14:24:37 +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
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 c823554b6b docs: usage: improved formatting, cosmetic changes 2015-08-29 04:00:22 +02:00
Thomas Waldmann 1d16e7a37c compression: update / refine docs 2015-08-15 15:45:15 +02:00
Thomas Waldmann 8b1d46caa4 docs: more about compression 2015-08-10 20:36:21 +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 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 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
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
Thomas Waldmann afc2dab71e docs: more borg (or project_name) 2015-05-15 19:22:52 +02:00
Thomas Waldmann 56fd96589b docs: make clear that remote repos used via ssh need a remote borg 2015-05-15 18:35:14 +02:00
Thomas Waldmann ff0c264e3e fix small doc bug in prune examples, fix attic #306 
--monthly is old/deprecated, --keep-monthly is new way.
 2015-05-15 01:07:04 +02:00
Thomas Waldmann 7cbff6925f Documentation for 'attic serve' 
Thanks to @lfam (attic PR #277 )!

Note: As I already had refactored a lot of these pathes you changed, it was easier
to just cherry pick the hunks with the other changes and apply them manually.
 2015-05-14 17:36:53 +02:00
Thomas Waldmann 35d06afd6b get rid of some .borg, be consistent with the backup repo name and path 
it's pretty useless to have .borg as a directory extension, especially
since there is a README in there stating that this is a borg repo.

conistency:
"backup" is always used as relative backup repository path
"/mnt/backup" is always used as absolute repository path
 2015-05-13 15:02:33 +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
Jonas Borgström 02a8172eee docs: More improvements 2014-04-06 22:47:22 +02:00
Jonas Borgström ead1511948 docs: More documentation improvements 2014-04-06 15:16:25 +02:00
Jonas Borgström 3982c34e6c Improve attic check documentation 
Closes #24.
 2014-02-26 23:13:48 +01:00
Dan Christensen 4c4018e1d7 Update prune documentation to use new command line options, 
and also to say that the time that matters is the time each
backup completes.
 2014-02-24 19:32:18 -05:00
Jonas Borgström 7b31f23722 Replace verify command with "extract --dry-run" 
closes #25
 2014-02-18 21:33:06 +01:00
Jonas Borgström faedaf8160 Basic repository consistency check functionality. 
Still no archive metadata validation or repair functionality.
 2014-02-05 00:04:30 +01:00
Dan Christensen 6b639e4c22 Update prune docs and a few other things in usage.rst. 2014-02-03 20:11:47 -05:00
Jonas Borgström 530dfd1558 Documentation update 2013-10-03 21:00:54 +02:00
Jonas Borgström a51a10a96c More documentation improvements. 2013-08-04 23:20:22 +02:00
Jonas Borgström a35339f2c2 Renamed commands.rst to usage.rst 2013-08-04 21:23:12 +02: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 0c1d6e8179 Fix usage.rst syntax 2013-07-05 17:04:01 +02:00
Jonas Borgström f827b99ffe Improved documentation. 2013-07-05 12:32:56 +02:00