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