From 43a4bf6829640d40cd8951b8ffcb6d37b2a74525 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Borgstr=C3=B6m?= Date: Tue, 30 Jul 2013 13:54:04 +0200 Subject: [PATCH] Updated documentation --- docs/global.rst.inc | 4 +-- docs/installation.rst | 4 +-- docs/update_usage.sh | 4 +-- docs/usage.rst | 79 +++++++++++++++++++++++++++---------------- 4 files changed, 55 insertions(+), 36 deletions(-) diff --git a/docs/global.rst.inc b/docs/global.rst.inc index 74ae2c03b..13eca9ea9 100644 --- a/docs/global.rst.inc +++ b/docs/global.rst.inc @@ -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 diff --git a/docs/installation.rst b/docs/installation.rst index 9301dd90d..ad897904e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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 ------------------------------ diff --git a/docs/update_usage.sh b/docs/update_usage.sh index f979a5381..7518aac4b 100755 --- a/docs/update_usage.sh +++ b/docs/update_usage.sh @@ -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 diff --git a/docs/usage.rst b/docs/usage.rst index 36c3666b2..680816619 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -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