Mirror/exec-notify
1
0
Fork 0
mirror of https://codeberg.org/privacy1st/exec-notify synced 2024-12-22 23:16:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
Daniel Langbein 2020-12-26 15:36:20 +01:00
parent 3f82cdd966
commit 8d2e0165a4
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,5 +1,8 @@
# execNotify
Send notification on failure.
Or send an unconditional notification.
## setup
Create a `config.ini` file inside `execNotifyDir/config`.
@ -12,13 +15,29 @@ For the required fields, see `execNotifyDir/config/config.ini.example`
sudo make install
```
## usage
## usage of execNotify
Add `execNotify` in front of your command to execute.
You can pipe into `execNotify` but **not** from `execNotify
You can pipe into `execNotify` but **not** from `execNotify`
as the output gets modified.
### Example
For `ls /home` run `execNotify ls /home`
## usage of notify
Send stdout via mail:
`echo "Hello world!" | notify`
Or with optional subject:
`echo "Hello world!" | notify "someSubject"`
Or without the pipe:
`notify "someSubject" "Hello" "World!" "What's" "up?"`
`notify "someSubject" "Hello World! What's up?"`