rip/README.org

42 lines
2 KiB
Org Mode
Raw Normal View History

2016-08-31 01:12:21 +00:00
* rip (Rm ImProved)
2016-10-04 11:55:38 +00:00
[[https://crates.io/crates/rm-improved][https://img.shields.io/crates/v/rm-improved.svg]]
2016-10-17 11:18:48 +00:00
[[https://travis-ci.org/nivekuil/rip][https://travis-ci.org/nivekuil/rip.svg?branch=master]]
2016-10-04 11:55:38 +00:00
Deleted files get sent to the graveyard (=/tmp/.graveyard= by default, under their absolute path) instead of being unlinked, giving you a chance to recover them.
2016-08-31 01:12:21 +00:00
2016-09-20 04:15:55 +00:00
No data is overwritten. If files that share the same path are deleted, they will be renamed as numbered backups.
2016-08-31 01:12:21 +00:00
If you want to put the graveyard somewhere else (like =~/.local/share/Trash=), you have two options, in order of precedence:
1. Alias =rip= to =rip --graveyard ~/.local/share/Trash=
2. Set the environment variable =$GRAVEYARD= to =~/.local/share/Trash=
2016-10-16 23:50:12 +00:00
This can be a good idea because if the graveyard is mounted on an in-memory filesystem, (as /tmp is in Arch Linux), deleting large files can quickly fill up your RAM. It's also much slower to move files across filesystems, although the delay should be minimal with an SSD.
2016-10-04 11:48:04 +00:00
A deletion log is kept in =.rip_history=, found in the top level of the graveyard.
2016-08-31 01:12:21 +00:00
2016-09-03 09:41:15 +00:00
** Installation
2016-10-17 09:11:04 +00:00
Get a binary [[https://github.com/nivekuil/rip/releases][release]] (x86_64) or build it with =cargo install rm-improved= (requires a nightly version of rustc).
2016-09-03 09:41:15 +00:00
** Usage
2016-08-31 01:12:21 +00:00
#+BEGIN_EXAMPLE
USAGE:
2016-10-16 23:50:12 +00:00
rip [FLAGS] [OPTIONS] [TARGET]...
2016-08-31 01:12:21 +00:00
FLAGS:
2016-10-16 23:50:12 +00:00
-d, --decompose Permanently delete (unlink) the entire graveyard
2016-09-04 14:01:00 +00:00
-h, --help Prints help information
2016-10-17 09:11:04 +00:00
-i, --inspect Print some info about TARGET before prompting for action
2016-10-16 23:50:12 +00:00
-r, --resurrect Undo the last removal by the current user
2016-09-04 14:01:00 +00:00
-s, --seance List all objects in the graveyard that were sent from the current directory
-V, --version Prints version information
2016-08-31 01:12:21 +00:00
OPTIONS:
--graveyard <graveyard> Directory where deleted files go to rest
ARGS:
2016-10-16 23:50:12 +00:00
<TARGET>... File or directory to remove
2016-08-31 01:12:21 +00:00
#+END_EXAMPLE
2016-10-17 00:01:16 +00:00
*** Notes
- In general, a deletion followed by a =--resurrect= should be idempotent.
- You probably shouldn't alias =rm= to =rip=. =rm -r= is two characters longer, anyway.