diff options
| -rw-r--r-- | readme.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/readme.md b/readme.md index 50c4119..522ffe6 100644 --- a/readme.md +++ b/readme.md @@ -1,2 +1,17 @@ +`whenwasit path` little thing meant to be called in a git-hook as to keep track of -file creation and modification dates, which are important to me. \ No newline at end of file +file creation and modification dates, which are important to me. +dumps csv output on stdout, errors abort with a panic. + +**CSV Output Defintion:** +data is output on `stdout` in a CSV format. because there are +varying ways to make a CSV, it's described in detail below. + +- there is no data header; the first row is data +- the data rows are in the format `path,btime,mtime,atime` + - `path`: file path relative to the root that was provided on the command line + - `btime`: time of file creation; birth time + - `mtime`: time file was last modified + - `atime`: time file was last accessed +- if the `path` contains a comma (`,`) or a backslash (`\`), it is escape with a backslash +- if any one of the time cannot be attained, the field is left empty. \ No newline at end of file |