From cf82990925dac83b2313e81633ed3e51cb847584 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lilian=20J=C3=B3nsd=C3=B3ttir?= Date: Tue, 30 Jul 2024 21:07:48 -0700 Subject: [PATCH] update readme to be more inline with manpage --- README.md | 89 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- gt.1.scd | 2 +- 2 files changed, 89 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a35a50..f0636a7 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,102 @@ Run with no command and only filename(s) as argument(s) to skip displaying files Files are displayed in an interactive table, allowing them to be sorted, filtered, and selectively operated on. ### trash / tr + Find files on the filesystem based on the filter flags and any filename args. +#### flags + +*--recursive*, *-r* +operate on files recursively + +*--work-dir* dir, *-w* dir +operate on files in this directory + +*--hidden*, *-h* +operate on hidden files + ### list / ls + Find files in the trash based on the filter flags and any filename args. +#### flags + +*--non-interactive*, *-n* +list files and quit + +*--original-path* dir, *-O* dir +list files trashed from this directory + ### restore / re + Find files in the trash based on the filter flags and any filename args. +#### flags + +*--all*, *-a* +operate on all files in trash + +*--original-path* dir, *-O* dir +restore files trashed from this directory + ### clean / cl + Find files in the trash based on the filter flags and any filename args. -See gt(1) or `gt --help` for more in depth information on all command line flags. +#### flags + +*--all*, *-a* +operate on all files in trash + +*--original-path* dir, *-O* dir +remove files trashed from this directory + +## Flags + +### Global flags + +*--confirm*, *-c* +ask for confirmation before executing any action + +*--log* level, *-l* level +set log level + +### Filter flags (usable with all commands) + +*--match* pattern, *-m* pattern +operate on files matching regex pattern + +*--glob* pattern, *-m* pattern +operate on files matching glob + +*--not-match* pattern, *-M* pattern +operate on files not matching regex pattern + +*--not-glob* pattern, *-G* pattern +operate on files not matching glob + +*--on* date, *-O* date +operate on files modified on date + +*--before* date, *-B* date +operate on files modified before date + +*--after* date, *-A* date +operate on files modified after date + +*--files-only*, *-F* +operate on files only + +*--dirs-only*, *-D* +operate on directories only + +*--min-size* size, *-N* size +operate on files larger than size + +*--max-size* size, *-X* size +operate on files smaller than size + +*--mode* mode, *-x* mode +operate on files matching mode mode + +See also gt(1) or `gt --help`. diff --git a/gt.1.scd b/gt.1.scd index ae0c6ef..75da2ea 100644 --- a/gt.1.scd +++ b/gt.1.scd @@ -51,7 +51,7 @@ _flags_: operate on files recursively *--work-dir* dir, *-w* dir - operate on files in this `DIRECTORY` + operate on files in this directory *--hidden*, *-h* operate on hidden files