Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README, add AUR helpers as dependencies #22

Merged
merged 1 commit into from
Nov 8, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# update-notifier
Script to check for pacman and AUR updates and notify user about it. Can be called with conky, autostart script or cron.
This script will notify the user as soon as updates are available. It can use the following AUR helpers as backend: yay, trizen, pacaur, yaourt.

This script will notify the user as soon as updates are available. It can use the following AUR helpers as backend: yay, trizen, pacaur, yaourt.


## Installation
update-notifier uses the "notify-send" command to notify the user about available updates. If you want to test, whether it works on your system execute the following command in your terminal and you should see a notification pop up:
```
notify-send "Hi"
```
If you don't you probably lack either libnotify or a notification daemon (dunst, xfce4-notification-daemon, lxqt-notificationd, etc).
If you don't you probably lack either libnotify or a notification daemon (dunst, xfce4-notification-daemon, lxqt-notificationd, etc).

### Installation from Repositories
Install update-notifier from Manjaro Repositories:
Expand All @@ -20,7 +20,10 @@ sudo pacman -S update-notifier
### Manual Installation
First, make sure all dependencies are installed on your system:
- pacman
- [yaourt](https://wiki.archlinux.org/index.php/Yaourt)
- [yay](https://github.com/Jguer/yay) (optional)
- [trizen](https://github.com/trizen/trizen) (optional)
- [pacaur](https://github.com/rmarquis/pacaur) (optional)
- [yaourt](https://wiki.archlinux.org/index.php/Yaourt) (optional)
- git
- libnotify (or a notification daemon - look above for a brief explanation)

Expand All @@ -35,10 +38,10 @@ cd update-notifier && chmod +x update-notifier update-checker


## How to Use
update-notifier can be used in differnt ways. Here are some common examples:
update-notifier can be used in different ways. Here are some common examples:

### conky
Add the following line to the main part of your conky in order to check for updates every 7200 seconds (= 2 hours) and display a notification:
Add the following line to the main part of your conky in order to check for updates every 7200 seconds (= 2 hours) and display a notification:
```
${execi 7200 update-notifier}
```
Expand All @@ -47,21 +50,21 @@ ${execi 7200 update-notifier}
You can also put update-notifier in your crontab file. There are differnt ways to do this. If you are already using a crontab file, you know what you need to do.

An example line in crontab can be (in order to check for updates every 7 hours):
```
* */7 * * * update-notifier
```
```
* */7 * * * update-notifier
```

### autostart
Autostart can vary in function and form depending on your Desktop Environment or Window Manager. Add the following command to your autostart in order to check for updates every 2.5 hours and display a notification:
Autostart can vary in function and form depending on your Desktop Environment or Window Manager. Add the following command to your autostart in order to check for updates every 2.5 hours and display a notification:
```
update-checker 2h 30m
```
Other examples are (for updating every 2 hours and 3 days):
```
update-checker 7200
```
```
update-checker 3d
```
```
update-checker 7200
```
```
update-checker 3d
```

The default is 6 hours. This happens if you run update-checker witgout arguments.