[Pkg-kde-extras] Bug#661729: update-notifier-kde: no README file (example attached)

[Mirosław Zalewski]

Package: update-notifier-kde
Version: 1.2.4
Severity: wishlist

update-notifier-kde has no README file, which is quite confusing. After
installing it, I had hard time finding what this package is supposed to
do and how to check if it is even running. I had to dig into source-code,
and we should not expect other users to do the same (as they may not even
know how to download update-notifier-kde source code).

I have found similar problem on debian-kde mailing list[0], but there
were no real solutions.

I am attaching example README file to bug report. Please feel free to
modify it and include in next release (and push into git, too!).

[0] <http://lists.debian.org/debian-kde/2010/06/msg00005.html>

Best regards
Mirosław Zalewski

-- System Information:
Debian Release: wheezy/sid
  APT prefers testing
  APT policy: (990, 'testing'), (500, 'unstable')
Architecture: amd64 (x86_64)

Kernel: Linux 3.2.0-1-amd64 (SMP w/2 CPU cores)
Locale: LANG=pl_PL.UTF-8, LC_CTYPE=pl_PL.UTF-8 (charmap=UTF-8) (ignored: LC_ALL set to pl_PL.UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages update-notifier-kde depends on:
ii  libc6                   2.13-26
ii  libkdecore5             4:4.6.5-2+b1
ii  libkdeui5               4:4.6.5-2+b1
ii  libkio5                 4:4.6.5-2+b1
ii  libqt4-dbus             4:4.7.4-2
ii  libqtcore4              4:4.7.4-2
ii  libqtgui4               4:4.7.4-2
ii  libstdc++6              4.6.2-12
ii  update-notifier-common  0.99.3debian10

Versions of packages update-notifier-kde recommends:
ii  anacron  2.3-14

update-notifier-kde suggests no packages.

-- no debconf information

*** ~/readme-update-notifier-kde
Update-notifier-kde is simple KDEd module which only purpose
is notifying user about availability of updates and requirement
of system reboot.

It loads itself on KDE login, waits two minutes and then
check status of four files once a second. These files are:
- /var/lib/update-notifier/dpkg-run-stamp and
  /var/lib/update-notifier/updates-available - updated
  after each successful manipulation of dpkg database 
  (e.g. installing or removing packages).

- /var/run/reboot-required - updated after installation of 
  new kernel.

- /var/lib/apt/periodic/update-success-stamp - updated after
  each update of APT database. Please note that due to a bug
  in aptitude 0.6.5 and earlier, `aptitude update` command
  does not run command specified as APT::Update::Post-Invoke
  APT option, and therefore update-notifier-kde will be unable
  to notify about new updates. In such case, please use apt-get
  instead.

Also please note, that update-notifier-kde does not in any
way invoke APT database update. It must be ensured by other
means (e.g. a cron job).

To check if update-notifier-kde is up and running, go to KDE
System Settings -> Startup and Shutdown -> Service Manager
and check list of startup services. You can also enable or
disable modules on the fly.