Skip to content

Commit ae1f2ff

Browse files
Improve wording, add -v option to README.md
1 parent c72ac68 commit ae1f2ff

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ cat "/usr/local/bin/pve_backup_usb.sh"
5959
# take care about owner and permissions
6060
chown "root:root" "/usr/local/bin/pve_backup_usb.sh"
6161
chmod 0755 "/usr/local/bin/pve_backup_usb.sh"
62+
63+
# print the script's version number
64+
/usr/local/bin/pve_backup_usb.sh -v
6265
```
6366

6467

@@ -123,6 +126,7 @@ No need to worry: existing partitions or drives not [intended](#preparation-of-a
123126
* `-l`: Name used for handling LUKS via `/dev/mapper/` and creating a mountpoint subdirectory at `/media/`. Defaults to `pve_backup_usb`. 16 alphanumeric chars at max.
124127
* `-q`: Flag to enable quiet mode. Emails will be sent only on `error` or `warning` then (but not on `info` or `success`).
125128
* `-u`: Username of the account used to run the backups. Defaults to `root`. The script checks if the correct user is calling it and permissions of e.g. the keyfile are fitting or are too permissive. The user also needs permissions to mount devices. Running the script as `root` is propably a good choice for most environments.
129+
* `-v`: Print the script's version number, then exit.
126130

127131

128132
### Cronjob example

pve_backup_usb.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -300,8 +300,7 @@ for most environments.
300300
Print this help.
301301
.TP
302302
.B -v
303-
Print the script's version.
304-
303+
Print the script's version number, then exit.
305304
306305
.SH EXIT STATUS
307306
This program returns an exit status of zero if it succeeds. Non zero

0 commit comments

Comments
 (0)