Thalian
2a90cbb5ef
docs: fix borg.1 manpage generation regression, #5211
...
To do: Fix Sphinx build warning "document isn't included in any toctree".
fixes #5211
2020-06-28 15:23:52 +02:00
Thomas Waldmann
29bd87d224
build_usage
2020-06-06 01:57:48 +02:00
Thomas Waldmann
2b1aa46d15
docs: clarify borg init's encryption modes
2020-04-21 12:06:08 +02:00
finefoot
89791c6f84
Add option to bypass locking mechanism
2020-04-11 20:34:30 +02:00
finefoot
ba83b4a539
Update prevalence of env vars to set config and cache paths
2020-04-02 00:00:09 +02:00
Thalian
b90a977ace
[DOCS] #4587 – Make Sphinx warnings break docs build
...
Backport from master and some other fixes for Sphinx warnings.
2020-03-22 16:01:28 +01:00
Thomas Waldmann
8a325ae3cc
build_usage
2020-03-07 22:40:04 +01:00
ntova
ca87539e4f
Fix various code blocks in the docs ( #4708 )
...
Fix various code blocks in the docs
- rst markup: put codeblock markup on separate line to make it better visible / separate it from normal text colons.
- borg help texts in archiver.py: put codeblock markup instead of colon - that way it looks like a single colon when using the cli help and also works as code block markup.
2019-08-09 23:35:01 +02:00
Thomas Waldmann
f2a39166d8
fix bad reference to borg compact (does not exist in 1.1), fixes #4660
...
introduced in 897b593ec4
2019-08-09 20:55:35 +02:00
Tiago Donato
bc2642a0cd
Update documentation of borg create
...
borg create examples within documentation mention 1.1 as a future version of borg.
2019-07-17 10:55:24 -05:00
Elmar Hoffmann
584367a119
fix spelling
2019-06-22 18:03:57 +02:00
TW
b2ea4e77ee
Merge pull request #4609 from ThomasWaldmann/1.1-fixes
...
cosmetic fixes (1.1)
2019-06-09 14:41:24 +02:00
Thomas Waldmann
f072a3579e
remove superfluous whitespace in docs
2019-06-08 17:56:58 +02:00
Thomas Waldmann
2f1f73c92c
build_usage
2019-05-16 02:37:58 +02:00
Mike Nye
016942a222
modified: serve.rst
...
Add "SSH Configuration" section to "borg serve" documentation, to outline ssh/sshd configuration to prevent borg serve keeping a lock on a repo in the event the ssh connection is abnormally disconnected.
In response to issues #3988 , #636 and #4485 (and probably others).
Backported from master.
2019-04-09 08:57:38 +08:00
Milkey Mouse
897b593ec4
Elaborate on append-only mode docs
2019-03-10 18:09:46 -07:00
Thomas Waldmann
be2bc78d69
build_usage
2019-02-10 21:20:32 +01:00
Thomas Waldmann
43e608af1d
build_usage
2018-12-08 23:54:16 +01:00
Thomas Waldmann
163356db56
build_usage
2018-08-11 18:05:09 +02:00
Thomas Waldmann
7b6e5009b3
build_usage
2018-06-11 01:55:37 +02:00
Thomas Waldmann
238dedd156
python setup.py build_usage
2018-03-30 00:33:38 +02:00
Thomas Waldmann
2f443cae73
docs: extend append-only repo rollback docs, fixes #3579
...
(cherry picked from commit 451b22ee51
2018-03-17 21:12:41 +01:00
Thomas Waldmann
9b4202fd48
build_usage
2017-12-30 01:58:32 +01:00
Gregor Kleen
dbf8d582f9
Add placeholder for fqdn in reverse notation
...
(cherry picked from commit 85fb38e2f3
2017-12-15 00:56:31 +01:00
Thomas Waldmann
278ed640e9
add auto-generated docs for borg config
...
also: move a bit upwards in the use docs
2017-12-09 13:41:03 +01:00
Thomas Waldmann
d373772517
build_usage
2017-11-27 00:02:36 +01:00
Thomas Waldmann
25b40a261b
docs: give examples for borg mount exclusion options
...
(cherry picked from commit 0eaec60384
2017-11-26 04:04:42 +01:00
Thomas Waldmann
ef39dc6554
docs: move bsdflags tuning comments to notes docs section
...
the atime comments are already there.
(cherry picked from commit 91ff2f81a6
2017-11-26 04:04:20 +01:00
Thomas Waldmann
938d122191
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.
(cherry picked from commit f2a1539f25
2017-11-26 04:03:16 +01:00
TW
26cfaf3681
Merge pull request #3359 from milkey-mouse/borg-config-cmd-bp1.1
...
Add borg config command (1.1 backport)
2017-11-26 03:56:01 +01:00
Thomas Waldmann
7bf838003a
build_usage (1.1-maint)
...
also: git add borgfs.rst.inc
2017-11-25 14:45:28 +01:00
Milkey Mouse
2ac0bf4980
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-24 16:38:56 -08:00
TW
9f9cb88a01
Merge pull request #3311 from milkey-mouse/borgfs-man-bp1.1
...
Generate usage & man page for borgfs (1.1-maint)
2017-11-14 00:28:59 +01:00
Milkey Mouse
eadb74eb6f
Generate man page for borgfs ( fixes #3216 )
2017-11-12 15:06:08 -08:00
Thomas Waldmann
851e85b426
build_usage
2017-11-05 23:09:14 +01:00
Thomas Waldmann
f53bd78b33
build_usage
2017-10-22 03:18:40 +02:00
TW
17ce2f728a
Merge pull request #3155 from ThomasWaldmann/maincommand-help-1.1
...
maincommand help 1.1
2017-10-13 01:45:19 +02:00
Thomas Waldmann
fcaf764604
add example showing --show-version --show-rc
...
(cherry picked from commit ed1a8b5cf1
2017-10-12 23:34:23 +02:00
Fabio Pedretti
0e44f07b88
use --format rather than --list-format in examples, the latter is
...
deprecated
(cherry picked from commit bc42f58c04
2017-10-11 01:13:12 +02:00
Thomas Waldmann
0263c9dd8a
build_usage
2017-10-01 02:24:54 +02:00
TW
fa66015cb3
Merge pull request #3054 from ThomasWaldmann/update-create-docs-1.1
...
Update create docs (1.1-maint)
2017-09-23 23:45:02 +02:00
Thomas Waldmann
cfc48d2899
docs: add auto compression example to borg create examples
...
(cherry picked from commit 3f16d91fd3
2017-09-23 23:42:02 +02:00
Thomas Waldmann
c616009724
docs: add compressor names to be more clear
...
(cherry picked from commit 0ec6c920b9
2017-09-23 23:41:46 +02:00
Thomas Waldmann
354d3f0b4f
fix docs: --compression lz4 is the default now, fixes #3034
...
(cherry picked from commit c88528512f
2017-09-23 23:41:27 +02:00
Thomas Waldmann
eacea02d8c
docs: add note about metadata dedup and --no[ac]time, fixes #2518
...
(cherry picked from commit d8766df998
2017-09-23 21:30:42 +02:00
Thomas Waldmann
2d7dc08c8c
build_usage
2017-09-10 00:07:45 +02:00
Thomas Waldmann
9f61747dae
python setup.py build_usage
2017-08-27 22:17:55 +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
