aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorterminaldweller <devi@terminaldweller.com>2023-03-20 19:53:48 +0000
committerterminaldweller <devi@terminaldweller.com>2023-03-20 19:53:48 +0000
commit56ac1ba44d5c4043590459c2beb11b73cf5be3f7 (patch)
tree31cd7e9d041598ed81ab781faacb89d3103ed31b /README.md
parentupdated the frontend example (diff)
downloadlclip-56ac1ba44d5c4043590459c2beb11b73cf5be3f7.tar.gz
lclip-56ac1ba44d5c4043590459c2beb11b73cf5be3f7.zip
added an option for passing options to detect-secrets. lclipd now changes the db file permission to read/write for user only.
Diffstat (limited to '')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index fddc369..3d55847 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ pip install detect-secrets
## Usage
-lclipd is technically just the "back-end". One way to have a frontend is to use dmenu:</br>
+lclipd is technically just the "backend". One way to have a frontend is to use dmenu:</br>
```sh
#!/usr/bin/env sh
@@ -40,22 +40,22 @@ SQL_DB="$(cat /tmp/lclipd/lclipd_db_name)"
content=$(sqlite3 "${SQL_DB}" "select replace(content,char(10),' '),id from lclipd;" | dmenu -fn "DejaVuSansMono Nerd Font Mono-11.3;antialias=true;autohint=true" -D "|" -l 20 -p "lclipd:")
sqlite3 "${SQL_DB}" "select content from lclipd where id = ${content}" | xsel -ib
```
+For the above to work you have to have added the dynamic patch to dmenu.</br>
## Options
```
-Usage: ./lclipd.lua [-h] [-s <hist_size>]
+Usage: ./lclipd.lua [-h] [-s <hist_size>] [-d <detect_secrets_args>]
Options:
-h, --help Show this help message and exit.
-s <hist_size>,
--hist_size <hist_size>
number of distinct entries for clipboard history
+ -d <detect_secrets_args>,
+ --detect_secrets_args <detect_secrets_args>
+ options that will be passed to detect secrets (default: )
```
## 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>
-* allow passing options to `detect-secrets`.</br>