borg/docs/usage
Thomas Waldmann b8bb0494f6 create --sparse, file map support for the "fixed" chunker, see #14
a file map can be:

- created internally inside chunkify by calling sparsemap, which uses
  SEEK_DATA / SEEK_HOLE to determine data and hole ranges inside a
  seekable sparse file.
  Usage: borg create --sparse --chunker-params=fixed,BLOCKSIZE ...
  BLOCKSIZE is the chunker blocksize here, not the filesystem blocksize!

- made by some other means and given to the chunkify function.
  this is not used yet, but in future this could be used to only read
  the changed parts and seek over the (known) unchanged parts of a file.

sparsemap: the generate range sizes are multiples of the fs block size.
           the tests assume 4kiB fs block size.
2020-12-27 22:06:08 +01:00
..
general docs: add another case of attempted hardlink usage 2020-12-26 00:04:24 +01:00
benchmark.rst docs: usage: add benchmark page 2017-06-07 00:42:43 +02:00
benchmark_crud.rst.inc build_usage 2019-09-07 00:27:17 +02:00
borgfs.rst [DOCS] #4587 – Make Sphinx warnings break docs build 2020-03-16 19:06:00 +01:00
borgfs.rst.inc build_usage (master) 2017-11-25 14:35:52 +01:00
break-lock.rst.inc python setup.py build_usage 2017-07-23 17:12:01 +02:00
change-passphrase.rst.inc build_usage (master) 2017-11-25 14:35:52 +01:00
check.rst
check.rst.inc build_usage 2020-10-04 20:32:38 +02:00
common-options.rst.inc build_usage 2020-10-04 20:32:38 +02:00
compact.rst compact: move --cleanup-commits description from examples to docs 2019-05-06 23:10:07 +02:00
compact.rst.inc build_usage 2020-04-12 19:51:49 +02:00
config.rst Add borg config command (fixes #3304) 2017-11-23 14:51:54 -08:00
config.rst.inc build_usage 2019-09-07 00:27:17 +02:00
create.rst create --sparse, file map support for the "fixed" chunker, see #14 2020-12-27 22:06:08 +01:00
create.rst.inc build usage 2020-12-06 20:44:59 +01:00
debug.rst
delete.rst Add a --list switch to borg delete (#5503) 2020-12-11 19:11:47 +01:00
delete.rst.inc build_usage 2020-04-12 19:51:49 +02:00
diff.rst
diff.rst.inc build_usage 2019-02-24 20:39:42 +01:00
export-tar.rst.inc python setup.py build_usage 2017-07-23 17:12:01 +02:00
extract.rst docs: extract: move cwd note to --help 2017-06-21 00:16:25 +02:00
extract.rst.inc build_usage 2020-04-12 19:51:49 +02:00
general.rst Merge pull request #5048 from finefoot/patch-8 2020-04-11 22:18:37 +02:00
help.rst
help.rst.inc build usage 2020-12-06 20:44:59 +01:00
info.rst docs: info: update and add examples 2017-06-29 11:49:27 +02:00
info.rst.inc build_usage 2019-09-07 00:27:17 +02:00
init.rst docs: clarify borg init's encryption modes 2020-04-16 21:35:33 +02:00
init.rst.inc build_usage 2020-04-21 22:56:55 +02:00
key.rst allow key-import+BORG_KEY_FILE to create key files 2020-06-04 19:29:15 -07:00
key_change-passphrase.rst.inc build_usage (master) 2017-11-25 14:35:52 +01:00
key_export.rst.inc fix typo: allows to -> allows one to 2018-01-03 11:42:38 +01:00
key_import.rst.inc build_usage 2020-10-04 20:32:38 +02:00
key_migrate-to-repokey.rst.inc python setup.py build_usage 2017-07-23 17:12:01 +02:00
list.rst add example for excluding content using the --pattern cmd line arg (#5456) 2020-10-28 23:32:40 +01:00
list.rst.inc build_usage 2020-10-04 20:32:38 +02:00
lock.rst
mount.rst docs: give examples for borg mount exclusion options 2017-11-25 20:18:59 +01:00
mount.rst.inc build_usage 2020-04-12 19:51:49 +02:00
notes.rst --umask is for the local borg process only, fixes #4947 2020-06-14 18:35:03 +02:00
prune.rst update docs about separated compaction 2018-07-14 14:53:23 +02:00
prune.rst.inc build_usage 2020-10-04 20:32:38 +02:00
recreate.rst docs: recreate: fix wrong "remove unwanted files" example 2017-07-21 11:51:46 +02:00
recreate.rst.inc build_usage 2020-10-04 20:32:38 +02:00
rename.rst
rename.rst.inc docs: use DOM ready event, not document loaded event 2017-06-20 15:48:30 +02:00
serve.rst remove superfluous whitespace in docs 2019-06-09 14:45:18 +02:00
serve.rst.inc build_usage 2019-02-24 20:39:42 +01:00
tar.rst docs: fix examples with problematic option placements, fixes #3356 2017-11-25 19:29:34 +01:00
umount.rst.inc docs: use DOM ready event, not document loaded event 2017-06-20 15:48:30 +02:00
upgrade.rst Name backup directories with 'before-upgrade' 2017-07-15 16:23:08 +02:00
upgrade.rst.inc build_usage 2019-09-07 00:27:17 +02:00
usage_general.rst.inc [DOCS] #4587 – Make Sphinx warnings break docs build 2020-03-16 19:22:59 +01:00
with-lock.rst.inc build_usage 2019-02-24 20:39:42 +01:00