summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2015-12-13 15:47:03 +0100
committerThomas Waldmann <tw@waldmann-edv.de>2015-12-13 15:47:03 +0100
commit2ecfa54aee99c36d810c5636a1e6f2c48acb9929 (patch)
tree5229e2379a3e4ab5dd1ddc9107b278415e6f54b3 /docs
parentf3d60fdb377045971d5cf5f7ae2d0379cdb0e76c (diff)
ran build_api and build_usage0.29.0
Diffstat (limited to 'docs')
-rw-r--r--docs/_static/logo.xcfbin0 -> 26715 bytes
-rw-r--r--docs/api.rst42
-rw-r--r--docs/usage/check.rst.inc6
-rw-r--r--docs/usage/create.rst.inc5
-rw-r--r--docs/usage/delete.rst.inc3
-rw-r--r--docs/usage/prune.rst.inc2
6 files changed, 32 insertions, 26 deletions
diff --git a/docs/_static/logo.xcf b/docs/_static/logo.xcf
new file mode 100644
index 000000000..ea9c55c26
--- /dev/null
+++ b/docs/_static/logo.xcf
Binary files differ
diff --git a/docs/api.rst b/docs/api.rst
index e16b9f181..4bc7c7635 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -2,86 +2,86 @@
API Documentation
=================
-.. automodule:: borg.key
+.. automodule:: borg.archiver
:members:
:undoc-members:
-.. automodule:: borg.cache
+.. automodule:: borg.upgrader
:members:
:undoc-members:
-.. automodule:: borg.locking
+.. automodule:: borg.archive
:members:
:undoc-members:
-.. automodule:: borg.platform
+.. automodule:: borg.fuse
:members:
:undoc-members:
-.. automodule:: borg.xattr
+.. automodule:: borg.platform
:members:
:undoc-members:
-.. automodule:: borg.fuse
+.. automodule:: borg.locking
:members:
:undoc-members:
-.. automodule:: borg.logger
+.. automodule:: borg.repository
:members:
:undoc-members:
-.. automodule:: borg.repository
+.. automodule:: borg.lrucache
:members:
:undoc-members:
-.. automodule:: borg.archiver
+.. automodule:: borg.remote
:members:
:undoc-members:
-.. automodule:: borg.archive
+.. automodule:: borg.xattr
:members:
:undoc-members:
-.. automodule:: borg.lrucache
+.. automodule:: borg.helpers
:members:
:undoc-members:
-.. automodule:: borg.remote
+.. automodule:: borg.cache
:members:
:undoc-members:
-.. automodule:: borg.upgrader
+.. automodule:: borg.key
:members:
:undoc-members:
-.. automodule:: borg.helpers
+.. automodule:: borg.logger
:members:
:undoc-members:
-.. automodule:: borg.platform_freebsd
+.. automodule:: borg.platform_darwin
:members:
:undoc-members:
-.. automodule:: borg.hashindex
+.. automodule:: borg.platform_linux
:members:
:undoc-members:
-.. automodule:: borg.chunker
+.. automodule:: borg.hashindex
:members:
:undoc-members:
-.. automodule:: borg.platform_darwin
+.. automodule:: borg.compress
:members:
:undoc-members:
-.. automodule:: borg.platform_linux
+.. automodule:: borg.chunker
:members:
:undoc-members:
-.. automodule:: borg.compress
+.. automodule:: borg.crypto
:members:
:undoc-members:
-.. automodule:: borg.crypto
+.. automodule:: borg.platform_freebsd
:members:
:undoc-members:
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc
index fb15b428c..020881e49 100644
--- a/docs/usage/check.rst.inc
+++ b/docs/usage/check.rst.inc
@@ -6,7 +6,8 @@ borg check
usage: borg check [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
[--no-files-cache] [--umask M] [--remote-path PATH]
- [--repository-only] [--archives-only] [--repair] [--last N]
+ [--repository-only] [--archives-only] [--repair]
+ [--save-space] [--last N] [-p PREFIX]
[REPOSITORY_OR_ARCHIVE]
Check repository consistency
@@ -30,7 +31,10 @@ borg check
--repository-only only perform repository checks
--archives-only only perform archives checks
--repair attempt to repair any inconsistencies found
+ --save-space work slower, but using less space
--last N only check last N archives (Default: all)
+ -p PREFIX, --prefix PREFIX
+ only consider archive names starting with this prefix
Description
~~~~~~~~~~~
diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc
index f00685745..96460f2a9 100644
--- a/docs/usage/create.rst.inc
+++ b/docs/usage/create.rst.inc
@@ -35,11 +35,10 @@ borg create
--umask M set umask to M (local and remote, default: 0077)
--remote-path PATH set remote path to executable (default: "borg")
-s, --stats print statistics for the created archive
- -p, --progress, --no-progress
- toggle progress display while creating the archive,
+ -p, --progress show progress display while creating the archive,
showing Original, Compressed and Deduplicated sizes,
followed by the Number of files seen and the path
- being processed, default: True
+ being processed, default: False
--filter STATUSCHARS only display items with the given status characters
-e PATTERN, --exclude PATTERN
exclude paths matching PATTERN
diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc
index 587e7064e..1c7642b9b 100644
--- a/docs/usage/delete.rst.inc
+++ b/docs/usage/delete.rst.inc
@@ -6,7 +6,7 @@ borg delete
usage: borg delete [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
[--no-files-cache] [--umask M] [--remote-path PATH] [-s]
- [-c]
+ [-c] [--save-space]
[TARGET]
Delete an existing repository or archive
@@ -28,6 +28,7 @@ borg delete
--remote-path PATH set remote path to executable (default: "borg")
-s, --stats print statistics for the deleted archive
-c, --cache-only delete only the local cache for the given repository
+ --save-space work slower, but using less space
Description
~~~~~~~~~~~
diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc
index 08504b5d6..d52532649 100644
--- a/docs/usage/prune.rst.inc
+++ b/docs/usage/prune.rst.inc
@@ -8,6 +8,7 @@ borg prune
[--no-files-cache] [--umask M] [--remote-path PATH] [-n]
[-s] [--keep-within WITHIN] [-H HOURLY] [-d DAILY]
[-w WEEKLY] [-m MONTHLY] [-y YEARLY] [-p PREFIX]
+ [--save-space]
[REPOSITORY]
Prune repository archives according to specified rules
@@ -42,6 +43,7 @@ borg prune
number of yearly archives to keep
-p PREFIX, --prefix PREFIX
only consider archive names starting with this prefix
+ --save-space work slower, but using less space
Description
~~~~~~~~~~~