CLI: add 'tahoe manifest', which takes a directory and returns a list of things you...

[tahoe-lafs/tahoe-lafs.git] / docs / CLI.txt

diff --git a/docs/CLI.txt b/docs/CLI.txt
index b581f6d6697fe6af9df4f95c3ce7140be60110e1..5a8a6815d7df0a046d63a0ae0e557dbb5ff5fcf2 100644 (file)
--- a/docs/CLI.txt
+++ b/docs/CLI.txt
@@ -325,6 +325,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"
 
+== Virtual Drive Maintenance ==
+
+tahoe manifest tahoe:
+tahoe manifest --storage-index tahoe:
+
+ This performs a recursive walk of the given directory, visiting every file
+ and directory that can be reached from that point. It then emits one line to
+ stdout for each object it encounters.
+
+ The default behavior is to print the access cap string (like URI:CHK:.. or
+ URI:DIR2:..), followed by a space, followed by the full path name.
+
+ If --storage-index is added, each line will instead contain the object's
+ storage index. This (string) value is useful to determine which share files
+ (on the server) are associated with this directory tree.
 
 
 == Debugging ==