aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThorsten Töpper <atsutane@freethoughts.de>2025-07-07 23:49:18 +0200
committerThorsten Töpper <atsutane@freethoughts.de>2025-07-07 23:49:18 +0200
commit50b487f19200555c983f043dd2627effcfd2c15c (patch)
tree65cb8a0f7346ffca952342a973281b59746ca3bb
parentca812ed447e6e254395b0044582b20be998445e9 (diff)
downloaddir_monitor-50b487f19200555c983f043dd2627effcfd2c15c.tar.gz
dir_monitor-50b487f19200555c983f043dd2627effcfd2c15c.tar.bz2
README: Update
-rw-r--r--README.md47
1 files changed, 45 insertions, 2 deletions
diff --git a/README.md b/README.md
index 53561c3..a295622 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,50 @@ 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
====
-- specification of a format string defining the columns to print
- and the order they are printed in.
+- 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.