Update documentation

This commit is contained in:
caem 2024-05-16 21:56:40 +02:00
parent f196ba0fe6
commit 424826e60d
No known key found for this signature in database
GPG key ID: 3BCEDBB0C38805DA
2 changed files with 20 additions and 1 deletions

View file

@ -32,3 +32,17 @@ to be removed by zypper.
#### Overview of arguments #### Overview of arguments
This script takes no arguments. This script takes no arguments.
### `webpautoconv.bash`
This script scans directories for webp files and converts them to png files. It can also be run as a daemon
that runs whenever a file is created in the specified (sub)directories.
#### Overview of arguments
```
arguments:
-c/--config [config file] (optional) <The configuration file> {default:~/.config/webpautoconv}
-d/--directory [scan directory] (optional) <The directory to convert files in> {default:~/Downloads}
-w/--watch [none] (optional) <Launch in daemon mode and watch folder> {default:off}
-r/--recursive [non] (optional) <Also scan subdirectories> {default:off}
```

View file

@ -67,7 +67,12 @@ args() {
while [ -n "$1" ]; do while [ -n "$1" ]; do
case "$1" in case "$1" in
"" | "-h" | "--help") "" | "-h" | "--help")
echo "unimplemented" printf "\n\
arguments:\n\
-c/--config [config file] (optional) <The configuration file> {default:~/.config/webpautoconv}\n\
-d/--directory [scan directory] (optional) <The directory to convert files in> {default:~/Downloads}\n\
-w/--watch [none] (optional) <Launch in daemon mode and watch folder> {default:off}\n\
-r/--recursive [non] (optional) <Also scan subdirectories> {default:off}\n"
exit 0 exit 0
;; ;;
"-c" | "--config") "-c" | "--config")