Thomas Waldmann
a16c7d8e16
mention file://
2016-10-28 05:04:23 +02:00
Thomas Waldmann
ca15cc80e5
document repo URLs / archive location
2016-10-28 04:43:33 +02:00
Thomas Waldmann
c000eb8083
add clarification about append-only mode, fixes #1689
2016-10-19 02:31:39 +02:00
Thomas Waldmann
a65707beb8
add more specific warning about write-access debug commands
2016-09-30 21:09:02 +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
f70008238a
link reference docs and faq about BORG_FILES_CACHE_TTL, fixes #1561
2016-09-03 19:23:59 +02:00
Thomas Waldmann
6e658a5a6c
docs: improve prune examples
2016-08-10 15:45:57 +02:00
Thomas Waldmann
5f7b466969
implement BORG_FILES_CACHE_TTL, update FAQ
...
raise default ttl to 20 (previously: 10).
2016-07-31 01:33:46 +02:00
Thomas Waldmann
cf4d761042
docs: fix the highlighting
...
default is "python", that's why some help fragments and bash scripts looked strange.
2016-07-11 23:16:53 +02:00
Thomas Waldmann
1fe3781186
backport some FAQ entries from master branch
2016-07-07 21:56:06 +02:00
Thomas Waldmann
3325126988
add missing BORG_REMOTE_PATH env var, fixes #1258
2016-07-04 15:06:20 +02:00
Thomas Waldmann
d59a1d5fef
doc and help update for --read-special
2016-07-04 14:06:30 +02:00
Lee Bousfield
c515d6018d
Add --append-only to borg serve
...
Fixes #1168
2016-06-30 17:58:36 -04:00
Thomas Waldmann
c773c882b9
add prune visualization / example, fixes #723
2016-06-27 21:20:35 +02:00
Thomas Waldmann
5ae340998c
update docs about placeholders
2016-06-22 08:40:31 +02:00
Thomas Waldmann
9e09786b33
borg create help: document format tags, fixes #894
...
docs: rephrased, more useful examples
2016-05-05 13:38:08 +02:00
Thomas Waldmann
700e715b23
add missing docs for borg break-lock, fixes #992
2016-04-30 00:32:25 +02:00
Thomas Waldmann
43b4fda393
docs: fix confusing usage of "repo" as archive name
2016-04-15 03:38:43 +02:00
Thomas Waldmann
bc854e3e64
docs: use /path/to/repo, fixes #901
...
/mnt/backup was confusing as people like to mount their backup disk on /mnt/backup,
but borg init /mnt/backup does not work if that directory already exists because it is
the mountpoint. it would work, if /mnt was the mountpoint, but that is not obvious
and also unusual.
2016-04-15 03:35:37 +02:00
TW
a519333376
add --warning, --error, --critical for completeness, fixes #826
...
it's not recommended to suppress warnings or errors,
but the user may decide this on his own.
note: --warning is not given to borg serve so a <= 1.0.0 borg
will still work as server. it is not needed as it is the default.
2016-04-03 20:20:48 +02:00
Marian Beermann
8f6ce9051b
append-only mode: docs reformulated
2016-03-31 18:52:40 +02:00
Marian Beermann
effa992d22
append-only mode: use single file for log, disallow check --repair, docs
2016-03-31 18:23:08 +02:00
Thomas Waldmann
95c4cf221d
implement password roundtrip, fixes #695
2016-03-05 16:21:44 +01:00
Thomas Waldmann
af2eaaabd4
update and improve docs
...
use the travis status image as png as svg does not show an image in firefox.
2016-02-27 17:22:56 +01:00
Teemu Toivanen
a94471dc0e
Usage examples for create format tags
2016-02-25 00:41:24 +02:00
Thomas Waldmann
08a7ce5cc3
Merge branch 'feature/list-formatting' of https://github.com/manwegit/borg into feature/list-formatting
2016-02-21 19:15:31 +01:00
Thomas Waldmann
347778b749
docs: add example how to restore a raw device
...
also: do not use /dev/sda in case someone stupidly tries out the examples.
/dev/sdx should be safe for people who do not understand what they do.
2016-02-18 21:38:31 +01:00
Thomas Waldmann
0b44944b47
docs: add examples for delete (and handle delete after list, before prune), fixes #656
2016-02-17 00:30:33 +01:00
jhemmje
bf31fe3173
docs: Updated examples in usage.rst, fixes #644
2016-02-15 21:38:11 +01:00
Mark Lopez
2b8083bb20
Fixed typo.
2016-02-08 19:54:20 -06:00
Mark Lopez
99a3bab68d
Added example to BORG_RSH documentation.
2016-02-07 22:07:30 -06:00
Thomas Waldmann
6c278e2e85
docs: formatting fixed
2016-02-07 19:33:26 +01:00
Teemu Toivanen
14f0fa6f6a
archive file listing output formatting
...
Coding style fixup
Add --list-format exmaple to usage examples
2016-02-05 21:07:04 +02:00
Thomas Waldmann
0a0f483daa
docs about borg serve's special support for forced/original ssh commands, fixes #544
2016-02-01 01:18:37 +01:00
Robin Schneider
a7ed461394
Use --one-file-system
instead of --do-not-cross-mountpoints
in docs.
...
Related to #296 in which support for `--do-not-cross-mountpoints` has
been deprecated.
2016-01-31 11:54:01 +01:00
Thomas Waldmann
e06b7162c2
update docs / docstring about new key location
2016-01-28 23:15:49 +01:00
Thomas Waldmann
824e548b9f
add missing example for --list option of borg create
2016-01-28 20:32:30 +01:00
Thomas Waldmann
1fc99ec9cd
update docs, remove references to passphrase mode
2016-01-24 16:04:00 +01:00
Thomas Waldmann
b2dedee3c8
refactor yes(), cleanup env var semantics, fixes #355
...
refactorings:
- introduced concept of default answer:
if the answer string is in the defaultish sequence, the return value of yes() will be the default.
e.g. if just pressing <enter> when asked on the console or if an empty string or "default" is
in the environment variable for overriding.
if an environment var has an invalid value and no retries are enabled: return default
if retries are enabled, next retry won't use the env var again, but either ask via input().
- simplify:
only one default - this should be a SAFE default as it is used in some special conditions
like EOF or invalid input with retries disallowed.
no isatty() magic, the "yes" shell command exists, so we could receive input even if it is not from a tty.
- clean:
separate retry flag from retry_msg
2016-01-24 16:04:00 +01:00
Thomas Waldmann
169634f2ca
change the builtin default for --chunker-params, create 2MiB chunks, fixes #343
...
one of the biggest issues with borg < 1.0 was that it had a default target chunk
size of 64kiB, thus it created a lot of chunks, a huge chunk management overhead
(high RAM and disk usage).
2016-01-24 15:44:09 +01:00
Thomas Waldmann
a2843bc939
docs: require python 3.4+
...
remove references to older pythons.
2016-01-24 14:57:48 +01:00
Michael Hanselmann
c7fb598ab9
Add shell-style pattern syntax
...
The fnmatch module in Python's standard library implements a pattern
format for paths which is similar to shell patterns. However, “*”
matches any character including path separators. This newly introduced
pattern syntax with the selector “sh” no longer matches the path
separator with “*”. Instead “**/” can be used to match zero or more
directory levels.
2016-01-21 16:07:24 +01:00
Piotr Pawlow
987aaa34df
Added SSH key options to the usage example.
2016-01-18 18:49:07 +01:00
Robin Schneider
1f49d16a71
Fixed my changes. Thanks to @ThomasWaldmann for the review!
2016-01-18 09:00:07 +01:00
Robin Schneider
89ce86a33b
Fixed more in usage.rst. - → –; – → -- (CLI); Bullet list.
2016-01-17 22:23:54 +01:00
Robin Schneider
83c5321f53
Fixed RST warning markup.
2016-01-17 20:13:45 +01:00
Robin Schneider
19eb8e2d3b
Use `--option
` in RST to not render "--" as "–".
2016-01-17 20:12:23 +01:00
Thomas Waldmann
2f05e4add9
use the usual commandline arguments order for borg prune examples, fixes #560
...
borg prune <options> <repo>
2016-01-16 20:57:22 +01:00
Danny Edel
6cedfbede9
Correct small typos in changes and usage
2016-01-15 09:24:00 +01:00
Thomas Waldmann
8ce84cab30
update docs / make them more clear about -v
2016-01-14 19:34:07 +01:00