FUN a.k.a Frugalware Update Notifier
====================================

FUN is a client-server application with a sole purpose of notifying the 
user of new package updates.

Note: As of version 0.3.0, FUN is now also capable of displaying notifications
when some news is available on the frugalware.org website. So, FUN is no longer
just an update notifier, but a news notifier too. Future versions will also
support notifications when a security fix is released.

fund (fun daemon) runs in the background waiting for commands from the
client. The fun client is a small application that resides in the user's 
system tray and periodically sends certain commands to the fun daemon to get
information about package updates and other package related information.

The fun daemon (fund) is written in C and uses DBUS for communication. 
The fun client (fun) is written in C using the GTK+ toolkit.

fun is not a DE specific application and it can work on GNOME/XFCE/KDE
or any other DE provided the following requirements are satisfied.

Requirements
============
* pacman-g2 >= 3.6.4
* dbus >= 1.1.2
* dbus-glib >= 0.73
* gtk+2 >= 2.12.0
* libglade-2.0 >= 2.6
* libnotify >= 0.4.4
* libcurl
* libnxml

Using FUN
=========
You need to start the daemon by running the following command as root:
# service fun start

Once the daemon is started, you may launch the client by running the
following command:
$ fun

(A shortcut to FUN is also available in your respective DEs)

Configuring FUN
===============
FUN stores it's configuration in /home/user/.funrc file. Although you
can configure the various options directly from within FUN, you may even
edit the .funrc file manually. Currently, fun supports the following
three configuration options:

1)	update_interval

	This specifies the time in minutes after which FUN should check for
	package updates.
	Example: If you want FUN to check for new updates every hour, you
	should set update_interval=60 in the configuration file.

2)	notification_timeout

	This specifies the number of seconds for which the notification
	tooltip (bubble) will be displayed once an update is available.
	The range is 1 to 30 seconds.

3)	gfpm_launcher

	FUN doesn't have any inherent capability of updating your system
	once new packages are available. Once the user is notified of new
	updates, he/she may launch Gfpm (Graphical Frugalware Package
	Manager) to download and install the new updates.
	Updating packages on the system requires Gfpm to be run with 
	administrator (root) privileges. This can be achieved in three ways - gksu/kdesu/sudo.

	If you're using GNOME/XFCE, you probably need gksu. On KDE, you'll need
	kdesu. If you have setup sudo (see man sudo) then you may use sudo.

	This setting lets FUN to run Gfpm with one of the above mentioned
	ways. Possible values for this setting are
	gksu
	kdesu
	sudo

	Example: gfpm_launcher=gksu  (If you're using GNOME/XFCE)

4)	news_enabled

	If set to true, FUN will also notify the user in case of a new News entry
	is available on the frugalware.org homepage.
	News notification will be disabled if this is set to false.
	
	Example: news_enabled=true

5)	news_interval

	This specifies the time in minutes after which FUN should check for
	news updates on frugalware.org. This setting has no effect if 
	news_enabled is set to false.
	Example: If you want FUN to check for new NEWS updates every hour, you
	should set news_interval=60 in the configuration file.

6)	news_browser

	This setting sets the default browser to be used when the user clicks
	"Visit Link" on a news item.
	Supported browsers are: Firefox, Epiphany, Opera, Konqueror
	
	Example: news_browser=Firefox
	


For Developers
==============
If someone is interested in developing a client for FUN, following are
the services currently provided by FUN daemon.

1) TestService
This command is basically used to test whether the client can connect to
the FUN daemon. Before sending any other commands, make sure you test
connectivity to the daemon using TestService.

2) PerformUpdate
This command checks for package updates. It tells the daemon to perform
a repository sync and check if any updates are available. It returns the
list of available package updates as a string or otherwise NULL.

3) GetPackageInfo
This command is used to get extra information about an available package
update, like it's version, description etc. It accepts one argument, the
package name for which information is needed. It returns two parameters
- the package's latest version and it's description as strings.

NOTE: Service names are subject to change

Bugs
====
If you encounter any bug(s) in FUN, please report them at
http://www.bugs.frugalware.org/

Author
======
Priyank M. Gosalia <priyankmg@gmail.com>