Commit Graph

578 Commits

Author SHA1 Message Date
Thomas Waldmann 4fecd223c8 api.rst: remove problematic stuff, fixes #881
some cython stuff can't be processed by sphinx.
some platform-dependant modules can't get imported.

also: reordered modules in api.rst so order makes some sense.
2016-07-10 17:26:04 +02:00
Thomas Waldmann 2f21488e81 fix most python-source related sphinx warnings 2016-07-10 17:26:04 +02:00
Thomas Waldmann 5660cd1f96 fix most non-python-source related sphinx warnings
literal blocks must be followed by an empty line

suppressed the non-local image uri warning via sphinx config

the links on the resources page must have different label texts

setup.py: do not generate pointless "::\n" - it does not create a literal block if the stuff below is not indented
2016-07-10 17:25:51 +02:00
Marian Beermann c4a8c53547
changelog: Added release dates to older borg releases 2016-07-10 00:55:51 +02:00
Thomas Waldmann 66cc520880 update CHANGES 2016-07-07 22:25:49 +02:00
Thomas Waldmann 1fe3781186 backport some FAQ entries from master branch 2016-07-07 21:56:06 +02:00
Thomas Waldmann 3218c5945a ran build_api / build_usage 2016-07-07 05:04:19 +02:00
Thomas Waldmann a4603cf010 update CHANGES 2016-07-07 04:57:44 +02:00
TW 91d1a4f76f Merge pull request #1278 from ThomasWaldmann/update-cygwin-docs
update cygwin installation docs
2016-07-07 04:12:47 +02:00
Thomas Waldmann 8db670cf7f update CHANGES 2016-07-06 00:37:01 +02:00
TW 9fa8aa495c Merge pull request #1263 from enkore/issue/1262
Repository: cleanup on ENOSPC
2016-07-06 00:23:55 +02:00
Thomas Waldmann 740c638030 update usage files 2016-07-05 23:30:08 +02:00
Marian Beermann 7ed425dae0
Repository: cleanup on ENOSPC 2016-07-05 20:33:07 +02:00
Jens Rantil 2922948100 Update faq.rst
Fix misspelling.
2016-07-05 18:23:42 +02:00
TW 6977fcf9e2 Merge pull request #1202 from ThomasWaldmann/update-1.0-changes
update CHANGES
2016-07-05 01:04:48 +02:00
Thomas Waldmann 19d1bbfa14 add advice about issue #1138, fixes #1223 2016-07-05 00:58:42 +02:00
Thomas Waldmann 54e5667477 update CHANGES 2016-07-05 00:58:42 +02:00
enkore 2fd6e5cf12 Merge pull request #1260 from ThomasWaldmann/update-frontpage
update frontpage / support docs
2016-07-04 23:38:02 +02:00
TW 65c1f40e2a Merge pull request #1261 from dragetd/patch-doc-compression
Update docs about lzma compression levels above 6
2016-07-04 23:36:17 +02:00
Thomas Waldmann 20eab2b5c8 update frontpage / support docs
less items in frontpage link list
add IRC chat link
minor other changes
2016-07-04 22:37:24 +02:00
Michael Gajda 0b488760a7 Update docs about lzma compreesion levels above 6
lzma compression levels above 6 do not increase compression ration but waste a lot of cpu cycles.
2016-07-04 21:58:52 +02:00
Thomas Waldmann 3325126988 add missing BORG_REMOTE_PATH env var, fixes #1258 2016-07-04 15:06:20 +02:00
Thomas Waldmann d59a1d5fef doc and help update for --read-special 2016-07-04 14:06:30 +02:00
Thomas Waldmann 7231107b5a update cygwin installation docs
cython is installed with pip later.
liblz4 is available from normal cygwin packages now.
creation of virtualenv worked now without issues.
2016-07-04 03:47:54 +02:00
Joachim Breitner f6deb09184 Documentation: Explicate that Fnmatch is default
This fixes #1247. It also regenerates the usage documentation, so that
styling fixex in that section (as well as other existing changes) make
it into the files in docs/.
2016-07-03 16:57:23 +02:00
Lee Bousfield c515d6018d
Add --append-only to borg serve
Fixes #1168
2016-06-30 17:58:36 -04:00
Thomas Waldmann c773c882b9 add prune visualization / example, fixes #723 2016-06-27 21:20:35 +02:00
Thomas Waldmann b10025c6e5 document sshd settings, fixes #545 2016-06-24 23:30:27 +02:00
Thomas Waldmann f54f159db8 more details about checkpoints, add split trick, fixes #1171 2016-06-24 22:32:38 +02:00
Thomas Waldmann ad65c5ac16 support docs: add freenode web chat link, fixes #1175 2016-06-24 21:48:21 +02:00
Thomas Waldmann 5ae340998c update docs about placeholders 2016-06-22 08:40:31 +02:00
Dan Helfman 7642632359 Update resources.rst to rename atticmatic to borgmatic
atticmatic wrapper script has been renamed to borgmatic!
2016-06-10 19:27:19 -07:00
Thomas Waldmann 5be71b506e update CHANGES 2016-05-20 21:49:01 +02:00
Thomas Waldmann 8d8374d23c ran build_api + build_usage 2016-05-20 14:34:48 +02:00
Thomas Waldmann 1e061a2fa4 update CHANGES 2016-05-20 14:05:05 +02:00
TW f9638645d1 Merge pull request #996 from ThomasWaldmann/update-1.0-docs
update CHANGES in 1.0-maint
2016-05-05 13:51:59 +02:00
Thomas Waldmann 7457c0f5da update CHANGES in 1.0-maint 2016-05-05 13:43:40 +02:00
Thomas Waldmann 9e09786b33 borg create help: document format tags, fixes #894
docs: rephrased, more useful examples
2016-05-05 13:38:08 +02:00
Thomas Waldmann 700e715b23 add missing docs for borg break-lock, fixes #992 2016-04-30 00:32:25 +02:00
Thomas Waldmann 4b73ebc613 update readthedocs urls, fixes #991 2016-04-29 03:19:27 +02:00
Thomas Waldmann 8662202486 update CHANGES 2016-04-16 02:39:22 +02:00
Thomas Waldmann 956e9957b2 update CHANGES 2016-04-16 00:59:59 +02:00
Thomas Waldmann 43b4fda393 docs: fix confusing usage of "repo" as archive name 2016-04-15 03:38:43 +02:00
Thomas Waldmann bc854e3e64 docs: use /path/to/repo, fixes #901
/mnt/backup was confusing as people like to mount their backup disk on /mnt/backup,
but borg init /mnt/backup does not work if that directory already exists because it is
the mountpoint. it would work, if /mnt was the mountpoint, but that is not obvious
and also unusual.
2016-04-15 03:35:37 +02:00
Thomas Waldmann 68e870795d update CHANGES 2016-04-15 03:09:18 +02:00
Thomas Waldmann 6a3f2d7864 update CHANGES 2016-04-08 23:41:15 +02:00
Thomas Waldmann d5d037b97d ran build_api build_usage 2016-04-08 23:38:46 +02:00
Thomas Waldmann e9b3b3fa1a updated CHANGES 2016-04-08 19:52:47 +02:00
TW a519333376 add --warning, --error, --critical for completeness, fixes #826
it's not recommended to suppress warnings or errors,
but the user may decide this on his own.

