From f5b20c023f74be2899ab63553e5446b8e3a5e6b3 Mon Sep 17 00:00:00 2001 From: deadc0de6 Date: Fri, 14 Jan 2022 10:43:52 +0100 Subject: [PATCH] add CSV doc --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 2fe2854..cc79e3c 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ Features: * Store md5 hash of files * Ability to update the catalog * Tag your different storages with additional information + * export catalog to CSV @@ -74,6 +75,7 @@ See the [examples](#examples) for an overview of the available features. * [Catalog graph](#catalog-graph) * [Edit storage](#edit-storage) * [Update catalog](#update-catalog) + * [Export catalog](#export-catalog) * [Examples](#examples) * [Contribution](#contribution) @@ -206,6 +208,21 @@ Updates are based on the access time of each of the files and on the hash checksum if present (catalog was indexed with `-c --hash` and `update` is called with the switch `-c --hash`). +## Export catalog + +The catalog can be exported to CSV using the `export` command. +Fields are separated by a comma (`,`) and are quoted with double quotes (`"`). + +Each line format is `name,type,path,size,indexed_at,maccess,md5`. + +* **name**: the entry name +* **type**: the entry type (file, directory) +* **path**: the entry path +* **size**: the entry size +* **indexed_at**: when this entry was indexed +* **maccess**: the entry modification date/time +* **md5**: the entry checksum (if any) + # Examples ## Simple example