Commit Graph

1177 Commits

Author SHA1 Message Date
Josh Holland b0c441660f
Improve formatting of GPG output in documentation
(cherry picked from commit 9f2f4132ec)
2018-03-05 15:15:52 +00:00
TW bf6961f5bd
Merge pull request #3660 from dragetd/draget-backport-1.1-doc
Add docs on how to verify a signed release
2018-03-03 00:20:24 +01:00
Michael Gajda 17bb3f8f98 Add docs on how to verify a signed release
Short howto on using gpg to verify a signed binary release.
Fixes #3634
2018-03-02 22:11:49 +01:00
TW fd79b90ec0
Merge pull request #3651 from miek/backport-3589
Backport #3589 to 1.1-maint
2018-03-02 16:08:57 +01:00
Rémi Oudin fe807046b4 Better formatting of CPU usage documentation
This is now displayed as a list, with bold fonts for each bullet.
Refers https://github.com/borgbackup/borg/issues/3554
2018-03-01 23:20:02 +00:00
Gregor Kleen 183966549f Chunk seed is generated per /repository/ 2018-02-28 15:46:23 +00:00
Alexander 'Leo' Bergolth 42a9053771 add chunker_params to json docs 2018-01-22 09:05:24 +01:00
Abogical f3791144ef Happy new year! 2018-01-02 19:44:35 +02:00
Thomas Waldmann 9b4202fd48 build_usage 2017-12-30 01:58:32 +01:00
Thomas Waldmann b8f6e47b42 build_man 2017-12-30 01:57:18 +01:00
Thomas Waldmann a44b5bb273 update CHANGES (1.1)
bump version to borg 1.1.4 "34c3 edition"
2017-12-30 01:00:41 +01:00
Thomas Waldmann 6da0a12a86 update CHANGES (1.1) 2017-12-29 03:28:07 +01:00
TW b500ab7509
Merge pull request #3480 from ThomasWaldmann/borg-base-dir-1.1
added BORG_BASE_DIR, s/get_home_dir/get_base_dir/g, docs, fixes #3338
2017-12-23 19:53:16 +01:00
Thomas Waldmann 28baa78595 added BORG_BASE_DIR, s/get_home_dir/get_base_dir/g, docs, fixes #3338
also: sorted env var docs by level
(cherry picked from commit c5a339384e)
2017-12-23 18:09:16 +01:00
Josh Holland 9f7ed7fcec docs: Fix missing apostrophe
(cherry picked from commit 95a05dbbf1)
2017-12-23 17:47:00 +01:00
Thomas Waldmann ce7864f6a6 readme / docs: mention zstd
(cherry picked from commit 2588e50f0b)
2017-12-20 03:25:04 +01:00
Thomas Waldmann 182c0fa636 update requirements and install docs about bundled lz4 and zstd
(cherry picked from commit 061321b668)
2017-12-20 03:24:48 +01:00
Thomas Waldmann 6043d8b257 update CHANGES (1.1-maint) 2017-12-19 02:19:15 +01:00
Thomas Waldmann 21ba3ff63c fix lz4 deprecation warning, require lz4 >= 1.7.0 (r129)
as we bundle lz4 1.8.0 now, platforms not having a recent liblz4 can
now just use the bundled code.

(cherry picked from commit fe48caf853)
2017-12-18 02:47:44 +01:00
Thomas Waldmann 83603acd48 rename BORG_LZ4_PREFIX env var to BORG_LIBLZ4_PREFIX
consistency:
we also have BORG_LIBB2_PREFIX and BORG_LIBZSTD_PREFIX.

(cherry picked from commit 9b6924d27f)
2017-12-18 02:42:03 +01:00
Thomas Waldmann 49f76a1e32 bundle lz4 1.8.0 src code, license
(cherry picked from commit c8b2820225)
2017-12-18 02:38:52 +01:00
Thomas Waldmann c7383589cc bundle zstd 1.3.2 source code
only .c and .h files + license

