aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a29562279ba2abe6589bf81abb00a2d8cd5f0729 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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.


|   |   |
| - | - |
| A | access time |
| C | change time |
| G | group name |
| g | group id |
| M | modification time |
| n | file name |
| p | permissions |
| s | size |
| T | type |
| t | time defined by --time-field |
| U | user name |
| u | user id |


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.