fso-frameworkd for Debian
-------------------------

Debian ships a device-agnostic freesmartphone.org frameworkd.  For
this reason, fso-frameworkd alone will not even start, because it is
missing the configuration files.

Strictly speaking, to start, freesmartphone.org frameworkd needs only
the main configuration file, namely /etc/frameworkd.conf (of which an
example is in /usr/share/doc/fso-frameworkd/examples/frameworkd.conf).
However, to fully use fso-frameworkd, please install the appropriate
fso-config-* and fso-sounds-* packages.


* fso-config virtual package

Whenever frameworkd is known to work on a specific device, a Debian
package should be created, containing all the necessary configuration
files: mandatory are frameworkd.conf and the scenario ones, but the
package can also ship other files as needed (e.g. a udev rules file or
the opreferences ones).  The package must provide the virtual package
fso-config and its name must be in the form fso-config-$DEVICE.  The
fso-config-general package can be used as an example.

If you want to know a list of all availables fso-config-* package,
please use `apt-cache showpkg fso-config`, section "Reverse Provides".


* fso-sounds virtual package

At least two sound files are needed, the ring- and message-tones, to
be placed in /usr/share/sounds.  Each package shipping these two
sounds must provide the virtual package fso-sounds and its name must
be in the form fso-sounds-$ORIGIN.

The default upstream freesmartphone.org frameworkd profile lists these
sounds in /etc/freesmartphone/opreferences/conf/phone/default.yaml.
However, to allow an easier customization, each fso-sounds-* package
should provide a phone file named after the $ORIGIN part of the
package name, to be installed into /usr/share/fso-sounds-rules.  This
file should then be registered as an alternative for the upstream
default file through update-alternatives.  The fso-sounds-none package
can be used as an example.

If you want to know a list of all availables fso-sounds-* package,
please use `apt-cache showpkg fso-sounds`, section "Reverse Provides".


* local configuration for the ring- and message-tones

If you do not want to install any fso-sounds-* package at all, you
should create your own local configuration file and register it as an
alternative for the upstream default file through update-alternatives.
The local configuration must have the highest alternative priority to
preserve it as the default alternative in case an fso-sounds-* package
is installed.

NB, sounds file should be in /usr/share/sounds and the extension
    should always be specified.

Please follow these commands:

  $ cat <<EOF >/usr/local/share/fso-frameworkd-default-sounds-local.yaml
    # Debian ring- and message-tones configuration: local
    ring-tone: "$RING_FILE"
    ring-volume: $RING_VOLUME
    message-tone: "$MESSAGE_FILE"
    message-volume: $MESSAGE_VOLUME
    EOF
  $ update-alternatives \
	--install \
	/etc/freesmartphone/opreferences/conf/phone/default.yaml \
	fso-frameworkd-default-sounds.yaml \
	/usr/local/share/fso-frameworkd-default-sounds-local.yaml \
	100

Check the update-alternatives manpage for further information about
how to manage the different alternatives.

 -- Luca Capello <luca@pca.it>, Fri, 15 May 2009 23:16:05 +0200
