add usage hint

This commit is contained in:
anna 2022-10-13 16:18:48 +02:00
parent c3ddc9a664
commit eaf292e5cf
Signed by: fef
GPG key ID: EC22E476DC2D3D84

View file

@ -4,6 +4,12 @@ This utility is a proxy for `poweroff` to prevent you from accidentally shutting
the wrong system. It does this by printing a warning message and asking for confirmation
followed by a countdown before executing the actual command.
It is most useful when creating an alias for `poweroff` in your shell, like:
```sh
alias poweroff=/usr/local/sbin/poweroff_guard
```
## Important Consideration
If the standard output is not a tty, this behaves exactly like the regular `poweroff`.