mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-23 16:26:29 +00:00
Code Issues Releases Wiki Activity

ran build_api + build_usage

Browse source
This commit is contained in:
Thomas Waldmann 2016-05-20 14:34:48 +02:00
parent 938628f4e1
commit 8d8374d23c
2 changed files with 42 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
docs/api.rst
View file

@ -2,31 +2,11 @@
API Documentation
=================
.. automodule:: borg.platform
.. automodule:: borg.archiver
:members:
:undoc-members:
.. automodule:: borg.shellpattern
:members:
:undoc-members:
.. automodule:: borg.locking
:members:
:undoc-members:
.. automodule:: borg.hash_sizes
:members:
:undoc-members:
.. automodule:: borg.logger
:members:
:undoc-members:
.. automodule:: borg.remote
:members:
:undoc-members:
.. automodule:: borg.fuse
.. automodule:: borg.upgrader
:members:
:undoc-members:
@ -34,7 +14,23 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.helpers
.. automodule:: borg.fuse
:members:
:undoc-members:
.. automodule:: borg.platform
:members:
:undoc-members:
.. automodule:: borg.locking
:members:
:undoc-members:
.. automodule:: borg.shellpattern
:members:
:undoc-members:
.. automodule:: borg.repository
:members:
:undoc-members:
@ -42,15 +38,19 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.remote
:members:
:undoc-members:
.. automodule:: borg.hash_sizes
:members:
:undoc-members:
.. automodule:: borg.xattr
:members:
:undoc-members:
.. automodule:: borg.archiver
:members:
:undoc-members:
.. automodule:: borg.repository
.. automodule:: borg.helpers
:members:
:undoc-members:
@ -62,7 +62,7 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.upgrader
.. automodule:: borg.logger
:members:
:undoc-members:
@ -70,15 +70,15 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.compress
:members:
:undoc-members:
.. automodule:: borg.platform_linux
:members:
:undoc-members:
.. automodule:: borg.crypto
.. automodule:: borg.hashindex
:members:
:undoc-members:
.. automodule:: borg.compress
:members:
:undoc-members:
@ -86,10 +86,10 @@ API Documentation
:members:
:undoc-members:
.. automodule:: borg.platform_freebsd
.. automodule:: borg.crypto
:members:
:undoc-members:
.. automodule:: borg.hashindex
.. automodule:: borg.platform_freebsd
:members:
:undoc-members:

6
docs/usage/create.rst.inc
View file

@ -82,6 +82,12 @@ This command creates a backup archive containing all files found while recursive
traversing all paths specified. The archive will consume almost no disk space for
files or parts of files that have already been stored in other archives.
The archive name needs to be unique. It must not end in '.checkpoint' or
'.checkpoint.N' (with N being a number), because these names are used for
checkpoints and treated in special ways.
In the archive name, you may use the following format tags:
{now}, {utcnow}, {fqdn}, {hostname}, {user}, {pid}
To speed up pulling backups over sshfs and similar network file systems which do
not provide correct inode information the --ignore-inode flag can be used. This