Commit Graph
27 Commits
Author SHA1 Message Date
AlexandClaude Opus 4.8 a3b39cfcf6 docs(man): backfill man pages with wiki-only info (source-of-truth pass)
Port information that previously lived only in the GitHub wiki into the
authoritative scdoc man pages, so the man pages become the single source
of truth for module documentation.

33 man pages enriched (options, format replacements, actions, style
selectors, troubleshooting and implementation notes). Additions were
verified against the source; stale/incorrect wiki entries were
deliberately not ported. All pages still compile with scdoc.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-04 02:55:57 +02:00
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
touero e189649c33 docs(custom): fix example error about update moudle by signal 2025-11-29 17:29:52 +08:00
aidansunbury 2b81782fa9 more changes 2025-08-16 16:01:41 -07:00
aidansunbury 6dc5a73a02 initial changes 2025-08-16 15:29:59 -07: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
Lukas Fink de170fa579 Update documentation 2024-09-17 02:56:38 +02:00
Michal Suchanek 1fa8019ad5 man: Clarify rotate option
fixes: #3576
2024-09-08 13:56:12 +02:00
Alexis Rouillard 93000e3fca Merge pull request #3395 from RobertMueller2/issue_33341
add hide-empty-text option to hide module whenever output is empty but format is not
2024-07-01 09:20:56 +02:00
Rene D. Obermueller 8eee568731 manpage for PR #3395 2024-06-30 21:23:54 +02:00
Benjamin Voisin d9f2e0f7d2 📝 add menu config informations in manpages 2024-05-28 20:42:12 +02:00
Alexis Rouillard 4c46d7d245 Merge pull request #2887 from dann-merlin/master
Add justify config option for Labels
2024-03-05 09:01:44 +01:00
Merlin Sievers 25b85800a5 Add documentation for justify option 2024-03-04 20:00:57 +01:00
Josh Jones 7f3e396383 add tooltip-format to custom module man page 2024-02-16 15:26:36 +01:00
Avishek Sen d0cab2a367 docs: fix typos and improve language coherence 2023-10-21 21:15:25 +05:30
Evan Overman f14fe96e19 add info to interval and signal in manpage for custom modules 2023-09-19 14:52:48 -07: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
snehrbass c80cc873af Update spotify example to work on copy paste 2022-02-02 00:01:18 -05:00
nullobsi 97f7050d7d Update man pages 2021-02-01 08:34:51 -08:00
Tamir Zahavi-Brunner 9e3e4368c7 custom: Add "exec-on-event" config
This config allows disabling the default behavior of re-executing the
script whenever an event that has a command set is triggered.

Fixes #841
2020-09-06 22:49:18 +03:00
Alex d1c4897f31 feat: update man 2020-04-12 18:38:51 +02:00
Alex d12ad1128e fix: man 2020-03-25 22:30:22 +01:00
Alex cb2f5c154c feat(custon): restart_interval for continuous script 2020-03-25 22:25:30 +01:00
fuzxi abeb406166 Update waybar-custom.5.scd 2020-01-06 13:30:11 +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 278f26e597 add info on "on-click-middle" option 2019-12-14 22:28:31 -08:00
Michael Aquilina db85224d59 Add waybar-custom(5) 2019-08-26 13:44:09 +01:00