1.TH FASTFETCH 1 "@FASTFETCH_BUILD_DATE@" "@CMAKE_PROJECT_NAME@ @CMAKE_PROJECT_VERSION@"
  2
  3.SH NAME
  4fastfetch \- a fast and customizable system information tool similar to neofetch
  5
  6.SH SYNOPSIS
  7
  8.B fastfetch
  9.I [options...]
 10
 11.SH DESCRIPTION
 12
 13Fastfetch is a tool for displaying system information in a visually appealing way. Written primarily in C, it focuses on performance and customizability while providing functionality similar to neofetch.
 14It supports Linux, Android, *BSD, macOS, Haiku, and Windows 7 or newer.
 15
 16.SH "EXIT STATUS"
 17
 18Fastfetch returns zero on successful execution. Any errors result in a non-zero exit code.
 19
 20.SH OPTIONS
 21
 22.SS "Informative Options"
 23.TP
 24
 25.B \-h, \-\-help \fI[command]
 26Display help information for all available options or for a specific command
 27.TP
 28
 29.B \-v, \-\-version
 30Display the version of fastfetch
 31.TP
 32
 33.B \-\-version\-raw
 34Display the raw version string (major.minor.patch)
 35.TP
 36
 37.B \-\-list\-config\-paths
 38List search paths for configuration files
 39.TP
 40
 41.B \-\-list\-data\-paths
 42List search paths for presets and logos
 43.TP
 44
 45.B \-\-list\-logos
 46List available logos that can be loaded with \fI\-\-logo
 47.TP
 48
 49.B \-\-list\-modules
 50List all available modules
 51.TP
 52
 53.B \-\-list\-presets
 54List available presets that can be loaded with \fI\-\-config
 55.TP
 56
 57.B \-\-list\-features
 58List the features that fastfetch was compiled with (mainly for development)
 59.TP
 60
 61.B \-\-print\-logos
 62Display all available logos
 63.TP
 64
 65.B \-\-print\-structure
 66Display the default structure
 67.TP
 68
 69.B \-\-format \fI<type>
 70Set the output format. Available options are:
 71.RS
 72.IP \(bu 2
 73\fIdefault\fR: Default human-readable format
 74.IP \(bu 2
 75\fIjson\fR: JSON format for machine processing
 76.RE
 77
 78.SS "Config Options"
 79.TP
 80
 81.B \-c, \-\-config \fI<config>
 82Use the specified config file or preset. Specify \fInone\fR to disable further config loading. See the CONFIGURATION section for details on config files.
 83.TP
 84
 85.B \-\-gen\-config \fI[path]
 86Generate a config file with options specified on the command line. If \fIpath\fR is not specified, it defaults to \fB~/.config/fastfetch/config.jsonc\fR. If \fIpath\fR is "\-", the configuration will be written to stdout.
 87.TP
 88
 89.B \-\-gen\-config\-force \fI[path]
 90Same as \fB\-\-gen\-config\fR, but overwrites any existing file at the destination path.
 91.TP
 92
 93.SS "Logo Options"
 94.TP
 95
 96.B \-l, \-\-logo \fI<logo>
 97Set the logo to display. Can be the name of a built-in logo or a path to an image file. Use \fInone\fR to disable the logo.
 98.TP
 99
100.B \-\-logo\-type \fI<type>
101Set the type of the logo specified with \fI\-\-logo\fR. Available types include \fIauto\fR, \fIbuiltin\fR, \fIfile\fR, \fIsixel\fR, \fIkitty\fR, and others. See \fB\-\-help logo\-type\fR for details.
102.TP
103
104.B \-\-logo\-width \fI<width>
105Set the width of the logo in characters (for image logos)
106.TP
107
108.B \-\-logo\-height \fI<height>
109Set the height of the logo in characters (for image logos)
110.TP
111
112.B \-\-logo\-color\-[1\-9] \fI<color>
113Override specific colors in the logo
114
115.SS "Display Options"
116.TP
117
118.B \-s, \-\-structure \fI<structure>
119Set the structure of the fetch (a colon-separated list of module names)
120.TP
121
122.B \-\-color \fI<color>
123Set the color of keys and title. See \fB\-\-help color\fR for available colors.
124.TP
125
126.B \-\-color\-keys \fI<color>
127Set the color of keys only
128.TP
129
130.B \-\-color\-title \fI<color>
131Set the color of the title only
132.TP
133
134.B \-\-separator \fI<string>
135Set the separator between key and value (default: ": ")
136.TP
137
138.B \-\-key\-width \fI<num>
139Align the width of keys to \fI<num>\fR characters
140.TP
141
142.B \-\-show\-errors
143Display errors when they occur (default: false)
144.TP
145
146.B \-\-pipe
147Disable colors (automatically detected based on whether stdout is a terminal)
148
149To list all available options including module-specific options, use \fB\-\-help\fR.
150
151.SH CONFIGURATION
152.SS "Fetch Structure"
153The structure defines which modules to display and in what order. It consists of module names separated by colons (:).
154For example: \fBtitle:separator:os:kernel:uptime\fR
155
156To list all available modules, use \fB\-\-list\-modules\fR
157
158.SS "Config Files"
159
160Fastfetch uses JSONC for configuration files. JSONC is JSON with support for comments (// and /* */). Configuration files must have the .jsonc extension.
161
162You can generate a default config file using \fB\-\-gen\-config\fR. By default, the config file is saved at \fB~/.config/fastfetch/config.jsonc\fR.
163
164The configuration/preset files are searched in the following locations (in order):
165
166.RS
167.IP 1. 4
168Relative to the current working directory
169.IP 2. 4
170Relative to ~/.local/share/fastfetch/presets/
171.IP 3. 4
172Relative to /usr/share/fastfetch/presets/
173.RE
174
175For detailed information on logo options, module configuration, and formatting, visit:
176.RS
177\fIhttps://github.com/fastfetch-cli/fastfetch/wiki/Configuration\fR
178.RE
179
180Fastfetch provides several built-in presets. List them with \fB\-\-list\-presets\fR.
181
182.SS "JSON Schema"
183A JSON schema is available for editor intelligence when editing the configuration file. Add the following line at the beginning of your config file:
184.PP
185\fB"$schema": "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json"\fR
186
187.SH EXAMPLES
188.TP
189Basic usage:
190.RS
191\fBfastfetch\fR
192.RE
193.TP
194Use a specific logo:
195.RS
196\fBfastfetch \-\-logo arch\fR
197.RE
198.TP
199Custom structure:
200.RS
201\fBfastfetch \-\-structure title:os:kernel:uptime:memory\fR
202.RE
203.TP
204Generate a config file:
205.RS
206\fBfastfetch \-\-gen\-config\fR
207.RE
208.TP
209Use a preset:
210.RS
211\fBfastfetch \-\-config neofetch\fR
212.RE
213
214.SH "SEE ALSO"
215.BR neofetch (1)
216
217.SH BUGS
218Please report bugs to: \fIhttps://github.com/fastfetch\-cli/fastfetch/issues\fR
219
220.SH AUTHORS
221Fastfetch is developed by a team of contributors on GitHub.
222Visit \fIhttps://github.com/fastfetch-cli/fastfetch\fR for more information.