From be41eadb43c9d675ecf54ce468af60ac0dc9dc12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lilian=20J=C3=B3nsd=C3=B3ttir?= Date: Tue, 30 Jul 2024 20:06:52 -0700 Subject: [PATCH] update readme and manpage --- README.md | 24 +++++++++++++++++------- gt.1 | 8 ++++---- gt.1.scd | 8 ++++---- 3 files changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 9331aa6..5a35a50 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,29 @@ # gt -g(o)t(rash) or something like that -small cli for xdg trash specification +g(o)t(rash) is a simple, command line program to interface with the XDG Trash. Files in the trash may be listed, cleaned, or restored via an interactive table, and filtered with various flags. -## commands +## Interactive Mode + +Run with no args to start interactive mode. In interactive mode, files in the trash are displayed, and may be selected to either restore or remove permanently. + +## rm-like Trashing + +Run with no command and only filename(s) as argument(s) to skip displaying files, sending them straight to the trash, in a quick, rm-like way. + +## Commands + +Files are displayed in an interactive table, allowing them to be sorted, filtered, and selectively operated on. ### trash / tr -moves files to trash +Find files on the filesystem based on the filter flags and any filename args. ### list / ls -list files in trash +Find files in the trash based on the filter flags and any filename args. ### restore / re -restore files from trash +Find files in the trash based on the filter flags and any filename args. ### clean / cl -clean files out of trash +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. diff --git a/gt.1 b/gt.1 index fb1d433..117b86c 100644 --- a/gt.1 +++ b/gt.1 @@ -56,7 +56,7 @@ trash [command options] [filename(s)] .RE \fIinfo\fR: .RS 4 -The trash command finds files on the filesystem based on the filter flags and any filename args, and displays them in a sortable and filterable table, allowing them to be selectively trashed.\& +The trash command finds files on the filesystem based on the filter flags and any filename args, and displays them in an interactive table, allowing them to be sorted, filtered, and selectively trashed.\& .PP .RE \fIflags\fR: @@ -90,7 +90,7 @@ list [command options] [filename(s)] .RE \fIinfo\fR: .RS 4 -The trash command finds files in the trash based on the filter flags and any filename args, and displays them in a sortable and filterable table.\& +The list command finds files in the trash based on the filter flags and any filename args, and displays them in an interactive table, allowing them to be sorted, filtered.\& .PP .RE \fIflags:\fR @@ -119,7 +119,7 @@ restore [command options] [filename(s)] .RE \fIinfo\fR: .RS 4 -The trash command finds files in the trash based on the filter flags and any filename args, and displays them in a sortable and filterable table, allowing them to be selectively restored.\& +The restore command finds files in the trash based on the filter flags and any filename args, and displays them in an interactive table, allowing them to be sorted, filtered, and selectively restored.\& .PP .RE \fIflags:\fR @@ -148,7 +148,7 @@ clean [command options] [filename(s)] .RE \fIinfo\fR: .RS 4 -The trash command finds files in the trash based on the filter flags and any filename args, and displays them in a sortable and filterable table, allowing them to be selectively removed permanently.\& +The clean command finds files in the trash based on the filter flags and any filename args, and displays them in an interactive table, allowing them to be sorted, filtered, and selectively removed permanently.\& .PP .RE \fIflags:\fR diff --git a/gt.1.scd b/gt.1.scd index 3d0b352..ae0c6ef 100644 --- a/gt.1.scd +++ b/gt.1.scd @@ -44,7 +44,7 @@ _usage_: trash [command options] [filename(s)] _info_: - The trash command finds files on the filesystem based on the filter flags and any filename args, and displays them in a sortable and filterable table, allowing them to be selectively trashed. + The trash command finds files on the filesystem based on the filter flags and any filename args, and displays them in an interactive table, allowing them to be sorted, filtered, and selectively trashed. _flags_: *--recursive*, *-r* @@ -64,7 +64,7 @@ _usage_: list [command options] [filename(s)] _info_: - The trash command finds files in the trash based on the filter flags and any filename args, and displays them in a sortable and filterable table. + The list command finds files in the trash based on the filter flags and any filename args, and displays them in an interactive table, allowing them to be sorted, filtered. _flags:_ *--non-interactive*, *-n* @@ -81,7 +81,7 @@ _usage_: restore [command options] [filename(s)] _info_: - The trash command finds files in the trash based on the filter flags and any filename args, and displays them in a sortable and filterable table, allowing them to be selectively restored. + The restore command finds files in the trash based on the filter flags and any filename args, and displays them in an interactive table, allowing them to be sorted, filtered, and selectively restored. _flags:_ *--all*, *-a* @@ -98,7 +98,7 @@ _usage_: clean [command options] [filename(s)] _info_: - The trash command finds files in the trash based on the filter flags and any filename args, and displays them in a sortable and filterable table, allowing them to be selectively removed permanently. + The clean command finds files in the trash based on the filter flags and any filename args, and displays them in an interactive table, allowing them to be sorted, filtered, and selectively removed permanently. _flags:_ *--all*, *-a*