/ 
App-trash-u-0.20
River stage one • 1 direct dependent • 1 total dependent
/ trash-u

NAME

trash-u - Trash files, with undo/redo capability

VERSION

This document describes version 0.20 of trash-u (from Perl distribution App-trash-u), released on 2016-12-27.

SYNOPSIS

# trash some files, but in simulation mode, not really trashing the files
% VERBOSE=1 trash-u --dry-run *.bak

# trash some files, for real
% trash-u *.bak

# list trash contents
% trash-u --list-contents

# trash some more files
% trash-u * .tmp

# oops, made a mistake; no worry, let's undo; now previous trashing is reversed
% trash-u --undo

# undo again; now the *.bak files are also restored
% trash-u --undo

# redo; now the *.bak files are trashed again
% trash-u --redo

# show history
% trash-u --history

# forget history; past actions can no longer be undone/redone
% trash-u --clear-history

# empty trash; this action is not undoable (the point is to reclaim space)
% trash-u --empty

# display help for more options
% trash-u --help

DESCRIPTION

This command-line program is an interface to File::Trash::Undoable, which in turn uses File::Trash::FreeDesktop.

Features: undo/redo, dry run mode, per-filesystem trash dir.

This program is relatively new and have not yet been tested extensively. Use with caution.

USING AS rm REPLACEMENT

trash-u can be used as rm replacement (a.k.a. alias) with some caveats:

  • trash-u deletes directories by default

    That is, it behaves as if -R rm option is in effect.

  • Some rm options exist but do not have any effect (noop)

  • Some rm options are still missing/unknown

    This include: -i/-I/--interactive, --one-file-system, --no-preserve-root.

SUBCOMMANDS

empty

Empty trash.

list_contents

List contents of trash directory.

trash

Trash files (with undo support).

OPTIONS

* marks required options.

Common options

--clear-history

Clear actions history.

--cmd=s

Select subcommand.

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--empty
--format-options=s

Pass options to formatter.

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--help, -h, -?

Display help message and exit.

--history

List actions history.

--json

Equivalent to --format=json-pretty.

--list-contents
--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--no-config

Do not use any configuration file.

--no-env

Do not read environment for default options.

--redo

Redo previous undone action.

--subcommands

List available subcommands.

--undo

Undo previous action.

--version, -v

Display program's version and exit.

Options for subcommand trash

--files-json=s

Files/dirs to delete (JSON-encoded).

See --files.

--files-yaml=s

Files/dirs to delete (YAML-encoded).

See --files.

--files=s@*

Files/dirs to delete.

Files must exist.

Can be specified multiple times.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C trash-u trash-u

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

complete trash-u 'p/*/`trash-u`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/trash-u.conf, ~/trash-u.conf, or /etc/trash-u.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

Common for all subcommands

format (see --format)
format_options (see --format-options)
naked_res (see --naked-res)

Configuration for subcommand 'empty'

Configuration for subcommand 'list_contents'

Configuration for subcommand 'trash'

files (see --files)

ENVIRONMENT

PROG_OPT => str

Specify additional command-line options

FILES

~/.config/trash-u.conf

~/trash-u.conf

/etc/trash-u.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-trash-u.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-trash-u.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-trash-u

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

File::Trash::Undoable

File::Trash::FreeDesktop

trash-cli

gvfs-trash

rmv

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.