1NEOFETCH(1)                      User Commands                     NEOFETCH(1)
2
3
4

NAME

6       Neofetch - A fast, highly customizable system info script
7

SYNOPSIS

9       neofetch func_name --option "value" --option "value"
10

DESCRIPTION

12       Neofetch  is  a  CLI  system information tool written in BASH. Neofetch
13       displays information about your system next to an image, your OS  logo,
14       or any ASCII file of your choice.
15
16       NOTE: Every launch flag has a config option.
17

OPTIONS

19   INFO:
20       func_name
21              Specify  a  function name (second part of info() from config) to
22              quickly display only that function's information.
23
24              Example: neofetch uptime --uptime_shorthand tiny
25
26              Example: neofetch uptime disk wm memory
27
28              This can be used in bars and scripts like so:
29
30              memory="$(neofetch memory)"; memory="${memory##*: }"
31
32              For multiple outputs at once (each line of info in an array):
33
34              IFS=$'\n' read -d "" -ra info < <(neofetch memory uptime wm)
35
36              info=("${info[@]##*: }")
37
38       --disable infoname
39              Allows you to disable an info line from appearing in the output.
40              'infoname' is the function name from the 'print_info()' function
41              inside the config file.  For  example:  'info  "Memory"  memory'
42              would be '--disable memory'
43
44              NOTE:  You can supply multiple args. eg. 'neofetch --disable cpu
45              gpu'
46
47       --package_managers on/off
48              Hide/Show Package Manager names . (tiny, on, off)
49
50       --os_arch on/off
51              Hide/Show OS architecture.
52
53       --speed_type type
54              Change the type of cpu speed to display.  Possible values:  cur‐
55              rent, min, max, bios, scaling_current, scaling_min, scaling_max
56
57              NOTE: This only supports Linux with cpufreq.
58
59       --speed_shorthand on/off
60              Whether or not to show decimals in CPU speed.
61
62       NOTE: This flag is not supported in systems with CPU speed less than
63              1 GHz.
64
65       --cpu_brand on/off
66              Enable/Disable CPU brand in output.
67
68       --cpu_cores type
69              Whether  or not to display the number of CPU cores Possible val‐
70              ues: logical, physical, off
71
72              NOTE: 'physical' doesn't work on BSD.
73
74       --cpu_speed on/off
75              Hide/Show cpu speed.
76
77       --cpu_temp C/F/off
78              Hide/Show cpu temperature.
79
80              NOTE: This only works on Linux and BSD.
81
82       NOTE: For FreeBSD and NetBSD-based systems, you need to enable
83              coretemp kernel module. This only supports newer  Intel  proces‐
84              sors.
85
86       --distro_shorthand on/off
87              Shorten the output of distro (tiny, on, off)
88
89              NOTE: This option won't work in Windows (Cygwin)
90
91       --kernel_shorthand on/off
92              Shorten the output of kernel
93
94              NOTE: This option won't work in BSDs (except PacBSD and PC-BSD)
95
96       --uptime_shorthand on/off
97              Shorten the output of uptime (tiny, on, off)
98
99       --refresh_rate on/off
100              Whether  to display the refresh rate of each monitor Unsupported
101              on Windows
102
103       --gpu_brand on/off
104              Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
105
106       --gpu_type type
107              Which GPU to display. (all, dedicated, integrated)
108
109              NOTE: This only supports Linux.
110
111       --gtk_shorthand on/off
112              Shorten output of gtk theme/icons
113
114       --gtk2 on/off
115              Enable/Disable gtk2 theme/font/icons output
116
117       --gtk3 on/off
118              Enable/Disable gtk3 theme/font/icons output
119
120       --shell_path on/off
121              Enable/Disable showing $SHELL path
122
123       --shell_version on/off
124              Enable/Disable showing $SHELL version
125
126       --disk_show value
127              Which disks to  display.   Possible  values:  '/',  '/dev/sdXX',
128              '/path/to/mount point'
129
130              NOTE:   Multiple   values   can   be   given.  (--disk_show  '/'
131              '/dev/sdc1')
132
133       --disk_subtitle type
134              What information to append to the Disk subtitle.   Takes:  name,
135              mount, dir
136
137              'name' shows the disk's name (sda1, sda2, etc)
138
139              'mount' shows the disk's mount point (/, /mnt/Local Disk, etc)
140
141              'dir'  shows  the  basename of the disks's path. (/, Local Disk,
142              etc)
143
144       --ip_host url
145              URL to query for public IP
146
147       --ip_timeout int
148              Public IP timeout (in seconds).
149
150       --song_format format
151              Print the song data in a specific format (see config file).
152
153       --song_shorthand on/off
154              Print the Artist/Album/Title on separate lines.
155
156       --memory_percent on/off
157              Display memory percentage.
158
159       --music_player player-name
160              Manually specify a player to use.  Available values  are  listed
161              in the config file
162
163   TEXT FORMATTING:
164       --colors x x x x x x
165              Changes the text colors in this order: title, @, underline, sub‐
166              title, colon, info
167
168       --underline on/off
169              Enable/Disable the underline.
170
171       --underline_char char
172              Character to use when underlining title
173
174       --bold on/off
175              Enable/Disable bold text
176
177       --separator string
178              Changes the default ':' separator to the specified string.
179
180   COLOR BLOCKS:
181       --color_blocks on/off
182              Enable/Disable the color blocks
183
184       --block_width num
185              Width of color blocks in spaces
186
187       --block_height num
188              Height of color blocks in lines
189
190       --block_range num num
191              Range of colors to print as blocks
192
193   BARS:
194       --bar_char 'elapsed char' 'total char'
195              Characters to use when drawing bars.
196
197       --bar_border on/off
198              Whether or not to surround the bar with '[]'
199
200       --bar_length num
201              Length in spaces to make the bars.
202
203       --bar_colors num num
204              Colors to make the bar.  Set in this order: elapsed, total
205
206       --cpu_display mode
207              Bar mode.  Possible values: bar, infobar, barinfo, off
208
209       --memory_display mode
210              Bar mode.  Possible values: bar, infobar, barinfo, off
211
212       --battery_display mode
213              Bar mode.  Possible values: bar, infobar, barinfo, off
214
215       --disk_display mode
216              Bar mode.  Possible values: bar, infobar, barinfo, off
217
218   IMAGE BACKEND:
219       --backend backend
220              Which image backend to use.  Possible values:  'ascii',  'caca',
221              'chafa', 'jp2a', 'iterm2', 'off', 'sixel', 'tycat', 'w3m'
222
223       --source source
224              Which  image  or  ascii  file  to use.  Possible values: 'auto',
225              'ascii',    'wallpaper',    '/path/to/img',    '/path/to/ascii',
226              '/path/to/dir/', 'command output' [ascii]
227
228       --ascii source
229              Shortcut to use 'ascii' backend.
230
231              NEW: neofetch --ascii "$(fortune | cowsay -W 30)"
232
233       --caca source
234              Shortcut to use 'caca' backend.
235
236       --chafa source
237              Shortcut to use 'chafa' backend.
238
239       --iterm2 source
240              Shortcut to use 'iterm2' backend.
241
242       --jp2a source
243              Shortcut to use 'jp2a' backend.
244
245       --kitty source
246              Shortcut to use 'kitty' backend.
247
248       --pixterm source
249              Shortcut to use 'pixterm' backend.
250
251       --sixel source
252              Shortcut to use 'sixel' backend.
253
254       --termpix source
255              Shortcut to use 'termpix' backend.
256
257       --tycat source
258              Shortcut to use 'tycat' backend.
259
260       --w3m source
261              Shortcut to use 'w3m' backend.
262
263       --off  Shortcut to use 'off' backend (Disable ascii art).
264
265              NOTE:  'source;  can  be  any of the following: 'auto', 'ascii',
266              'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'
267
268   ASCII:
269       --ascii_colors x x x x x x
270              Colors to print the ascii art
271
272       --ascii_distro distro
273              Which Distro's ascii art to print
274
275              NOTE: Arch and Ubuntu have 'old' logo variants.
276
277              NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
278
279              NOTE: Ubuntu has flavor variants.
280
281       NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu-GNOME',
282              'Ubuntu-Studio' or 'Ubuntu-Budgie' to use the flavors.
283
284       NOTE: Alpine, Arch, CRUX, Debian, Gentoo, FreeBSD, Mac, NixOS,
285              OpenBSD, and Void have a smaller logo variant.
286
287              NOTE: Use '{distro name}_small' to use the small variants.
288
289       --ascii_bold on/off
290              Whether or not to bold the ascii logo.
291
292       -L, --logo
293              Hide the info text and only show the ascii logo.
294
295   IMAGE:
296       --loop Redraw the image constantly until Ctrl+C  is  used.  This  fixes
297              issues in some terminals emulators when using image mode.
298
299       --size 00px | --size 00%
300              How to size the image.  Possible values: auto, 00px, 00%, none
301
302       --crop_mode mode
303              Which crop mode to use Takes the values: normal, fit, fill
304
305       --crop_offset value
306              Change the crop offset for normal mode.  Possible values: north‐
307              west, north, northeast, west, center,  east,  southwest,  south,
308              southeast
309
310       --xoffset px
311              How close the image will be to the left edge of the window. This
312              only works with w3m.
313
314       --yoffset px
315              How close the image will be to the top edge of the window.  This
316              only works with w3m.
317
318       --bg_color color
319              Background color to display behind transparent image.  This only
320              works with w3m.
321
322       --gap num
323              Gap between image and text.
324
325       NOTE: --gap can take a negative value which will move the text
326              closer to the left side.
327
328       --clean
329              Delete cached files and thumbnails.
330
331   OTHER:
332       --config /path/to/config
333              Specify a path to a custom config file
334
335       --config none
336              Launch the script without a config file
337
338       --print_config
339              Print the default config file to stdout.
340
341       --stdout
342              Turn off all colors and disables any ASCII/image backend.
343
344       --help Print this text and exit
345
346       --version
347              Show neofetch version
348
349       -v     Display error messages.
350
351       -vv    Display a verbose log for error reporting.
352
353   DEVELOPER:
354       --gen-man
355              Generate a manpage for  Neofetch  in  your  PWD.  (Requires  GNU
356              help2man)
357

REPORTING BUGS

359       Report bugs to https://github.com/dylanaraps/neofetch/issues
360
361
362
363Neofetch 6.0.0                   January 2019                      NEOFETCH(1)
Impressum