~sil2100/location-service/gps-arm64

« back to all changes in this revision

Viewing changes to examples/service/service.1.ronn

  • Committer: Thomas Voß
  • Date: 2013-05-28 14:20:45 UTC
  • Revision ID: thomas.voss@canonical.com-20130528142045-kq5umqdmm4o53vwk
Initial push.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
ubuntu-location-service(1) -- A location service aggregating position/velocity/heading updates and exporting them over dbus.
 
2
============================================================================================================================
 
3
 
 
4
## SYNOPSIS
 
5
`ubuntu-location-service` `--bus` <bus> `--provider` <provider> [`--provider` <provider>] [provider specific options] [logging options]
 
6
 
 
7
## DESCRIPTION
 
8
A location service aggregating position/velocity/heading updates and exporting them over dbus.
 
9
 
 
10
## OPTIONS
 
11
These options control which bus the service is exposed upon and which providers are instantiated:
 
12
 
 
13
  * `--bus`=<bus>:
 
14
  Specify the bus that the service should be exposed upon, valid values are "session" or "system".
 
15
  
 
16
  * `--provider`=<provider>:
 
17
  Specify the provider that should be instantiated and configured for this service instance.
 
18
  Valid values are: geoclue::Provider, gps::Provider and skyhook::Provider.
 
19
    
 
20
These options control the behavior of the geoclue provider:
 
21
 
 
22
  * `--geoclue::Provider::name`=<name>:
 
23
  The name of the provider on the bus.
 
24
  
 
25
  * `--geoclue::Provider::path`=<path>:
 
26
  The object path of the provider on the bus.
 
27
  
 
28
These options control the behavior of the Skyhook provider:
 
29
 
 
30
  * `--skyhook::Provider::username`=<username>:
 
31
  Username for authenicating with the Skyhook service.
 
32
  
 
33
  * `--skyhook::Provider::realm`=<realm>:
 
34
  Realm for authenticating with the Skyhook service.
 
35
  
 
36
  * `--skyhook::Provider::period`=<period>:
 
37
  Delay between updates in [ms].
 
38
  
 
39
These options control the logging behavior of the service:
 
40
 
 
41
  * `--logtostderr`=<boolean, default: false>:
 
42
  Log messages to stderr instead of logfiles, defaults to false.
 
43
  
 
44
  * `--stderrthreshold`=<threshold, default: 2>:
 
45
  Copy log messages at or above this level to stderr in addition to logfiles. The numbers of severity levels INFO, WARNING, ERROR, and FATAL are 0, 1, 2, and 3, respectively. Defa
 
46
 
 
47
  * `--minloglevel`=<level, default: 0>:
 
48
  Log messages at or above this level. Again, the numbers of severity levels INFO, WARNING, ERROR, and FATAL are 0, 1, 2, and 3, respectively.
 
49
  
 
50
  * `--log_dir`=<path, default: "">:
 
51
  If specified, logfiles are written into this directory instead of the default logging directory.
 
52
 
 
53
  * `--v`=<level, default: 0>:
 
54
  Show all VLOG(m) messages for m less or equal the value of this flag.
 
55
 
 
56
## EXAMPLES
 
57
 
 
58
Starting the service with a gps and a skyhook provider, exposing it on the system bus:
 
59
    $ /usr/bin/ubuntu-location-service/examples/service
 
60
        --bus system 
 
61
        --provider gps::Provider 
 
62
        --provider skyhook::Provider 
 
63
        --skyhook::Provider::username=a_registered_user_name 
 
64
        --skyhook::Provider::realm=a_registered_realm
 
65
 
 
66
A slightly more verbose instance:
 
67
    $ /usr/bin/ubuntu-location-service/examples/service      
 
68
        --bus system
 
69
        --provider gps::Provider 
 
70
        --provider skyhook::Provider 
 
71
        --skyhook::Provider::username=a_registered_user_name
 
72
        --skyhook::Provider::realm=a_registered_realm
 
73
        --logtostderr=true
 
74
        --v=5
 
75
 
 
76
## COPYRIGHT
 
77
 
 
78
Ubuntu Location Service is Copyright (C) 2013 Canonical Ltd.