[Merge] lp:~thomas-voss/location-service/add-documentation-and-tooling into lp:location-service/15.04

[Alberto Mardegan]

The indentation of the commands appears still wrong in the diff (due to TABs being used in other lines), but I'm fine with it. :-)

Diff comments:

> 
> === added file 'doc/daemon_and_cli.md'
> --- doc/daemon_and_cli.md	1970-01-01 00:00:00 +0000
> +++ doc/daemon_and_cli.md	2015-10-20 12:02:23 +0000
> @@ -0,0 +1,55 @@
> +# Service Daemon and CLI
> +
> +The location service offers a daemon executable and a corresponding
> +command-line interface for interacting with it. The daemon does not
> +necessarily require root privileges, but might so depending on your
> +configuration.
> +
> +Run the following command to receive an overview of the arguments to
> +the daemon:
> +
> +    ubuntu-location-serviced --help
> +
> +An example invocation of the daemon, configuring a GPS provider that
> +relies on the Android HAL to talk to the chipset, exposing the service
> +on the system DBus instance:
> +
> +    ubuntu-location-serviced --bus system --provider gps::Provider
> +
> +The cli allows for querying properties of a running service instance, e.g.:
> +
> +    ubuntu-location-serviced-cli --bus system --get --property is_online
> +
> +## Configuring an Out-Of-Process Provider
> +
> +If you want to run a provider out of process, the daemon executable
> +allows you to do so by instantiating a so-called remote provider. The
> +following invocation of the service tries to connect to the provider
> +instance described by the given unique DBus name and path.
> +
> +    ubuntu-location-serviced \
> +	  --bus system \
> +	  --provider remote::Provider \
> +          --remote::Provider::bus=system \

This is still offset, due to tabs being used in the other lines.

> +	  --remote::Provider::name=com.ubuntu.location.provider.Gps \
> +	  --remote::Provider::path=/
> +
> +Please note that the service allows for decorating provider names to
> +uniquely identify per provider configuration options and to allow for
> +loading more than one provider of a certain kind. The following
> +configuration configures two remote providers, one relying on GPS
> +(decorated with @gps) and another one relying on network-based
> +positioning (decorated with @network):
> +
> +    ubuntu-location-serviced \
> +	  --bus system \
> +	  --provider remote::Provider at gps \
> +          --remote::Provider at gps::bus=system \
> +	  --remote::Provider at gps::name=com.ubuntu.location.provider.Gps \
> +	  --remote::Provider at gps::path=/ \
> +	  --provider remote::Provider at network \
> +          --remote::Provider at network::bus=system \
> +	  --remote::Provider at network::name=com.ubuntu.location.provider.Network \
> +	  --remote::Provider at network::path=/
> +
> +    


-- 
https://code.launchpad.net/~thomas-voss/location-service/add-documentation-and-tooling/+merge/275006
Your team Ubuntu Phablet Team is subscribed to branch lp:location-service/15.04.