Commit Graph

150 Commits

Author SHA1 Message Date
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
Jonas Borgström faedaf8160 Basic repository consistency check functionality.
Still no archive metadata validation or repair functionality.
2014-02-05 00:04:30 +01:00
Dan Christensen 6b639e4c22 Update prune docs and a few other things in usage.rst. 2014-02-03 20:11:47 -05:00
Jonas Borgström 530dfd1558 Documentation update 2013-10-03 21:00:54 +02:00
Jonas Borgström a51a10a96c More documentation improvements. 2013-08-04 23:20:22 +02:00
Jonas Borgström a35339f2c2 Renamed commands.rst to usage.rst 2013-08-04 21:23:12 +02:00
Jonas Borgström b6c8392c03 More documentation work 2013-08-03 13:05:06 +02:00