Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Config File

Dylan Araps edited this page Jan 30, 2017 · 22 revisions

#!/usr/bin/env bash

Neofetch config file

See this wiki page for more info:

print_info() { info title info underline

info "OS" distro
info "Model" model
info "Kernel" kernel
info "Uptime" uptime
info "Packages" packages
info "Shell" shell
info "Resolution" resolution
info "DE" de
info "WM" wm
info "WM Theme" wm_theme
info "Theme" theme
info "Icons" icons
info "Terminal" term
info "Terminal Font" term_font
info "CPU" cpu
info "GPU" gpu
info "Memory" memory

# info "CPU Usage" cpu_usage
# info "Disk" disk
# info "Battery" battery
# info "Font" font
# info "Song" song
# info "Local IP" local_ip
# info "Public IP" public_ip
# info "Users" users
# info "Install Date" install_date

info line_break
info cols
info line_break

}

Kernel

Shorten the output of the kernel function.

Default: 'on'

Values: 'on', 'off'

Flag: --kernel_shorthand

Supports: Everything except *BSDs (except PacBSD and PC-BSD)

Example:

on: '4.8.9-1-ARCH'

off: 'Linux 4.8.9-1-ARCH'

kernel_shorthand="on"

Distro

Shorten the output of the distro function

Default: 'off'

Values: 'on', 'off', 'tiny'

Flag: --distro_shorthand

Supports: Everything except Windows and Haiku

distro_shorthand="off"

Show/Hide OS Architecture.

Show 'x86_64', 'x86' and etc in 'Distro:' output.

Default: 'on'

Values: 'on', 'off'

Flag: --os_arch

Example:

on: 'Arch Linux x86_64'

off: 'Arch Linux'

os_arch="on"

Uptime

Shorten the output of the uptime function

Default: 'on'

Values: 'on', 'off', 'tiny'

Flag: --uptime_shorthand

Example:

on: '2 days, 10 hours, 3 mins'

off: '2 days, 10 hours, 3 minutes'

tiny: '2d 10h 3m'

uptime_shorthand="on"

Shell

Show the path to $SHELL

Default: 'off'

Values: 'on', 'off'

Flag: --shell_path

Example:

on: '/bin/bash'

off: 'bash'

shell_path="off"

Show $SHELL version

Default: 'on'

Values: 'on', 'off'

Flag: --shell_version

Example:

on: 'bash 4.4.5'

off: 'bash'

shell_version="on"

CPU

CPU speed type

Default: 'bios_limit'

Values: 'scaling_cur_freq', 'scaling_min_freq', 'scaling_max_freq', 'bios_limit'.

Flag: --speed_type

Supports: Linux with 'cpufreq'

NOTE: Any file in '/sys/devices/system/cpu/cpu0/cpufreq' can be used as a value.

speed_type="bios_limit"

Shorten the output of the CPU function

Default: 'off'

Values: 'on', 'off', 'tiny', 'name', 'speed'

Flag: --cpu_shorthand

Example:

on: 'i7-6500U (4) @ 3.1GHz'

off: 'Intel i7-6500U (4) @ 3.1GHz'

tiny: 'i7-6500U (4)'

name: 'Intel i7-6500U (4)'

speed: '3.1GHz'

cpu_shorthand="off"

CPU Speed

Hide/Show CPU speed.

Default: 'on'

Values: 'on', 'off'

Flag: --cpu_speed

Example:

on: 'Intel i7-6500U (4) @ 3.1GHz'

off: 'Intel i7-6500U (4)'

cpu_speed="on"

CPU Cores

Display CPU cores in output

Default: 'logical'

Values: 'logical', 'physical', 'off'

Flag: --cpu_cores

Support: 'physical' doesn't work on BSD.

Example:

logical: 'Intel i7-6500U (4) @ 3.1GHz' (All virtual cores)

physical: 'Intel i7-6500U (2) @ 3.1GHz' (All physical cores)

off: 'Intel i7-6500U @ 3.1GHz'

cpu_cores="logical"

CPU Temperature

Hide/Show CPU temperature.

Note the temperature is added to the regular CPU function.

Default: 'off'

Values: 'C', 'F', 'off'

Flag: --cpu_temp

Supports: Linux

Example:

C: 'Intel i7-6500U (4) @ 3.1GHz [27.2°C]'

F: 'Intel i7-6500U (4) @ 3.1GHz [82.0°F]'

off: 'Intel i7-6500U (4) @ 3.1GHz'

cpu_temp="off"

GPU

Enable/Disable GPU Brand

Default: 'on'

Values: 'on', 'off'

Flag: --gpu_brand

Example:

on: 'AMD HD 7950'

off: 'HD 7950'

gpu_brand="on"

Which GPU to display

Default: 'all'

Values: 'all', 'dedicated', 'integrated'

Flag: --gpu_type

Supports: Linux

Example:

all:

GPU1: AMD HD 7950

GPU2: Intel Integrated Graphics

dedicated:

GPU1: AMD HD 7950

integrated:

GPU1: Intel Integrated Graphics

