[](https://travis-ci.org/theimpossibleastronaut/rmw)
[](https://semaphoreci.com/andy5995/rmw-3)
# rmw v0.4.05
rmw is a cross-platform command-line "trash can" utility. It can send
files to your "Desktop" trash, or a completely separate folder. It can
also: restore files; permanently delete files that were rmw'ed more
than x number of days ago; skip files or directories that have a
"PROTECT" directive in the configuration file; and append a unique
string to the filenames so they won't be overwritten (duplication
protection).
Web site: https://github.com/theimpossibleastronaut/rmw/wiki
Anyone interested in this project is welcome to join the [Matrix chat
room](https://matrix.to/#/!XeJxcdkywroPaRKKtr:matrix.org).
## For Translators
We use Transifex to translate the output messages. To start translating
rmw, create an account in Transifex and ask to join a translation
team (or create a new one) at
https://www.transifex.com/na-309/rmw/
## Required libraries
libncurses5
If you are building from source, you will need the libncurses(5 or 6)-dev
package from your operating system distribution.
## Installation
### With superuser privileges:
Use `./configure --help` to view available compile-time options.
./configure
make
make install
### As a normal user:
./configure --prefix=$HOME/usr
make
make install
rmw will be installed to $HOME/usr/bin and the configuration file will be
copied to $HOME/usr/etc
### Pre-built binary packages
Packages for some operating systems are available on the
[Downloads](https://github.com/theimpossibleastronaut/rmw/releases) page
### Using _Homebrew_ on Mac OS X
Add a tap and install rmw:
* brew tap [theimpossibleastronaut/homebrew-extras](https://github.com/theimpossibleastronaut/homebrew-extras)
* brew install rmw
## Uninstall / Cleaning up
* make uninstall (uninstalls the program if installed with 'make install`)
* make distclean (removes files in the build directory created by
`configure` and 'make')
## Usage
```
== First-time use ==
If you installed rmw as a normal user, this next step can be skipped.
After rmw is installed, create the user configuration directory by
typing 'rmw' and hitting enter. Afterward, copy rmwrc to
$HOME/.config/rmw and rename it to 'config':
cd ~/.config/rmw
~/.config/rmw$ cp rmwrc config
Then edit the file to suit your needs.
rmw will automatically create a 'lastpurge' and 'lastrmw' in that same
directory.
== Configuration File ==
Documentation explaining the configuration can be found in rmwrc.
Waste folders will be created automatically. (e.g. if '$HOME/trash.rmw'
is listed in the config file, these 3 directories will be created:
$HOME/trash.rmw
$HOME/trash.rmw/files
$HOME/trash.rmw/info
If one of the WASTE folders is on removable media, then the user has the
option of appending ',removable' (details in etc/rmwrc).
== Features and Options ==
Usage: rmw [OPTION]... FILE...
ReMove the FILE(s) to a WASTE directory listed in configuration file
or: rmw -s
or: rmw -u
or: rmw -z FILE...
Restore FILE(s) from a WASTE directory
-h, --help
-t, --translate display a translation of the configuration file
-c, --config filename use an alternate configuration
-l, --list list waste directories
-g, --purge run purge even if it's been run today
-o, --orphaned check for orphaned files (maintenance)
-f, --force allow purge to run
-B, --bypass bypass directory protection
-v, --verbose increase output messages
-w, --warranty display warranty
-V, --version display version and license information
===] Restoring [===
-z, --restore <wildcard filename(s) pattern>
-s, --select select files from list to restore
-u, --undo-last undo last ReMove
== Purging ==
If purging is 'on', rmw will permanently delete files from the folders
specified in the configuration file after 'x' number of days. Purging can be
disabled by using 'purge_after = 0' in configuration file. rmw will only check
once per day if it's time to purge (use -g to check more often).
Purge requires -f (--force) to run.
To skip that requirement, add the line
force_not_required
to your configuration file.
The day of the last purge is stored in $HOME/config/rmw/lastpurge
== Empty the Trash ==
To empty the trash completely, rmw can use the environmental variable
RMWTRASH. Usage:
RMWTRASH=empty rmw -fg
== -z option ==
To restore a file, or multiple files, specify the path to them in in the
<WASTE>/files folder (wildcards ok).
e.g. 'rmw -z ~/.local/share/Trash/files/foo*'
Files can also be restored using only the basename, from within any directory.
NOTE: That feature will not process wildcards unless the user is in a
<WASTE>/files folder and the filespec actually exists in the present working
directory.
== Protected directories ==
If 'PROTECT = /home/andy' is specified in the config file, /home/andy, and all
dirs and files beneath it will be "protected"; they will be skipped, and this
warning will be displayed:
"File is in protected directory: <filename/dir>"
WASTE folders and the rmw configuration/data directory are protected by
default (there is no need to add a 'PROTECT =' line for them.
Protection can by bypassed using -B
== -t, --translate ==
If a translation of the configuration file is available in your native
language is available, it will be displayed.
(If you would be interested in adding a translation, please visit
https://github.com/theimpossibleastronaut/rmw/wiki/Translating)
== -f, --force ==
rmw will normally refuse to purge directories if they contain non-writable
subdirectories. You can use -f 2 times if you ever see a message that tells
you "permission denied; directory still contains files" (e.g. rwm -gff).
```
|
