-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathaarchup.1
129 lines (109 loc) · 7.53 KB
/
aarchup.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
.TH "aarchup" "1" "JUN 2011" "aericson <[email protected]>" ""
.SH "NAME"
aarchup \- lightweight pacman update notifier, a fork from archup by Rorschach
.SH "SYNOPSIS"
\fIaarchup\fR [options]
.SH "DESCRIPTION"
aarchup is a small C application which informs the user when system\-updates for Archlinux are available. It's licensed under the GPLv3. In contrast to other update notifiers aarchup is intended to be lightweight and just do what it should, notify about possible updates.
aarchup uses GTk+ and libnotify to show a desktop notification if updates are available. It follows the unix-philosophy of "just doing one thing, but doing it well". It notifies about new updates. With a systemd timer aarchup can be used to regularly check for new updates and get a desktop notification if there are some. It can also runs on it's own and check for updates regularly.
.SH "OPTIONS"
--command|-c [value] Set the command which gives out the list of updates.
The default is /usr/bin/checkupdates
--icon|-p [value] Shows the icon, whose path has been given as value, in the notification.
By default no icon is shown.
--maxentries|-m [value] Set the maximum number of packages which shall be displayed in the notification.
The default value is 30.
--timeout|-t [value] Set the timeout after which the notification disappears in seconds.
The default value is 3600 seconds, which is 1 hour.
--uid|-i [value] Set the uid of the process.
The default is to keep the uid of the user who started aarchup.
!!You should change this if root is executing aarchup!!
--urgency|-u [value] Set the libnotify urgency-level. Possible values are: low, normal and critical.
The default value is normal. With changing this value you can change the color of the notification.
--loop-time|-l [value] When this is used the program will control the check for updates in the interval of minutes specified,
if none is specified, the default(60) will be used. See: Loop-time above.
--help Prints this help.
--version Shows the version.
--aur Check aur for new packages too. Will need cower installed.
--debug|-d Print debug info.
--ftimeout [value] Program will manually enforce timeout for closing notification.
Do NOT use with --timeout, if --timeout works or without --loop-time [value].
The value for this option should be in minutes.
--pkg-no-ignore If this flag is set will not use the IgnorePkg variable from pacman.conf. Without the flag will ignore those
packages. Feel free to add packages names to pacman.conf even if they are from AUR, will cause no harm and will
also ignore it and not show updates.
.SH "CONFIGURATION"
aarchup can simply be invoked by executing it from the commandline. But you surely want to automate this task and let aarchup continuously be run with a systemd timer.
There are two ways of automating aarchup runs. One setup is to use the --loop-time option and the other is using a systemd timer.
\fIConfiguration File\fR
You can set up a configuration file instead of passing commandline arguments.
Simply create the file /etc/aarchup.conf
edit it with the following syntax:
.PP
# Comments are ignored
# The [main] line defines the group main
# You need to include this and no arguments
# can be placed before it.
# also notice that all options should be in the long form
# ie: for loop-time use only loop-time do not try to use 'l' or '-l'
[main]
# Argument on the left then '=' then the value of it
# ie:
loop-time=30
# Arguments without a value must have the '=' sign
# ie:
aur=
.PP
Please notice that if you have the file /etc/aarchup.conf all arguments passed to aarchup will be ignored except --help and --version.
\fILoop-time\fR
When using the --loop-time option the program will run endless. This has an advantage over the systemd method. For example on gnome3 when running aarchup with systemd, if you get more than one notification of updates and you don't close them, they will keep getting stacked and you are going to end up with a few notifications(of the same thing) at the notification bar. Which can get really annoying to close manually.
When the program is running on its own it can keep track of it's notifications and update them as needed instead of creating new ones.
In case you would like to use this method on startup copy /usr/share/doc/aarchup/aarchup.desktop to /home/user/.config/autostart
.PP
$ sudo cp /usr/share/doc/aarchup/aarchup.desktop /home/user/.config/autostart/
.PP
where user is your username.
Copy the file /usr/share/doc/aarchup/aarchupstartup.example
.PP
$ sudo cp /usr/share/doc/aarchup/aarchupstartup.example /usr/share/aarchup/aarchupstartup.sh
.PP
Edit the new file with different options if needed. Include --aur if you want to check for updates in AUR(you will need cower installed).
Archup will run on next boot or you can manually start it running /usr/share/aarchup/aarchupstartup.sh
\fIHourly\fR
The most simple setup is for a single user system where you want to check once an hour for updates. In this case just type:
.PP
$ sudo systemctl start aarchup.timer
.PP
and make it enabled at boot:
.PP
$ sudo systemctl enable aarchup.timer
.PP
Now every hour your package database will get updated and after that aarchup will be executed. If there are updates aarchup shows a desktop notification, if there are no updates nothing will happen. The desktop notification will automatically disappear after 60min or if you simply click on it.
\fIother Intervals\fR
If you want to execute aarchup at other intervals than hourly you are free to do so simply by editing the file /etc/systemd/system/aarchup.timer
Some hints on this:
* you can adjust the timeout value, before the notification will disappear with the --timeout option of aarchup
.SH "AUTHORS"
Written originally by Rorschach.
aarchup by aericson.
.SH "CREDITS"
Most of the credits goes to Rorshach for the original archup.
The features made in the fork was made by aericson and can
be found in the CHANGELOG file.
Also some minor changes were made by Andrew Kravchuk and can be
found at his github(https://github.com/lockie/archup) logs.
.SH "REPORTING BUGS"
Bugs? If you find one, send an email to [email protected]
or at https://bbs.archlinux.org/viewtopic.php?id=119129
.SH "COPYRIGHT"
Copyright 2011 aericson <[email protected]>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.