leanshot/README.md

61 lines
978 B
Markdown

leanshot
========
Screenshot-capturing utility for X11.
Requirements
------------
You must have:
- python3 (build-time)
- libxcb
- xcb-util-image
Installation
------------
Find it in package repositories:
- [`leanshot` on Arch Linux (AUR)](https://aur.archlinux.org/packages/leanshot/)
To install from crates.io, use:
```
cargo install leanshot
```
Usage
-----
```
leanshot -o hello.png select
leanshot -o hello.png fullscreen
```
Example Integration
-------------------
It's nice to have a script like:
```bash
#!/bin/bash
SCREENSHOT=$HOME/.cargo/bin/leanshot
# choose some file to save it to
FILE="/path/to/screenshot.png"
$SCREENSHOT $1 -o $FILE
# optional: copy to clipboard
XCLIP=/usr/bin/xclip
$XCLIP -selection clipboard -t image/png -i $FILE
```
Then, you can bind this script to the keybinds of your choice using your window manager's config.
You can find other scripts in the `contrib/` directory.
Contact
-------
Author: Michael Zhang
License: MIT