summaryrefslogtreecommitdiff
path: root/doc/walkthrough
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-04-08 14:56:57 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-04-08 14:56:57 -0400
commitf3cf20d22a5c27b83138c4ee062edb7532fecbb3 (patch)
tree39265aff7a0aab93bc478ac0f901c2e88134be98 /doc/walkthrough
parenta77c34d2b4795a5d41f82a78e999ce33f43d8862 (diff)
document bup special remotes
Diffstat (limited to 'doc/walkthrough')
-rw-r--r--doc/walkthrough/using_bup.mdwn18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/walkthrough/using_bup.mdwn b/doc/walkthrough/using_bup.mdwn
new file mode 100644
index 000000000..1a506c281
--- /dev/null
+++ b/doc/walkthrough/using_bup.mdwn
@@ -0,0 +1,18 @@
+Another [[special_remote|special_remotes]] that git-annex can use is
+a [[special_remotes/bup]] repository. Bup stores large file contents
+in a git repository of its own, with deduplication. Combined with
+git-annex, you can have git on both the frontend and the backend.
+
+Here's how to create a bup remote, and describe it.
+
+ # git annex initremote mybup type=bup encryption=none remote=example.com/big/mybup
+ initremote bup (init) ok
+ # git annex describe mybup "my bup repository at example.com"
+ describe mybup ok
+
+Now the remote can be used like any other remote.
+
+ # git annex move my_cool_big_file --to mybup
+ move my_cool_big_file (to mybup...) ok
+
+See [[special_remotes/bup]] for details.