Changeset 2232 for trunk/eraser/Eraser/Program.cs

Timestamp:

8/4/2010 9:23:35 AM (22 months ago)

Author:

lowjoel

Message:

Make the generation of help text for addtask parameters done by the plugins, since the arguments are passed to them, they should document their own CLIs. To do this, the ICliConfigurer interface was modified.

File:

• trunk/eraser/Eraser/Program.cs (modified) (5 diffs)

trunk/eraser/Eraser/Program.cs

@@ -40 +40 @@
 using Eraser.Util;
 using Eraser.DefaultPlugins;
+using System.Text;
 
 namespace Eraser
@@ -291 +292 @@
         private static void PrintCommandHelp()
         {
+            //Get the command-line help for every erasure target
+            StringBuilder targets = new StringBuilder();
+            foreach (ErasureTarget target in ManagerLibrary.Instance.ErasureTargetRegistrar)
+            {
+                //Replace all \r\n with \n, and split into lines
+                string[] helpText = target.Configurer.Help().Replace("\r\n", "\n").Split('\r', '\n');
+
+                //Pad the start of each line with spaces
+                foreach (string line in helpText)
+                    targets.AppendLine(line.Insert(0, "    "));
+            }
+
+            //Print the message
             Console.WriteLine(S._(@"usage: Eraser <action> <arguments>
 where action is
@@ -308 +322 @@
 
 parameters for addtask:
-  eraser addtask [/method=<methodGUID>] [/schedule=(now|manually|restart)] (recyclebin | unused=<volume> | dir=<directory> | file=<file>)[...]
+  eraser addtask [/method=<methodGUID>] [/schedule=(now|manually|restart)] <target> [target [...]]
 
   /method             The Erasure method to use.
@@ -317 +331 @@
       restart         The task will be queued for execution when the computer
                       is next restarted.
-  recyclebin          Erases files and folders in the recycle bin
-  unused              Erases unused space in the volume.
-    optional arguments: unused=<drive>[,clusterTips[=(true|false)]]
-      clusterTips     If specified, the drive's files will have their
-                      cluster tips erased. This parameter accepts a Boolean
-                      value (true/false) as an argument; if none is specified
-                      true is assumed.
-  dir                 Erases files and folders in the directory
-    optional arguments: dir=<directory>[,-excludeMask][,+includeMask][,deleteIfEmpty]
-      excludeMask     A wildcard expression for files and folders to
-                      exclude.
-      includeMask     A wildcard expression for files and folders to
-                      include.
-                      The include mask is applied before the exclude mask.
-      deleteIfEmpty   Deletes the folder at the end of the erasure if it is
-                      empty.
-  file                Erases the specified file
+
+  where target is:
+{0}
 
 parameters for querymethods:
@@ -351 +351 @@
 ""@"" to the path to the file, and passing it into the command line. The
 contents of the response files' will be substituted at the same position into
-the command line."));
+the command line.", targets));
+
             Console.Out.Flush();
         }