Commit Graph
14 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 1afb1a5229 docs(man): document options implemented but missing from man pages
Sync man pages with the code for options that were read but undocumented:
- sway/workspaces: ignore-workspaces
- niri/workspaces: sort-by-number, hide-empty
- wayfire/workspaces: disable-scroll, enable-bar-scroll
- river/tags: set-tags, toggle-tags
- hyprland/workspaces: persistent-workspaces (formalized)
- hyprland/window: fallback, tooltip-format
- cpu: format-<state>, tooltip-format, tooltip-format-<state>
- pulseaudio/slider: ignored-sinks
- hyprland/niri/mango language: format-<lang>-<variant> (+ hyprland tooltip variant)
2026-07-03 23:35:12 +02:00
Alex 6de8871882 Merge remote-tracking branch 'origin/master' into hyprland-language-tooltip
# Conflicts:
#	man/waybar-hyprland-language.5.scd
2026-07-03 21:01:53 +02:00
ladenburger 8a741f6ec7 fix: JSON format for Hyprland keyboard example 2025-02-01 00:38:52 +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
Victor Perez Cano cb0ecfbddc updated man for hyprland/language 2024-10-19 18:04:07 +02:00
Benjamin Voisin d9f2e0f7d2 📝 add menu config informations in manpages 2024-05-28 20:42:12 +02:00
Diederik de Haas a3904ff039 man: Fix several whitespace formatting issues
Fix the following whitespace formatting issues:
- Indentation in scdoc source files should be done with tabs.
- Lines where there (clearly) should be a line break, need to have '++'
  at the end, but several were missing them.
- The scdoc manual (clearly) states that lines should be hard wrapped
  at 80 columns, but when line(s) are indented, that causes rendering
  issues. So lines where a line break was not clearly intended or
  clearly not intended, have been put onto 1 line to circumvent the
  rendering issue.

Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
2023-07-30 17:37:30 +02:00
en3wton 4ab4ff790e add more format replacements for hyprland/language 2023-03-19 15:12:11 +00:00
Enes Hecan 6e296838e4 Update hyprland language module docs 2022-12-21 00:20:16 +01:00
NotAShelf 40bc2e96db wording 2022-08-18 20:21:14 +03:00
NotAShelf b181cd04b6 update man docs for format-<lang> option 2022-08-18 20:11:44 +03:00
NotAShelf 97f0d6fa42 remove redundant formatting 2022-08-18 19:35:40 +03:00
NotAShelf b8a68b8085 man documentation for hl language module 2022-08-18 19:32:26 +03:00