.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar-gps" "5" "2025-07-03" "waybar-gps" "User Manual"
.PP
.SH NAME
.PP
waybar - gps module
.PP
.SH DESCRIPTION
.PP
\fBgps\fR module for gpsd.\&
.PP
.PP
.SH FILES
.PP
$XDG_CONFIG_HOME/waybar/config 
.br
	Per user configuration file
.PP
.SH ADDITIONAL FILES
.PP
libgps lives in:
.PP
.PD 0
.IP 1. 4
/usr/lib/libgps.\&so or /usr/lib64/libgps.\&so
.IP 2. 4
/usr/lib/pkgconfig/libgps.\&pc or /usr/lib64/pkgconfig/libgps.\&pc
.IP 3. 4
/usr/include/gps
.PD
.PP
.SH CONFIGURATION
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {glyph} 
.br
	The text format.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	default: Games running: {glyph} 
.br
	The text format of the tooltip.\&
.PP
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 5 
.br
	The interval in which the GPS information gets polled (e.\&g.\& current speed).\&
.RS 4
Significant updates (e.\&g.\& the current fix mode) are updated immediately.\&
.PP
.RE
\fBhide-disconnected\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Defines if the module should be hidden if there is no GPS receiver.\&
.PP
\fBhide-no-fix\fR: 
.br
	typeof: bool 
.br
	default: false 
.br
	Defines if the module should be hidden if there is no GPS fix.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{mode}\fR: Fix mode
.PP
\fB{status}\fR: Technology used for GPS fix.\& Not all GPS receivers report this.\&
.PP
\fB{latitude}\fR: Latitude, decimal degrees.\& Can be NaN.\&
.PP
\fB{latitude_error}\fR: Latitude uncertainty, meters.\& Can be NaN.\&
.PP
\fB{longitude}\fR: Longitude, decimal degrees.\& Can be NaN.\&
.PP
\fB{longitude_error}\fR: Longitude uncertainty, meters.\& Can be NaN.\&
.PP
\fB{altitude_hae}\fR: Altitude, height above ellipsoid, meters.\& Can be NaN.\&
.PP
\fB{altitude_msl}\fR: Longitude, MSL, meters.\& Can be NaN.\&
.PP
\fB{altitude_error}\fR: Altitude uncertainty, meters.\& Can be NaN.\&
.PP
\fB{speed}\fR: Speed over ground, meters/sec.\& Can be NaN.\&
.PP
\fB{speed_error}\fR: Speed uncertainty, meters/sec.\& Can be NaN.\&
.PP
\fB{climb}\fR: Vertical speed, meters/sec.\& Can be NaN.\&
.PP
\fB{climb_error}\fR: Vertical speed uncertainty, meters/sec.\& Can be NaN.\&
.PP
\fB{satellites_visible}\fR: Number of satellites visible from the GPS receiver.\&
.PP
\fB{satellites_used}\fR: Number of satellites used for the GPS fix.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"gps": {
	"format": "{mode}",
	"format-disabled": "", // an empty format will hide the module
	"format-no-fix": "No fix",
	"format-fix-3d": "{status}",
	"tooltip-format": "{mode}",
	"tooltip-format-no-fix": "{satellites_visible} satellites visible",
	"tooltip-format-fix-2d": "{satellites_used}/{satellites_visible} satellites used",
	"tooltip-format-fix-3d": "Altitude: {altitude_hae}m",
	"hide-disconnected": false
}
.fi
.RE
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#gps\fR
.IP \(bu 4
\fB#gps.\&disabled\fR Applied when GPS is disabled.\&
.IP \(bu 4
\fB#gps.\&fix-none\fR Applied when GPS is present, but there is no fix.\&
.IP \(bu 4
\fB#gps.\&fix-2d\fR Applied when there is a 2D fix.\&
.IP \(bu 4
\fB#gps.\&fix-3d\fR Applied when there is a 3D fix.\&