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>
This commit is contained in:
@@ -124,6 +124,11 @@ The *battery* module displays the current capacity and state (eg. charging) of y
|
||||
default: true ++
|
||||
Option to disable tooltip on hover.
|
||||
|
||||
*tooltip-format*: ++
|
||||
typeof: string ++
|
||||
default: {timeTo} ++
|
||||
The tooltip format. See *CUSTOM FORMATS* for status/state-specific variants.
|
||||
|
||||
*bat-compatibility*: ++
|
||||
typeof: bool ++
|
||||
default: false ++
|
||||
@@ -165,6 +170,12 @@ The *battery* module displays the current capacity and state (eg. charging) of y
|
||||
|
||||
*{health}*: The percentage of the highest-capacity battery's original maximum charge it can still hold.
|
||||
|
||||
The following additional replacement is available in *tooltip-format* (and its
|
||||
custom variants) only:
|
||||
|
||||
*{timeTo}*: Either an estimate of time until full or empty, or "Full", "Plugged"
|
||||
or "Empty" depending on the current battery status.
|
||||
|
||||
# TIME FORMAT
|
||||
|
||||
The *battery* module allows you to define how time should be formatted via *format-time*.
|
||||
@@ -184,6 +195,11 @@ The *battery* module allows one to define custom formats based on up to two fact
|
||||
|
||||
*format-<status>-<state>*: You can also set a custom format depending on both values.
|
||||
|
||||
The tooltip format can be customized the same way. The best fitting from
|
||||
*tooltip-format*, *tooltip-format-<state>*, *tooltip-format-<status>* and
|
||||
*tooltip-format-<status>-<state>* will be used (using the same logic as
|
||||
*format-\**).
|
||||
|
||||
# STATES
|
||||
|
||||
- Every entry (*state*) consists of a *<name>* (typeof: *string*) and a *<value>* (typeof: *integer*).
|
||||
@@ -229,6 +245,20 @@ Where:
|
||||
}
|
||||
```
|
||||
|
||||
Custom icon set depending on the status (*format-icons* as an object):
|
||||
|
||||
```
|
||||
"battery": {
|
||||
"bat": "BAT2",
|
||||
"interval": 60,
|
||||
"format": "{capacity}% {icon}",
|
||||
"format-icons": {
|
||||
"default": ["", "", "", "", "", "", "", "", "", "", ""],
|
||||
"charging": ["", "", "", "", "", "", "", "", "", "", ""]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
# STYLE
|
||||
|
||||
- *#battery*
|
||||
|
||||
Reference in New Issue
Block a user