Commit Graph
23 Commits
Author SHA1 Message Date
AlexandClaude Opus 4.8 72fdf77c19 docs: align man pages with code + fill documentation gaps (0.16.0 audit)
A full man<->code consistency audit surfaced options, format placeholders
and CSS classes that were implemented but undocumented, documented but not
implemented (some causing fmt crashes when copied from examples), and
defaults that disagreed with the code. This aligns the docs with the code
and fixes a few genuine code gaps.

Docs:
- Add the missing waybar-user(5) man page (and register it in meson.build)
- Document previously-undocumented options/placeholders/CSS across many
  modules (custom image-path/image-name/icon-size, graph_type/width/
  datapoints; battery smooth-power; wireplumber format-source/only-physical;
  mpris {position}/prefer-album-artist; network {signalStrengthApp}/compact
  bandwidth; pulseaudio {source_volume}/{source_desc}; upower {temperature}/
  {model}/{native-path}; wwan {power_state}/{imei}; tray ignore-list; and
  many CSS state classes: .sink-muted, .source-muted, .workspace-hover, etc.)
- Correct documented defaults to match the code (hyprland format {name},
  gamemode {count}, cpu-graph interval 5, cava input_delay 4, niri taskbar
  icon-size 16, disk/gps/wayfire formats, menu-actions object type, ...)
- Remove placeholders/options that do not apply (custom-graph {icon}/format/
  format-icons/rotate) and fix crashing examples (wwan {mode}, gps
  format-no-fix); note cava background/foreground/continuous_rendering are
  cava-config-file options

Code:
- bluetooth: accept the documented `controller` key as a synonym of
  `controller-alias` (the option was silently ignored)
- mango/workspaces: supply the documented `{name}` fmt arg (was missing ->
  fmt::format threw)
- privacy: read `tooltip` as a bool (was guarded on isString(), so the
  documented `tooltip: false` was silently ignored)

All man pages validated with scdoc 1.11.4. Not compiled locally (no gtkmm);
C++ build relies on CI.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-04 02:39:38 +02:00
Alex aea5b73fdd Merge remote-tracking branch 'origin/master' into theoratkin/master
# Conflicts:
#	include/modules/mpd/state.inl.hpp
2026-07-03 22:26:54 +02:00
Theo Ratkin 929c817eb4 chore(man): add playing-interval option to mpd man page 2025-08-08 07:55:28 -04:00
Stefan Haan d100e78872 mpd: add uri and filename format arguments 2024-12-28 13:58:19 +01:00
Lars Niesen f9acc1fed9 Add stretching of modules and modules-center toggling
This Patch allows the stretching of modules-{left,center,right} as well
add a "expand" flag to AModule. This allows one module to consume the
leftover space.
To allow the left or right modules to fully consume the center, the
changes also include a way to remove the center box (center_)
altogether.
2024-11-20 00:00:27 +01:00
Michal Suchanek 1fa8019ad5 man: Clarify rotate option
fixes: #3576
2024-09-08 13:56:12 +02:00
Benjamin Voisin d9f2e0f7d2 📝 add menu config informations in manpages 2024-05-28 20:42:12 +02:00
Merlin Sievers 25b85800a5 Add documentation for justify option 2024-03-04 20:00:57 +01:00
Avishek Sen d0cab2a367 docs: fix typos and improve language coherence 2023-10-21 21:15:25 +05:30
chayleaf a53c97f7f6 mpris: add tooltip and length limits 2023-03-31 19:53:53 +07:00
Sefa Eyeoglu fc89b01ba6 feat: implement mpd volume format template
Allow the user to show the current volume from MPD status via the
`format` and/or `tooltip-format` configuration options.

The values are provided by libmpdclient and are integers, generally
between 0-100 (without %). Values above 100 are also possible, as mpd
output plugins like `pulse` support volumes above 100%.

Signed-off-by: Sefa Eyeoglu <contact@scrumplex.net>
2021-04-20 08:35:47 +02:00
nullobsi b12b500bfc Merge branch 'master' into master 2021-02-10 09:39:03 -08:00
nullobsi 97f7050d7d Update man pages 2021-02-01 08:34:51 -08:00
nullobsi 6cc3212605 add length limits for MPD module tags 2021-01-30 18:04:59 -08:00
Joseph Benden 587eb5fdb4 mpd: support password protected MPD
- Add MPD module option `password`, and document it.
- Add logic to send the password, directly after connecting to
  MPD.

Fixes: #576
Signed-off-by: Joseph Benden <joe@benden.us>
2020-10-19 11:54:36 -07:00
koffeinfriedhof c651670222 Added song position and queue length. 2020-09-13 18:49:47 +02:00
Alex d1c4897f31 feat: update man 2020-04-12 18:38:51 +02:00
Cole Helbling 75c6e2e7d5 mpd: add paused format string 2020-01-07 09:15:54 -08:00
fuzxi c41cedd407 Update waybar-mpd.5.scd 2020-01-06 13:29:04 +01:00
Alex f9543e47dd Revert "Add info on "on-click-middle" option to custom module man page" 2019-12-17 11:58:30 +01:00
fuzxi ac8e892cbd Update waybar-mpd.5.scd 2019-12-15 15:09:08 -08:00
Michael Aquilina 0b237246f0 Fixes to man pages 2019-08-27 10:40:19 +01:00
Michael Aquilina ac461f38f4 Add waybar-mpd(5) 2019-08-26 15:27:32 +01:00