mirror of https://github.com/borgbackup/borg.git
Updated documentation
This commit is contained in:
Jonas Borgström
parent
df5e4a52a6
commit
43a4bf6829
|
|
@ -1,8 +1,8 @@
|
|||
.. |project_name| replace:: ``Attic``
|
||||
.. |project_version| replace:: 0.6.1
|
||||
.. |project_version| replace:: 0.7
|
||||
.. |package_dirname| replace:: Attic-|project_version|
|
||||
.. |package_filename| replace:: |package_dirname|.tar.gz
|
||||
.. |package_url| replace:: https://pypi.python.org/packages/source/A/Attic/Attic-0.6.1.tar.gz
|
||||
.. |package_url| replace:: https://pypi.python.org/packages/source/A/Attic/Attic-0.7.tar.gz
|
||||
.. |git_url| replace:: https://github.com/jborg/attic.git
|
||||
.. _deduplication: https://en.wikipedia.org/wiki/Data_deduplication
|
||||
.. _AES: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ Other dependencies:
|
|||
* `msgpack-python`_ >= 0.1.10
|
||||
* OpenSSL_ >= 1.0.0
|
||||
|
||||
The OpenSSL provided by Mac OS X is too old so OS X users are recommended
|
||||
to install a newer version using homebrew_.
|
||||
The OpenSSL version bundled with Mac OS X and FreeBSD is most likey too old.
|
||||
Newer versions are available from homebrew_ on OS X and from FreeBSD ports.
|
||||
|
||||
Installing from PyPI using pip
|
||||
------------------------------
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/bash
|
||||
echo -n > usage.rst
|
||||
for cmd in init create extract delete prune verify change-passphrase; do
|
||||
LINE=`echo -n attic $cmd | tr 'a-z ' '~'`
|
||||
for cmd in change-passphrase create delete extract init mount prune verify; do
|
||||
LINE=`echo -n attic $cmd | tr 'a-z- ' '~'`
|
||||
echo -e ".. _usage_attic_$cmd:\n\nattic $cmd\n$LINE\n::\n" >> usage.rst
|
||||
attic $cmd -h >> usage.rst
|
||||
done
|
||||
|
|
|
|||
|
|
@ -1,21 +1,19 @@
|
|||
.. _usage_attic_init:
|
||||
.. _usage_attic_change-passphrase:
|
||||
|
||||
attic init
|
||||
~~~~~~~~~~
|
||||
attic change-passphrase
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
::
|
||||
|
||||
usage: attic init [-h] [-v] [--key-file] [--passphrase] repository
|
||||
usage: attic change-passphrase [-h] [-v] repository
|
||||
|
||||
Initialize a new repository
|
||||
Change passphrase on repository key file
|
||||
|
||||
positional arguments:
|
||||
repository repository to create
|
||||
repository
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-v, --verbose verbose output
|
||||
--key-file enable key file based encryption
|
||||
--passphrase enable passphrase based encryption
|
||||
.. _usage_attic_create:
|
||||
|
||||
attic create
|
||||
|
|
@ -43,6 +41,22 @@ optional arguments:
|
|||
--do-not-cross-mountpoints
|
||||
do not cross mount points
|
||||
--numeric-owner only store numeric user and group identifiers
|
||||
.. _usage_attic_delete:
|
||||
|
||||
attic delete
|
||||
~~~~~~~~~~~~
|
||||
::
|
||||
|
||||
usage: attic delete [-h] [-v] ARCHIVE
|
||||
|
||||
Delete archive
|
||||
|
||||
positional arguments:
|
||||
ARCHIVE archive to delete
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-v, --verbose verbose output
|
||||
.. _usage_attic_extract:
|
||||
|
||||
attic extract
|
||||
|
|
@ -64,22 +78,43 @@ optional arguments:
|
|||
-e PATTERN, --exclude PATTERN
|
||||
exclude paths matching PATTERN
|
||||
--numeric-owner only obey numeric user and group identifiers
|
||||
.. _usage_attic_delete:
|
||||
.. _usage_attic_init:
|
||||
|
||||
attic delete
|
||||
~~~~~~~~~~~~
|
||||
attic init
|
||||
~~~~~~~~~~
|
||||
::
|
||||
|
||||
usage: attic delete [-h] [-v] ARCHIVE
|
||||
usage: attic init [-h] [-v] [--key-file] [--passphrase] repository
|
||||
|
||||
Delete archive
|
||||
Initialize a new repository
|
||||
|
||||
positional arguments:
|
||||
ARCHIVE archive to delete
|
||||
repository repository to create
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-v, --verbose verbose output
|
||||
--key-file enable key file based encryption
|
||||
--passphrase enable passphrase based encryption
|
||||
.. _usage_attic_mount:
|
||||
|
||||
attic mount
|
||||
~~~~~~~~~~~
|
||||
::
|
||||
|
||||
usage: attic mount [-h] [-v] [-f] [-o OPTIONS] ARCHIVE MOUNTPOINT
|
||||
|
||||
Mount archive as a FUSE fileystem
|
||||
|
||||
positional arguments:
|
||||
ARCHIVE archive to mount
|
||||
MOUNTPOINT where to mount filesystem
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-v, --verbose verbose output
|
||||
-f, --foreground stay in foreground, do not daemonize
|
||||
-o OPTIONS Extra mount options
|
||||
.. _usage_attic_prune:
|
||||
|
||||
attic prune
|
||||
|
|
@ -129,19 +164,3 @@ optional arguments:
|
|||
-v, --verbose verbose output
|
||||
-e PATTERN, --exclude PATTERN
|
||||
exclude paths matching PATTERN
|
||||
.. _usage_attic_change-passphrase:
|
||||
|
||||
attic change-passphrase
|
||||
~~~~~~~~~~~~-~~~~~~~~~~
|
||||
::
|
||||
|
||||
usage: attic change-passphrase [-h] [-v] repository
|
||||
|
||||
Change passphrase on repository key file
|
||||
|
||||
positional arguments:
|
||||
repository
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-v, --verbose verbose output
|
||||
|
|
|
|||
Loading…
Reference in New Issue