gpu_type="all"

Resolution

Display refresh rate next to each monitor

Default: 'off'

Values: 'on', 'off'

Flag: --refresh_rate

Supports: Doesn't work on Windows.

Example:

on: '1920x1080 @ 60Hz'

off: '1920x1080'

refresh_rate="off"

Gtk Theme / Icons / Font

Shorten output of GTK Theme / Icons / Font

Default: 'off'

Values: 'on', 'off'

Flag: --gtk_shorthand

Example:

on: 'Numix, Adwaita'

off: 'Numix [GTK2], Adwaita [GTK3]'

gtk_shorthand="off"

Enable/Disable gtk2 Theme / Icons / Font

Default: 'on'

Values: 'on', 'off'

Flag: --gtk2

Example:

on: 'Numix [GTK2], Adwaita [GTK3]'

off: 'Adwaita [GTK3]'

gtk2="on"

Enable/Disable gtk3 Theme / Icons / Font

Default: 'on'

Values: 'on', 'off'

Flag: --gtk3

Example:

on: 'Numix [GTK2], Adwaita [GTK3]'

off: 'Numix [GTK2]'

gtk3="on"

IP Address

Website to ping for the public IP

Default: 'http://ident.me'

Values: 'url'

Flag: --ip_host

public_ip_host="http://ident.me"

Disk

Which disks to display.

The values can be any /dev/sdXX, mount point or directory.

NOTE: By default we only show the disk info for '/'.

Default: '/'

Values: '/', '/dev/sdXX', '/path/to/drive'.

Flag: --disk_show

Example:

disk_show=('/' '/dev/sdb1'):

'Disk (/): 74G / 118G (66%)'

'Disk (/mnt/Videos): 823G / 893G (93%)'

disk_show=('/'):

'Disk (/): 74G / 118G (66%)'

disk_show=('/')

Disk subtitle.

What to append to the Disk subtitle.

Default: 'mount'

Values: 'mount', 'name'

Flag: --disk_subtitle

Example:

name: 'Disk (/dev/sda1): 74G / 118G (66%)'

'Disk (/dev/sdb2): 74G / 118G (66%)'

mount: 'Disk (/): 74G / 118G (66%)'

'Disk (/mnt/Local Disk): 74G / 118G (66%)'

disk_subtitle="mount"

Song

Print the Artist and Title on separate lines

Default: 'off'

Values: 'on', 'off'

Flag: --song_shorthand

Example:

on: 'Artist: The Fratellis'

'Song: Chelsea Dagger'

off: 'Song: The Fratellis - Chelsea Dagger'

song_shorthand="off"

Install Date

Whether to show the time in the output

Default: 'on'

Values: 'on', 'off'

Flag: --install_time

Example:

on: 'Thu 14 Apr 2016 11:50 PM'

off: 'Thu 14 Apr 2016'

install_time="on"

Set time format in the output

Default: '24h'

Values: '12h', '24h'

Flag: --install_time_format

Example:

12h: 'Thu 14 Apr 2016 11:50 PM'

24h: 'Thu 14 Apr 2016 23:50'

install_time_format="12h"

Text Colors

Text Colors

Default: 'distro'

Values: 'distro', 'num' 'num' 'num' 'num' 'num' 'num'

Flag: --colors

Each number represents a different part of the text in

this order: 'title', '@', 'underline', 'subtitle', 'colon', 'info'

Example:

colors=(distro) - Text is colored based on Distro colors.

colors=(4 6 1 8 8 6) - Text is colored in the order above.

colors=(distro)

Text Options

Toggle bold text

Default: 'on'

Values: 'on', 'off'

Flag: --bold

bold="on"

Enable/Disable Underline

Default: 'on'

Values: 'on', 'off'

Flag: --underline

underline_enabled="on"

Underline character

Default: '-'

Values: 'string'

Flag: --underline_char

underline_char="-"

Color Blocks

Color block range

The range of colors to print.

Default: '0', '7'

Values: 'num'

Flag: --block_range

Example:

Display colors 0-7 in the blocks. (8 colors)

neofetch --block_range 0 7

Display colors 0-15 in the blocks. (16 colors)

neofetch --block_range 0 15

block_range=(0 7)

Toggle color blocks

Default: 'on'

Values: 'on', 'off'

Flag: --color_blocks

color_blocks="on"

Color block width in spaces

Default: '3'

Values: 'num'

Flag: --block_width

block_width=3

Color block height in lines

Default: '1'

Values: 'num'

Flag: --block_height

block_height=1

Progress Bars

Bar characters

Default: '-', '='

Values: 'string', 'string'

Flag: --bar_char

Example:

neofetch --bar_char 'elapsed' 'total'

neofetch --bar_char '-' '='

bar_char_elapsed="-" bar_char_total="="

Toggle Bar border

Default: 'on'

Values: 'on', 'off'

Flag: --bar_border

bar_border="on"

Progress bar length in spaces

Number of chars long to make the progress bars.

Default: '15'

Values: 'num'

Flag: --bar_length

bar_length=15