note: --warning is not given to borg serve so a <= 1.0.0 borg
will still work as server. it is not needed as it is the default.
2016-04-03 20:20:48 +02:00
TW 86361fd75f update CHANGES
the password roundtrip was already in 1.0.0, removed it from 1.0.1 changes.
rephrase / prettify some stuff.
2016-04-03 17:49:37 +02:00
Thomas Waldmann 2f74d2e288 update CHANGES 2016-03-31 21:44:43 +02:00
wormingdead 1cc053bee4 Document logo font. Recreate logo png. Remove GIMP logo file. 2016-03-31 21:37:30 +02:00
Thomas Waldmann c35dbac44b update CHANGES 2016-03-31 21:28:35 +02:00
Marian Beermann 8f6ce9051b append-only mode: docs reformulated 2016-03-31 18:52:40 +02:00
Marian Beermann effa992d22 append-only mode: use single file for log, disallow check --repair, docs 2016-03-31 18:23:08 +02:00
Thomas Waldmann 40dbb7411c fix cygwin requirements (gcc-g++) 2016-03-21 16:11:43 +01:00
Thomas Waldmann b6966a56dc document how to debug / file filesystem issues, fixes #664
if the filesystem issue can't be reproduced with a known-good,
local fs like ext4 on linux, the issue is likely not borg's fault.
2016-03-12 00:48:26 +01:00
alexskc 2931891352 CSS !important overwrite. Fix borgbackup/borg#727 2016-03-09 19:01:49 -06:00
Thomas Waldmann 95c4cf221d implement password roundtrip, fixes #695 2016-03-05 16:21:44 +01:00
Thomas Waldmann 96702ec1e3 prepare CHANGES for 1.0.0 2016-03-05 14:46:28 +01:00
Thomas Waldmann fa797655a6 updated CHANGES 2016-03-05 02:23:01 +01:00
TW fbc4172c73 Merge pull request #705 from manwegit/feature/docs-bwlimit
Faq: how to limit bandwidth
2016-03-02 15:49:55 +01:00
Thomas Waldmann 1324ef51a9 changes: fix old chunker params, fixes #698 2016-03-02 14:22:52 +01:00
Teemu Toivanen 9883b1af51 Faq: how to limit bandwidth
Example to faq documentation how bandwidth limiting can be done with pipeviewer.
2016-03-02 08:40:16 +02:00
Thomas Waldmann 66c5735b58 update CHANGES 2016-02-28 00:35:02 +01:00
Thomas Waldmann 3ae8a95935 ran build_api and build_usage 2016-02-27 20:55:14 +01:00
Thomas Waldmann 1ce41da704 update CHANGES, 1.0.0rc2 2016-02-27 20:53:05 +01:00
Thomas Waldmann af2eaaabd4 update and improve docs
use the travis status image as png as svg does not show an image in firefox.
2016-02-27 17:22:56 +01:00
Thomas Waldmann 6561ad46e2 CHANGES: move compat notes to top 2016-02-26 00:57:50 +01:00
Thomas Waldmann d6fb77f2c6 update CHANGES 2016-02-26 00:56:10 +01:00
Teemu Toivanen a94471dc0e Usage examples for create format tags 2016-02-25 00:41:24 +02:00
Thomas Waldmann 08a7ce5cc3 Merge branch 'feature/list-formatting' of https://github.com/manwegit/borg into feature/list-formatting 2016-02-21 19:15:31 +01:00
TW 4c31e7a4bd Merge pull request #687 from ThomasWaldmann/fix-attic-changelog
fix ReST syntax for old attic changelog
2016-02-21 17:25:26 +01:00
Thomas Waldmann 5bfb1df873 fix ReST syntax for old attic changelog 2016-02-21 17:24:34 +01:00
jungle-boogie 1d4f591691 updated freeBSD docs
With the now improved steps, I was able to build Borg on a vagrant image:
% borg -V
borg 1.0.0rc2.dev40+ngfb83f61
2016-02-20 14:12:57 -08:00
jungle-boogie fdf1dd75dd freebsd fuse for mount for #649 2016-02-20 10:24:43 -08:00
TW a44c1f5092 Merge pull request #676 from ThomasWaldmann/block-dev-restore-docs
docs: add example how to restore a raw device, fixes #671
2016-02-18 22:54:52 +01:00
Thomas Waldmann 347778b749 docs: add example how to restore a raw device
also: do not use /dev/sda in case someone stupidly tries out the examples.
/dev/sdx should be safe for people who do not understand what they do.
2016-02-18 21:38:31 +01:00
Thomas Waldmann 5e5911dd49 docs: add a hint about the dev headers needed when installing from source 2016-02-18 21:30:44 +01:00
TW 89b2421ed4 Merge pull request #667 from ThomasWaldmann/add-delete-docs
docs: add examples for delete (and handle delete after list, …
2016-02-17 01:00:51 +01:00
Thomas Waldmann 91f10e1a29 docs: update example for borg create -v --stats (use iso datetime format), fixes #663
the code already was updated after 1.0.0rc1, but not the quickstart docs.
2016-02-17 00:43:05 +01:00
Thomas Waldmann 0b44944b47 docs: add examples for delete (and handle delete after list, before prune), fixes #656 2016-02-17 00:30:33 +01:00
jhemmje bf31fe3173 docs: Updated examples in usage.rst, fixes #644 2016-02-15 21:38:11 +01:00
jhemmje 7e7c33c3cf docs: Updated examples in quickstart.rst, fixes #644 2016-02-15 21:38:02 +01:00
jhemmje aeec29545e docs: Updated examples in deployment.rst, fixes #644 2016-02-15 21:37:50 +01:00
Mark Lopez 2b8083bb20 Fixed typo. 2016-02-08 19:54:20 -06:00
Mark Lopez 99a3bab68d Added example to BORG_RSH documentation. 2016-02-07 22:07:30 -06:00
Thomas Waldmann b1dacd8861 CHANGES minor fixes 2016-02-08 01:11:03 +01:00
Thomas Waldmann 5ffb0fd7cd borg upgrade: add to docs that only LOCAL repos are supported 2016-02-07 21:08:20 +01:00
Thomas Waldmann 6db6c22cd4 docs: add faq entry and point to issue 636 2016-02-07 21:01:49 +01:00
Thomas Waldmann 50a82e97dd update CHANGES 2016-02-07 19:45:32 +01:00
Thomas Waldmann 6c278e2e85 docs: formatting fixed 2016-02-07 19:33:26 +01:00
Thomas Waldmann 316f5a345f docs: borg upgrade also handles borg 0.xx -> 1.0 2016-02-07 19:23:06 +01:00
Thomas Waldmann 2f95c8ea79 docs: use pip extras or requirements file to install llfuse 2016-02-07 19:15:30 +01:00
Thomas Waldmann c2edfab237 all FUSE related version requirements in 1 place 2016-02-07 19:08:03 +01:00
Thomas Waldmann 69300e473d document and automate llfuse requirement 2016-02-07 19:03:32 +01:00
Thomas Waldmann c42f3d07f4 run build_usage 2016-02-07 14:50:39 +01:00
Thomas Waldmann 2170d6e502 fix order in release process docs
it is important to first do all the changes that modify the release contents,
then tag/sign it, then build the binaries via vagrant.

Only then the binaries will have the correct version number.
2016-02-07 14:44:49 +01:00
Thomas Waldmann 8a8f0263c8 update CHANGES for 1.0.0rc1 2016-02-07 03:01:26 +01:00
Thomas Waldmann 94451cd2e8 update CHANGES 2016-02-06 20:24:20 +01:00
Teemu Toivanen 14f0fa6f6a archive file listing output formatting
Coding style fixup
Add --list-format exmaple to usage examples
2016-02-05 21:07:04 +02:00
Thomas Waldmann 4355150efa docs: OS X binary does not work for older OS X releases, fixes #629 2016-02-04 20:48:43 +01:00
Thomas Waldmann 435d30d61b docs: updates and fixes 2016-02-01 03:22:02 +01:00
Thomas Waldmann 0a0f483daa docs about borg serve's special support for forced/original ssh commands, fixes #544 2016-02-01 01:18:37 +01:00
Robin Schneider a7ed461394
Use `--one-file-system` instead of `--do-not-cross-mountpoints` in docs.
Related to #296 in which support for `--do-not-cross-mountpoints` has
been deprecated.
2016-01-31 11:54:01 +01:00
Robin Schneider 57b0ab7475
Fixed spelling in deployment docs. 2016-01-31 11:50:06 +01:00
Thomas Waldmann a65b7ec339 updates CHANGES 2016-01-30 23:05:40 +01:00
TW 5d93b6cda9 Merge pull request #613 from ThomasWaldmann/xdg-base-dir-keys
use xdg base dir for keys
2016-01-30 20:02:38 +01:00
Thomas Waldmann 7773e632db fix some minor cosmetic code/docs issues 2016-01-30 00:01:13 +01:00
Thomas Waldmann e06b7162c2 update docs / docstring about new key location 2016-01-28 23:15:49 +01:00
Thomas Waldmann 824e548b9f add missing example for --list option of borg create 2016-01-28 20:32:30 +01:00
Adam Kouse dcffa5c6a2 Single quote exclude line that includes an asterisk to prevent shell expansion 2016-01-26 11:51:38 -05:00
Gianfranco Costamagna 37eb22ad55 Delete Ubuntu Vivid, EOL
Ubuntu Vivid is not supported anymore.
2016-01-25 09:07:30 +01:00
Thomas Waldmann d2bfa24814 update CHANGES 2016-01-24 17:54:36 +01:00
Thomas Waldmann 1fc99ec9cd update docs, remove references to passphrase mode 2016-01-24 16:04:00 +01:00
Thomas Waldmann b2dedee3c8 refactor yes(), cleanup env var semantics, fixes #355
refactorings:

- introduced concept of default answer:

if the answer string is in the defaultish sequence, the return value of yes() will be the default.
e.g. if just pressing <enter> when asked on the console or if an empty string or "default" is
in the environment variable for overriding.

if an environment var has an invalid value and no retries are enabled: return default
if retries are enabled, next retry won't use the env var again, but either ask via input().

- simplify:

only one default - this should be a SAFE default as it is used in some special conditions
like EOF or invalid input with retries disallowed.

no isatty() magic, the "yes" shell command exists, so we could receive input even if it is not from a tty.

- clean:

separate retry flag from retry_msg
2016-01-24 16:04:00 +01:00
Thomas Waldmann 6d615ec30a change encryption to be on by default (repokey mode)
it's 2015, let's be safe-by-default and unsafe-as-option.

also: show default mode in builtin help
2016-01-24 15:44:09 +01:00
Thomas Waldmann 169634f2ca change the builtin default for --chunker-params, create 2MiB chunks, fixes #343
one of the biggest issues with borg < 1.0 was that it had a default target chunk
size of 64kiB, thus it created a lot of chunks, a huge chunk management overhead
(high RAM and disk usage).
2016-01-24 15:44:09 +01:00
Thomas Waldmann a2843bc939 docs: require python 3.4+
remove references to older pythons.
2016-01-24 14:57:48 +01:00
Thomas Waldmann 9ea79d738e add chunks.archive.d trick to FAQ 2016-01-23 22:57:26 +01:00
Thomas Waldmann f4561e813f update CHANGES 2016-01-23 21:43:24 +01:00
Thomas Waldmann dee1d462cc ran setup.py build_usage 2016-01-23 20:54:20 +01:00
Thomas Waldmann 162d94b2e4 ran setup.py build_api 2016-01-23 20:52:04 +01:00
Thomas Waldmann 541bbd4a5b add --list requirement hint 2016-01-23 15:21:38 +01:00
Michael Hanselmann 14934dab08 Update changes for shell-style pattern support 2016-01-23 11:05:17 +01:00
Antoine Beaupré da7bc4af94 add netbsd install instructions 2016-01-22 14:35:53 -05:00
TW 068c68b24c Merge pull request #584 from hansmi/shell-pattern
Add shell-style pattern syntax
2016-01-22 20:14:37 +01:00
Thomas Waldmann 92969ea5f1 add gcc gcc-c++ to redhat/fedora/corora install docs 2016-01-22 14:03:48 +01:00
Michael Hanselmann c7fb598ab9 Add shell-style pattern syntax
The fnmatch module in Python's standard library implements a pattern
format for paths which is similar to shell patterns. However, “*”
matches any character including path separators. This newly introduced
pattern syntax with the selector “sh” no longer matches the path
separator with “*”. Instead “**/” can be used to match zero or more
directory levels.
2016-01-21 16:07:24 +01:00
Thomas Waldmann 854215b7dd mention pp: in CHANGES 2016-01-20 01:00:35 +01:00
Thomas Waldmann 2dde49f0d4 update CHANGES 2016-01-19 01:02:14 +01:00
Piotr Pawlow 987aaa34df Added SSH key options to the usage example. 2016-01-18 18:49:07 +01:00
Piotr Pawlow a3fa965ded Added no-agent-forwarding,no-user-rc to SSH key options. 2016-01-18 18:39:11 +01:00
Piotr Pawlow 7851df089a Disable unneeded SSH features in authorized_keys example for security. 2016-01-18 14:35:11 +01:00
Robin Schneider 32900c8679
`Mi` does stand for a IEC binary prefix e.g. 2^20. 2016-01-18 10:38:55 +01:00
Robin Schneider 665c3db2e9
Improved understandability of sentence in deployment.rst.
Thanks to @xor-gate.

Related to https://github.com/borgbackup/borg/pull/529/files#r49952612
2016-01-18 09:32:51 +01:00
Robin Schneider 1f49d16a71
Fixed my changes. Thanks to @ThomasWaldmann for the review! 2016-01-18 09:00:07 +01:00
Robin Schneider 8b9ae0ae92
More – → -- (CLI) fixes. Fixed spelling. AES-256 is used.
* According to the comment in `borg/key.py`.
2016-01-17 23:49:54 +01:00
Robin Schneider 576348a9d4
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 22:31:08 +01:00
Robin Schneider 89ce86a33b
Fixed more in usage.rst. - → –; – → -- (CLI); Bullet list. 2016-01-17 22:23:54 +01:00
Robin Schneider 83c5321f53
Fixed RST warning markup. 2016-01-17 20:13:45 +01:00
Robin Schneider 19eb8e2d3b
Use ``--option`` in RST to not render "--" as "–". 2016-01-17 20:12:23 +01:00
Thomas Waldmann 2f05e4add9 use the usual commandline arguments order for borg prune examples, fixes #560
borg prune <options> <repo>
2016-01-16 20:57:22 +01:00
TW f35ba0b577 Merge pull request #559 from ThomasWaldmann/metastream-chunker
finer chunker granularity for items metadata stream, fixes #547, fixes #487
2016-01-15 22:42:20 +01:00
Thomas Waldmann 888e078382 use finer chunker granularity for items metadata stream, fixes #547, fixes #487
the items metadata stream is usually not that big (compared to the file content data) -
it is just file and dir names and other metadata.

if we use too rough granularity there (and big minimum chunk size), we usually will get no deduplication.
2016-01-15 20:56:21 +01:00
Jerry Jacobs a1e1ce552c Update README.md with doc|stable shield, minor markup fixes on docs/deployment.rst 2016-01-15 20:02:42 +01:00
Gianfranco Costamagna e644dae793 Move to my ppa and add Trusty/Vivid packages 2016-01-15 13:55:04 +01:00
Thomas Waldmann d08c51bdfc add gource video to resources docs, fixes #507 2016-01-15 10:34:05 +01:00
Danny Edel 6cedfbede9 Correct small typos in changes and usage 2016-01-15 09:24:00 +01:00
TW b6c47bad23 Merge pull request #554 from ThomasWaldmann/update-docs
update docs / make them more clear about -v
2016-01-14 22:02:12 +01:00