Merge branch 'refs/heads/t/lopsub'

[osl.git] / oslfsck.suite

diff --git a/oslfsck.suite b/oslfsck.suite
new file mode 100644 (file)
index 0000000..a58e54f
--- /dev/null
+++ b/oslfsck.suite
@@ -0,0 +1,61 @@
+[suite oslfsck]
+[supercommand oslfsck]
+       purpose = check and repair the tables of an osl database
+       non-opts-name = [table]...
+       [description]
+               oslfsck tries to recover the tables of an osl database after a crash
+               which potentially leaves the database in an inconsistent state.
+       [/description]
+       [option help]
+               summary = print help and exit
+               short_opt = h
+       [option detailed-help]
+               summary = print help, including all details, and exit
+       [option version]
+               summary = print version and exit
+               short_opt = V
+       [option loglevel]
+               short_opt = l
+               summary = set loglevel (0-6)
+               arg_info = required_arg
+               arg_type = uint32
+               typestr = severity
+               default_val = 3
+               [help]
+                       Log messages are always written to stderr while normal output goes
+                       to stdout. Lower values mean more verbose logging.
+               [/help]
+       [option database-dir]
+               short_opt = d
+               summary = full path to the database directory
+               arg_info = required_arg
+               arg_type = string
+               typestr = path
+               [help]
+                       Unless non-option arguments are given, all subdirectories of <path>
+                       are considered osl tables which oslfsck will try to fix.
+               [/help]
+       [option dump-dir]
+               short_opt = D
+               summary = enable dump mode
+               arg_info = required_arg
+               arg_type = string
+               typestr = path
+               [help]
+                       If path is non-empty, oslfsck will write a dump of all given tables
+                       to the specified path.
+               [/help]
+       [option no-fsck]
+               short_opt = n
+               summary = disable fsck mode
+               [help]
+                       This is mainly useful in conjunction with the --dump-dir option.
+               [/help]
+       [option force]
+               short_opt = f
+               summary = enable force mode
+               [help]
+                       Ignore the dirty bit when opening osl tables.
+               [/help]
+       [option dry-run]
+               summary = only report problems, don't try to fix them