Commit 2b9e3cc3 authored by Sachin Chand's avatar Sachin Chand

Add man page for geoclue configuration file

Change in meson.build to build geoclue.5 man page from geoclue.5.in

Fixes #49
parent 2e4d41ae
Pipeline #24710 passed with stage
in 11 minutes and 7 seconds
.TH "GEOCLUE CONFIGURATION" 5
.SH NAME
geoclueconf
\-
geoclue configuration parameters
.SH SYNOPSIS
.IP
.B agent configuration options
\fIwhitelist
\fI[network-nmea]
[3G]
\fI\fI[cdma]
\fI[modem-gps]
\fI[wifi]
.IP
.B application configuration options
\fI[random-app]
.SH DESCRIPTION
.ad
.fi
All configurations settings below are mandatory and the defaults are
what you see before you edit them in geoclue.conf. If you want to keep the default
values around, copy and comment out the appropriate line(s) before
changing them.
.SH agent configuration options \fI[agent]
.IP \fBwhitelist
.br
Whitelist of desktop IDs (without .desktop part) of all agents we recognise,
separated by a ';'.public key
.IP
.B whitelist=geoclue-demo-agent;gnome-shell;io.elementary.desktop.agent-geoclue2
.br
.IP \fB[network-nmea]
.br
Network NMEA source configuration options
.IP
.B \fBenable=true
.br
Fetch location from NMEA sources on local network?
.br
.IP \fB[3G]
.br
3G source configuration options
.IP
.B \fBenable=true
.br
Enable 3G source
.br
.IP \fB[cdma]
.br
CDMA source configuration options
.IP
.B \fBenable=true
.br
Enable CDMA source
.br
.IP \fB[modem-gps]
.br
Modem GPS source configuration options
.IP
.B \fBenable=true
.br
Enable Modem-GPS source
.br
.IP \fB[wifi]
.br
WiFi source configuration options
.IP
.B \fBenable=true
.br
Enable WiFi source
.IP
.B url=\fIhttps://location.services.mozilla.com/v1/geolocate?key=geoclue
.br
URL to the wifi geolocation service. The key can currenty be anything, just
needs to be present but that is likely going to change in future.
.br
To use the Google geolocation service instead of mozilla's, simply uncomment
this url while changing API_KEY to your Google API key and comment out or
remove the url above.
.IP
.B WARNING:
Please make sure that you are complying with the Google's ToS and
policies if you uncomment this:
https://developers.google.com/maps/documentation/geolocation/policies
url=https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_KEY
.IP
.B submit-data=false
Submit data to Mozilla Location Service
.br
If set to true, geoclue will automatically submit network data to Mozilla
each time it gets a GPS lock.
.IP
.B submission-url=\fIhttps://location.services.mozilla.com/v1/submit?key=geoclue
.br
URL to submission API of Mozilla Location Service
.IP
.B submission-nick=geoclue
.br
A nickname to submit network data with. This is currently used for leaderboard:
https://location.services.mozilla.com/leaders
A nickname must be 2-32 characters long.
.br
.SH application configuration options \fI[agent]
.IP Note:
.IP
Having an entry here for an application with \fBallowed=true means that
geoclue will not ask agent to authorize the application. This is to
ensure that system components and applications with built-in
authorization mechanism (e.g web browsers) do not have to be bound to
agents.
.IP
If your application is denied access to location information and your
operating system doesn't provide any mechanism to change that, it is
likely a bug in your operation system (or geoclue). The solution is to
report the issue with all details, rather than adding your application
to this list.
.IP Format:
.IP
.B [random-app]
.br
Desktop ID of application without .desktop part
.IP
.B allowed=true|false
.br
Allowed access to location information?
.IP
.B system=true|false
.br
Is application a system component?
.IP
.B users=
.br
List of UIDs of all users for which this application is allowed location
info access, separate by ';'. Keep it empty for allowing it for all users.
.IP Examples:
.IP
\fB[gnome-datetime-panel]
allowed=true
system=true
users=
.IP
\fB[gnome-color-panel]
allowed=true
system=true
users=
.IP
\fB[org.gnome.Shell]
allowed=true
system=true
users=
.IP
\fB[io.elementary.desktop.agent-geoclue2]
allowed=true
system=true
users=
.IP
\fB[epiphany]
allowed=true
system=false
users=
.IP
\fB[firefox]
allowed=true
system=false
users=
.br
.SH AUTHOR
.na
.nf
Sachin Chand
NIT Agartala
Tripura, India, pin: 201301
\ No newline at end of file
......@@ -51,4 +51,11 @@ if get_option('enable-backend')
configuration: conf,
install_dir: systemd_unit_dir)
endif
if systemd_unit_dir != ''
configure_file(output: 'geoclue.5',
input: 'geoclue.5.in',
configuration: conf,
install_dir: systemd_unit_dir)
endif
endif
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment