fastfetch.1.in

.TH FASTFETCH 1 "@FASTFETCH_BUILD_DATE@" "@CMAKE_PROJECT_NAME@ @CMAKE_PROJECT_VERSION@"

.SH NAME
fastfetch \- a neofetch\-like tool for fetching system information and
displaying them in a pretty way

.SH SYNOPSIS

.B fastfetch
.I [options...]

.SH DESCRIPTION

Fastfetch is a neofetch\-like tool for fetching system information and
displaying them in a pretty way. It is written mainly in C, with performance
and customizability in mind.
Currently, Linux, Android, FreeBSD, MacOS and Windows 7+ are supported.

.SH "EXIT STATUS"

On successful execution, fastfetch returns zero. If any error happened,
the exit code will be non\-zero.

.SH OPTIONS

.SS "Informative Options"
.TP

.B \-h, \-\-help \fI[command]
Show help output, displaying all available options or help for given command
.TP

.B \-v, \-\-version
Show version of fastfetch
.TP

.B \-\-list\-config\-paths
List search paths of config files
.TP

.B \-\-list\-data\-paths
List search paths of presets and logos
.TP

.B \-\-list\-logos
List available logos, they can be loaded with \fI\-\-logo
.TP

.B \-\-list\-modules
List available modules
.TP

.B \-\-list\-presets
List available presets, they can be loaded with \fI\-\-config
.TP

.B \-\-list\-features
List the supported features fastfetch was compiled with
.TP

.B \-\-print\-logos
Print available logos
.TP

.B \-\-print\-structure
Print the default structure
.TP

.B \-\-format \fI<type>
Set the output format. Besides the
.I default
format, only
.I json
is supported currently.


.SS "Display Options"
.TP

.B \-l, \-\-logo \fI<logo>
Set the logo to display
.TP

.B \-s, \-\-structure \fI<structure>
Set the structure of the fetch. For details about the structure,
see the CONFIGURATION section.


.SS "Config Options"
.TP

.B \-c, \-\-config \fI<config>
Use the specified config file or preset. If
.I none
is specified, disable further config loading. For details about
config files, see the CONFIGURATION section
.TP

.B \-\-gen\-config \fI[file]
Generate a config file with options specified on the command line.
If \fIfile\fR is specified, the configuration will be written to the
file, otherwise it will be written to stdout.
.TP

.B \-\-gen\-config\-force \fI[file]
Same as \fB\-\-gen\-config\fR, but overwrites existing config
.TP


To list all options, use \fB\-\-help\fR. It will also print all available module options.

.SH CONFIGURATION
.SS "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 \fB\-\-list\-modules\fR

.SS "Config Files"

Fastfetch uses JSONC based format for configuration. Fastfetch doesn't generate
config file automatically; it should be generated manually by \fB\-\-gen\-config\fR.
The config file will be saved in \fB~/.config/fastfetch/config.jsonc\fR 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 \fB\-\-list\-presets\fR.

.SH "SEE ALSO"
.BR neofetch (1)

.SH BUGS
Please report bugs to: \fIhttps://github.com/fastfetch\-cli/fastfetch/issues\fR