From b9c1921b135593966804d4515b9d07ede2715a3d Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Mon, 6 Apr 2020 23:31:05 -0700 Subject: [PATCH] Added manpage --- trash.1 | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 trash.1 diff --git a/trash.1 b/trash.1 new file mode 100644 index 0000000..9a521ed --- /dev/null +++ b/trash.1 @@ -0,0 +1,86 @@ +.\" Manpage for trash. +.\" Contact bruce@bruce-hill.com to correct errors or typos. +.TH man 8 "6 April 2020" "1.0" "trash manual page" +.SH NAME +trash \- A shell program for FreeDesktop.org-compliant trash management. +.SH SYNOPSIS +.B trash +[\fI-h\fR|\fI--help\fR] +[\fI-V\fR|\fI--version\fR] +[\fI-v\fR|\fI--verbose\fR] +[\fI-i\fR|\fI--interactive\fR] +[\fI-f\fR|\fI--force\fR] +[\fI-r\fR|\fI-R\fR|\fI--recursive\fR] +[\fI-u\fR|\fI--untrash\fR] +[\fI-e\fR|\fI--empty\fR] +[\fI-E\fR|\fI--empty-all\fR] +[\fI-l\fR|\fI--list\fR] +[[\fI--\fR] [\fIfiles...\fR]] + +.SH DESCRIPTION +\fBtrash\fR is a small shell program that helps you send files to a trash +directory (specified by the FreeDesktop.org Trash Specification), restore +files from there, and empty the trash directory. +.SH OPTIONS +.B \-h +.B \--help +Print the command line usage and exit. + +.B \-V +.B \--version +Print \fBtrash\fR's version and exit. + +.B \-v +.B \--verbose +Print more logging output. + +.B \-i +.B \--interactive +Always ask for confirmation. + +.B \-f +.B \--force +Never ask for confirmation. + +.B \-r +.B \-R +.B \--recursive +Ignored. (For compatibility with \fBrm -r\fR) + +.B \-u +.B \--untrash +Bring up a fuzzy picker for restoring a file from the trash. + +.B \-e +.B \--empty +Empty one or more files from the trash. + +.B \-E +.B \--empty-all +Empty all files from the trash. + +.B \-l +.B \--list +List all files in the trash. + +.B files... +The files to send to the trash. + +.SH EXAMPLES +.TP +.B +trash foo.txt baz.txt +Send \fIfoo.txt\fR and \fIbaz.txt\fR to the trash. + +.TP +.B +trash -u +Pick a file and untrash it. + +.TP +.B +trash -E +Empty the trash. + +.SH AUTHOR +Bruce Hill (bruce@bruce-hill.com)