Merge branch 'refs/heads/t/lopsub'
[osl.git] / oslfsck.suite
1 [suite oslfsck]
2 [supercommand oslfsck]
3         purpose = check and repair the tables of an osl database
4         non-opts-name = [table]...
5         [description]
6                 oslfsck tries to recover the tables of an osl database after a crash
7                 which potentially leaves the database in an inconsistent state.
8         [/description]
9         [option help]
10                 summary = print help and exit
11                 short_opt = h
12         [option detailed-help]
13                 summary = print help, including all details, and exit
14         [option version]
15                 summary = print version and exit
16                 short_opt = V
17         [option loglevel]
18                 short_opt = l
19                 summary = set loglevel (0-6)
20                 arg_info = required_arg
21                 arg_type = uint32
22                 typestr = severity
23                 default_val = 3
24                 [help]
25                         Log messages are always written to stderr while normal output goes
26                         to stdout. Lower values mean more verbose logging.
27                 [/help]
28         [option database-dir]
29                 short_opt = d
30                 summary = full path to the database directory
31                 arg_info = required_arg
32                 arg_type = string
33                 typestr = path
34                 [help]
35                         Unless non-option arguments are given, all subdirectories of <path>
36                         are considered osl tables which oslfsck will try to fix.
37                 [/help]
38         [option dump-dir]
39                 short_opt = D
40                 summary = enable dump mode
41                 arg_info = required_arg
42                 arg_type = string
43                 typestr = path
44                 [help]
45                         If path is non-empty, oslfsck will write a dump of all given tables
46                         to the specified path.
47                 [/help]
48         [option no-fsck]
49                 short_opt = n
50                 summary = disable fsck mode
51                 [help]
52                         This is mainly useful in conjunction with the --dump-dir option.
53                 [/help]
54         [option force]
55                 short_opt = f
56                 summary = enable force mode
57                 [help]
58                         Ignore the dirty bit when opening osl tables.
59                 [/help]
60         [option dry-run]
61                 summary = only report problems, don't try to fix them