Skip to content

Commit

Permalink
update readme and manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
celediel committed Jul 31, 2024
1 parent b2854a5 commit be41ead
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 15 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 4 additions & 4 deletions gt.1
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions gt.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Expand All @@ -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*
Expand All @@ -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*
Expand All @@ -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*
Expand Down

0 comments on commit be41ead

Please sign in to comment.