borgbackup/borg
1
1
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-10-06 09:01:30 +03:00
Code Issues Projects Releases Wiki Activity

ran build_api and build_usage

Browse Source
This commit is contained in:
Thomas Waldmann 2015-12-13 15:47:03 +01:00
parent f3d60fdb37
commit 2ecfa54aee
6 changed files with 35 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_static/logo.xcf vendored Normal file
View File

Binary file not shown.

48
docs/api.rst
View File

@ -2,23 +2,15 @@
API Documentation
=================
.. automodule:: borg.key
.. automodule:: borg.archiver
:members:
:undoc-members:
.. automodule:: borg.cache
.. automodule:: borg.upgrader
:members:
:undoc-members:
.. automodule:: borg.locking
:members:
:undoc-members:
.. automodule:: borg.platform
:members:
:undoc-members:
.. automodule:: borg.xattr
.. automodule:: borg.archive
:members:
:undoc-members:
@ -26,7 +18,11 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.logger
.. automodule:: borg.platform
:members:
:undoc-members:
.. automodule:: borg.locking
:members:
:undoc-members:
@ -34,14 +30,6 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.archiver
:members:
:undoc-members:
.. automodule:: borg.archive
:members:
:undoc-members:
.. automodule:: borg.lrucache
:members:
:undoc-members:
@ -50,7 +38,7 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.upgrader
.. automodule:: borg.xattr
:members:
:undoc-members:
@ -58,15 +46,15 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.platform_freebsd
.. automodule:: borg.cache
:members:
:undoc-members:
.. automodule:: borg.hashindex
.. automodule:: borg.key
:members:
:undoc-members:
.. automodule:: borg.chunker
.. automodule:: borg.logger
:members:
:undoc-members:
@ -78,10 +66,22 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.hashindex
:members:
:undoc-members:
.. automodule:: borg.compress
:members:
:undoc-members:
.. automodule:: borg.chunker
:members:
:undoc-members:
.. automodule:: borg.crypto
:members:
:undoc-members:
.. automodule:: borg.platform_freebsd
:members:
:undoc-members:

6
docs/usage/check.rst.inc
View File

@ -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
~~~~~~~~~~~

5
docs/usage/create.rst.inc
View File

@ -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

3
docs/usage/delete.rst.inc
View File

@ -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
~~~~~~~~~~~

2
docs/usage/prune.rst.inc
View File

@ -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
~~~~~~~~~~~