From: Brian Warner <warner@allmydata.com>
Date: Fri, 6 Feb 2009 05:14:45 +0000 (-0700)
Subject: docs/CLI: document 'tahoe backup'
X-Git-Tag: allmydata-tahoe-1.3.0~73
X-Git-Url: https://git.rkrishnan.org/%5B/%5D%20/file/URI:LIT:krugkidfnzsc4/index.php?a=commitdiff_plain;h=177ffa0870390c6ebdb915cd03fe2b1f0e43b8e5;p=tahoe-lafs%2Ftahoe-lafs.git

docs/CLI: document 'tahoe backup'
---

diff --git a/docs/frontends/CLI.txt b/docs/frontends/CLI.txt
index e1553133..4ea6cf1e 100644
--- a/docs/frontends/CLI.txt
+++ b/docs/frontends/CLI.txt
@@ -197,6 +197,7 @@ tahoe cp [-r] [alias:]frompath [alias:]topath
 tahoe rm [alias:]what
 tahoe mv [alias:]from [alias:]to
 tahoe ln [alias:]from [alias:]to
+tahoe backup localfrom [alias:]to
 
 === Command Examples ===
 
@@ -332,6 +333,21 @@ tahoe mv tahoe:uploaded.txt fun:uploaded.txt
  These move a file from your tahoe root directory to the virtual directory
  set up earlier with "tahoe add-alias fun DIRCAP"
 
+tahoe backup ~ work:backups
+
+ This command performs a full versioned backup of every file and directory
+ underneath your "~" home directory, placing a read-only timestamped snapshot
+ in e.g. work:backups/Archives/2009-02-06_04:00:05Z/ (note that the timestamp
+ is in UTC, hence the "Z" suffix), and a link to the latest snapshot in
+ work:backups/Latest/ . This command will use a small SQLite database known
+ as the "backupdb", stored in ~/.tahoe/private/backupdb.sqlite, to remember
+ which local files have been backed up already, and will avoid uploading
+ files that have already been backed up. It compares timestamps and filesizes
+ when making this comparison. The "tahoe backup" command also shares
+ directories with the previous backup when nothing has changed, to run faster
+ and to reduce the number of directories created.
+
+
 == Virtual Drive Maintenance ==
 
 tahoe manifest tahoe: