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

REPORTING BUGS

411       Report bugs to https://github.com/dylanaraps/neofetch/issues
412
413
414
415Neofetch 7.1.0                     Aug 2020                        NEOFETCH(1)
Impressum