Commit Graph

1087 Commits

Author SHA1 Message Date
Thomas Waldmann c2521a7759 link to the homepage for support/service
otherwise people ONLY reading the docs (and not coming from the
homepage) will miss these options.

(cherry picked from commit 7438cb2ef4)
2017-11-26 23:37:04 +01:00
Michael Rupert 6dd54f93ce fixed support links (#3379)
fixed support links
2017-11-26 05:10:22 +01:00
Thomas Waldmann 0eaec60384 docs: give examples for borg mount exclusion options 2017-11-25 20:18:59 +01:00
Thomas Waldmann 91ff2f81a6 docs: move bsdflags tuning comments to notes docs section
the atime comments are already there.
2017-11-25 20:08:33 +01:00
Thomas Waldmann a107233f75 docs: document birthtime support on platforms supporting it
stat.st_birthtime, MacOS and (some?) BSDs.
2017-11-25 19:51:33 +01:00
Thomas Waldmann e3cb7c3c32 docs: document good and problematic option placements, see #3356 2017-11-25 19:46:48 +01:00
Thomas Waldmann f2a1539f25 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.
2017-11-25 19:29:34 +01:00
Thomas Waldmann ef8217afc9 build_man (master)
also: git add borgfs.1
2017-11-25 14:38:04 +01:00
Thomas Waldmann 73fac09dda build_usage (master)
also: add new borgfs.rst.inc
2017-11-25 14:35:52 +01:00
Michael Rupert 71fbac94fb Moved Support to .org (#3360)
docs: moved support options to www.borgbackup.org
2017-11-25 03:15:18 +01:00
TW c5dc75ae23
Merge pull request #3312 from milkey-mouse/borg-config-cmd
Add borg config command
2017-11-24 16:56:15 +01:00
Milkey Mouse 5b47cf6fa5
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-23 14:51:54 -08:00
TW 483d3e8a8b
Merge pull request #3292 from milkey-mouse/document-ntfsclone
Add instructions for using ntfsclone
2017-11-23 22:07:15 +01:00
Milkey Mouse c0edc60ca6
Move image backup-related FAQ entries to a new page 2017-11-23 12:14:35 -08:00
Milkey Mouse 759c8f77cf Mention break-lock in checkpointing FAQ entry (#3340)
Mention break-lock in checkpointing FAQ entry, fixes #3328
2017-11-20 23:18:37 +01:00
TW 22ae15f5b4
Merge pull request #3327 from anarcat/faq-remove
add FAQ about removing old files and policies
2017-11-18 21:01:31 +01:00
Milkey Mouse 7cb36a20b4 Document sshfs rename workaround (fixes #3315) (#3325)
Document sshfs rename workaround, fixes #3315
2017-11-18 20:57:39 +01:00
Antoine Beaupré 1a2906ae7e 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-18 09:08:37 -05:00
TW b8dece0ae7
Merge pull request #3290 from milkey-mouse/borgfs-man
Generate usage & man page for borgfs
2017-11-12 16:41:54 +01:00
Tom Denley c6591a7c06 Correct usage of "fewer" in place of "less" 2017-11-11 11:21:45 +00:00
Milkey Mouse b0d68036c2
Add instructions for zerofree 2017-11-10 11:54:45 -08:00
Milkey Mouse 2b254abb39
Add instructions for ntfsclone (fixes #81) 2017-11-10 11:54:45 -08:00
Milkey Mouse 17d5c794d3
Generate man page for borgfs (fixes #3216) 2017-11-10 11:25:19 -08:00
Milkey Mouse 7b485c23f7 Clarify create --stats duration vs. wall time (fixes #3301) (#3303)
clarify create --stats duration vs. wall time, fixes #3301
2017-11-10 17:44:34 +01:00
Thomas Waldmann 818b61935b update release checklist about security fixes 2017-11-06 10:38:04 +01:00
TW febb7ffca8
Merge pull request #3288 from ThomasWaldmann/doc-updates2
Doc updates 2
2017-11-05 22:18:41 +01:00
Thomas Waldmann e7fd1ff2ee docs: more than 23 is not supported for CHUNK_MAX_EXP, fixes #3115 2017-11-05 21:35:58 +01:00
Thomas Waldmann 61d6c58241 update / rephrase cygwin / WSL status, fixes #3174 2017-11-05 19:24:49 +01:00
TW ddecd4b618
Merge pull request #3182 from TBurchfield/master
Removal of |project_name|.
2017-11-01 02:41:02 +01:00
TW c640e3815b
Merge pull request #3236 from narendravardi/borg_config_dir_documentation
Added documentation for BORG_CONFIG_DIR
2017-10-30 06:49:43 +01:00
narendravardi 764a62f42c Added documentation for BORG_CONFIG_DIR 2017-10-29 21:52:33 +05:30
Milkey Mouse 87a9952f3b
Clarify using a blank passphrase in keyfile mode 2017-10-25 19:42:02 -07:00
Svein Ove Aas 98443f15d5 Add Nix/NixOS install command 2017-10-20 17:08:10 +01:00
8bit 8d830d069f Removed all |project_name
| instances, replaced with Borg
2017-10-17 11:50:55 -05:00
Thomas Waldmann e674822888 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.
2017-10-17 18:34:32 +02:00
Thomas Waldmann ed1a8b5cf1 add example showing --show-version --show-rc 2017-10-12 06:03:12 +02:00
Fabio Pedretti bc42f58c04 use --format rather than --list-format in examples, the latter is
deprecated
2017-10-09 14:09:43 +02:00
Thomas Waldmann 62e0f7a64e manpage: fix typos, update homepage 2017-10-07 03:34:03 +02:00
Thomas Waldmann fe08437337 faq: we do not implement futile attempts of ETA / progress displays 2017-10-05 22:19:39 +02:00
Timothy Burchfield 21601d5f53 Quickstart guide minor corrections (#3084)
quickstart: minor grammar correction and added consistency with substitution of 'Borg'
2017-10-03 23:18:33 +02:00
Thomas Waldmann 5e2de8ba67 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)
2017-10-01 00:52:32 +02:00
Alexander Meshcheryakov f7ec13eabb 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.
2017-09-25 15:43:07 +03:00
Thomas Waldmann 112bf43956 docs: twitter account @borgbackup, fixes #2948 2017-09-22 23:36:48 +02:00
Thomas Waldmann d8766df998 docs: add note about metadata dedup and --no[ac]time, fixes #2518 2017-09-22 23:08:33 +02:00
Thomas Waldmann 3f16d91fd3 docs: add auto compression example to borg create examples 2017-09-21 14:00:50 +02:00
Thomas Waldmann 0ec6c920b9 docs: add compressor names to be more clear 2017-09-21 04:28:35 +02:00
Thomas Waldmann c88528512f fix docs: --compression lz4 is the default now, fixes #3034 2017-09-21 04:26:52 +02:00
TW 133e847f8e document utf-8 locale requirement for json mode, #2273 (#3009) 2017-09-08 08:31:51 +02:00
Markus Engelbrecht e157328228 Use correct casing for macOS 2017-09-03 20:04:28 +02:00
Markus Engelbrecht aadb9cd2ee Fix macOS keychain integration command 2017-09-03 20:03:11 +02:00