mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
7,402 Commits 9 Branches 137 Tags 57 MiB
Commit Graph

256 Commits

Author SHA1 Message Date
Thomas Waldmann 9c380405a2 build_usage 2019-03-21 21:11:18 +01:00
Thomas Waldmann 9507856049 build_usage 2019-03-11 00:11:16 +01:00
TW d7c6399396
Merge pull request #4384 from milkey-mouse/append-only-docs-3504 
Elaborate on append-only mode docs
 2019-03-10 15:04:23 +01:00
Thomas Waldmann 7ad5290501 redo stale lock handling, fixes #3986 
drop BORG_HOSTNAME_IS_UNIQUE (please use BORG_HOST_ID if needed)

borg now always assumes it has a unique hostid - either automatically
from fqdn plus uuid.getnode() or overridden via BORG_HOST_ID.
 2019-03-04 21:07:05 +01:00
Thomas Waldmann bece7e8090 build_usage 2019-02-24 20:39:42 +01:00
Milkey Mouse cb2b86274e
Elaborate on append-only mode docs 2019-02-22 19:05:29 -08:00
Thomas Waldmann 7f46eb99aa update docs about fixed chunker and chunker algo spec needed 2019-02-13 06:30:13 +01:00
Thomas Waldmann a8d52351bb update man pages / usage docs 2018-07-14 14:56:29 +02:00
Thomas Waldmann e6fcf4ea42 update docs about separated compaction 2018-07-14 14:53:23 +02:00
Saurav Sachidanand b3c1104760 Update docs on deleting multiple archives 2018-05-27 09:38:23 +05:30
infectormp 60f9849336 docs: Improve borg with-lock (#3780) 
docs: improve borg with-lock, link to FAQ
 2018-04-19 15:29:47 +02:00
Thomas Waldmann 451b22ee51 docs: extend append-only repo rollback docs, fixes #3579 2018-03-09 23:27:31 +01:00
Gianfranco Costamagna 0980d6ac43 fixup allows one to, with suggestions from Dan Christensen 2018-01-03 15:54:52 +01:00
Gianfranco Costamagna 111a19f7fa fix typo: allows to -> allows one to 2018-01-03 11:42:38 +01:00
Gianfranco Costamagna 1a74326b5a borg: fix typo: explicitely -> explicitly 2018-01-03 11:42:30 +01:00
Gregor Kleen 85fb38e2f3 Add placeholder for fqdn in reverse notation 2017-12-11 23:00:38 +01:00
Thomas Waldmann ce92960c63 add auto-generated docs for borg config 
also: move a bit upwards in the use docs
(cherry picked from commit 278ed640e9)
 2017-12-09 13:43:36 +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 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 73fac09dda build_usage (master) 
also: add new borgfs.rst.inc
 2017-11-25 14:35:52 +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
Milkey Mouse 17d5c794d3
Generate man page for borgfs (fixes #3216) 2017-11-10 11:25:19 -08: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 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
Marian Beermann 2ff4550d4b docs: tar: tarpipe example 2017-07-26 10:40:35 +02:00
Thomas Waldmann 43ecde1bde python setup.py build_usage 2017-07-23 17:12:01 +02:00
enkore a61462693a docs: recreate: fix wrong "remove unwanted files" example 2017-07-21 11:51:46 +02:00
TW 26bc80f210 Merge pull request #2818 from takluyver/i2815 
Use code markup for command line option headings
 2017-07-15 17:01:05 +02:00
Thomas Kluyver ae2a1b8135 Name backup directories with 'before-upgrade' 
Closes gh-2811
 2017-07-15 16:23:08 +02:00
Thomas Kluyver 0fcdb97f5d Fix cross reference 2017-07-15 15:03:46 +02:00
Thomas Kluyver 84940e32b2 Use code markup for command line options 
Closes gh-2815
 2017-07-15 15:02:41 +02:00
Marian Beermann 946f1a4eec docs: mount: show usage of archive filters 
this is pretty vital, since the versions view is basically
useless without them.
 2017-07-02 22:15:14 +02:00
Thomas Waldmann 51458b6b58 FUSE versions view: keep original file extension at end, fixes #2769 
some tools depend on seeing the correct file extension to operate
correctly, so put our version to the left of the file extension.
 2017-07-02 19:11:24 +02:00
Marian Beermann 52f76d2cd6 docs: mount: add repository example 2017-06-30 10:54:18 +02:00
Marian Beermann 4009a764ed docs: info: update and add examples 
The form of the output has changed and
new output has been added.
 2017-06-29 11:49:27 +02:00
Marian Beermann 310a9b3486 docs: prune: fix include path 2017-06-23 19:17:18 +02:00
rugk e967edad98 Include prune example in doc 2017-06-23 19:17:18 +02:00
enkore 64be888e60 Merge pull request #2736 from rugk/docs-sshrestrict 
Fix typo
 2017-06-23 19:12:01 +02:00
rugk 6051969df8
Fix typo 2017-06-23 16:54:02 +02:00
enkore 36d22ae240 Merge pull request #2732 from rugk/docs-sshrestrict 
Simplify ssh authorized_keys file
 2017-06-23 16:16:34 +02:00
rugk 5b0b4f4b00
Remove unneccessary space 2017-06-23 14:52:11 +02:00
rugk 41248bbab1
Add legacy note & normalize order 2017-06-23 14:50:00 +02:00
rugk b27b9894d1
Simplify ssh authorized_keys file 
Just using "restrict"; closes https://github.com/borgbackup/borg/issues/2121
 2017-06-23 13:28:49 +02:00
Marian Beermann 771168a3af docs: extract: move cwd note to --help 2017-06-21 00:16:25 +02:00
Marian Beermann a9059a64bd docs: use DOM ready event, not document loaded event 2017-06-20 15:48:30 +02:00
Marian Beermann 9d33ff1720 docs: skip empty option groups 2017-06-20 15:30:20 +02:00
Marian Beermann e869e7dc2f ran build_usage 2017-06-20 15:23:52 +02:00
Marian Beermann a1a92bf00f docs: less space waste following "Common options" 2017-06-20 11:53:36 +02:00
Marian Beermann e5012b11ca ran build_usage 2017-06-20 11:49:26 +02:00
Marian Beermann c7dda0aca9 docs: assorted formatting fixes 2017-06-18 12:12:50 +02:00
Marian Beermann 125b02c5c8 docs: list: fix unintended block quote 2017-06-18 02:10:10 +02:00
Marian Beermann 48e815883f docs: usage: fix unintended block quota in common options 2017-06-18 02:07:37 +02:00
Marian Beermann 0288fff6b7 docs: explain formatting 2017-06-17 14:29:56 +02:00
Marian Beermann 772be8fa97 python setup.py build_usage 2017-06-17 12:28:42 +02:00
Marian Beermann 5aa865c8d8 docs: double backticks for --options 2017-06-17 12:27:53 +02:00
enkore eb6deb9b05 Merge pull request #2642 from enkore/docs/deployment-local 
docs: deployment: Automated backups to a local hard drive
 2017-06-11 20:47:57 +02:00
Marian Beermann 501859ca33 docs: less bothersome experimental stripes 2017-06-11 20:46:53 +02:00
Marian Beermann 221dc1c4c7 normalize authenticated key modes 
rename authenticated to authenticated-blake2, consistent with the other
blake2 key modes

add authenticated mode that fills the blank and is consistent with the
other "unqualified" key modes
 2017-06-11 18:07:09 +02:00
enkore 33a7331bda Merge pull request #2643 from enkore/f/experimental-patterns 
mark --pattern, --patterns-from as experimental
 2017-06-10 17:15:22 +02:00
Marian Beermann 4cd1cc6a28 docs: correct create exclude comment 2017-06-10 12:06:18 +02:00
rugk 4987c04e5b
Remove re docs 
Fixes https://github.com/borgbackup/borg/issues/2458
 2017-06-10 11:57:06 +02:00
Marian Beermann 5cab72035a mark --pattern, --patterns-from as experimental 2017-06-10 10:29:02 +02:00
Marian Beermann 827c478500 nanorst for "borg help TOPIC" 2017-06-10 10:29:02 +02:00
Andrea Gelmini e4247cc0d2 Fix typos 2017-06-09 16:49:30 +02:00
Marian Beermann 3664adb95d docs: highlight experimental features in online docs 2017-06-09 14:19:55 +02:00
Marian Beermann 0d6064e7f3 docs: fix build_man for relocated examples 2017-06-07 16:29:37 +02:00
Marian Beermann 13adc80cde docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-07 00:44:53 +02:00
Marian Beermann 22311abe02 docs: usage: add benchmark page 
Previously, benchmark crud was not contained in the usage pages
at all.
 2017-06-07 00:42:43 +02:00
Marian Beermann 8fb7db71bc docs: split usage 2017-06-07 00:38:48 +02:00
Marian Beermann 4edf77788d Implement storage quotas 2017-05-31 18:36:03 +02:00
enkore 226d1f6094 Revert "docs: borg_domain for custom priority index entries" 2017-05-22 20:45:29 +02:00
Marian Beermann 7284413e3f docs: borg_domain for custom priority index entries 2017-05-22 20:08:11 +02:00
Marian Beermann 384d7635a4 docs: add systemd warning regarding placeholders 2017-05-21 17:22:29 +02:00
Marian Beermann b7a6ac94c3 docs: ran build_man, build_usage 2017-05-17 11:52:48 +02:00
enkore 5788219ff4 borg export-tar (#2519) 2017-05-17 00:09:41 +02:00
Thomas Waldmann 3c279dbf78 ran build_usage 2017-04-30 01:31:20 +02:00
Thomas Waldmann 251983a741 ran setup.py build_usage 2017-03-27 01:45:45 +02:00
Marian Beermann 95b69a433c docs: usage: remove not-updated-anymore debug* files. 2017-02-12 18:51:41 +01:00
Marian Beermann 96fa1e8414 docs: define "ours" merge strategy for auto-generated files 2017-02-12 18:51:40 +01:00
Marian Beermann fa24e1f38f man pages: add borg(1) master/intro page 2017-02-12 15:28:59 +01:00
Marian Beermann 5fe32866e6 Move migrate-to-repokey to the "key" command group 2017-02-04 15:10:45 +01:00
Thomas Waldmann e19537ff6f ran build_usage 2017-01-29 05:54:25 +01:00
Thomas Waldmann e32503b84c ran setup.py build_usage 2017-01-15 02:10:55 +01:00
Marian Beermann e0e5bc4aa4 ran build_usage 2016-12-20 23:09:28 +01:00
Thomas Waldmann 82cd1fd392 run setup.py build_usage 2016-12-14 03:42:38 +01:00
Thomas Waldmann c855c687eb Merge branch '1.0-maint' 2016-12-14 03:33:53 +01:00
Marian Beermann 288cac788c setup.py: build_usage: don't generate includes for debug commands 2016-12-02 13:28:49 +01:00
Thomas Waldmann 4746d20534 ran build_usage 
had merge conflicts in the usage files, decided to just recreate them afterwards.
 2016-11-28 02:25:56 +01:00
Thomas Waldmann 5de31f57e5 ran build_usage 2016-11-27 02:33:57 +01:00
Thomas Waldmann afab1cc9b0 Merge branch '1.0-maint' 
# Conflicts:
#	borg/platform.py
#	src/borg/archiver.py
#	src/borg/helpers.py
#	src/borg/platform/darwin.pyx
#	src/borg/platform/freebsd.pyx
#	src/borg/platform/linux.pyx
#	src/borg/testsuite/__init__.py
 2016-11-17 23:56:34 +01:00
Thomas Waldmann e17fe2b295 borg umount, fixes #1855 
this refactors umount code we already used for the testsuite into the platform module's namespace.

also, it exposes that functionality via the cli api, so users can use it via "borg umount <mountpoint>",
which is more consistent than using borg to mount and fusermount -u (or umount) to un-mount.
 2016-11-17 20:16:28 +01:00
Thomas Waldmann 8a15916284 Merge branch '1.0-maint' into merge-1.0-maint 
# Conflicts:
#	docs/changes.rst
#	docs/usage/help.rst.inc
#	src/borg/cache.py
#	src/borg/remote.py
#	src/borg/testsuite/__init__.py
#	src/borg/testsuite/archiver.py
 2016-10-31 18:24:13 +01:00
Thomas Waldmann 84637322f2 ran build_usage 2016-10-29 01:58:21 +02:00
Thomas Waldmann 3550b24ed9 ran build_usage 2016-10-17 03:59:47 +02:00
Thomas Waldmann 0411512750 ran build_usage 2016-10-01 18:23:36 +02:00
textshell b84014e7d9 archiver: Add documentation for "key export" and "key import" commands. (#1641) 
archiver: Add documentation for "key export" and "key import" commands
 2016-09-27 15:24:31 +02:00
Thomas Waldmann 83c99943c3 ran build_usage 2016-08-28 00:17:24 +02:00
Thomas Waldmann 6da34fcc5a add debug-info usage help file 2016-08-22 00:14:11 +02:00
Thomas Waldmann a7c370b5ed add debug-info usage help file 2016-08-21 23:37:07 +02:00
Thomas Waldmann c955d59273 Merge branch '1.0-maint' 2016-08-09 20:09:13 +02:00
Thomas Waldmann 6c1c87f7ae add forgotten usage help file from build_usage 2016-08-06 01:28:02 +02:00
Thomas Waldmann a56b010960 ran build_usage 2016-08-05 20:26:09 +02:00
Marian Beermann 2e6eb63174
Merge branch '1.0-maint' into master 2016-07-14 01:28:26 +02:00
Thomas Waldmann bbb280c129 ran build_usage 2016-07-12 23:10:13 +02:00
Thomas Waldmann 3baa8a3728 Merge branch '1.0-maint' 
# Conflicts:
#	docs/changes.rst
#	docs/usage/mount.rst.inc
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/fuse.py
#	src/borg/testsuite/archiver.py
 2016-07-11 01:23:27 +02:00
Thomas Waldmann b8198c4ff1 ran build_usage 2016-07-10 19:00:55 +02:00
Thomas Waldmann 2f21488e81 fix most python-source related sphinx warnings 2016-07-10 17:26:04 +02:00
Thomas Waldmann fe627246e4 Merge branch '1.0-maint' 2016-07-08 12:13:52 +02:00
Thomas Waldmann 3218c5945a ran build_api / build_usage 2016-07-07 05:04:19 +02:00
Thomas Waldmann 12f55f4e9f Merge branch '1.0-maint' 2016-07-06 01:33:53 +02:00
Thomas Waldmann 740c638030 update usage files 2016-07-05 23:30:08 +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
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 f363ddd7ca Merge branch '1.0-maint' 2016-07-04 20:11:21 +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
Abogical 6658112f8c Add documentation for listing repository archives 2016-06-21 20:01:01 +03:00
Michael Herold d45a13babf Changes archive format from uuid to uuid4 
This allows for future support of other uuid versions
 2016-06-11 22:57:03 +02:00
Michael Herold 5aa97e283c Adds uuid to archive format tags 2016-06-11 12:03:55 +02:00
Thomas Waldmann b8303a38bf Merge branch '1.0-maint' 2016-05-20 22:48:57 +02:00
Thomas Waldmann 8d8374d23c ran build_api + build_usage 2016-05-20 14:34:48 +02:00
Thomas Waldmann 962c2e9d54 borg with-lock REPO CMD ARGS 2016-05-02 23:29:17 +02:00
Marian Beermann 0bc0fa22b4
recreate: improve tests, docs, check chunk availability[1] 
[1] So if e.g. delete/prune/check are run these can delete the
    recreate_partial_chunks. This is now caught and handled correctly.
 2016-04-10 15:59:12 +02:00
Marian Beermann 4b5e6ffa77
Assimilate "borg comment" into "borg recreate" 2016-04-10 14:09:09 +02:00
Marian Beermann a3ee9d2c5f borg recreate: Re-create existing archives. 
Use with caution: permanent data loss by specifying incorrect patterns
is easily possible. Make a dry run to make sure you got everything right.

borg recreate has many uses:
- Can selectively remove files/dirs from old archives, e.g. to free
  space or purging picturarum biggus dickus from history
- Recompress data
- Rechunkify data, to have upgraded Attic / Borg 0.xx archives deduplicate
  with Borg 1.x archives. (Or to experiment with chunker-params for
  specific use cases

It is interrupt- and resumable.

Chunks are not freed on-the-fly.
Rationale:
  Makes only sense when rechunkifying, but logic on which new chunks to
  free what input chunks is complicated and *very* delicate.

Future TODOs:
- Refactor tests using py.test fixtures
  -- would require porting ArchiverTestCase to py.test: many changes,
     this changeset is already borderline too large.
- Possibly add a --target option to not replace the source archive
  -- with the target possibly in another Repo
     (better than "cp" due to full integrity checking, and deduplication
      at the target)
- Detect and skip (unless --always-recompress) already recompressed chunks

Fixes #787 #686 #630 #70 (and probably some I overlooked)
Also see #757 and #770
 2016-04-10 13:54:44 +02:00
Marian Beermann 0a369c0985
Better help texts and Sphinx reproduction of usage 
- Group options
- Nicer list of options in Sphinx
- Deduplicate 'Common options'
  (including --help)

The latter is done by explicitly declaring --help in the common_parser,
which is then inherited by the sub-parsers; no change in observable
behaviour.
 2016-04-10 01:28:19 +02:00
Thomas Waldmann cece7f9e6d merged 1.0-maint into master 2016-04-10 01:13:35 +02:00
Thomas Waldmann d5d037b97d ran build_api build_usage 2016-04-08 23:38:46 +02:00
Lauri Niskanen 327c7219df Add archive comments 
- Archives now have a new metadata field 'comment'
- 'info' command shows a comment if it's present
- 'create' command now has option '--comment' for adding comments to archives.
- A new command 'comment' is added for modifying the comments on existing
  archives.

Resolves #842.
 2016-04-08 19:03:14 +03:00
Lauri Niskanen 9d1a30c08b Add '--sort' option for sorting diff command output 
Previously, on 'borg diff', the output always had first the modifications, then
additions, and finally removals. Output may be easier to follow if the various
kinds of changes are interleaved. This commit is a simple solution that first
collects the output lines and sorts them by file path before printing. This new
behavior is optional and disabled by default. It can be enabled with '--sort'
command line option.

This option will be especially useful after the planned multi-threading changes
arrive. Multi-threading may shuffle the archive order of files making diff
output hard to follow without sorting.

Resolves #797.
 2016-03-31 18:55:02 +03:00
Marian Beermann 9cf129935e borg diff help: clarify: for new archives different chunker params still require content compare 2016-03-18 15:42:32 +01:00
Marian Beermann e64d91b735 Update borg diff help message regarding --same-chunker-params 2016-03-18 13:30:39 +01:00
Marian Beermann 343d84b427 ItemFormatter: group keys in help output 2016-03-18 13:29:49 +01:00
Marian Beermann 89120a9843 Update usage docs 2016-03-18 12:17:57 +01:00
Daniel Reichelt 9adf13d8b9 add changes from running build_api and build_usage 2016-03-17 14:35:56 +01:00
Daniel Reichelt e1f6a34820 provide wrapper for borg mount, fixes #743 
- add archiver.main_mount()

- provide borgfs behaviour when the monolithic binary is called via a
  symlink called borgfs

- docs: update usage of mount subcommand, provide examples for borgfs and
  add symlink creation to standalone binary installation

- run build_usage

- add entry point in setup.py

- patch helpers.py:get_keys_dir() to allow mounting fstab entries with
  "user" option set

  Without this, setuid() called at some point by mount changes the HOME
  environment variable to '/root' and os.expanduser('~') would return
  '/root' as well, thus the mount would fail with
 	 PermissionError: [Errno 13] Permission denied: '/root/.config'
  After setuid(), the HOME variable stays intact, so we still can
  explicitly query USER's home.

  Also, os.path.expanduser() behaves differently for '~' and '~someuser'
  as parameters: when called with an explicit username, the possibly set
  environment variable HOME is no longer respected. So we have to check if
  it is set and only expand the user's home directory if HOME is unset.

- add myself to AUTHORS
 2016-03-17 01:40:17 +01:00
Thomas Waldmann 3ae8a95935 ran build_api and build_usage 2016-02-27 20:55:14 +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 316f5a345f docs: borg upgrade also handles borg 0.xx -> 1.0 2016-02-07 19:23:06 +01:00
Thomas Waldmann c42f3d07f4 run build_usage 2016-02-07 14:50:39 +01:00
Thomas Waldmann dee1d462cc ran setup.py build_usage 2016-01-23 20:54:20 +01:00
Thomas Waldmann 2ecfa54aee ran build_api and build_usage 2015-12-13 15:47:03 +01:00
Thomas Waldmann f7abff87f9 ran build_usage 2015-12-08 10:21:20 +01:00
Antoine Beaupré 8e36075fe9 commit usage files directly into git 
the generation of those files was causing us way too much pain to
justify automatically generating them all the time.

those will have to be re-generated with `build_api` or `build_usage`
as appropriate, for example when function signatures or commandline
flags change.

see #384
 2015-11-13 10:42:52 -05:00
Jonas Borgström 052e4f2074 Remove some autogenerated files 2014-02-18 23:10:32 +01:00