Doc: remove command line flags of modules

This commit is contained in:
李通洲
2025-08-04 15:08:30 +08:00
parent 75d2c668d0
commit e753d4d3a4
2 changed files with 3 additions and 903 deletions
-901
View File
@@ -898,906 +898,5 @@
}
}
}
],
"Module specific": [
{
"long": "title-fqdn",
"desc": "Specify whether the title should use fully qualified domain name",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "title-color-user",
"desc": "Set the color of the user name (left part)",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "Use color of \"--color-title\""
}
},
{
"long": "title-color-at",
"desc": "Set the color of the @ symbol (middle part)",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "Use color of \"--color-title\""
}
},
{
"long": "title-color-host",
"desc": "Set the color of the host name (right part)",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "default"
}
},
{
"long": "separator-string",
"desc": "Set the string to be printed by the separator line",
"arg": {
"type": "str",
"default": "-"
}
},
{
"long": "separator-output-color",
"desc": "Set the color of the separator line",
"arg": {
"type": "color",
"default": "default"
}
},
{
"long": "separator-length",
"desc": "Set the length of the separator line",
"remark": "Set to 0 to automatically calculate it based on the title length",
"arg": {
"type": "num",
"default": "0"
}
},
{
"long": "disk-folders",
"desc": "A colon (semicolon on Windows) separated list of folder paths to detect",
"remark": "On Windows, a drive letter must be upper-cased and end with \"\\\". \"/\" is used as an alias of the system drive. This option overrides other disk-show-* options",
"arg": {
"type": "path",
"default": "Auto detection using mount-points"
}
},
{
"long": "disk-hide-folders",
"desc": "A colon (semicolon on Windows) separated list of folder paths to hide from the disk output",
"arg": {
"type": "path",
"default": "/efi:/boot:/boot/efi:/boot/firmware"
}
},
{
"long": "disk-hide-fs",
"desc": "A colon separated list of file systems to hide from the disk output",
"arg": {
"type": "string",
"default": ""
}
},
{
"long": "disk-show-regular",
"desc": "Specify whether regular volumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "disk-show-external",
"desc": "Specify whether external volumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "disk-show-hidden",
"desc": "Specify whether hidden volumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "disk-show-subvolumes",
"desc": "Specify whether subvolumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "disk-show-readonly",
"desc": "Specify whether read-only volumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "disk-show-unknown",
"desc": "Specify whether unknown volumes (unable to detect sizes) should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "disk-use-available",
"desc": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes",
"remark": "May be required for macOS to display correct results",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "diskio-detect-total",
"desc": "Detect total bytes instead of current rate",
"arg": {
"type": "bool",
"default": false
}
},
{
"long": "diskio-name-prefix",
"desc": "Show only disks with the given name prefix",
"arg": {
"type": "str"
}
},
{
"long": "diskio-wait-time",
"desc": "Set the wait time (in ms) when detecting disk usage",
"arg": {
"type": "num",
"default": 1000
}
},
{
"long": "physicaldisk-name-prefix",
"desc": "Show only disks with the given name prefix",
"arg": {
"type": "str"
}
},
{
"long": "physicaldisk-temp",
"desc": "Detect and display SSD temperature if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "bluetooth-show-disconnected",
"desc": "Specify whether disconnected Bluetooth devices should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "packages-disabled",
"desc": "A colon-separated list of package managers to disable when detecting",
"remark": [
"Some detection methods can be very slow.",
"You may need to increase the value of '--processing-timeout' to make it work properly.",
"Use `--packages-disabled none` to enable all."
],
"arg": {
"type": "string",
"default": "winget"
}
},
{
"long": "packages-combined",
"desc": "Whether to combine related package managers into single counts",
"remark": "e.g., nix-system + nix-user = nix",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "display-compact-type",
"desc": "Specify whether all displays should be printed in one line",
"arg": {
"type": "enum",
"enum": {
"none": "Disable this compact mode",
"original": "Print original resolutions",
"scaled": "Print scaled resolutions",
"original-with-refresh-rate": "Print original resolutions with refresh rate",
"scaled-with-refresh-rate": "Print scaled resolutions with refresh rate"
},
"default": "none"
}
},
{
"long": "display-precise-refresh-rate",
"desc": "Specify whether decimal refresh rates should not be rounded to integers when printing",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "display-order",
"desc": "Set the order to use when printing displays",
"arg": {
"type": "enum",
"enum": {
"none": "Use the detected order",
"asc": "Sort by display name in ascending order",
"desc": "Sort by display name in descending order"
},
"default": "none"
}
},
{
"long": "brightness-ddcci-sleep",
"desc": "Set the sleep time (in ms) when sending DDC/CI requests",
"remark": "See <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for details",
"arg": {
"type": "num",
"default": 10
}
},
{
"long": "brightness-compact",
"desc": "Specify whether multiple results should be printed in one line",
"arg": {
"type": "bool",
"default": false
}
},
{
"long": "sound-type",
"desc": "Set which types of sound devices should be displayed",
"arg": {
"type": "enum",
"enum": {
"main": "Print only main sound devices",
"active": "Print only active sound devices",
"all": "Print all sound devices"
},
"default": "main"
}
},
{
"long": "battery-use-setup-api",
"desc": "Specify whether \"SetupAPI\" should be used on Windows to detect battery info",
"remark": [
"SetupAPI supports multiple batteries, but is slower.",
"Windows only"
],
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpu-temp",
"desc": "Detect and display CPU temperature if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpu-show-pe-core-count",
"desc": "Detect and display CPU frequency of different core types (e.g., P-cores and E-cores) if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpucache-compact",
"desc": "Show all CPU caches in one line",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpuusage-separate",
"desc": "Display CPU usage per logical core, instead of an average result",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpuusage-wait-time",
"desc": "Set the wait time (in ms) when detecting CPU usage",
"arg": {
"type": "num",
"default": 200
}
},
{
"long": "de-slow-version-detection",
"desc": "Specify whether DE version should be detected with slower operations",
"remark": [
"This is only used as a fallback method. Please file a bug report if you encounter any issues.",
"Linux only"
],
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "gpu-temp",
"desc": "Detect and display GPU temperature if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "gpu-driver-specific",
"desc": "Use driver-specific methods to detect more detailed GPU information (memory usage, core count, etc.)",
"remark": "Requires the latest GPU drivers to be installed.",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "gpu-detection-method",
"desc": "Force using a specified method to detect GPUs",
"remark": "Will fall back to other methods if the specified method fails",
"arg": {
"type": "enum",
"enum": {
"auto": "Query platform-specific graphics APIs. Requires proper GPU drivers to be installed. Supported on Linux, FreeBSD, Windows and macOS",
"pci": "Search PCI devices, which does not require GPU drivers to be installed. Not supported on Windows and macOS",
"vulkan": "Use Vulkan API. Slow and requires proper Vulkan drivers to be installed. Used for Android",
"opencl": "Use OpenCL API. Slow and requires proper OpenCL drivers to be installed",
"opengl": "Use OpenGL API. Slow and only detects one GPU. Used for OpenBSD"
},
"default": "auto"
}
},
{
"long": "gpu-hide-type",
"desc": "Specify which types of GPUs should not be displayed (default: all GPUs are shown, regardless of recognition)",
"arg": {
"type": "enum",
"enum": {
"integrated": "Hide integrated GPUs",
"discrete": "Hide discrete GPUs",
"unknown": "Hide unknown (unrecognized) GPUs",
"none": "Do not hide any GPUs"
},
"default": "none"
}
},
{
"long": "battery-temp",
"desc": "Detect and display battery temperature if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "loadavg-ndigits",
"desc": "Set the number of digits to keep after the decimal point when printing load average",
"arg": {
"type": "num",
"default": 2
}
},
{
"long": "loadavg-compact",
"desc": "Show load average values in one line",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "localip-show-ipv4",
"desc": "Show IPv4 addresses in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "localip-show-ipv6",
"desc": "Show IPv6 addresses in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-mac",
"desc": "Show MAC addresses in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-loop",
"desc": "Show loopback addresses (127.0.0.1) in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-mtu",
"desc": "Show network interface MTU (Maximum Transmission Unit) size in bytes",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-speed",
"desc": "Show network interface link speed in human-readable format (or as a 1Mb units integer in JSON format)",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-prefix-len",
"desc": "Show network prefix length (/N) in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "localip-name-prefix",
"desc": "Show only interfaces with the given interface name prefix",
"arg": {
"type": "str"
}
},
{
"long": "localip-default-route-only",
"desc": "Show only the interface that is used for default routing",
"remark": "Doesn't work on Android",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "localip-show-all-ips",
"desc": "Show all IPs bound to the same interface. By default, only the first IP is shown",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-flags",
"desc": "Show network interface flags in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-compact",
"desc": "Show all IPs in one line",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "dns-show-type",
"desc": "Specify which types of DNS servers should be detected",
"arg": {
"type": "enum",
"enum": {
"ipv4": "Show IPv4 addresses only",
"ipv6": "Show IPv6 addresses only",
"both": "Show both IPv4 and IPv6 addresses"
},
"default": "both"
}
},
{
"long": "netio-name-prefix",
"desc": "Show only interfaces with the given name prefix",
"arg": {
"type": "str"
}
},
{
"long": "netio-default-route-only",
"desc": "Show only the interface that is used for default routing",
"remark": "Doesn't work on Android",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "netio-detect-total",
"desc": "Detect total bytes instead of current rate",
"arg": {
"type": "bool",
"default": false
}
},
{
"long": "netio-wait-time",
"desc": "Set the wait time (in ms) when detecting network usage",
"arg": {
"type": "num",
"default": 1000
}
},
{
"long": "publicip-timeout",
"desc": "Time in milliseconds to wait for the public IP server to respond",
"remark": "0 to disable timeout",
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "publicip-url",
"desc": "The URL of the public IP detection server to use",
"arg": {
"type": "str"
}
},
{
"long": "publicip-ipv6",
"desc": "Specify whether to use IPv6 for the public IP detection server",
"arg": {
"type": "bool",
"default": false
}
},
{
"long": "weather-location",
"desc": "Set the location to use",
"remark": "Must be URI encoded (e.g., a whitespace must be encoded as \"+\")",
"arg": {
"type": "str"
}
},
{
"long": "weather-timeout",
"desc": "Time in milliseconds to wait for the weather server to respond",
"remark": "0 to disable timeout",
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "weather-output-format",
"desc": "The output weather format to use",
"remark": "Must be URI encoded",
"arg": {
"type": "str"
}
},
{
"long": "wm-detect-plugin",
"desc": "Specify whether window manager plugins should be detected on supported platforms",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "users-compact",
"desc": "Show all active users in one line",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "users-myself-only",
"desc": "Show only the current user",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "player-name",
"desc": "The name of the player to use for the Media and Player modules",
"remark": "Linux only",
"arg": {
"type": "str"
}
},
{
"long": "opengl-library",
"desc": "Set the OpenGL context creation library to use",
"arg": {
"type": "enum",
"enum": {
"auto": "Prefer EGL on *nix; prefer platform-specific implementation on others",
"egl": "EGL",
"glx": "GLX (*nix only)"
},
"default": "auto"
}
},
{
"long": "command-shell",
"desc": "Set the shell program to execute the command text",
"arg": {
"type": "str",
"default": "\"cmd\" for Windows; \"/bin/sh\" for *nix"
}
},
{
"long": "command-param",
"desc": "Set the parameter to use when starting the shell",
"remark": "If set to an empty string, it will be ignored",
"arg": {
"type": "str",
"default": "\"/c\" for Windows; \"-c\" for *nix"
}
},
{
"long": "command-key",
"desc": "Set the module key to display",
"arg": {
"type": "str"
}
},
{
"long": "command-text",
"desc": "Set the command text to execute",
"arg": {
"type": "str"
}
},
{
"long": "colors-symbol",
"desc": "Set the symbol to be printed by the Colors module",
"arg": {
"type": "enum",
"enum": {
"block": "\u2588\u2588\u2588",
"background": "(whitespaces with background)",
"circle": "\u25cf",
"diamond": "\u25c6",
"triangle": "\u25b2",
"square": "\u25a0",
"star": "\u2605"
},
"default": "background"
}
},
{
"long": "colors-padding-left",
"desc": "Set the number of white spaces to print before the symbol",
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "colors-block-width",
"desc": "Set the block width in spaces",
"arg": {
"type": "num",
"default": 3
}
},
{
"long": "colors-block-range-start",
"desc": "Set the start range of colors in the blocks to print",
"remark": [
"Display colors 0-15 in the blocks. (16 colors)",
"Display colors 0-7 in the blocks. (8 colors)",
"Only works for `--colors-symbol block`.",
"Must be in range 0-15",
"See also `--colors-range-end`"
],
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "colors-block-range-end",
"desc": "Set the end range of colors in the blocks to print",
"remark": [
"Display colors 0-15 in the blocks. (16 colors)",
"Display colors 0-7 in the blocks. (8 colors)",
"Only works for `--colors-symbol block`.",
"Must be in range 0-15",
"See also `--colors-range-start`"
],
"arg": {
"type": "num",
"default": 15
}
}
],
"General module": [
{
"long": "<module>-format",
"desc": [
"Set the format string to use for a specific module",
"See <https://github.com/fastfetch-cli/fastfetch/wiki/Format-String-Guide>",
"For help about a specific format string, use \"fastfetch -h <module>-format\""
],
"arg": {
"type": "format"
},
"pseudo": true
},
{
"long": "<module>-key",
"desc": [
"Set the key to use for a specific module.",
"For modules that print multiple lines, the string is parsed",
"as a format string with the index as the first character"
],
"arg": {
"type": "key"
},
"pseudo": true
},
{
"long": "<module>-key-color",
"desc": "Override the global \"--color-keys\" option for a specific module",
"arg": {
"type": "color"
},
"pseudo": true
},
{
"long": "<module>-key-icon",
"desc": "Set the icon to be displayed by \"--key-type icon\"",
"arg": {
"type": "string"
},
"pseudo": true
},
{
"long": "<module>-output-color",
"desc": "Override the global \"--color-output\" option for a specific module",
"arg": {
"type": "color"
},
"pseudo": true
},
{
"long": "<module>-key-width",
"desc": "Override the global \"--key-width\" option for a specific module",
"arg": {
"type": "num"
},
"pseudo": true
},
{
"long": "<module>-percent-green",
"desc": [
"Threshold for percentage color ranges",
"Values less than percent-green will be shown in green"
],
"arg": {
"type": "num"
},
"pseudo": true
},
{
"long": "<module>-percent-yellow",
"desc": [
"Threshold for percentage color ranges",
"Values greater than percent-green and less than percent-yellow will be shown in yellow",
"Values greater than percent-yellow will be shown in red"
],
"arg": {
"type": "num"
},
"pseudo": true
},
{
"long": "<module>-percent-type",
"desc": "Set the percentage output type",
"remark": [
"0 to use global `--percent-type` value",
"1 for percentage number",
"2 for multi-color bar",
"3 for both",
"6 for bar only",
"9 for colored number",
"10 for monochrome bar"
],
"arg": {
"type": "num",
"default": 0
},
"pseudo": true
},
{
"long": "<module>-temp-green",
"desc": [
"Threshold for temperature color ranges",
"Values less than temp-green will be shown in green"
],
"arg": {
"type": "num"
},
"pseudo": true
},
{
"long": "<module>-temp-yellow",
"desc": [
"Threshold for temperature color ranges",
"Values greater than temp-green and less than temp-yellow will be shown in yellow",
"Values greater than temp-yellow will be shown in red"
],
"arg": {
"type": "num"
},
"pseudo": true
}
]
}
+3 -2
View File
@@ -183,10 +183,11 @@ static void printFullHelp()
yyjson_doc_free(doc);
puts("\n\
Parsing is not case sensitive. E.g. `--print-logos` is equal to `--Print-Logos`\n\
Command flags are not case sensitive. E.g. `--print-logos` is equal to `--Print-Logos`\n\
If a value starts with a ?, it is optional. An optional boolean value defaults to true if not specified.\n\
More detailed help messages for each options can be printed with `-h <option_without_dash_prefix>`\n\
All options can be made permanent with command `fastfetch <options> --gen-config`");
For detailed information on logo options, module configuration, and formatting, visit:\n\
https://github.com/fastfetch-cli/fastfetch/wiki/Configuration");
}
static bool printSpecificCommandHelp(const char* command)