Introduce clumsy manpage dir_monitor(1)

1 files changed, 102 insertions, 0 deletions

diff --git a/man/dir_monitor.1.adoc b/man/dir_monitor.1.adoc
new file mode 100644
index 0000000..d3ed9fe
--- /dev/null
+++ b/man/dir_monitor.1.adoc
@@ -0,0 +1,102 @@
+dir_monitor(1)
+==============
+
+== NAME
+
+dir_monitor - present stat information of a path formatted and sorted
+
+
+== SYNOPSIS
+
+**dir_monitor** [*OPTION*]... directory
+
+
+== DESCRIPTION
+dir_monitor is a simple tool, intended to present the content of a directory in a sorted order with definition of which information from the *stat(2)* call are to be presented.
+
+It can be used for continuous monitoring of a path by wrappers like *watch*.
+
+
+== OPTIONS
+
+**--format-string** 'format'::
+define columns to print, details below
+
+**--help**, **-h**::
+    Show this message and exit
+
+**--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**, **-a**::
+Show hidden entries in the directory
+
+**--sort-by** 'name | size | time'::
+Sort either by size or time
+
+**--time-field** 'a | c | m'::
+Sort by (a)ccess, (c)hange or (m)odification time. Default: 'm'
+
+
+=== format-string characters
+Other characters than the following are ignored.
+
+[cols=2]
+|===
+
+|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** (default: 'modification time')
+
+|U
+|user name
+
+|u
+|user id
+
+|===
+
+
+== EXAMPLES
+
+dir_monitor --long-timestamp --print-header --format-string \'sAMn' --sort-by time --show-hidden /tmp
+
+watch -d \'*dir_monitor -t -H /tmp/*'
+
+== SEE ALSO
+*watch(1)*
+
+== AUTHOR
+Thorsten Töpper