Commit Graph

149 Commits

Author SHA1 Message Date
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