projects/package-update-indicator: README annotate

annotate README @ 46:8ed91c5e0116

Explicitly schedule the initial check for updates after a fixed short delay Explicitly schedule the first check after startup to run after a short delay defined in PUI_STARTUP_DELAY. This was always intended but not correctly handled before, the first check could thus take up to the number of seconds defined in PUI_CHECK_UPDATES_INTERVAL.

author	Guido Berhoerster <guido+pui@berhoerster.name>
date	Mon, 09 Nov 2020 15:06:04 +0100
parents	d7d2ac4dbac6
children

rev	line source
0 6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	1 package-update-indicator
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	2 ========================
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	3
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	4 Description
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	5 -----------
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	6
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	7 The package-update-indicator utility regularly checks for software updates and
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	8 notifies the user about available updates using desktop notifications and
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	9 either a status notifier icon or a system tray icon.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	10
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	11 Build Instructions
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	12 ------------------
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	13
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	14 package-update-indicator requires a POSIX:2004 compatible operating system, it
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	15 has been tested to work on Linux distributions. The following tools and
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	16 shared libraries are required to build package-update-indicator:
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	17
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	18 - GNU make 3.81 or later
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	19 - pkg-config
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	20 - GNU gettext 0.19 or later
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	21 - GNU or BSD install
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	22 - GLib version 2.48 or later
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	23 - GTK+ version 3.18 or later
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	24 - libappindicator 12.10.0 or later
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	25 - PackageKit-glib2 0.8.17 or later
5 a4020e99e550 Do not check for updates if the battery is low Guido Berhoerster <guido+pui@berhoerster.name> parents: 0 diff changeset	26 - upower-glib 0.99.0 or later
6 2477a6151087 Make PackagKit use the user's network proxies Guido Berhoerster <guido+pui@berhoerster.name> parents: 5 diff changeset	27 - polkit 0.105 or later
0 6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	28 - the xsltproc tool from libxml2
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	29
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	30 Before building package-update-indicator check the commented macros in the
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	31 Makefile for any macros you may need to override depending on the used
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	32 toolchain and operating system.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	33
13 d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	34 By default the "update-command" setting is empty which means users will not be
d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	35 offered to install updates from a notification or the indicator menu.
d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	36 Distribution vendors may override this or any other default setting by
d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	37 installing a vendor override file alongside the schema file. An example for
d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	38 is distributed with package-update-indicator, see the file
d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	39 "examples/10_vendor_update_command.gschema.override.example". For details on
d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	40 how to install a vendor override file see the manual page for
d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	41 glib-compile-schemas.
d7d2ac4dbac6 Add note for vendors on how to override default settings Guido Berhoerster <guido+pui@berhoerster.name> parents: 6 diff changeset	42
0 6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	43 By default, all files will be installed under the "/usr/local" directory, a
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	44 different installation path prefix can be set via the `prefix` macro. In
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	45 addition, a second path prefix can be specified via the `DESTDIR` macro which
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	46 will be prepended to any path, incuding the `prefix` macro path prefix. In
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	47 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	48 prepended to paths during installation and not be used for constructing
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	49 internal paths.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	50
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	51 The following instructions assume that `make` is GNU make, on some platforms
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	52 it may be installed under a different name or a non-default path. In order to
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	53 start the build process run `make all`. After a successful build, run `make
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	54 install` to install the program, any associated data files and the
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	55 documentation.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	56
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	57 Previously built binaries, object files, generated data files and
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	58 documentation can be removed by running `make clean`, any additional,
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	59 generated files which are not removed by the `clean` target can be removed by
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	60 running `make clobber`.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	61
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	62 Contact
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	63 -------
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	64
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	65 Please send any feedback, translations or bug reports via email to
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	66 <guido+pui@berhoerster.name>.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	67
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	68 Bug Reports
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	69 -----------
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	70
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	71 When sending bug reports, please always mention the exact version of
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	72 package-update-indicator with which the issue occurs as well as the version of
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	73 the operating system you are using and make sure that you provide sufficient
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	74 information to reproduce the issue and include any input, output, any error
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	75 messages.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	76
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	77 In case of build issues, please also specify the implementations and versions
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	78 of the tools and shared libraries used to build the program, in particular the
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	79 compiler.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	80
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	81 In case of crashes, please generate a stack trace with a suitable debugger
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	82 such as gdb, lldb, dbx, or debug after a crash has occurred either by
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	83 examining the resulting core file or by running the program from the debugger
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	84 and attach it to the bug report. In order to generate a meaningful stack
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	85 trace the program as well as any dynamically linked libraries need to be built
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	86 with debugging information, see the documentation of the used compiler for the
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	87 required compiler flags. If any of the dynamically linked shared libraries do
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	88 not contain debugging information, please either install debugging information
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	89 for these libraries using mechanisms provided by your operating system or
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	90 rebuild the libraries accordingly. Please refer to the documentation of the
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	91 debugger for detailed instructions on generating backtraces.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	92
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	93 License
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	94 -------
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	95
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	96 Except otherwise noted, all files are Copyright (C) 2018 Guido Berhoerster and
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	97 distributed under the following license terms:
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	98
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	99 Copyright (C) 2018 Guido Berhoerster <guido+pui@berhoerster.name>
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	100
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	101 Permission is hereby granted, free of charge, to any person obtaining
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	102 a copy of this software and associated documentation files (the
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	103 "Software"), to deal in the Software without restriction, including
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	104 without limitation the rights to use, copy, modify, merge, publish,
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	105 distribute, sublicense, and/or sell copies of the Software, and to
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	106 permit persons to whom the Software is furnished to do so, subject to
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	107 the following conditions:
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	108
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	109 The above copyright notice and this permission notice shall be included
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	110 in all copies or substantial portions of the Software.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	111
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	112 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	113 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	114 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	115 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	116 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	117 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
6884bb8130ca Initial revision Guido Berhoerster <guido+pui@berhoerster.name> parents: diff changeset	118 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Mercurial > projects > package-update-indicator

annotate README @ 46:8ed91c5e0116