Skip to content

Commit cd07354

Browse files
CarterLiCarterLi
committed
Doc: update changelog and other docs
1 parent fd5aeb2 commit cd07354

File tree

3 files changed

+81
-8
lines changed

3 files changed

+81
-8
lines changed

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Changes:
1111
* `--packages-winget`: control whether `winget` packages count should be detected. Note it's a very slow operation, please enable it with caution.
1212
* `--chassis-use-wmi`: control whether `WMI` query should be used to detect chassis type, which detects more information, but slower. This flag only affects `--chassis-format` and `--format json`.
1313
* `--battery-use-setup-api`: control whether `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower.
14+
* `--wm-detect-plugin`: control whether WM plugins should be detected. Note it's implemented with global processes enumeration and can report false results.
15+
* `--de-slow-version-detection`: control DE version should be detected with slow operations. It's usually not necessary and only provided as a backup.
1416

1517
Features:
1618
* Quirks for MIPS platforms (CPU, Linux)
@@ -65,6 +67,7 @@ Logo:
6567
* Add EndeavourSmall
6668
* Add Xenia
6769
* Add MainsailOS
70+
* Fix phyOS
6871

6972
# 2.1.0
7073

‎doc/json_schema.json‎

Lines changed: 76 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -652,10 +652,6 @@
652652
"const": "datetime",
653653
"description": "Print current date and time"
654654
},
655-
{
656-
"const": "de",
657-
"description": "Print desktop environment name"
658-
},
659655
{
660656
"const": "font",
661657
"description": "Print system font name"
@@ -760,10 +756,6 @@
760756
"const": "wallpaper",
761757
"description": "Print image file path of current wallpaper"
762758
},
763-
{
764-
"const": "wm",
765-
"description": "Print window manager name and version"
766-
},
767759
{
768760
"const": "wifi",
769761
"description": "Print connected Wi-Fi info (SSID, connection and security protocol)"
@@ -879,6 +871,18 @@
879871
"description": "Set if WMI query should be used on Windows, which detects more information but slower",
880872
"type": "boolean",
881873
"default": false
874+
},
875+
"key": {
876+
"$ref": "#/$defs/key"
877+
},
878+
"keyColor": {
879+
"$ref": "#/$defs/keyColor"
880+
},
881+
"keyWidth": {
882+
"$ref": "#/$defs/keyWidth"
883+
},
884+
"format": {
885+
"$ref": "#/$defs/format"
882886
}
883887
}
884888
},
@@ -1133,6 +1137,32 @@
11331137
},
11341138
"additionalProperties": false
11351139
},
1140+
{
1141+
"title": "DE",
1142+
"properties": {
1143+
"type": {
1144+
"const": "de",
1145+
"description": "Print desktop environment name"
1146+
},
1147+
"slowVersionDetection": {
1148+
"type": "boolean",
1149+
"description": "Set if DE version should be detected with slow operations.\nShould be unnecessary for most cases.",
1150+
"default": "false"
1151+
},
1152+
"key": {
1153+
"$ref": "#/$defs/key"
1154+
},
1155+
"keyColor": {
1156+
"$ref": "#/$defs/keyColor"
1157+
},
1158+
"keyWidth": {
1159+
"$ref": "#/$defs/keyWidth"
1160+
},
1161+
"format": {
1162+
"$ref": "#/$defs/format"
1163+
}
1164+
}
1165+
},
11361166
{
11371167
"title": "GPU",
11381168
"properties": {
@@ -1309,6 +1339,18 @@
13091339
"description": "Set if winget package count should be detected.\nNote this is very slow operation. Please make sure `winget list` works before enable this option\nWindows only",
13101340
"type": "boolean",
13111341
"default": false
1342+
},
1343+
"key": {
1344+
"$ref": "#/$defs/key"
1345+
},
1346+
"keyColor": {
1347+
"$ref": "#/$defs/keyColor"
1348+
},
1349+
"keyWidth": {
1350+
"$ref": "#/$defs/keyWidth"
1351+
},
1352+
"format": {
1353+
"$ref": "#/$defs/format"
13121354
}
13131355
}
13141356
},
@@ -1474,6 +1516,32 @@
14741516
}
14751517
},
14761518
"additionalProperties": false
1519+
},
1520+
{
1521+
"title": "WM",
1522+
"properties": {
1523+
"type": {
1524+
"const": "wm",
1525+
"description": "Print window manager name and version"
1526+
},
1527+
"detectPlugin": {
1528+
"title": "Set if window manager plugin should be detected on supported platforms",
1529+
"type": "boolean",
1530+
"default": false
1531+
},
1532+
"key": {
1533+
"$ref": "#/$defs/key"
1534+
},
1535+
"keyColor": {
1536+
"$ref": "#/$defs/keyColor"
1537+
},
1538+
"keyWidth": {
1539+
"$ref": "#/$defs/keyWidth"
1540+
},
1541+
"format": {
1542+
"$ref": "#/$defs/format"
1543+
}
1544+
}
14771545
}
14781546
]
14791547
}

‎src/data/help.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ Module specific options:
149149
--cpu-temp <?value>: Detect and display CPU temperature if supported. Default is false
150150
--cpu-freq-ndigits <num>: Set the number of digits to keep after the decimal point when printing CPU frequency. Default is 2
151151
--cpuusage-separate <?value>: Display CPU usage per CPU logical core, instead of an average result. Default is false
152+
--de-slow-version-detection <?value>: Set if DE version should be detected with slow operations. Default is false
152153
--gpu-temp <?value>: Detect and display GPU temperature if supported. Default is false
153154
--gpu-use-nvml <?value>: Use nvml (NVIDIA Management Library) to detect more detailed GPU information (memory usage, CUDA core count, etc). Default is false
154155
--gpu-force-vulkan <?value>: Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`. Default is false
@@ -168,6 +169,7 @@ Module specific options:
168169
--weather-location: Set the location to be used. It must be URI encoded (eg a whitespace must be encoded as `+`).
169170
--weather-timeout: Time in milliseconds to wait for the weather server to respond. Default is disabled (0)
170171
--weather-output-format: The output weather format to be used. It must be URI encoded.
172+
--wm-detect-plugin: Set if window manager plugin should be detected on supported platforms. Default is false
171173
--player-name: The name of the player to use for module Media and Player. Linux only
172174
--opengl-library <value>: Set the OpenGL context creation library to use. Must be auto, egl, glx or osmesa. Default is auto
173175
--command-shell <str>: Set the shell program to execute the command text. Default is cmd for Windows, /bin/sh for *nix

0 commit comments

Comments
 (0)