dirvish-expire(8)

1DIRVISH-EXPIRE(8)           System Manager's Manual          DIRVISH-EXPIRE(8)
2
3
4

NAME

6       dirvish-expire - delete expired dirvish images
7

SYNOPSIS

9       dirvish-expire[OPTIONS]
10

DESCRIPTION

12       Delete dirvish image trees or whole images that have expired.
13
14       Each  image  summary  file  is  checked for the Expire: field.  If that
15       field indicates the image has expired dirvish-expire will  delete  that
16       image from the vault.
17
18       By  default  all  subdirectories of all banks will be treated as vaults
19       and all directories therein  except  the  one  named  dirvish  will  be
20       checked for summary files.
21
22       The removal of an image will have no effect on other images.
23
24       Dirvish-expire  will  not  delete an image unless it finds at least one
25       image in that branch that has an intact image tree and Status:  success
26       in the summary that is not expired.
27

OPTIONS

29       Each  option  on the command line may be specified any number of times.
30       Those options that support lists in the config  files  will  accumulate
31       all  of  their arguments otherwise each specification will override the
32       ones before.
33
34       Each option may be unambiguously abbreviated.
35
36       --time time_expression
37              Execute as though time_expression were the current time.
38
39              Time_expression is processed by Time::Parsedate(3pm) so relative
40              time  and  date strings are permitted.  See Time::Parsedate(3pm)
41              for more details.
42
43       --tree Only delete the image tree, leave in place the rest of the image
44              directory  with  summary, log and any other image administrative
45              files.
46
47       --vault vault
48              Restrict expiration to the specified vault.
49
50       --no-run
51              Don't actually do anything.  Just display what would  have  hap‐
52              pened.
53
54       --quiet
55              Run quietly, only report errors.
56
57              Normally dirvish-expire will report the images deleted.
58

EXIT CODES

60       To facilitate further automation and integration of dirvish-expire with
61       other tools dirvish-expire provides rationalised exit codes.  The  exit
62       codes  are range based.  While the code for a specific error may change
63       from one version to another it will remain within the specified  range.
64       So  don't  test for specific exit codes but instead test for a range of
65       values.  To the degree  possible  higher  value  ranges  indicate  more
66       severe errors.
67
68       0      success
69
70       200-219
71              An error was encountered in loading a configuration file.
72
73       220-254
74              An error was detected in the configuration.
75
76       255    Incorrect usage.
77

FILES

79       /etc/dirvish/master.conf
80              alternate master configuration file.
81
82       /etc/dirvish.conf
83              master configuration file.
84
85       bank/vault/image/summary
86              image creation summary.
87
88       bank/vault/image/tree
89              actual image of source directory tree.
90

BUGS

96       Dirvish-expire  will walk the file hierarchy of all banks or the speci‐
97       fied vault looking for summary files.  Anything  non-dirvish  in  there
98       may cause excess file-walking.
99
100
101
102                                                             DIRVISH-EXPIRE(8)