Progress bar colors

When set to distro, uses your distro's logo colors.

Default: 'distro', 'distro'

Values: 'distro', 'num'

Flag: --bar_colors

Example:

neofetch --bar_colors 3 4

neofetch --bar_colors distro 5

bar_color_elapsed="distro" bar_color_total="distro"

Info display

Display a bar with the info.

Default: 'off'

Values: 'bar', 'infobar', 'barinfo', 'off'

Flags: --cpu_display

--memory_display

--battery_display

--disk_display

Example:

bar: '[---=======]'

infobar: 'info [---=======]'

barinfo: '[---=======] info'

off: 'info'

cpu_display="off" memory_display="off" battery_display="off" disk_display="off"

Backend Settings

Image backend.

Default: 'ascii'

Values: 'ascii', 'caca', 'catimg', 'jp2a', 'iterm2', 'off', 'tycat', 'w3m'

Flag: --backend

image_backend="ascii"

Image Source

Which image or ascii file to display.

Default: 'auto'

Values: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'

Flag: --source

NOTE: 'auto' will pick the best image source for whatever image backend is used.

In ascii mode, distro ascii art will be used and in an image mode, your

wallpaper will be used.

image_source="auto"

Ascii Options

Ascii distro

Which distro's ascii art to display.

Default: 'auto'

Values: 'auto', 'distro_name'

Flag: --ascii_distro

NOTE: Arch and Ubuntu have 'old' logo variants.

Change this to 'arch_old' or 'ubuntu_old' to use the old logos.

NOTE: Ubuntu has flavor variants.

Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu-GNOME' or 'Ubuntu-Budgie' to use the flavors.

NOTE: Arch, Crux and Gentoo have a smaller logo variant.

Change this to 'arch_small', 'crux_small' or 'gentoo_small' to use the small logos.

ascii_distro="auto"

Ascii Colors

Default: 'distro'

Values: 'distro', 'num' 'num' 'num' 'num' 'num' 'num'

Flag: --ascii_colors

Example:

ascii_colors=(distro) - Ascii is colored based on Distro colors.

ascii_colors=(4 6 1 8 8 6) - Ascii is colored using these colors.

ascii_colors=(distro)

Bold ascii logo

Whether or not to bold the ascii logo.

Default: 'on'

Values: 'on', 'off'

Flag: --ascii_bold

ascii_bold="on"

Image Options

Thumbnail directory

Default: '~/.cache/thumbnails/neofetch'

Values: 'dir'

thumbnail_dir="${XDG_CACHE_HOME:-${HOME}/.cache}/thumbnails/neofetch"

Crop mode

Default: 'normal'

Values: 'normal', 'fit', 'fill'

Flag: --crop_mode

See this wiki page to learn about the fit and fill options.

crop_mode="normal"

Crop offset

Note: Only affects 'normal' crop mode.

Default: 'center'

Values: 'northwest', 'north', 'northeast', 'west', 'center'

'east', 'southwest', 'south', 'southeast'

Flag: --crop_offset

crop_offset="center"

Image size

The image is half the terminal width by default.

Default: 'auto'

Values: 'auto', '00px', '00%', 'none'

Flags: --image_size

--size

image_size="auto"

Ggap between image and text

Default: '3'

Values: 'num', '-num'

Flag: --gap

gap=3

Image offsets

Only works with the w3m backend.

Default: '0'

Values: 'px'

Flags: --xoffset

--yoffset

yoffset=0 xoffset=0

Image background color

Only works with the w3m backend.

Default: ''

Values: 'color', 'blue'

Flag: --bg_color

background_color=

Scrot Options

Whether or not to always take a screenshot

You can manually take a screenshot with "--scrot" or "-s"

Default: 'off'

Values: 'on', 'off'

Flags: --scrot

-s

scrot="off"

Screenshot Program

Neofetch will automatically use whatever screenshot tool

is installed on your system.

If 'neofetch -v' says that it couldn't find a screenshot

tool or you're using a custom tool then you can change

the option below to a custom command.

Default: 'auto'

Values: 'auto' 'cmd -flags'

Flag: --scrot_cmd

scrot_cmd="auto"

Screenshot Directory

Where to save the screenshots

Default: '~/Pictures/'

Values: 'dir'

Flag: --scrot_dir

Note: Neofetch won't create the directory if it doesn't exist.

scrot_dir="$HOME/Pictures/"

Screenshot Filename

What to name the screenshots

Default: 'neofetch-$(date +%F-%I-%M-%S-${RANDOM}).png'

Values: 'string'

Flag: --scrot_name

scrot_name="neofetch-$(date +%F-%I-%M-%S-${RANDOM}).png"

Image upload host

Where to upload the image.

Default: 'teknik'

Values: 'imgur', 'teknik'

Flag: --image_host

NOTE: If you'd like another image host to be added to Neofetch.

Open an issue on github.

image_host="teknik"

Misc Options

Config version.

NOTE: Don't change this value, neofetch reads this to determine

how to handle backwards compatibility.

config_version="3.0.1"

Clone this wiki locally