waybar-gps(5)

πŸ’– waybar-gps β€” the manual page, but make it a group chat πŸ’–

okay so bestie. you found the waybar-gps(5) page. this is section 5 of the manual, it's the gps module situation, and we're gonna get through it together because honestly? it's giving iconic GPS widget energy and you deserve to understand every single crumb. πŸ›°οΈβœ¨


🌸 NAME 🌸

waybar β€” the gps module. that's it. that's the name. short, sweet, main character. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

it's the gps module for gpsd. yes, fr fr, that's the whole description. it talks to gpsd and gives you the tea about where you are on this big blue marble. 🌍


πŸŽ€ FILES πŸŽ€

  • $XDG_CONFIG_HOME/waybar/config β€” your per user configuration file. this is where you put your lil config dreams. 🫢

✨ ADDITIONAL FILES ✨

so libgps lives in these places, and it's lowkey just vibing in one of them:

  1. /usr/lib/libgps.so or /usr/lib64/libgps.so
  2. /usr/lib/pkgconfig/libgps.pc or /usr/lib64/pkgconfig/libgps.pc
  3. /usr/include/gps

like, pick a lane bestie, but also slay. 🌈


πŸ’… CONFIGURATION πŸ’…

okay here's every single knob. do not skip a single one, i will know. πŸ‘€

  • format β€” typeof: string, default: {glyph}. the text format. what it even says. πŸ’¬
  • tooltip β€” typeof: bool, default: true. option to disable tooltip on hover. if hover popups are too much for you, set this to false, no judgement. πŸ™ˆ
  • tooltip-format β€” typeof: string, default: Games running: {glyph}. the text format of the tooltip. (yes, Games running: β€” we do not ask questions, we copy the default exactly. 😭)
  • interval β€” typeof: integer, default: 5. the interval in which the GPS information gets polled (e.g. current speed).
    • heads up: significant updates (e.g. the current fix mode) are updated immediately. so the important stuff is not sitting there marinating in the interval queue. periodt. ⭐
  • hide-disconnected β€” typeof: bool, default: true. defines if the module should be hidden if there is no GPS receiver. default is hide it, because nobody wants to see a ghost. πŸ’€
  • hide-no-fix β€” typeof: bool, default: false. defines if the module should be hidden if there is no GPS fix. default is do show it. πŸ”₯

🌟 FORMAT REPLACEMENTS 🌟

these are the little {guys} you can stick in your formats. they're the whole personality of the module, honestly. 🧚

  • {mode} β€” Fix mode.
  • {status} β€” Technology used for GPS fix. not all GPS receivers report this. (rude of them, but okay. 😀)
  • {latitude} β€” Latitude, decimal degrees. can be NaN.
  • {latitude_error} β€” Latitude uncertainty, meters. can be NaN.
  • {longitude} β€” Longitude, decimal degrees. can be NaN.
  • {longitude_error} β€” Longitude uncertainty, meters. can be NaN.
  • {altitude_hae} β€” Altitude, height above ellipsoid, meters. can be NaN.
  • {altitude_msl} β€” Longitude, MSL, meters. can be NaN.
  • {altitude_error} β€” Altitude uncertainty, meters. can be NaN.
  • {speed} β€” Speed over ground, meters/sec. can be NaN.
  • {speed_error} β€” Speed uncertainty, meters/sec. can be NaN.
  • {climb} β€” Vertical speed, meters/sec. can be NaN.
  • {climb_error} β€” Vertical speed uncertainty, meters/sec. can be NaN.
  • {satellites_visible} β€” Number of satellites visible from the GPS receiver. πŸ‘€πŸ›°οΈ
  • {satellites_used} β€” Number of satellites used for the GPS fix. the chosen ones. πŸ‘‘
bestie note: a lot of these can be NaN. that's their business, not ours. don't come for them. 🫢

🌈 EXAMPLES 🌈

here is a real one, copy it exactly, character for character, because we are not risking a typo in the group chat:

"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
}

look at that comment: an empty format will hide the module. sneaky little trick and it ate. πŸ’…βœ¨


πŸ’œ STYLE πŸ’œ

the CSS classes you can dress up. get in, we're doing glam. πŸŽ€

  • #gps
  • #gps.disabled β€” applied when GPS is disabled.
  • #gps.fix-none β€” applied when GPS is present, but there is no fix.
  • #gps.fix-2d β€” applied when there is a 2D fix.
  • #gps.fix-3d β€” applied when there is a 3D fix. the glow-up tier. πŸ‘‘

and that's the whole page, bestie. go forth, configure your gps module, and let it be known that you understood every option. i'm so proud of you. πŸŒΈπŸ¦‹πŸŽ€

this beauty came to you as waybar-gps, dated 2026-02-08, and it's page 5 of the manual (waybar-gps(5)). mwah. πŸ’–

πŸ“¦ where this page comes from