- USING AS rm REPLACEMENT
- CONFIGURATION FILE
- SEE ALSO
- COPYRIGHT AND LICENSE
trash-u - Trash files, with undo/redo capability
This document describes version 0.19 of trash-u (from Perl distribution File-Trash-Undoable), released on 2016-06-12.
# 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
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
List contents of trash directory.
Trash files (with undo support).
* marks required options.
Clear actions history.
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Pass options to formatter.
Choose output format, e.g. json, text.
- --help, -h, -?
Display help message and exit.
List actions history.
Equivalent to --format=json-pretty.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
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:
Do not use any configuration file.
Do not read environment for default options.
Redo previous undone action.
List available subcommands.
Undo previous action.
- --version, -v
Display program's version and exit.
Options for subcommand trash
Files/dirs to delete (JSON-encoded).
Files/dirs to delete (YAML-encoded).
Files/dirs to delete.
Files must exist.
Can be specified multiple times.
This script has shell tab completion capability with support for several shells.
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.
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).
For fish and zsh, install
shcompgen as described above.
This script can read configuration file, which by default is searched at ~/.config/trash-u.conf, ~/trash-u.conf or /etc/trash-u.conf (can be changed by specifying
--config-path). All found files will be read and merged.
To disable searching for configuration files, pass
Configuration file is in the format of IOD, which is basically INI with some extra features.
To put configuration for a certain subcommand only, use a section name like
You can put multiple profiles in a single file by using section names like
[profile=SOMENAME] (filter by profile) or
[SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching
You can also put configuration for multiple programs inside a single file, and use filter
program=NAME in section names, e.g.
[program=foo ...]. 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 ...]. If you only want a section to be read when the value of an environment variable has value equals something:
[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 ...]. If you only want a section to be read when an environment variable contains something:
[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)
PROG_OPT => str
Specify additional command-line options
Please visit the project's homepage at https://metacpan.org/release/File-Trash-Undoable.
Source repository is at https://github.com/sharyanto/perl-File-Trash-Undoable.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-Trash-Undoable
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.
COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by firstname.lastname@example.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.