aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: c719c157e63f7b30016d6e73f1ec7eeac51dde0e (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
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
=======
Information can be found in the manpage or by calling the executable with `--help`.

BUILD
=====

`cmake -S .`

`make`

This  will also build executables with debug options and create a manpage.
The latter requires `asciidoc`, `xmlto` and `gzip` for compression.



TODO
====
- option for output file
- option for recursion
- configuration file in `${HOME}/.config/` ? (No from my side, KISS, but patches welcome)
- formatting with non-ASCII characters in filenames, `--print-boxed`
  misformats due to the strlen result not matching the visual representation.
- repeat mode? The original intention was to write a small utility creating
  output formatted in a form easy to be processed by the human eye/brain.
  This program was intended to be handled by the watch command (or similar)
  for active monitoring in a terminal.
  A repeat mode in combination with an output file could be used for logging,
  however this could also be done with a small shell script. If the output of
  the whole loop in the script is redirected the amount of additional filesystem
  related syscalls would be low. Of course if the redirection would be done
  for each call and attached to the end of the target file much more would be
  going on.