gt/gt.1

239 lines
4.6 KiB
Groff
Raw Normal View History

2024-07-30 22:55:55 -04:00
.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "gt" "1" "2024-08-15" "gt version v0.0.3" "User Commands"
2024-07-30 22:55:55 -04:00
.PP
.SH NAME
.PP
gt - manual page for gt version 0.\&0.\&3
2024-07-30 22:55:55 -04:00
.PP
.SH DESCRIPTION
.PP
.SS NAME:
.PP
gt - Simple command line XDG Trash application
.PP
.SS USAGE:
.PP
gt [global options] [command [command options] / filename(s)]
.PP
.SS INFO:
.PP
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.\&
.PP
.SS VERSION:
.PP
0.\&0.\&3
2024-07-30 22:55:55 -04:00
.PP
.SS AUTHOR:
.PP
Lilian Jónsdóttir <lilian.\&jonsdottir@gmail.\&com>
.PP
.SH INTERACTIVE MODE
.PP
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.\&
.PP
.SH RM-LIKE TRASHING
.PP
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.\&
.PP
.SH COMMANDS
.PP
.SS TRASH:
\fIcommand\fR: trash, tr
.RS 4
Trash a file or files
.PP
.RE
\fIusage\fR:
.RS 4
trash [command options] [filename(s)]
.PP
.RE
\fIinfo\fR:
.RS 4
2024-07-30 23:06:52 -04:00
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.\&
2024-07-30 22:55:55 -04:00
.PP
.RE
\fIflags\fR:
.RS 4
\fB--recursive\fR, \fB-r\fR
.RS 4
operate on files recursively
.PP
.RE
\fB--work-dir\fR dir, \fB-w\fR dir
.RS 4
operate on files in this directory
2024-07-30 22:55:55 -04:00
.PP
.RE
\fB--hidden\fR, \fB-h\fR
.RS 4
operate on hidden files
.PP
.RE
.RE
.SS LIST:
\fIcommand\fR: list, ls
.RS 4
List trashed files
.PP
.RE
\fIusage\fR:
.RS 4
list [command options] [filename(s)]
.PP
.RE
\fIinfo\fR:
.RS 4
2024-07-30 23:06:52 -04:00
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.\&
2024-07-30 22:55:55 -04:00
.PP
.RE
\fIflags:\fR
.RS 4
\fB--non-interactive\fR, \fB-n\fR
.RS 4
list files and quit
.PP
.RE
\fB--original-path\fR dir, \fB-O\fR dir
.RS 4
list files trashed from this directory
.PP
.RE
.RE
.SS RESTORE:
\fIcommand\fR: restore, re
.RS 4
Restore a trashed file or files
.PP
.RE
\fIusage\fR:
.RS 4
restore [command options] [filename(s)]
.PP
.RE
\fIinfo\fR:
.RS 4
2024-07-30 23:06:52 -04:00
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.\&
2024-07-30 22:55:55 -04:00
.PP
.RE
\fIflags:\fR
.RS 4
\fB--all\fR, \fB-a\fR
.RS 4
operate on all files in trash
.PP
.RE
\fB--original-path\fR dir, \fB-O\fR dir
.RS 4
restore files trashed from this directory
.PP
.RE
.RE
.SS CLEAN:
\fIcommand\fR: clean, cl
.RS 4
Clean files from trash
.PP
.RE
\fIusage\fR:
.RS 4
clean [command options] [filename(s)]
.PP
.RE
\fIinfo\fR:
.RS 4
2024-07-30 23:06:52 -04:00
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.\&
2024-07-30 22:55:55 -04:00
.PP
.RE
\fIflags:\fR
.RS 4
\fB--all\fR, \fB-a\fR
.RS 4
operate on all files in trash
.PP
.RE
\fB--original-path\fR dir, \fB-O\fR dir
.RS 4
remove files trashed from this directory
.PP
.RE
.RE
.SH GLOBAL FLAGS
.PP
\fB--confirm\fR, \fB-c\fR
.RS 4
ask for confirmation before executing any action
.PP
.RE
\fB--log\fR level, \fB-l\fR level
.RS 4
set log level
.PP
.RE
.SH FILTER FLAGS (USABLE WITH ALL COMMANDS)
.PP
\fB--match\fR pattern, \fB-m\fR pattern
.RS 4
operate on files matching regex pattern
.PP
.RE
\fB--glob\fR pattern, \fB-m\fR pattern
.RS 4
operate on files matching glob
.PP
.RE
\fB--not-match\fR pattern, \fB-M\fR pattern
.RS 4
operate on files not matching regex pattern
.PP
.RE
\fB--not-glob\fR pattern, \fB-G\fR pattern
.RS 4
operate on files not matching glob
.PP
.RE
\fB--on\fR date, \fB-O\fR date
.RS 4
operate on files modified on date
.PP
.RE
\fB--before\fR date, \fB-B\fR date
.RS 4
operate on files modified before date
.PP
.RE
\fB--after\fR date, \fB-A\fR date
.RS 4
operate on files modified after date
.PP
.RE
\fB--files-only\fR, \fB-F\fR
.RS 4
operate on files only
.PP
.RE
\fB--dirs-only\fR, \fB-D\fR
.RS 4
operate on directories only
.PP
.RE
\fB--min-size\fR size, \fB-N\fR size
.RS 4
operate on files larger than size
.PP
.RE
\fB--max-size\fR size, \fB-X\fR size
.RS 4
operate on files smaller than size
.PP
.RE
\fB--mode\fR mode, \fB-x\fR mode
.RS 4
operate on files matching mode mode