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 . (on, tiny, 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 (on, tiny, 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 (on, tiny, 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       --de_version on/off
112              Show/Hide Desktop Environment version
113
114       --gtk_shorthand on/off
115              Shorten output of gtk theme/icons
116
117       --gtk2 on/off
118              Enable/Disable gtk2 theme/font/icons output
119
120       --gtk3 on/off
121              Enable/Disable gtk3 theme/font/icons output
122
123       --shell_path on/off
124              Enable/Disable showing $SHELL path
125
126       --shell_version on/off
127              Enable/Disable showing $SHELL version
128
129       --disk_show value
130              Which disks to  display.   Possible  values:  '/',  '/dev/sdXX',
131              '/path/to/mount point'
132
133              NOTE:   Multiple   values   can   be   given.  (--disk_show  '/'
134              '/dev/sdc1')
135
136       --disk_subtitle type
137              What information to append to the Disk subtitle.   Takes:  name,
138              mount, dir, none
139
140              'name' shows the disk's name (sda1, sda2, etc)
141
142              'mount' shows the disk's mount point (/, /mnt/Local Disk, etc)
143
144              'dir'  shows  the  basename of the disks's path. (/, Local Disk,
145              etc)
146
147              'none' shows only 'Disk' or the configured title.
148
149       --disk_percent on/off
150              Hide/Show disk percent.
151
152       --ip_host url
153              URL to query for public IP
154
155       --ip_timeout int
156              Public IP timeout (in seconds).
157
158       --song_format format
159              Print the song data in a specific format (see config file).
160
161       --song_shorthand on/off
162              Print the Artist/Album/Title on separate lines.
163
164       --memory_percent on/off
165              Display memory percentage.
166
167       --music_player player-name
168              Manually specify a player to use.  Available values  are  listed
169              in the config file
170
171   TEXT FORMATTING:
172       --colors x x x x x x
173              Changes the text colors in this order: title, @, underline, sub‐
174              title, colon, info
175
176       --underline on/off
177              Enable/Disable the underline.
178
179       --underline_char char
180              Character to use when underlining title
181
182       --bold on/off
183              Enable/Disable bold text
184
185       --separator string
186              Changes the default ':' separator to the specified string.
187
188   COLOR BLOCKS:
189       --color_blocks on/off
190              Enable/Disable the color blocks
191
192       --col_offset auto/num
193              Left-padding of color blocks
194
195       --block_width num
196              Width of color blocks in spaces
197
198       --block_height num
199              Height of color blocks in lines
200
201       --block_range num num
202              Range of colors to print as blocks
203
204   BARS:
205       --bar_char 'elapsed char' 'total char'
206              Characters to use when drawing bars.
207
208       --bar_border on/off
209              Whether or not to surround the bar with '[]'
210
211       --bar_length num
212              Length in spaces to make the bars.
213
214       --bar_colors num num
215              Colors to make the bar.  Set in this order: elapsed, total
216
217       --cpu_display mode
218              Bar mode.  Possible values: bar, infobar, barinfo, off
219
220       --memory_display mode
221              Bar mode.  Possible values: bar, infobar, barinfo, off
222
223       --battery_display mode
224              Bar mode.  Possible values: bar, infobar, barinfo, off
225
226       --disk_display mode
227              Bar mode.  Possible values: bar, infobar, barinfo, off
228
229   IMAGE BACKEND:
230       --backend backend
231              Which image backend to use.  Possible values:  'ascii',  'caca',
232              'chafa',  'jp2a',  'iterm2',  'off',  'sixel',  'tycat',  'w3m',
233              'kitty'
234
235       --source source
236              Which image or ascii file  to  use.   Possible  values:  'auto',
237              'ascii',    'wallpaper',    '/path/to/img',    '/path/to/ascii',
238              '/path/to/dir/', 'command output' [ascii]
239
240       --ascii source
241              Shortcut to use 'ascii' backend.
242
243              NEW: neofetch --ascii "$(fortune | cowsay -W 30)"
244
245       --caca source
246              Shortcut to use 'caca' backend.
247
248       --chafa source
249              Shortcut to use 'chafa' backend.
250
251       --iterm2 source
252              Shortcut to use 'iterm2' backend.
253
254       --jp2a source
255              Shortcut to use 'jp2a' backend.
256
257       --kitty source
258              Shortcut to use 'kitty' backend.
259
260       --pixterm source
261              Shortcut to use 'pixterm' backend.
262
263       --sixel source
264              Shortcut to use 'sixel' backend.
265
266       --termpix source
267              Shortcut to use 'termpix' backend.
268
269       --tycat source
270              Shortcut to use 'tycat' backend.
271
272       --w3m source
273              Shortcut to use 'w3m' backend.
274
275       --off  Shortcut to use 'off' backend (Disable ascii art).
276
277              NOTE: 'source; can be any of  the  following:  'auto',  'ascii',
278              'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'
279
280   ASCII:
281       --ascii_colors x x x x x x
282              Colors to print the ascii art
283
284       --ascii_distro distro
285              Which Distro's ascii art to print
286
287       NOTE: AIX, Alpine, Anarchy, Android, Antergos, antiX, AOSC,
288              Apricity,  ArcoLinux,  ArchBox, ARCHlabs, ArchStrike, XFerience,
289              ArchMerge, Arch, Artix, Arya, Bedrock, Bitrig, BlackArch,  BLAG,
290              BlankOn,  BlueLight,  bonsai, BSD, BunsenLabs, Calculate, Carbs,
291              CentOS, Chakra, ChaletOS, Chapeau,  Chrom,  Cleanjaro,  ClearOS,
292              Clear_Linux,  Clover,  Condres, Container_Linux, CRUX, Cucumber,
293              Debian, Deepin, DesaOS, Devuan, DracOS, DragonFly, Drauger, Ele‐
294              mentary,   EndeavourOS,  Endless,  EuroLinux,  Exherbo,  Fedora,
295              Feren, FreeBSD, FreeMiNT, Frugalware, Funtoo, GalliumOS, Gentoo,
296              Pentoo,  gNewSense,  GNU,  GoboLinux,  Grombyang,  Guix,  Haiku,
297              Huayra,  Hyperbola,  janus,  Kali,  KaOS,   KDE_neon,   Kibojoe,
298              Kogaion,  Korora, KSLinux, Kubuntu, LEDE, LFS, Linux_Lite, LMDE,
299              Lubuntu, Lunar,  macos,  Mageia,  MagpieOS,  Mandriva,  Manjaro,
300              Maui,  Mer,  Minix, LinuxMint, MX_Linux, Namib, Neptune, NetBSD,
301              Netrunner, Nitrux, NixOS, Nurunner, NuTyX,  OBRevenge,  OpenBSD,
302              OpenIndiana,  OpenMandriva, OpenWrt, osmc, Oracle, PacBSD, Para‐
303              bola, Pardus, Parrot,  Parsix,  TrueOS,  PCLinuxOS,  Peppermint,
304              popos,  Porteus,  PostMarketOS,  Proxmox,  Puppy, PureOS, Qubes,
305              Radix,   Raspbian,   Reborn_OS,   Redstar,   Redcore,    Redhat,
306              Refracted_Devuan,  Regata,  Rosa,  sabotage,  Sabayon, Sailfish,
307              SalentOS, Scientific, Septor, SharkLinux, Siduction,  Slackware,
308              SliTaz,  SmartOS,  Solus,  Source_Mage,  Sparky,  Star, SteamOS,
309              SunOS, openSUSE_Leap, openSUSE_Tumbleweed,  openSUSE,  SwagArch,
310              Tails,   Trisquel,   Ubuntu-Budgie,  Ubuntu-GNOME,  Ubuntu-MATE,
311              Ubuntu-Studio,  Ubuntu,  Void,  Obarun,   windows10,   Windows7,
312              Xubuntu, Zorin, and IRIX have ascii logos
313
314              NOTE:  Arch, Ubuntu, Redhat, and Dragonfly have 'old' logo vari‐
315              ants.
316
317              NOTE: Use '{distro name}_old' to use the old logos.
318
319              NOTE: Ubuntu has flavor variants.
320
321       NOTE: Change this to Lubuntu, Kubuntu, Xubuntu, Ubuntu-GNOME,
322              Ubuntu-Studio, Ubuntu-Mate  or Ubuntu-Budgie to use the flavors.
323
324       NOTE: Arcolinux, Dragonfly, Fedora, Alpine, Arch, Ubuntu,
325              CRUX, Debian, Gentoo, FreeBSD,  Mac,  NixOS,  OpenBSD,  android,
326              Antrix,  CentOS,  Cleanjaro, ElementaryOS, GUIX, Hyperbola, Man‐
327              jaro, MXLinux,  NetBSD,  Parabola,  POP_OS,  PureOS,  Slackware,
328              SunOS,  LinuxLite,  OpenSUSE,  Raspbian,  postmarketOS, and Void
329              have a smaller logo variant.
330
331              NOTE: Use '{distro name}_small' to use the small variants.
332
333       --ascii_bold on/off
334              Whether or not to bold the ascii logo.
335
336       -L, --logo
337              Hide the info text and only show the ascii logo.
338
339   IMAGE:
340       --loop Redraw the image constantly until Ctrl+C  is  used.  This  fixes
341              issues in some terminals emulators when using image mode.
342
343       --size 00px | --size 00%
344              How to size the image.  Possible values: auto, 00px, 00%, none
345
346       --crop_mode mode
347              Which crop mode to use Takes the values: normal, fit, fill
348
349       --crop_offset value
350              Change the crop offset for normal mode.  Possible values: north‐
351              west, north, northeast, west, center,  east,  southwest,  south,
352              southeast
353
354       --xoffset px
355              How close the image will be to the left edge of the window. This
356              only works with w3m.
357
358       --yoffset px
359              How close the image will be to the top edge of the window.  This
360              only works with w3m.
361
362       --bg_color color
363              Background color to display behind transparent image.  This only
364              works with w3m.
365
366       --gap num
367              Gap between image and text.
368
369       NOTE: --gap can take a negative value which will move the text
370              closer to the left side.
371
372       --clean
373              Delete cached files and thumbnails.
374
375   OTHER:
376       --config /path/to/config
377              Specify a path to a custom config file
378
379       --config none
380              Launch the script without a config file
381
382       --no_config
383              Don't create the user config file.
384
385       --print_config
386              Print the default config file to stdout.
387
388       --stdout
389              Turn off all colors and disables any ASCII/image backend.
390
391       --help Print this text and exit
392
393       --version
394              Show neofetch version
395
396       -v     Display error messages.
397
398       -vv    Display a verbose log for error reporting.
399
400   DEVELOPER:
401       --gen-man
402              Generate a manpage for  Neofetch  in  your  PWD.  (Requires  GNU
403              help2man)
404

REPORTING BUGS

406       Report bugs to https://github.com/dylanaraps/neofetch/issues
407
408
409
410Neofetch 7.0.0                   January 2020                      NEOFETCH(1)
Impressum