OVERVIEW
========

dir\_monitor is a simple utility to print stat information
from a directory in a formatted and organized form. In
combination with watch it can be used for continous monitoring.

OPTIONS
=======
Call: dir\_monitor OPTIONS path\_to\_open

| long | short | option | description |
| ---- | ----- | ------ | ----------- |
| `--help` | `-h` | | Show this message and exit |
| `--format-string` | | format | define columns to print, details below |
| `--long-timestamp` | `-t` | | Print timestamp in long form yyyymmdd HH:MM:SS ZONE |
| `--print-header` | `-H` |            | Print a header above the columns |
| `--reverse-sort` | | | | Sort reversed |
| `--show-hidden-entries` | `-v` | | Show hidden entries in the directory |
| `--sort-by` | | variant  | Sort either by variant |
| `--time-field` | | `a`\|`c`\|`m` | Sort by (a)ccess, (c)hange or (m)odification time. Default: m |


`--sort-by` variants: `name` | `size` | `time`


`--format-string` Aside from the characters in the table only space is
accepted. Currently at max 80 bytes of the format string are processed.


| char | description |
| ---- | ----------- |
| `A`  | access time |
| `C`  | change time |
| `G`  | group name |
| `g`  | group id |
| `M`  | modification time |
| `n`  | file name |
| `p`  | permissions |
| `s`  | size in bytes or kB (base 1024) |
| `T`  | type (file, directory, link etc.) |
| `t`  | time as defined by `--time-field` |
| `U`  | user name |
| `u`  | user id |

The time stamps in `t`, `A`, `C`, `M` are by default only the daily time,
`--long-timestamp` / `-t` needs to be set to activate the full timestamp
including date and timezone.

TODO
====
- option for output file
- option for recursion
- option for symlink handling
- option with lowest priority: nice formatting, do the whole formatting in
  memory and based on the length information gathered put it into a visual
  table.
- configuration file in ${HOME}/.config/ ?