wpfind/README.md

96 lines
3.1 KiB
Markdown
Executable file

# WPFind
![wpfind](pics/logo.png)
The purpose of this script is to find wallpapers among pictures files in directory and sub-directories and move/copy them to a separate directory.
It can be useful when you are trying to clean your mess on your computer ;-)
## Requirements
- Ubuntu, Linux Mint (should work on Ubuntu derivatives), Arch Linux (should work on Ubuntu derivatives) and probably any Linux distro
- detox
- imagemagick
## Installation
For Ubuntu 18.04, Linux Mint 19.x, and other derivatives
```shell
curl -L https://packagecloud.io/makoto/stable/gpgkey | sudo apt-key add -
echo "deb https://packagecloud.io/makoto/stable/ubuntu/ bionic main" | sudo tee /etc/apt/sources.list.d/makoto.list
sudo apt-get update
sudo apt-get install wpfind
```
For Ubuntu 20.04, Linux Mint 20.x, and other derivatives
```shell
curl -L https://packagecloud.io/makoto/stable/gpgkey | sudo apt-key add -
echo "deb https://packagecloud.io/makoto/stable/ubuntu/ focal main" | sudo tee /etc/apt/sources.list.d/makoto.list
sudo apt-get update
sudo apt-get install wpfind
```
For Arch Linux and derivatives
```shell
yay -S wpfind
```
## Usage options
```
██╗ ██╗██████╗ ███████╗██╗███╗ ██╗██████╗
██║ ██║██╔══██╗██╔════╝██║████╗ ██║██╔══██╗
██║ █╗ ██║██████╔╝█████╗ ██║██╔██╗ ██║██║ ██║
██║███╗██║██╔═══╝ ██╔══╝ ██║██║╚██╗██║██║ ██║
╚███╔███╔╝██║ ██║ ██║██║ ╚████║██████╔╝
╚══╝╚══╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═══╝╚═════╝
Find wallpapers recursively in a dir and sub-directories...
Version : 0.1.3
Author : Francois B (Makoto)
Licence : GPLv3
Usage : wpfind [options]
-c : copy wallpapers found in a specific folder
-m : move wallpapers found in a specific folder
-s : interactive mode (ask confirmation before overwriting a file)
-i <directory_to_analyze_to_find_wallpapers> (default: current directory)
-o <wallpapers_found_save_directory> (default: wpfiles inside the current directory)
-w <minimum_pixel_width> (default: 1920px)
-v : verbose mode
-h : show help & informations
```
## Usage examples
Copy wallpapers in the current directory and sub-directories with minimum width of 1920px to wpfiles
```shell
wpfind -c
```
Move wallpapers in the current directory and sub-directories with minimum width of 1920px to wpfiles
```shell
wpfind -m
```
Move wallpapers in the /home/user/MyPics directory and sub-directories with minimum width of 2560px to /home/user/MyWP directory
```shell
wpfind -m -w 2560 -i /home/user/MyPics -o /home/user/MyWP
```
## Credits
This script has been written by Francois B. (Makotosan/Shakasan)
- Email : francois@exoseed.be
- Website : https://makotonoblog.be/wpfind/
## Licence
The script is licensed under the terms of the GPLv3