perlancar > File-Trash-Undoable > trash-u

Download:
File-Trash-Undoable-0.17.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

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

VERSION ^

This document describes version 0.17 of trash-u (from Perl distribution File-Trash-Undoable), released on 2015-08-17.

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.

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

{en_US Clear actions history}.

--cmd=s

{en_US Select subcommand}.

--config-path=filename

{en_US Set path to configuration file}.

Can be specified multiple times.

--config-profile=s

{en_US Set configuration profile to use}.

--empty
--format-options=s

{en_US Pass options to formatter}.

--format=s

{en_US Choose output format, e.g. json, text}.

Default value:

 undef
--help, -h, -?

{en_US Display help message and exit}.

--history

{en_US List actions history}.

--json

{en_US Equivalent to --format=json-pretty}.

--list-contents
--no-config

{en_US Do not use any configuration file}.

--no-env

{en_US Do not read environment for default options}.

--redo

{en_US Redo previous undone action}.

--subcommands

{en_US List available subcommands}.

--undo

{en_US Undo previous action}.

--version, -v

{en_US Display program's version and exit}.

Options for subcommand trash

--files-json=s

{en_US Files/dirs to delete} (JSON-encoded).

See --files.

--files-yaml=s

{en_US Files/dirs to delete} (YAML-encoded).

See --files.

--files=s@*

{en_US Files/dirs to delete}.

{en_US Files must exist. }

Can be specified multiple times.

USING AS rm REPLACEMENT ^

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

SEE ALSO ^

File::Trash::Undoable

File::Trash::FreeDesktop

trash-cli

gvfs-trash

rmv

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.

ENVIRONMENT ^

=> str

Specify additional command-line options

CONFIGURATION FILE ^

This script can read configuration file, which by default is searched at ~/.config/.conf, ~/.conf or /etc/.conf (can be changed by specifying --config-path). All found files will be read and merged.

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

Configuration file is in the format of IOD, which is basically INI with some extra features. Section names map to subcommand names.

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

List of available configuration parameters:

Common for all subcommands

 format (see --format)
 format_options (see --format-options)

For subcommand 'empty'

For subcommand 'list_contents'

For subcommand 'trash'

 files (see --files)

FILES ^

~/.config/.conf

~/.conf

/etc/.conf

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/File-Trash-Undoable.

SOURCE ^

Source repository is at https://github.com/sharyanto/perl-File-Trash-Undoable.

BUGS ^

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.

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2015 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.

syntax highlighting: