X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=dss.suite;h=f9cf8af5993345452fddc7b3d9790d0d7e6d7a13;hb=71a8073e6f18ccc21880a475af8d864279a960b8;hp=16c7e58542eff8750c8437dcea137f347a435950;hpb=5f5cd0b291c62b056c294cd947c00118572bc002;p=dss.git

diff --git a/dss.suite b/dss.suite
index 16c7e58..f9cf8af 100644
--- a/dss.suite
+++ b/dss.suite
@@ -450,19 +450,38 @@ caption = Subcommands
 		snapshots.
 	[/description]
 [subcommand prune]
-	purpose = remove redundant and outdated snapshots
+	purpose = remove snapshots
 	[description]
-		A snapshot is considered outdated if its interval number is greater or
-		equal than the specified number of unit intervals. See --unit-interval
-		and --num-intervals above.
-
-		A snapshot is said to be redundant if the interval it belongs to
-		contains more than the configured number of snapshots.
-
-		The prune command gets rid of both outdated and redundant snapshots. At
-		most one snapshot is removed per invocation. If --dry-run is given, the
-		subcommand only prints the snapshot that would be removed.
+		A snapshot is said to be (a) outdated if its interval number is greater
+		or equal than the specified number of unit intervals, (b) redundant if
+		the interval it belongs to contains more than the configured number of
+		snapshots, and (c) orphaned if it is incomplete and not being created
+		or deleted. All other snapshots are called regular.
+
+		Unless --dry-run is given, which just prints the snapshot that would be
+		removed, this subcommand gets rid of non-regular snapshots.  At most
+		one snapshot is removed per invocation. If no such snapshot exists
+		and disk space is low, the subcommand also removes regular snapshots,
+		always picking the oldest one.
+
+		The subcommand fails if there is another dss "run" process.
 	[/description]
+	[option disk-space]
+		summary = act as if free disk space was high/low
+		arg_info = required_arg
+		arg_type = string
+		typestr = mode
+		values = {
+			FDS_CHECK = "check",
+			FDS_HIGH = "high",
+			FDS_LOW = "low"
+		}
+		default_val = check
+		[help]
+			By default, free disk space is checked and even regular snapshots
+			become candidates for removal if disk space is low. This option
+			overrides the result of the check.
+		[/help]
 [subcommand ls]
 	purpose = print the list of all snapshots
 	[description]