diff --git a/src/data/help.txt b/src/data/help.txt index ca4edde2f..f247833fd 100644 --- a/src/data/help.txt +++ b/src/data/help.txt @@ -1,68 +1,68 @@ Usage: fastfetch Informative options: - -h,--help: shows this message and exits - -h,--help : shows help for a specific command and exits - -v,--version: prints the version of fastfetch and exits - --list-logos: list available logos and exits - --list-modules: lists available modules and exits - --list-presets: list presets fastfetch knows about and exits. They can be loaded with --load-config. (+) - --list-features: list the supported features fastfetch was compiled with and exits. Mainly for development. - --print-logos: show available logos and exits - --print-config-system: prints the default system config and exits - --print-config-user: prints the default user config and exits - --print-structure: prints the default stucture and exits + -h,--help: Show this message + -h,--help : Show help for a specific command + -v,--version: Show the version of fastfetch + --list-logos: List available logos + --list-modules: List available modules + --list-presets: List presets fastfetch knows about; they can be loaded with --load-config (+) + --list-features: List the supported features fastfetch was compiled with (mainly for development) + --print-logos: Print available logos + --print-config-system: Print the default system config + --print-config-user: Print the default user config + --print-structure: Print the default structure General options: - --load-config : load a config file or a preset (+) - --multithreading : use multiple threads to detect values - --stat : print time usage (in ms) for individual modules - --allow-slow-operations : allow operations that are usually very slow for more detailed output - --escape-bedrock : on bedrock linux, sets if it should escape the bedrock jail or not - --pipe : disable logo and all escape sequences + --load-config : Load a config file or preset (+) + --multithreading : Use multiple threads to detect values + --stat : Show time usage (in ms) for individual modules + --allow-slow-operations : Allow operations that are usually very slow for more detailed output + --escape-bedrock : On Bedrock Linux, whether to escape the bedrock jail + --pipe : Disable logo and all escape sequences Logo options: - -l,--logo : set the logo to use. The type is specified by --logo-type. If default: the name of a builtin logo or a path to a file - --logo-type : set the type of the logo given. Must be auto, builtin, file, file-raw, data, data-raw, sixel, kitty or chafa. - --logo-width : set the width of the logo (in characters), if it is an image - --logo-height : set the height of the logo (in characters), if it is an image - --logo-color-[1-9] : overwrite a color in the logo - --logo-padding : set the padding on the left and the right of the logo - --logo-padding-left : set the padding on the left of the logo - --logo-padding-right : set the padding on the right of the logo - --logo-print-remaining : weather to print the remaining logo, if it has more lines than modules to display - --file : short for --logo-type file --logo - --file-raw : short for --logo-type file-raw --logo - --data : short for --logo-type data --logo - --data-raw : short for --logo-type data-raw --logo - --sixel : short for --logo-type sixel --logo - --kitty : short for --logo-type kitty --logo - --chafa : short for --logo-type chafa --logo - --chafa-symbols : specify character symbols to employ in final output. See chafa document for detail - --chafa-fg-only : produces character-cell output using foreground colors only. See chafa document for detail + -l,--logo : Set the logo; if default, the name of a builtin logo or a path to a file + --logo-type : Set the type of the logo given; must be auto, builtin, file, file-raw, data, data-raw, sixel, kitty or chafa + --logo-width : Set the width of the logo (in characters), if it is an image + --logo-height : Set the height of the logo (in characters), if it is an image + --logo-color-[1-9] : Overwrite a color in the logo + --logo-padding : Set the padding on the left and the right of the logo + --logo-padding-left : Set the padding on the left of the logo + --logo-padding-right : Set the padding on the right of the logo + --logo-print-remaining : Whether to print the remaining logo, if it has more lines than modules to display + --file : Short for --logo-type file --logo + --file-raw : Short for --logo-type file-raw --logo + --data : Short for --logo-type data --logo + --data-raw : Short for --logo-type data-raw --logo + --sixel : Short for --logo-type sixel --logo + --kitty : Short for --logo-type kitty --logo + --chafa : Short for --logo-type chafa --logo + --chafa-symbols : Specify character symbols to employ in final output. See chafa document for detail + --chafa-fg-only : Produce character-cell output using foreground colors only. See chafa document for detail Display options: - -s,--structure : sets the structure of the fetch. Must be a colon separated list of keys. Use "fastfetch --list-modules" to see the ones available. - --color-keys : sers the color of the keys - --color-title : sets the color of the title - -c,--color : sets the color of both the keys and the title - --separator : sets the separator between key and value. Default is a colon with a space - --set : hard set the value of a key - --set-keyless : hard set the value of a key, but don't print the key or the separator - --show-errors : print occuring errors - --disable-linewrap : weather to disable linewrap during the run - --hide-cursor : weather to hide the cursor during the run - --binary-prefix : sets the binary prefix to used. Must be IEC, SI or JEDEC. Default is IEC + -s,--structure : Set the structure of the fetch. Must be a colon separated list of keys. Use "fastfetch --list-modules" to see the ones available. + --color-keys : Set the color of the keys + --color-title : Set the color of the title + -c,--color : Set the color of both the keys and title + --separator : Set the separator between key and value. Default is a colon with a space + --set : Hard set the value of a key + --set-keyless : Hard set the value of a key, but don't print the key or the separator + --show-errors : Print occurring errors + --disable-linewrap : Whether to disable line wrap during the run + --hide-cursor : Whether to hide the cursor during the run + --binary-prefix : Set the binary prefix to used. Must be IEC, SI or JEDEC. Default is IEC. General module options: - ---format : Sets the format string to use for each specific module. + ---format : Set the format string to use for each specific module. To see how a format string works, use fastfetch --help format. To see help about a specific format string, use fastfetch --help -format. - ---key : Sets the key to use for each specific module. + ---key : Set the key to use for each specific module. For modules which print multiple lines, the string is parsed as a format string with the index as first character. - ---error : Sets the error format string to use for each specific module. + ---error : Set the error format string to use for each specific module. The error is given as the first and only argument. Setting this for a module will cause it to appear, even if --show-errors is not given. @@ -90,27 +90,27 @@ Library options: Set the path of a library to load --lib-cjson Module specific options: - --title-fqdn : Sets if the title should use fully qualified domain name. Default is false. + --title-fqdn : Set if the title should use fully qualified domain name. Default is false --separator-string : Set the string printed by the separator module - --os-file : Set the path to the file containing OS informations + --os-file : Set the path to the file containing OS information --disk-folders : A colon (semicolon on Windows) separated list of folder paths for the disk output. Default is "/:/home" ("C:\\;D:\\ ..." on Windows) - --disk-show-removable : Sets if removable volume should be printed. Default is true. - --disk-show-hidden : Sets if hidden volumes should be printed. Default is false + --disk-show-removable : Set if removable volume should be printed. Default is true + --disk-show-hidden : Set if hidden volumes should be printed. Default is false --battery-dir : The directory where the battery folders are. Standard: /sys/class/power_supply/ --cpu-temp : Detect and display CPU temperature if supported. Default is false --gpu-temp : Detect and display GPU temperature if supported. Default is false --battery-temp : Detect and display Battery temperature if supported. Default is false - --localip-show-ipv4 : Show ipv4 addresses in local ip module. Default is true - --localip-show-ipv6 : Show ipv6 addresses in local ip module. Default is false + --localip-show-ipv4 : Show IPv4 addresses in local ip module. Default is true + --localip-show-ipv6 : Show IPv6 addresses in local ip module. Default is false --localip-show-loop : Show loop back addresses (127.0.0.1) in local ip module. Default is false - --localip-name-prefix : Show ips with given name prefix only. Default is empty + --localip-name-prefix : Show IPs with given name prefix only. Default is empty --public-ip-timeout: Time in milliseconds to wait for the public ip server to respond. Default is disabled (0) --public-ip-url: The URL of public IP detection server to be used. --weather-timeout: Time in milliseconds to wait for the weather server to respond. Default is disabled (0) --weather-output-format: The output weather format to be used. It must be URI encoded. --player-name: The name of the player to use - --gl : Sets the opengl context creation library to use. Must be auto, egl, glx or osmesa. Default is auto - --percent-type : Sets the percentage output type. 1 for percentage number, 2 for bar, 3 for both. Default is 1 + --gl : Set the OpenGL context creation library to use. Must be auto, egl, glx or osmesa. Default is auto + --percent-type : Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both. Default is 1 Parsing is not case sensitive. E.g. "--lib-PCI" is equal to "--Lib-Pci" If a value starts with a ?, it is optional. "true" will be used if not set.