Implement support for listing a generation in kdirstat.cache format

This implements an ls variant whose output format is compatible with the
kdirstat cache format. The best reference I can find for this is from an old fork:
https://github.com/thomas-joiner/k4dirstat/blob/master/kdirstat/cache-file-format.txt

Recent versions of k4dirstat appear to be able to read the files produced just
fine, although this document is not present in their source AFAICT.

I find k4dirstat to be an excellent way to visualise what is included in a
backup, e.g. for the purposes of excluding file types or marking directories
with a CACHEDIR.TAG. My previous solution involved post-processing the output
of ls which require a ssh to the machine with the files (for stat() purposes).
This approach pulls all of the data out of the obnam repo, so is much faster,
less hacky and gets the status of the actual generation and not the current
files etc.

1 files changed, 7 insertions, 0 deletions

diff --git a/obnam.1.in b/obnam.1.in
index 50b0092a..c0c7185e 100644
--- a/obnam.1.in
+++ b/obnam.1.in
@@ -68,6 +68,13 @@ This can be useful for scripting.
 lists the contents of a given generation, similar to
 .BR "ls \-lAR" .
 .IP \(bu
+.B kdirstat
+lists the contents of a given generation, in a format which is
+compatible with the
+.BR "kdirstat"
+cache file format, which can then be used to visualise the contents
+of a backup.
+.IP \(bu
 .B verify
 compares data in the backup with actual user data,
 and makes sure they are identical.