Alexander/threadwatcher
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

explain ENV vars

Browse Source
This commit is contained in:
Alexander Bocken 2021-09-27 11:57:00 +02:00
parent 98a2156b94
commit 8ad1af4f73
Signed by: Alexander
GPG Key ID: 1D237BE83F9B05E8
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -8,27 +8,29 @@ This script relies mainly on `dmenu` for interactions.
threadwatcher [add URL DL_LOCATION] [list] [edit] [clean] threadwatcher [add URL DL_LOCATION] [list] [edit] [clean]
add URL DL_LOCATION add URL DL_LOCATION
downloads specified thread to given locaton. Paths can be relative to HOME or absolute. downloads specified thread to given location. Paths can be relative to \$HOME or absolute.
list list lists all currently watched URLs and where they are downloading to
lists all currently watched URLs and where they are downloading to edit open threads file in \$EDITOR/vim to manually edit.
edit clean deletes threads file. This will not delete already downloaded material.
open threads file in $EDITOR/vim to manually edit error prune manually prune list of threads. Deletes all finished threads from list.
clean dedupe [DIR]
deletes threads file. This will not delete already downloaded material. remove all duplicate files from current download directories. (Comparing sha512 sums)
If no DIR is given, will check all currently downloading directories.
help display this help and exit.
``` ```
## Installation ## Installation
### AUR ### AUR
threadwatcher is in the AUR! Using your favorite AUR package manager, paru for example, it's a simple threadwatcher is in the AUR! Using your favorite AUR package manager, paru for example, it's a simple
``` ```sh
paru -S threadwatcher paru -S threadwatcher
``` ```
This is the recommended installation version for Arch-based distros. This is the recommended installation version for Arch-based distros.
### From Source ### From Source
As the Makefile might suggest, it's As the Makefile might suggest, it's
``` ```sh
git clone https://github.com/AlexBocken/threadwatcher git clone https://github.com/AlexBocken/threadwatcher
cd threadwatcher cd threadwatcher
make install make install
@ -36,12 +38,18 @@ make install
root privileges are required for the default install location. root privileges are required for the default install location.
If issues with running the program persist, first check the "Requirements" section below. If issues with running the program persist, first check the "Requirements" section below.
## Environment variables
There are some environment variables which can be set to change threadwatchers behaviour:
| variable name | explanation | default |
| `TW_THREADWATCHER_DIR` | sets location of file with list of threads | `${XDG_DATA_HOME:-$HOME/.local/share}/threadwatcher` |
| `TW_AUTOPRUNE` | delete threads out of list if nothing can be found on scan. (Can result in wrong behaviour with unreliable internet connections) | `true` |
| `TW_AUTODEDUPE` | remove duplicates automatically after each scan. (Using sha521 sums) | `false` |
## Requirements ## Requirements
Besides the obvious stuff for shell scripts like `sed`,`awk`,`grep` and other base-devel programs, this script relies on `jq` and, of course, `dmenu`. Besides the obvious stuff for shell scripts like `sed`,`awk`,`grep` and other base-devel programs, this script relies on `jq` and, of course, `dmenu` (now only optionally relies on dmenu).
Make sure these programs are installed. Make sure these programs are installed.
## TODO ## TODO
[ ] differentiate between thread complete and 4chan down (curl error codes don't work because of cloudflare) [ ] differentiate between thread complete and 4chan down (curl error codes don't work because of cloudflare)