Mercurial > projects > pk-update-icon

annotate README @ 56:63347002d746

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Simplify PkuiBackend Make the "check-interval" property construct-only since it is never changed at runtime and schedule the first check for updates in the "constructed" method. Remove unused property get methods. Destroy PkClient and remove periodic check in the "dispose" method.
author Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
date Sun, 01 Jul 2018 22:38:11 +0200
parents 7de92a24e86c
children 75249ce94ca0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
1 pk-update-icon
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
2 ==============
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
3
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
4 Description
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
5 -----------
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
6
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
7 pk-update-icon displays notifications and an icon in the tray area of the panel
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
8 when package updates are available.
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
9
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
10 Build Instructions
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
11 ------------------
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
12
44
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
13 pk-update-icon requires a POSIX:2004 compatible operating system, it has been
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
14 tested to work on Linux distributions. The following tools and shared
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
15 libraries are required to build pk-update-icon:
38
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
16
44
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
17 - GNU make >= 3.81
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
18 - pkg-config
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
19 - GNU gettext
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
20 - GNU or BSD install
38
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
21 - GLib version 2.30 or later
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
22 - GTK+ version 2.24 or later
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
23 - libunique
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
24 - libnotify
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
25 - PackageKit-glib2
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
26
44
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
27 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
28
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
29 Before building pk-update-icon check the commented macros in the Makefile for
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
30 any macros you may need to override depending on the used toolchain and
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
31 operating system.
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
32
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
33 By default, all files will be installed under the "/usr/local" directory, a
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
34 different installation path prefix can be set via the `prefix` macro. In
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
35 addition, a second path prefix can be specified via the `DESTDIR` macro which
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
36 will be prepended to any path, incuding the `prefix` macro path prefix. In
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
37 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
38 prepended to paths during installation and not be used for constructing
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
39 internal paths.
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
40
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
41 The following instructions assume that `make` is GNU make, on some platforms
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
42 it may be installed under a different name or a non-default path. In order to
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
43 start the build process run `make all`. After a successful build, run `make
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
44 install` to install the program, any associated data files and the
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
45 documentation.
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
46
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
47 Previously built binaries, object files, generated data files and
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
48 documentation can be removed by running `make clean`, any additional,
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
49 generated files which are not removed by the `clean` target can be removed by
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
50 running `make clobber`.
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
51
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
52 Contact
38
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
53 -------
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
54
44
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
55 Please send any feedback, translations or bug reports via email to
53
7de92a24e86c Update email address
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents: 44
diff changeset
56 <guido+pk-update-icon@berhoerster.name>.
44
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
57
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
58 Bug Reports
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
59 -----------
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
60
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
61 When sending bug reports, please always mention the exact version of
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
62 pk-update-icon with which the issue occurs as well as the version of the
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
63 operating system you are using and make sure that you provide sufficient
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
64 information to reproduce the issue and include any input, output, any error
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
65 messages.
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
66
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
67 In case of build issues, please also specify the implementations and versions
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
68 of the tools and shared libraries used to build the program, in particular the
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
69 compiler.
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
70
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
71 In case of crashes, please generate a stack trace with a suitable debugger
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
72 such as gdb, lldb, dbx, or debug after a crash has occurred either by
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
73 examining the resulting core file or by running the program from the debugger
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
74 and attach it to the bug report. In order to generate a meaningful stack
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
75 trace the program as well as any dynamically linked libraries need to be built
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
76 with debugging information, see the documentation of the used compiler for the
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
77 required compiler flags. If any of the dynamically linked shared libraries do
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
78 not contain debugging information, please either install debugging information
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
79 for these libraries using mechanisms provided by your operating system or
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
80 rebuild the libraries accordingly. Please refer to the documentation of the
cf2421217491 Improve README file
Guido Berhoerster <gber@opensuse.org>
parents: 38
diff changeset
81 debugger for detailed instructions on generating backtraces.
38
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
82
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
83 License
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
84 -------
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
85
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
86 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
87 distributed under the following license terms:
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
88
53
7de92a24e86c Update email address
Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
parents: 44
diff changeset
89 Copyright (C) 2014 Guido Berhoerster <guido+pk-update-icon@berhoerster.name>
38
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
90
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
91 Licensed under the GNU General Public License Version 2
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
92
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
93 This program is free software; you can redistribute it and/or modify
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
94 it under the terms of the GNU General Public License as published by
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
95 the Free Software Foundation; either version 2 of the License, or
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
96 (at your option) any later version.
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
97
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
98 This program is distributed in the hope that it will be useful,
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
99 but WITHOUT ANY WARRANTY; without even the implied warranty of
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
100 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
101 GNU General Public License for more details.
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
102
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
103 You should have received a copy of the GNU General Public License
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
104 along with this program; if not, write to the Free Software
db09b66c3853 Add README file with build instructions and author information
Guido Berhoerster <gber@opensuse.org>
parents:
diff changeset
105 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.