fastfetch/src/data/help.txt

Usage: fastfetch <options>

Informative options:
    -h,--help:           shows this message and exits
    -h,--help <command>: 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:      prints the default config and exits
    --print-structure:   prints the default stucture and exits

General options:
    -r,--recache <?value>:            generate new cached values
    --nocache <?value>:               don't use cached values, but also don't overwrite existing ones
    --load-config <file>:             load a config file or a preset (+)
    --multithreading <?value>:        use multiple threads to detect values
    --allow-slow-operations <?value>: allow operations that are usually very slow for more detailed output
    --escape-bedrock <?value>:        on bedrock linux, sets if it should escape the bedrock jail or not
    --pipe <?value>:                  disable logo and all escape sequences

Logo options:
    -l,--logo <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 <type>:              set the type of the logo given. Must be auto, builtin, file, raw, sixel, kitty or chafa.
    --logo-width <width>:            set the width of the logo (in characters), if it is an image
    --logo-height <height>:          set the height of the logo (in characters), if it is an image
    --logo-color-[1-9] <color>:      overwrite a color in the logo
    --logo-padding <padding>:        set the padding on the left and the right of the logo
    --logo-padding-left <padding>:   set the padding on the left of the logo
    --logo-padding-right <padding>:  set the padding on the right of the logo
    --logo-print-remaining <?value>: weather to print the remaining logo, if it has more lines than modules to display
    --sixel <file>:                  short for --logo-type sixel --logo <file>
    --kitty <file>:                  short for --logo-type kitty --logo <file>
    --chafa <file>:                  short for --logo-type chafa --logo <file>
    --file <file>:                   short for --logo-type file --logo <file>
    --raw <file>:                    short for --logo-type raw --logo <file>

Display options:
    -s,--structure <structure>:  sets the structure of the fetch. Must be a colon separated list of keys. Use "fastfetch --list-modules" to see the ones available.
    -c,--color <color>:          sets the color of the keys. Must be a linux console color code or the name of a color (+)
    --separator <str>:           sets the separator between key and value. Default is a colon with a space
    --set <key=value>:           hard set the value of a key
    --show-errors <?value>:      print occuring errors
    --disable-linewrap <?value>: weather to disable linewrap during the run
    --hide-cursor <?value>:      weather to hide the cursor during the run

Format options: Provide the format string for custom output. Use fastfetch --help *-format for specific help.
    --os-format <format>
    --host-format <format>
    --kernel-format <format>
    --uptime-format <format>
    --processes-format <format>
    --packages-format <format>
    --shell-format <format>
    --resolution-format <format>
    --de-format <format>
    --wm-format <format>
    --wm-theme-format <format>
    --theme-format <format>
    --icons-format <format>
    --font-format <format>
    --cursor-format <format>
    --terminal-format <format>
    --terminal-font-format <format>
    --cpu-format <format>
    --cpu-usage-format <format>
    --gpu-format <format>
    --memory-format <format>
    --disk-format <format>
    --battery-format <format>
    --locale-format <format>
    --local-ip-format <format>
    --public-ip-format <format>
    --player-format <format>
    --song-format <format>
    --datetime-format <format>
    --time-format <format>
    --date-format <format>
    --vulkan-format <format>
    --opengl-format <format>
    --opencl-format <format>

Key options: Provide a custom key for an output
    --os-key <key>
    --host-key <key>
    --kernel-key <key>
    --uptime-key <key>
    --processes-key <key>
    --packages-key <key>
    --shell-key <key>
    --resolution-key <key>: takes the resolution index as argument
    --de-key <key>
    --wm-key <key>
    --wm-theme-key <key>
    --theme-key <key>
    --icons-key <key>
    --font-key <key>
    --cursor-key <key>
    --terminal-key <key>
    --terminal-font-key <key>
    --cpu-key <key>
    --cpu-usage-key <key>
    --gpu-key <key>: takes the gpu index as format argument
    --memory-key <key>
    --disk-key <key>: takes the mount path as format argument
    --battery-key <key>: takes the battery index as format argument
    --locale-key <key>
    --local-ip-key <key>: takes the name of this network interface as format argument
    --public-ip-key <key>
    --player-key <key>
    --song-key <key>
    --datetime-key <key>
    --time-key <key>
    --date-key <key>
    --vulkan-key <key>
    --opengl-key <key>
    --opencl-key <key>

Library options: Set the path of a library to load
    --lib-PCI <path>
    --lib-vulkan <path>
    --lib-wayland <path>
    --lib-xcb-randr <path>
    --lib-xcb <path>
    --lib-Xrandr <path>
    --lib-X11 <path>
    --lib-gio <path>
    --lib-DConf <path>
    --lib-DBus <path>
    --lib-XFConf <path>
    --lib-sqlite3 <path>
    --lib-rpm <path>
    --lib-imagemagick <path>
    --lib-z <path>
    --lib-chafa <path>
    --lib-egl <path>
    --lib-glx <path>
    --lib-osmesa <path>
    --lib-opencl <path>

Module specific options:
    --separator-string <str>:     Set the string printed by the separator module
    --os-file <path>:             Set the path to the file containing OS informations
    --disk-folders <folders>:     A colon separated list of folder paths for the disk output. Default is "/:/home"
    --battery-dir <folder>:       The directory where the battery folders are. Standard: /sys/class/power_supply/
    --localip-show-ipv4 <?value>: Show ipv4 addresses in local ip module. Default is true
    --localip-show-ipv6 <?value>: Show ipv6 addresses in local ip module. Default is false
    --localip-show-loop <?value>: Show loop back addresses (127.0.0.1) in local ip module. Default is false
    --public-ip-timeout:          Time in milliseconds to wait for the public ip server to respond. Default is disabled (0)
    --player-name:                The name of the player to use
    --gl <value>:                 Sets the opengl context creation library to use. Must be auto, egl, glx or osmesa. Default is auto

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.
A (+) at the end indicates that more help can be printed with --help <option>
All options can be made permanent in $XDG_CONFIG_HOME/fastfetch/config.conf