Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
FASTFETCH(1)		      Fastfetch	man page		  FASTFETCH(1)

NAME
       fastfetch  -  A maintained, feature-rich	and performance	oriented, neo-
       fetch like system information tool

SYNOPSIS
       fastfetch [OPTIONS]

WIKI
       Fastfetch   github   wiki   :	https://github.com/fastfetch-cli/fast-
       fetch/wiki/Configuration

CONFIGURATION
   Fetch Structure
       The  structure of a fetch describes the modules that should be included
       in the output. It consists of a string of modules, separated by a colon
       (:). To list all	available modules, use --list-modules.

   Config Files
       Fastfetch uses JSONC based format for configuration.  Fastfetch doesn't
       generate	config file automatically; it should be	generated manually  by
       --gen-config.   The  config  file  will	be  saved  in  ~/.config/fast-
       fetch/config.jsonc by default.

       A JSONC config file is a	JSON file that also supports comments with (//
       and /* */). Those files must have the extension '.jsonc'.

       The specified configuration/preset files	are searched in	the  following
       order:

       1. relative to the current working directory

       2. relative to ~/.local/share/fastfetch/presets/

       3. relative to /usr/share/fastfetch/presets/

       Fastfetch provides some default presets.	List them with --list-presets.

OPTIONS
       Parsing	is  not	 case  sensitive. E.g. --logo-type is equal to --LOGO-
       TYPE.

       If a value is between square brackets, it  is  optional.	  An  optional
       boolean value defaults to true if not specified.

       More  detailed  help  messages  for each	options	can be printed with -h
       <option_without_dash_prefix>.

       All options can be made	permanent  with	 command  fastfetch  <options>
       --gen-config.

   Informative:
       -h, --help [?command]
	       Show this message, or help for a	specific command

       -v, --version
	       Show the	full version of	fastfetch

       --version-raw
	       Show the	raw version string (major.minor.patch)

       --list-config-paths
	       List search paths of config files

       --list-data-paths
	       List search paths of presets and	logos

       --list-logos
	       List available logos

       --list-modules
	       List available modules

       --list-presets
	       List presets fastfetch knows about

       --list-features
	       List the	supported features fastfetch was compiled with

       --print-logos
	       Print available logos

       --print-structure
	       Print the default structure

       --format	enum
	       Set output format

   Config:
       -c, --config config
	       Specify the config file or preset to be loaded

       --gen-config [?path]
	       Generate	a config file to specified path	with options specified
	      in the command line (if any)

       --gen-config-force [?path]
	       Generate	 a config file to specified path. Overwrite the	exist-
	      ing one

   General:
       --thread	[?bool]
	       Use separate threads to send HTTP requests

       --wmi-timeout num
	       Set the timeout (ms) for	WMI queries

       --processing-timeout num
	       Set the timeout (ms) when waiting for child processes

       --ds-force-drm [?enum]
	       Set if only DRM should be used to detect	displays

       --detect-version	[?bool]
	       Whether to detect and display the version  of  terminal,	 shell
	      and editor

   Logo:
       -l, --logo logo
	       Set the logo source. Use	"none" to disable the logo

       --logo-type enum
	       Set the type of the logo	given in "--logo"

       --logo-width num
	       Set the width of	the logo (in characters), if it	is an image

       --logo-height num
	       Set the height of the logo (in characters), if it is an image

       --logo-preserve-aspect-ratio [?bool]
	       Set  if	the logo should	fill the specified width and height as
	      much as possible without stretching

       --logo-color-[1-9] color
	       Overwrite a color in the	logo

       --logo-padding num
	       Set the padding on the left and the right of the	logo

       --logo-padding-left num
	       Set the padding on the left of the logo

       --logo-padding-right num
	       Set the padding on the right of the logo

       --logo-padding-top num
	       Set the padding on the top of the logo

       --logo-print-remaining [?bool]
	       Whether to print	the remaining logo, if it has more lines  than
	      modules to display

       --logo-position enum
	       Set the position	of the logo should be displayed

       --logo-recache [?bool]
	       If true,	regenerate image logo cache

       --file path
	       Short for --logo-type file --logo <path>

       --file-raw path
	       Short for --logo-type file-raw --logo <path>

       --data data
	       Short for --logo-type data --logo <data>

       --data-raw data
	       Short for --logo-type data-raw --logo <data>

       --raw path
	       Short for --logo-type raw --logo	<path>

       --sixel path
	       Short for --logo-type sixel --logo <path>

       --kitty path
	       Short for --logo-type kitty --logo <path>

       --kitty-direct path
	       Short for --logo-type kitty-direct --logo <path>

       --kitty-icat path
	       Short for --logo-type kitty-icat	--logo <path>

       --iterm path
	       Short for --logo-type iterm --logo <path>

       --chafa path
	       Short for --logo-type chafa --logo <path>

       --chafa-fg-only [?bool]
	       Produce character-cell output using foreground colors only

       --chafa-symbols str
	       Specify character symbols to employ in final output

       --chafa-canvas-mode enum
	       Determine how colors are	used in	the output

       --chafa-color-space enum
	       Set color space used for	quantization

       --chafa-dither-mode enum
	       Set output dither mode (No effect with 24-bit color)

   Display:
       -s, --structure structure
	       Set the structure of the	fetch

       --stat [?bool]
	       Show time usage (in ms) for individual modules

       --pipe [?bool]
	       Disable colors

       --color-keys color
	       Set the color of	the keys

       --color-title color
	       Set the color of	the title

       --color-output color
	       Set the color of	module output

       --color-separator color
	       Set the color of	the key-value separator

       --color color
	       Set the color of	both the keys and title

       --key-width num
	       Align the width of keys to <num>	characters

       --key-padding-left num
	       Set the left padding of keys to <num> characters

       --key-type enum
	       Set whether to show icon	before string keys

       --bright-color [?bool]
	       Set  if	the  keys,  title  and ASCII logo should be printed in
	      bright color

       --separator str
	       Set the separator between key and value

       --show-errors [?bool]
	       Print occurring errors

       --disable-linewrap [?bool]
	       Whether to disable line wrap during the run

       --hide-cursor [?bool]
	       Whether to hide the cursor during the run

       --percent-type num
	       Set the percentage output type

       --percent-ndigits num
	       Set the number of digits	to keep	after the decimal  point  when
	      formatting percentage numbers

       --percent-color-green color
	       Set color used in green state of	percentage bars	and numbers

       --percent-color-yellow color
	       Set color used in yellow	state of percentage bars and numbers

       --percent-color-red color
	       Set color used in red state of percentage bars and numbers

       --bar-char-elapsed str
	       Set the character to use	in elapsed part	of percentage bars

       --bar-char-total	str
	       Set the character to use	in total part of percentage bars

       --bar-border-left string
	       Set the string to use at	left border of percentage bars

       --bar-border-right string
	       Set the string to use at	right border of	percentage bars

       --bar-width num
	       Set the width of	percentage bars, in number of characters

       --no-buffer [?bool]
	       Set if the stdout application buffer should be disabled

       --size-ndigits num
	       Set  the	 number	of digits to keep after	the decimal point when
	      formatting sizes

       --size-binary-prefix enum
	       Set the binary prefix to	used when formatting sizes

       --size-max-prefix enum
	       Set the largest binary prefix to	use when formatting sizes

       --freq-ndigits num
	       Set the number of digits	to keep	after the decimal  point  when
	      printing CPU / GPU frequency in GHz

       --temp-unit enum
	       Set the unit of the temperature

       --temp-ndigits num
	       Set  the	 number	of digits to keep after	the decimal point when
	      printing temperature

       --temp-color-green color
	       Set color used in green state of	temperature values

       --temp-color-yellow color
	       Set color used in yellow	state of temperature values

       --temp-color-red	color
	       Set color used in red state of temperature values

   Module specific:
       --title-fqdn [?bool]
	       Set if the title	should use fully qualified domain name

       --title-color-user color
	       Set color of the	user name (left	part)

       --title-color-at	color
	       Set color of the	@ symbol (middle part)

       --title-color-host color
	       Set color of the	host name (right part)

       --separator-string str
	       Set the string to be printed by the separator line

       --separator-output-color	color
	       Set the color of	the separator line

       --separator-length num
	       Set the length of the separator line

       --disk-folders path
	       A colon (semicolon on Windows) separated	list of	 folder	 paths
	      to be detected

       --disk-show-regular [?bool]
	       Set if regular volume should be printed

       --disk-show-external [?bool]
	       Set if external volume should be	printed

       --disk-show-hidden [?bool]
	       Set if hidden volumes should be printed

       --disk-show-subvolumes [?bool]
	       Set if subvolumes should	be printed

       --disk-show-readonly [?bool]
	       Set if read only	volumes	should be printed

       --disk-show-unknown [?bool]
	       Set  if	unknown	 (unable  to  detect  sizes) volumes should be
	      printed

       --disk-use-available [?bool]
	       Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead
	      of f_bfree to calculate used bytes

       --diskio-detect-total bool
	       Detect total bytes instead of current rate

       --diskio-name-prefix str
	       Show disks with given name prefix only

       --diskio-wait-time num
	       Set the wait time (in ms) when detecting	disk usage

       --physicaldisk-name-prefix str
	       Show disks with given name prefix only

       --physicaldisk-temp [?bool]
	       Detect and display SSD temperature if supported

       --bluetooth-show-disconnected [?bool]
	       Set if disconnected bluetooth devices should be printed

       --packages-disabled string
	       A colon separated list of package managers to be	disabled  when
	      detecting

       --display-compact-type enum
	       Set if all displays should be printed in	one line

       --display-precise-refresh-rate [?bool]
	       Set  if	decimal	refresh	rates should not be rounded into inte-
	      gers when	printing

       --display-order enum
	       Set the order should be used when printing displays

       --brightness-ddcci-sleep	num
	       Set the sleep times (in ms) when	sending	DDC/CI requests

       --brightness-compact bool
	       Set if multiple results should be printed in one	line

       --sound-type enum
	       Set what	type of	sound devices should be	printed

       --battery-use-setup-api [?bool]
	       Set if "SetupAPI" should	be used	on Windows to  detect  battery
	      info

       --cpu-temp [?bool]
	       Detect and display CPU temperature if supported

       --cpu-show-pe-core-count	[?bool]
	       Detect  and  display CPU	frequency of different core types (eg.
	      Pcore and	Ecore) if supported

       --cpucache-compact [?bool]
	       Show all	CPU caches in one line

       --cpuusage-separate [?bool]
	       Display CPU usage per CPU logical core, instead of  an  average
	      result

       --cpuusage-wait-time num
	       Set the wait time (in ms) when detecting	CPU usage

       --de-slow-version-detection [?bool]
	       Set if DE version should	be detected with slow operations

       --gpu-temp [?bool]
	       Detect and display GPU temperature if supported

       --gpu-driver-specific [?bool]
	       Use driver specific method to detect more detailed GPU informa-
	      tion (memory usage, core count, etc)

       --gpu-detection-method enum
	       Force using a specified method to detect	GPUs

       --gpu-hide-type enum
	       Specify the type	of GPUs	should not be printed

       --battery-temp [?bool]
	       Detect and display Battery temperature if supported

       --loadavg-ndigits num
	       Set  the	 number	of digits to keep after	the decimal point when
	      printing load average

       --loadavg-compact [?bool]
	       Show load average values	in one line

       --localip-show-ipv4 [?bool]
	       Show IPv4 addresses in local ip module

       --localip-show-ipv6 [?bool]
	       Show IPv6 addresses in local ip module

       --localip-show-mac [?bool]
	       Show mac	addresses in local ip module

       --localip-show-loop [?bool]
	       Show loop back addresses	(127.0.0.1) in local ip	module

       --localip-show-mtu [?bool]
	       Show net	interface's MTU	(Maximum Transmission  Unit)  size  in
	      bytes

       --localip-show-speed [?bool]
	       Show  net interface's link speed	with human-readable format (or
	      an 1Mb units integer in JSON format)

       --localip-show-prefix-len [?bool]
	       Show network prefix length (/N) in local	ip module

       --localip-name-prefix str
	       Show interfaces with given interface name prefix	only

       --localip-default-route-only [?bool]
	       Show the	interface that is used for default routing only

       --localip-show-all-ips [?bool]
	       Show all	IPs bound to the same interface. By default  only  the
	      first IP is shown

       --localip-show-flags [?bool]
	       Show net	interface flags	in local ip module

       --localip-compact [?bool]
	       Show all	IPs in one line

       --dns-show-type enum
	       Specify the type	of DNS servers should be detected

       --netio-name-prefix str
	       Show interfaces with given name prefix only

       --netio-default-route-only [?bool]
	       Show the	interfac that is used for default routing only

       --netio-detect-total bool
	       Detect total bytes instead of current rate

       --netio-wait-time num
	       Set the wait time (in ms) when detecting	network	usage

       --publicip-timeout num
	       Time  in	 milliseconds  to wait for the public ip server	to re-
	      spond

       --publicip-url str
	       The URL of public IP detection server to	be used

       --publicip-ipv6 bool
	       Whether to use IPv6 for public IP detection server

       --weather-location str
	       Set the location	to be used

       --weather-timeout num
	       Time in milliseconds to wait for	the weather server to respond

       --weather-output-format str
	       The output weather format to be used

       --wm-detect-plugin [?bool]
	       Set if window manager plugin should be  detected	 on  supported
	      platforms

       --users-compact [?bool]
	       Show all	active users in	one line

       --users-myself-only [?bool]
	       Show only current user

       --player-name str
	       The name	of the player to use for module	Media and Player

       --opengl-library	enum
	       Set the OpenGL context creation library to use

       --command-shell str
	       Set the shell program to	execute	the command text

       --command-param str
	       Set the parameter used when starting the	shell

       --command-key str
	       Set the module key to display

       --command-text str
	       Set the command text to be executed

       --colors-symbol enum
	       Set the symbol to be printed by Colors module

       --colors-padding-left num
	       Set the number of white spaces to print before the symbol

       --colors-block-width num
	       Set the block width in spaces

       --colors-block-range-start num
	       Set the start range of colors in	the blocks to print

       --colors-block-range-end	num
	       Set the end range of colors in the blocks to print

   General module:
       --<module>-format format
	       ['Set  the  format string to use	for each specific module', 'To
	      see how a	format string works, use "fastfetch -h format".',  'To
	      see help about a specific	format string, use "fastfetch -h <mod-
	      ule>-format"']

       --<module>-key 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']

       --<module>-key-color color
	       Override	 the  global  "--color-keys"  option for each specific
	      module

       --<module>-key-icon string
	       Set the icon to be displayed by "--key-type icon"

       --<module>-output-color color
	       Override	the global "--color-output" option for	each  specific
	      module

       --<module>-key-width num
	       Override	the global "--key-width" option	for each specific mod-
	      ule

       --<module>-percent-green	num
	       ['Threshold  of	percentage  colors', 'Value less then percent-
	      green will be shown in green']

       --<module>-percent-yellow num
	       ['Threshold of percentage colors', 'Value greater than percent-
	      green and	less then yellow will  be  shown  in  yellow',	'Value
	      greater than percent-yellow will be shown	in red']

       --<module>-percent-type num
	       Set the percentage output type

       --<module>-temp-green num
	       ['Threshold of temperature colors', 'Value less then temp-green
	      will be shown in green']

       --<module>-temp-yellow num
	       ['Threshold  of	temperature colors', 'Value greater than temp-
	      green and	less then yellow will  be  shown  in  yellow',	'Value
	      greater than temp-yellow will be shown in	red']

EXAMPLES
   Config files:
       // ~/.config/fastfetch/config.jsonc
       {
	   "$schema": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json",
	   "modules": [
	       "title",
	       "separator",
	       "module1",
	       {
		   "type": "module2",
		   "module2-option": "value"
	       }
	   ]
       }

BUGS
       Please  report bugs to :	https://github.com/fastfetch-cli/fastfetch/is-
       sues

2.39.1				  Apr 14 2025			  FASTFETCH(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=fastfetch&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help