From: Alberto Berti <alberto@metapensiero.it>
Date: Tue, 24 Feb 2009 16:30:49 +0000 (-0700)
Subject: Added documentation for '--exclude' and friends cli backup command.
X-Git-Url: https://git.rkrishnan.org/components/com_hotproperty/%22doc.html/copyable.html?a=commitdiff_plain;h=82352add2263d91a5877c974c795c1c39224c5bb;p=tahoe-lafs%2Ftahoe-lafs.git

Added documentation for '--exclude' and friends cli backup command.
---

diff --git a/docs/frontends/CLI.txt b/docs/frontends/CLI.txt
index 4ea6cf1e..4fbb7e5c 100644
--- a/docs/frontends/CLI.txt
+++ b/docs/frontends/CLI.txt
@@ -347,6 +347,45 @@ tahoe backup ~ work:backups
  directories with the previous backup when nothing has changed, to run faster
  and to reduce the number of directories created.
 
+tahoe backup --exclude=*~ ~ work:backups
+
+ Same as above, but this time the backup process will ignore any
+ filename that will end with '~'. '--exclude' will accept any standard
+ unix shell-style wildcards, have a look at
+ http://docs.python.org/library/fnmatch.html for a more detailed
+ reference.  You may give multiple '--exclude' options.  Please pay
+ attention that the pattern will be matched against any level of the
+ directory tree, it's still impossible to specify absolute path exclusions.
+
+tahoe backup --exclude-from=/path/to/filename ~ work:backups
+
+ '--exclude-from' is similar to '--exclude', but reads exclusion
+ patterns from '/path/to/filename', one per line.
+
+tahoe backup --exclude-vcs ~ work:backups
+
+ This command will ignore any known file or directory that's used by
+ version control systems to store metadata. The list of the exluded
+ names is:
+
+  * CVS
+  * RCS
+  * SCCS
+  * .git
+  * .gitignore
+  * .cvsignore
+  * .svn
+  * .arch-ids
+  * {arch}
+  * =RELEASE-ID
+  * =meta-update
+  * =update
+  * .bzr
+  * .bzrignore
+  * .bzrtags
+  * .hg
+  * .hgignore
+  * _darcs
 
 == Virtual Drive Maintenance ==