(cherry picked from commit dc883f62ae)
2017-12-15 03:14:33 +01:00
Gregor Kleen dbf8d582f9 Add placeholder for fqdn in reverse notation
(cherry picked from commit 85fb38e2f3)
2017-12-15 00:56:31 +01:00
Thomas Waldmann 278ed640e9 add auto-generated docs for borg config
also: move a bit upwards in the use docs
2017-12-09 13:41:03 +01:00
Thomas Waldmann 831a06a07d move 3rd party docs/license file from package dir to docs/3rd_party
setup.py excludes all .c .h .pyx files from installation, but such
docs / license files would still be copied to the target directory
if they are inside the python "borg" package dir.
2017-11-27 00:02:37 +01:00
Thomas Waldmann 6becbb259b manually fix build_man issue with highlight directive 2017-11-27 00:02:36 +01:00
Thomas Waldmann 51504bad18 build_man 2017-11-27 00:02:36 +01:00
Thomas Waldmann d373772517 build_usage 2017-11-27 00:02:36 +01:00
Thomas Waldmann 54883434b9 update CHANGES (1.1-maint) for 1.1.3 release 2017-11-27 00:02:36 +01:00
Thomas Waldmann c7994b598b docs: fix broken links (1.1-maint) 2017-11-26 23:56:32 +01:00
Thomas Waldmann 7438cb2ef4 link to the homepage for support/service (1.1-maint)
otherwise people ONLY reading the docs (and not coming from the
homepage) will miss these options.
2017-11-26 23:34:10 +01:00
Michael Rupert 2e365f46de do remaining part of #3360 backport to 1.1-maint 2017-11-26 23:23:57 +01:00
TW d8ff84c2f4
WIP: update CHANGES (1.1-maint) (#3368)
update CHANGES (1.1-maint)
2017-11-26 18:47:20 +01:00
Michael Rupert a40dd4c3b6 fixed support links (#3379) (#3381)
fixed support links, #3379

(cherry picked from commit 6dd54f93ce)
2017-11-26 05:30:09 +01:00
Thomas Waldmann 25b40a261b docs: give examples for borg mount exclusion options
(cherry picked from commit 0eaec60384)
2017-11-26 04:04:42 +01:00
Thomas Waldmann ef39dc6554 docs: move bsdflags tuning comments to notes docs section
the atime comments are already there.

(cherry picked from commit 91ff2f81a6)
2017-11-26 04:04:20 +01:00
Thomas Waldmann b175f1fdf1 docs: document birthtime support on platforms supporting it
stat.st_birthtime, MacOS and (some?) BSDs.

(cherry picked from commit a107233f75)
2017-11-26 04:04:01 +01:00
Thomas Waldmann 21afd17f2f docs: document good and problematic option placements, see #3356
(cherry picked from commit e3cb7c3c32)
2017-11-26 04:03:42 +01:00
Thomas Waldmann 938d122191 docs: fix examples with problematic option placements, fixes #3356
have options to the left OR to the right of all positional arguments,
but not on BOTH sides and not in between them.

(cherry picked from commit f2a1539f25)
2017-11-26 04:03:16 +01:00
TW 26cfaf3681
Merge pull request #3359 from milkey-mouse/borg-config-cmd-bp1.1
Add borg config command (1.1 backport)
2017-11-26 03:56:01 +01:00
Thomas Waldmann 0340fbe420 build_man (1.1-maint)
also: git add borgfs.1
2017-11-25 14:49:00 +01:00
Thomas Waldmann 7bf838003a build_usage (1.1-maint)
also: git add borgfs.rst.inc
2017-11-25 14:45:28 +01:00
Milkey Mouse 2ac0bf4980
Add borg config command (fixes #3304)
This command works similarly to "git config" - it parses repo and
cache configs to get, set, and delete values. It only works on local
repos so a malicious client can't e.g. override their storage quota
or reset the append_only flag.

Add tests for borg config

Add documentation for borg config

Change manual config edits -> borg config

There were a couple places in the documentation where it was advised
to edit the repository or cache config file, a process that is stream-
lined by borg config.
2017-11-24 16:38:56 -08:00
Milkey Mouse 46698bde6e
Move image backup-related FAQ entries to a new page 2017-11-23 15:06:23 -08:00
Milkey Mouse f9ed3b3ed7
Add instructions for zerofree 2017-11-23 15:05:22 -08:00
Milkey Mouse 454317dc02
Add instructions for ntfsclone (fixes #81) 2017-11-23 15:05:17 -08:00
Tom Denley 8fb8692d42
Correct usage of "fewer" in place of "less" 2017-11-22 21:52:41 -08:00
TW 78189ed613
Merge pull request #3342 from milkey-mouse/document-sshfs-stupidity-bp1.1
Document sshfs rename workaround (1.1 backport)
2017-11-20 23:21:02 +01:00
TW 96b6033f29
Merge pull request #3341 from milkey-mouse/break-lock-interrupt-bp1.1
Mention break-lock in checkpointing FAQ entry (1.1 backport)
2017-11-20 23:19:23 +01:00
Antoine Beaupré 8735e17575
add FAQ about removing old files and policies
This has been asked twice already this year:

https://mail.python.org/pipermail/borgbackup/2017q3/000796.html
https://mail.python.org/pipermail/borgbackup/2017q4/000891.html

... and I was asked again privately today, so this qualifies as FAQ to
me.
2017-11-20 13:52:09 -08:00
Milkey Mouse ebecd8bd73
Document sshfs rename workaround (fixes #3315) 2017-11-20 13:03:12 -08:00
Milkey Mouse fda9b7d5b9
Mention break-lock in checkpointing FAQ entry (fixes #3328) 2017-11-20 12:35:14 -08:00
TW 9f9cb88a01
Merge pull request #3311 from milkey-mouse/borgfs-man-bp1.1
Generate usage & man page for borgfs (1.1-maint)
2017-11-14 00:28:59 +01:00
Milkey Mouse eadb74eb6f
Generate man page for borgfs (fixes #3216) 2017-11-12 15:06:08 -08:00
TW 3d2f2b8a39
Merge pull request #3310 from milkey-mouse/clarify-duration-bp1.1
Clarify create --stats duration vs. wall time (1.1-maint)
2017-11-12 12:39:23 +01:00
Milkey Mouse e20b1ebbc4
Clarify create --stats duration vs. wall time (fixes #3301) 2017-11-10 11:51:16 -08:00
Thomas Waldmann 07f36542a6 update release checklist about security fixes
(cherry picked from commit 818b61935b)
2017-11-06 10:42:28 +01:00
Thomas Waldmann 3097c059ff build_man 2017-11-05 23:09:39 +01:00
Thomas Waldmann 851e85b426 build_usage 2017-11-05 23:09:14 +01:00
TW 701a7a5ef8
Merge pull request #3284 from ThomasWaldmann/update-changes-1.1
update CHANGES (1.1-maint)
2017-11-05 23:00:58 +01:00
Thomas Waldmann ff3910637d update CHANGES (1.1-maint) 2017-11-05 23:00:26 +01:00
Thomas Waldmann 0c7eaec99d docs: more than 23 is not supported for CHUNK_MAX_EXP, fixes #3115
(cherry picked from commit e7fd1ff2ee)
2017-11-05 22:38:51 +01:00
Thomas Waldmann e0d967aeb7 update / rephrase cygwin / WSL status, fixes #3174
(cherry picked from commit 61d6c58241)
2017-11-05 22:37:52 +01:00
narendravardi 00152e8a61 Added documentation for BORG_CONFIG_DIR
(cherry picked from commit 764a62f42c)
2017-11-03 18:39:15 +01:00
Milkey Mouse 5b7d4392dc
Clarify using a blank passphrase in keyfile mode 2017-10-25 22:42:27 -07:00
Thomas Waldmann 23ac694e3d build_man 2017-10-22 03:19:23 +02:00
Thomas Waldmann f53bd78b33 build_usage 2017-10-22 03:18:40 +02:00
Thomas Waldmann 8ade3a960a update CHANGES (1.1-maint) 2017-10-22 02:54:58 +02:00
Thomas Waldmann d535c6a25d remove hardlinked symlinks warning, update docs, fixes #3175
the warning was annoying for people with a lot of such items and
they can not do anything about it anyway.

thus, just document this as a limitation.

(cherry picked from commit e674822888)
2017-10-17 21:39:51 +02:00
TW 17ce2f728a Merge pull request #3155 from ThomasWaldmann/maincommand-help-1.1
maincommand help 1.1
2017-10-13 01:45:19 +02:00
Thomas Waldmann fcaf764604 add example showing --show-version --show-rc
(cherry picked from commit ed1a8b5cf1)
2017-10-12 23:34:23 +02:00
Fabio Pedretti 0e44f07b88 use --format rather than --list-format in examples, the latter is
deprecated

(cherry picked from commit bc42f58c04)
2017-10-11 01:13:12 +02:00
Thomas Waldmann 8685c24a95 build_man 2017-10-07 22:15:27 +02:00
Thomas Waldmann ce121246ca update CHANGES 2017-10-07 22:13:44 +02:00
TW ce1d3ec7e4 Merge pull request #3098 from ThomasWaldmann/fix-man-typo-1.1
manpage: fix typos, update homepage
2017-10-07 16:16:37 +02:00
Thomas Waldmann 164bb059ec manpage: fix typos, update homepage
(cherry picked from commit 62e0f7a64e)
2017-10-07 16:15:34 +02:00
Thomas Waldmann 1e370d4d23 faq: we do not implement futile attempts of ETA / progress displays
(cherry picked from commit fe08437337)
2017-10-06 20:31:12 +02:00
Thomas Waldmann 180a37db46 build_man 2017-10-01 02:26:55 +02:00
Thomas Waldmann 0263c9dd8a build_usage 2017-10-01 02:24:54 +02:00
TW 6c04f6f1b6 Merge pull request #3065 from ThomasWaldmann/update-changes-1.1
update CHANGES (1.1-maint)
2017-10-01 02:12:09 +02:00
Thomas Waldmann 9723f38855 update CHANGES (1.1-maint) 2017-10-01 02:10:57 +02:00
Thomas Waldmann eab9f5a07b implement files cache mode control, fixes #911
You can now control the files cache mode using this option:

--files-cache={ctime,mtime,size,inode,rechunk,disabled}*

(only some combinations are supported)

Previously, only these modes were supported:
- mtime,size,inode (default of borg < 1.1.0rc4)
- mtime,size (by using --ignore-inode)
- disabled (by using --no-files-cache)

Now, you additionally get:
- ctime alternatively to mtime (more safe), e.g.:
  ctime,size,inode (this is the new default of borg >= 1.1.0rc4)
- rechunk (consider all files as changed, rechunk them)

Deprecated:
- --ignore-inodes (use modes without "inode")
- --no-files-cache (use "disabled" mode)

The tests needed some changes:
- previously, we use os.utime() to set a files mtime (atime) to specific
  values, but that does not work for ctime.
- now use time.sleep() to create the "latest file" that usually does
  not end up in the files cache (see FAQ)

(cherry picked from commit 5e2de8ba67)
2017-10-01 01:27:18 +02:00
Alexander Meshcheryakov d3533de5f7 Simplified rate limiting wrapper in FAQ
Exporting $RATE as environment variable is not need in this case.

And example does not use any bash specific features.
It should use default system shell instead.
(cherry picked from commit f7ec13eabb)
2017-09-26 23:51:06 +02:00
TW fa66015cb3 Merge pull request #3054 from ThomasWaldmann/update-create-docs-1.1
Update create docs (1.1-maint)
2017-09-23 23:45:02 +02:00
Thomas Waldmann cfc48d2899 docs: add auto compression example to borg create examples
(cherry picked from commit 3f16d91fd3)
2017-09-23 23:42:02 +02:00
Thomas Waldmann c616009724 docs: add compressor names to be more clear
(cherry picked from commit 0ec6c920b9)
2017-09-23 23:41:46 +02:00
Thomas Waldmann 354d3f0b4f fix docs: --compression lz4 is the default now, fixes #3034
(cherry picked from commit c88528512f)
2017-09-23 23:41:27 +02:00
Thomas Waldmann 055f34f025 docs: twitter account @borgbackup, fixes #2948
(cherry picked from commit 112bf43956)
2017-09-23 21:31:00 +02:00
Thomas Waldmann eacea02d8c docs: add note about metadata dedup and --no[ac]time, fixes #2518
(cherry picked from commit d8766df998)
2017-09-23 21:30:42 +02:00
Thomas Waldmann 313529b929 build_man 2017-09-10 00:08:25 +02:00
Thomas Waldmann 2d7dc08c8c build_usage 2017-09-10 00:07:45 +02:00
TW ae541b4027 Merge pull request #3013 from ThomasWaldmann/update-changes-1.1
update CHANGES (1.1-maint)
2017-09-09 23:51:48 +02:00
Thomas Waldmann 3ed6f2367c update CHANGES (1.1-maint) 2017-09-09 23:47:31 +02:00
TW a99060508f document utf-8 locale requirement for json mode, #2273 (#3009)
(cherry picked from commit 133e847f8e)
2017-09-08 21:12:46 +02:00
Markus Engelbrecht ff1c4d1f4c Use correct casing for macOS
(cherry picked from commit e157328228)
2017-09-07 02:56:34 +02:00
Markus Engelbrecht 6dab333616 Fix macOS keychain integration command
(cherry picked from commit aadb9cd2ee)
2017-09-07 02:56:21 +02:00
Thomas Waldmann 168293ea80 python setup.py build_man 2017-08-27 22:18:45 +02:00
Thomas Waldmann 9f61747dae python setup.py build_usage 2017-08-27 22:17:55 +02:00
Thomas Waldmann d07a6e14e7 add release date to changelog 2017-08-27 22:08:14 +02:00
Thomas Waldmann 24400fcecd update CHANGES (1.1-maint) 2017-08-27 21:48:29 +02:00