diff options
| author | terminaldweller <devi@terminaldweller.com> | 2023-03-19 14:05:56 +0000 |
|---|---|---|
| committer | terminaldweller <devi@terminaldweller.com> | 2023-03-19 14:05:56 +0000 |
| commit | 5a35848eaa352cccbebb844e9767755ff6233b62 (patch) | |
| tree | cca3aa7d72677d33948b13c4697754f75622448f /README.md | |
| parent | added function names to the logs (diff) | |
| download | lclip-5a35848eaa352cccbebb844e9767755ff6233b62.tar.gz lclip-5a35848eaa352cccbebb844e9767755ff6233b62.zip | |
updated the README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 55 |
1 files changed, 50 insertions, 5 deletions
@@ -1,10 +1,55 @@ -# lclip -a minimal clip manager in lua.</br> -This is technically just the back-end. I'm using dmenu as the front-end but it has its limitations.</br> +# lclipd +A minimal clipboard manager in lua.</br> + +# How it works +lclipd runs the clipboard contents through `detect-secrets` and then puts the content in a sqlite3 database.</br> + +lclipd keeps the clipboard content database in the `tmp` directory.</br> + +Both X11 and wayland are supported.</br> + +lclipd is meant to be run as a user service. It can also be simply run by just running the script directly.</br> + +lclipd puts its logs in the system log.</br> + +lclipd does not require elevated privileges to run.</br> + +## Requirements +* lua5.3 +* [luaposix](https://github.com/luaposix/luaposix) +* [argparse](https://github.com/mpeterv/argparse) +* [luasqlite3](http://lua.sqlite.org/index.cgi/home): luasqlite3 comes in two flavours. One include sqlite3 in the lua rock itself and one does not. If you choose to install the rock without sqlite3 you need to have that installed on your system. +* [detect-secrets](https://github.com/Yelp/detect-secrets) +* xclip +* wl-clipboard + ```sh -sqlite3 $(cat /tmp/lclipd_db_name) 'select content from lclipd;' | dmenu +luarocks install --local luaposix +luarocks install --local argparse +luarocks install --local lsqlite3 +pip install detect-secrets ``` +lclipd is technically just the "back-end". One way to have a frontend is to use dmenu:</br> +```sh +sqlite3 $(cat /tmp/lclipd/lclipd_db_name) 'select content from lclipd;' | dmenu -l 10 | xsel -ib +``` + +## Options + +``` +Usage: ./lclipd.lua [-h] [-s <hist_size>] + +Options: + -h, --help Show this help message and exit. + -s <hist_size>, + --hist_size <hist_size> + history file size +``` + +## Supported OSes +lcilpd uses luaposix so any POSIX-half-compliant OS will do.</br> + ## TODO * The DB permissions are not being taken care of.</br> -* This doesn't support wayland yet.</br> +* allow passing options to `detect-secrets`.</br> |